Pular para o conteúdo principal

Consulta de despesas

Lista as despesas de um fundo ou de todos os fundos da gestora. A lista traz todas as despesas do fundo: as lançadas pela gestora ou consultoria, inclusive as que ainda estão em análise, e as calculadas pela QI Tech. Para a consultoria, ela traz só as lançadas por agentes (expense_contract, expense, reimbursement e rebate_fee).

Listar despesas do fundo​

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Despesas ou Ler Consolidações

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/expense/fund_class/{fund_class_key}/expenses
MÉTODO
GET

Parâmetros de caminho​

ParâmetroTipoDescrição
fund_class_keystringChave da classe de fundo (UUID).

Parâmetros de consulta​

Todos opcionais. Parâmetros marcados como lista aceitam vários valores separados por vírgula.

ParâmetroTipoDescrição
pageintegerPágina, a partir de 0. Padrão: 0.
limitintegerItens por página, de 0 a 100. Padrão: 10.
statuslistaStatus da despesa. Valor desconhecido não dá erro; só não encontra nada.
expense_status_to_ignorestringExclui um status.
expense_typelistaTipos de despesa.
expense_type_to_ignorelistaExclui tipos de despesa.
origin_typelistaOrigens da despesa.
exclude_origin_typelistaExclui origens. Use rebate_fee para esconder os rebates.
reference_datestringData de referência exata, YYYY-MM-DD.
from_end_deferral_datestringend_deferral_date a partir desta data, YYYY-MM-DD.
to_end_deferral_datestringend_deferral_date até esta data, YYYY-MM-DD.
payment_date_startstringData de pagamento a partir desta data, YYYY-MM-DD.
payment_date_endstringData de pagamento até esta data, YYYY-MM-DD. Não pode ser anterior a payment_date_start.
ignore_paid_on_futurebooleantrue exclui despesas com pagamento confirmado depois da data de referência.
contract_keystringDespesas de um contrato.
vendor_keystringDespesas do fornecedor do contrato.
recipient_namestringParte do nome do fornecedor do contrato ou do favorecido do pagamento.
recipient_documentstringParte do CPF ou CNPJ do fornecedor ou do favorecido, com ou sem pontuação.
rebated_expense_keystringRebates de uma taxa de gestão.
created_by_agent_typestringmanager ou consultant: quem lançou a despesa.
permission_typestringowner ou viewer: a permissão de quem consulta sobre a despesa. Só traz despesas lançadas pela gestora ou consultoria.
descriptionstringParte da descrição.
kpistringIndicador: in_analysis, in_provision ou pending_invoice. Exclui despesas canceladas e rebates.
daysintegerPeríodo do kpi, contando hoje: 1, 7 ou 30.

A lista vem da despesa mais recente para a mais antiga.

Exemplo de chamada
GET /expense/fund_class/{fund_class_key}/expenses?status=consolidated,paid&exclude_origin_type=rebate_fee&limit=50

Resposta​

STATUS
200
Corpo da resposta
{
"data": [
{
"expense_key": "b7f1c8e2-5a7d-4c7f-9a0e-2c3d4e5f6a7b",
"fund_class": {
"name": "FIDC EXEMPLO",
"manager": {
"name": "EXEMPLO GESTORA LTDA",
"manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"document_number": "22.333.444/0001-81"
},
"fund_class_key": "c1d2e3f4-a5b6-4789-abcd-ef1234567890",
"document_number": "33.444.555/0001-81",
"accounting_date": "2026-11-06"
},
"status": "consolidated",
"type": "audit_tax",
"origin": {
"origin_type": "expense_contract",
"origin_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
},
"payment_value": 15000.0,
"created_by": {
"agent_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"agent_type": "manager",
"name": "EXEMPLO GESTORA LTDA"
},
"reference_date": "2026-11-06",
"start_deferral_date": null,
"end_deferral_date": null,
"consolidated_value": 15000.0,
"provisioned_value": null,
"recognized_value": 15000.0,
"payment": {
"target": {
"name": "AUDITORES EXEMPLO S.A.",
"document_number": "44.555.666/0001-81"
},
"target_account": {
"account_number": "123456",
"account_branch": "0001",
"account_digit": "7",
"financial_institution_code": "341",
"financial_institution_ispb": "60701190"
}
},
"expense_datetime": "2026-11-03T14:03:21Z",
"last_updated": "2026-11-06T10:15:40Z",
"description": "Auditoria do exercício 2026",
"payment_method": "transfer",
"payment_date": "2026-11-20",
"consolidation_analysis": {
"consolidation_analysis_key": "e3f4a5b6-c7d8-4e9f-8a0b-1c2d3e4f5a6b",
"analysis_number": 1,
"status": "approved"
},
"contract": {
"contract_key": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "Auditoria 2026",
"status": "active",
"vendor": {
"vendor_key": "5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57",
"name": "AUDITORES EXEMPLO S.A."
}
},
"rebate": false,
"rebated_expense_key": null,
"permission_type": "owner"
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}

Atributos de cada despesa​

CampoTipoDescrição
expense_keystringChave da despesa (UUID).
fund_classobjectClasse de fundo: name, fund_class_key, document_number, accounting_date (data contábil atual, YYYY-MM-DD) e manager (name, manager_key, document_number).
statusstringStatus da despesa. Ver status.
typestringTipo da despesa. Ver tipos.
originobjectorigin_type e origin_key. Ver origem.
payment_valuenumberValor a pagar, ou null.
created_byobjectQuem lançou: agent_key, agent_type (manager ou consultant), name. null para despesas calculadas pela QI Tech.
reference_datestringData em que a despesa entrou na carteira, YYYY-MM-DD, ou null enquanto está na etapa de submissão.
start_deferral_datestringInício da provisão, YYYY-MM-DD, ou null.
end_deferral_datestringFim da provisão, YYYY-MM-DD, ou null.
consolidated_valuenumberValor consolidado, ou null.
provisioned_valuenumberValor provisionado, ou null.
recognized_valuenumberValor já reconhecido na carteira.
paymentobjectDados de pagamento: target (name, document_number) e, conforme o meio de pagamento, target_account, target_pix_key, pix_qrcode, bank_slip, source_account, vendor_bank_account_key, conciliation_metadata. Pode vir vazio ({}).
expense_datetimestringCriação, ISO 8601 em UTC (2026-11-03T14:03:21Z).
last_updatedstringÚltima alteração da despesa ou da análise, ISO 8601 em UTC.
descriptionstringDescrição.
payment_methodstringtransfer, pix, bank_slip ou automatic_debit, ou null.
payment_datestringData de pagamento, YYYY-MM-DD. Presente só quando definida.
payment_confirmationobjectconfirmation_date (YYYY-MM-DD). Presente só depois do pagamento.
consolidation_analysisobjectAnálise de consolidação vigente: consolidation_analysis_key, analysis_number, status. Ver análise de consolidação.
contractobjectContrato da despesa: contract_key, name, status, vendor (vendor_key, name). null sem contrato.
rebatebooleantrue quando a despesa é um rebate de taxa de gestão.
rebated_expense_keystringTaxa de gestão do rebate, ou null.
permission_typestringowner quando quem consulta lançou a despesa; viewer quando outro agente lançou (para a gestora, a consultoria). null para despesas calculadas pela QI Tech.
gross_provisioned_valuenumberSó em management_tax: o valor provisionado da taxa, que os rebates não reduzem (0 sem provisionado).
approved_rebate_valuenumberSó em management_tax: soma dos rebates com análise aprovada.

Listar despesas de todos os fundos​

Lista as despesas de todos os fundos da gestora, com a mesma resposta da lista do fundo.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura

URL base de cada host: Ambientes (Hosts).

ENDPOINT
/expense/expenses
MÉTODO
GET

Aceita os mesmos filtros da lista do fundo, exceto reference_date, from_end_deferral_date, to_end_deferral_date e ignore_paid_on_future, que são ignorados. Tem dois parâmetros a mais:

ParâmetroTipoDescrição
fund_class_keystringRestringe a esses fundos. Repetível: fund_class_key=...&fund_class_key=....
payment_datestringData de pagamento exata, YYYY-MM-DD.
Exemplo de chamada
GET /expense/expenses?fund_class_key={fund_class_key_1}&fund_class_key={fund_class_key_2}&payment_date=2026-11-20

Erros​

StatuscodeQuando acontece
400EXP000069A classe de fundo não é da gestora.
400EXP000186created_by_agent_type, permission_type ou kpi com valor fora da lista, ou payment_date_end anterior a payment_date_start.
400EXP000185days diferente de 1, 7 e 30 (filtro kpi).
404EXP000018Lista de todos os fundos: a gestora não tem fundos no serviço de despesas.
500QIT000500limit ou page fora do intervalo, data fora do formato YYYY-MM-DD ou booleano inválido (ignore_paid_on_future). A validação desses parâmetros chega como erro interno: corrija o parâmetro e repita a chamada.
Exemplo
{
"title": "Manager Not Associated with Fund Class",
"description": "Manager with key a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c is not associated with Fund Class with key c1d2e3f4-a5b6-4789-abcd-ef1234567890.",
"translation": "Gestor com chave a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c nao esta associado com Fundo com chave c1d2e3f4-a5b6-4789-abcd-ef1234567890.",
"code": "EXP000069"
}

Erros de autenticação, permissão e host: veja Erros da API.