Consultar extrato

Superfície ainda não disponível

Os endpoints financeiros descritos nesta seção ainda não estão publicados no gateway externo. Esta seção descreve o contrato-alvo e pode mudar antes da liberação — confirme a disponibilidade com o time de Integração (api@qitech.com.br) antes de implementar contra ela.

Retorna o extrato paginado das movimentações da sua posição de comissão: créditos por parcela liquidada, estornos de cancelamento e liquidações de repasse. Cada movimentação de comissão é correlacionada à apólice que a originou pelo policy_key.

Request

ENDPOINT

/finance/v1/statement

MÉTODO

GET

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
page	integer	opcional	Número da página. Padrão: 1.
page_size	integer	opcional	Registros por página. Padrão: 50. Máximo: 200.
from	string	opcional	Data mínima da movimentação (AAAA-MM-DD).
to	string	opcional	Data máxima da movimentação (AAAA-MM-DD).

Exemplo de chamada

GET /finance/v1/statement?from=2026-07-01&to=2026-07-31&page=1&page_size=50

Response

STATUS

200

Response Body

{
  "items": [
    {
      "event_type": "REQUESTER_COMMISSION_BOOKED",
      "amount": "14.64",
      "policy_key": "0b6e7c1a-9a4e-4c1e-b1d4-2f5a8c9e0d31",
      "installment_number": 1,
      "occurred_at": "2026-07-20T14:05:01.000Z"
    },
    {
      "event_type": "REQUESTER_CLAWBACK_BOOKED",
      "amount": "-14.64",
      "policy_key": "0b6e7c1a-9a4e-4c1e-b1d4-2f5a8c9e0d31",
      "occurred_at": "2026-07-25T11:00:00.000Z"
    },
    {
      "event_type": "TRANSFER_SETTLED",
      "amount": "-980.10",
      "transfer_key": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
      "occurred_at": "2026-07-21T09:00:12.000Z"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total": 3
}

Atributos da resposta

Campo	Tipo	Descrição
items	array	Movimentações da sua posição, da mais recente para a mais antiga.
page	integer	Página atual.
page_size	integer	Tamanho da página solicitado.
total	integer	Total de movimentações no período.

Objeto em items

Campo	Tipo	Descrição
event_type	string	Tipo da movimentação. Veja a tabela de tipos abaixo.
amount	string	Valor com sinal: positivo credita a posição, negativo debita (estornos e liquidações de repasse).
policy_key	string	Apólice que originou a movimentação. Presente em créditos de comissão e estornos.
installment_number	integer	Número da parcela liquidada que originou o crédito. Presente em créditos de comissão.
transfer_key	string	Repasse correspondente. Presente em liquidações de repasse.
occurred_at	string	Instante da movimentação.

Tipos de movimentação

event_type	Sinal	Significado
REQUESTER_COMMISSION_BOOKED	+	Comissão creditada sobre uma parcela de prêmio liquidada.
REQUESTER_CLAWBACK_BOOKED	−	Estorno de comissão pelo cancelamento de uma apólice com devolução de prêmio.
TRANSFER_SETTLED	−	Repasse liquidado na sua conta — a posição é debitada pelo valor transferido.
MANUAL_ADJUSTMENT	+/−	Ajuste operacional lançado pela QI Tech (ex.: resolução de incidente).

Possíveis erros

Status	Descrição
400	Parâmetro de filtro ou paginação inválido.
401 / 403	Falha de autenticação ou autorização.
500 / 503	Erro interno ou serviço indisponível — seguro repetir a chamada.