Pular para o conteúdo principal

Consulta de despesa por chave

Consulta uma despesa pela chave, com os documentos e o histórico de status da despesa e das análises de consolidação. Para listar despesas com filtros, veja Consulta de despesas.

Consultar despesa por chave​

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}/expense/{expense_key}
MÉTODO
GET

Parâmetros de caminho​

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

Resposta​

STATUS
200

A resposta traz os campos da lista até payment_confirmation, mais consolidation_analysis, contract, rebated_expense_key, permission_type e os campos abaixo. Não traz rebate, gross_provisioned_value nem approved_rebate_value.

Trecho da resposta
{
"expense_key": "b7f1c8e2-5a7d-4c7f-9a0e-2c3d4e5f6a7b",
"status": "pre_approved",
"is_reimbursement": false,
"reimbursement_recipient": null,
"reproval_reason": null,
"reproval_details": null,
"documents": [
{
"document_key": "d4e5f6a7-b8c9-4123-def4-567890abcdef",
"name": "memoria_de_calculo.pdf",
"document_type": "calculation_memory",
"status": "in_manual_analysis"
}
],
"status_events": [
{
"status": "created",
"event_datetime": "2026-11-03T14:03:21Z",
"author_type": "manager",
"author_name": "Maria Souza"
},
{
"status": "pending_submission",
"event_datetime": "2026-11-03T14:03:21Z",
"author_type": "manager",
"author_name": "Maria Souza"
},
{
"status": "pre_approved",
"event_datetime": "2026-11-03T14:05:02Z",
"author_type": "manager",
"author_name": "Maria Souza"
}
],
"consolidation_status_events": [
{
"analysis_number": 1,
"status": "created",
"event_datetime": "2026-11-03T14:03:21Z",
"author_type": "manager",
"author_name": "Maria Souza",
"reproval_reason": null,
"reproval_details": null
},
{
"analysis_number": 1,
"status": "pending_submission",
"event_datetime": "2026-11-03T14:03:21Z",
"author_type": "manager",
"author_name": "Maria Souza",
"reproval_reason": null,
"reproval_details": null
}
]
}
CampoTipoDescrição
is_reimbursementbooleantrue quando a despesa é um reembolso.
reimbursement_recipientstringmanager ou consultant no reembolso; senão null.
reproval_reasonstringMotivo da reprovação da despesa, ou null.
reproval_detailsstringDetalhe da reprovação, ou null.
documentsarrayDocumentos da despesa: document_key, name, document_type, status. Para baixar, a gestora usa a consulta do documento; a consultoria baixa os da análise de consolidação.
recurrenceobjectSó em despesas de origem recurring_expense: recurring_expense_key, status, start_date, end_date, contract_key.
status_eventsarrayMudanças de status da despesa, da mais antiga para a mais recente: status, event_datetime, author_type, author_name. Nas despesas lançadas pela gestora ou consultoria, o primeiro evento é created.
consolidation_status_eventsarrayMudanças de status de todas as análises de consolidação: analysis_number, status, event_datetime, author_type, author_name, reproval_reason, reproval_details. Cada análise começa com created e pending_submission. Os campos de reprovação vêm só no último evento reproved de cada análise.

author_type é manager ou consultant quando um usuário do portal fez a mudança; o nome dele vem em author_name. Nos demais casos (transições automáticas, decisões da QI Tech e chamadas pela API com chave de integração), é qitech, com author_name: null.

Erros​

StatuscodeQuando acontece
400EXP000069A classe de fundo não é da gestora.
404EXP000010A expense_key não existe nessa classe de fundo.
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.