Pular para o conteúdo principal

Consulta de despesas consolidadas

Endpoints para consultar as despesas de uma classe de fundo. Existem dois modos de consulta: a listagem paginada de todas as despesas de uma classe de fundo, e a consulta individual de uma despesa específica.

Quando utilizar

Utilize estes endpoints para acompanhar o status das despesas cadastradas, verificar valores provisionados e consolidados, e consultar os dados de pagamento de cada despesa.

Listagem de despesas

Retorna a lista paginada de todas as despesas de uma classe de fundo, com suporte a diversos filtros.

Request

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

Query params

ParâmetroTipoObrigatoriedadeDescrição
pageintegeropcionalNúmero da página (começa em 0). Padrão: 0.
limitintegeropcionalQuantidade de registros por página. Mínimo: 0. Máximo: 100. Padrão: 10.
reference_datestringopcionalFiltra despesas pela data de referência exata, no formato YYYY-MM-DD.
from_end_deferral_datestringopcionalFiltra despesas com data de encerramento de diferimento maior ou igual à data informada, no formato YYYY-MM-DD.
to_end_deferral_datestringopcionalFiltra despesas com data de encerramento de diferimento menor ou igual à data informada, no formato YYYY-MM-DD.
statusstringopcionalFiltra pelo status da despesa. Aceita múltiplos valores separados por vírgula (ex: paid,consolidated). Veja enumeradores de status.
expense_typestringopcionalFiltra pelo tipo da despesa. Aceita múltiplos valores separados por vírgula (ex: management_tax,custody_tax). Veja enumeradores de type.
expense_status_to_ignorestringopcionalExclui da listagem despesas com o status informado.
expense_type_to_ignorestringopcionalExclui da listagem despesas com o tipo informado.
ignore_paid_on_futurebooleanopcionalQuando true, exclui despesas que já foram pagas mas com data de confirmação posterior à data de referência.
Exemplo de chamada
GET /expense/fund_class/{fund_class_key}/expenses?page=0&limit=10&status=consolidated,paid

Response

STATUS
200
Response Body
{
"data": [
{
"expense_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"fund_class": {
"name": "Fundo de Investimento XYZ",
"manager": {
"name": "Gestora ABC",
"manager_key": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"document_number": "12.345.678/0001-90"
},
"fund_class_key": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
"document_number": "98.765.432/0001-10",
"accounting_date": "2025-06-10"
},
"status": "consolidated",
"type": "management_tax",
"reference_date": "2025-06-10",
"start_deferral_date": "2025-06-01",
"end_deferral_date": "2025-06-30",
"consolidated_value": 1500.00,
"provisioned_value": 1500.00,
"recognized_value": 1500.00,
"payment": null,
"expense_datetime": "2025-06-01T00:00:00Z",
"description": "Taxa de gestão referente ao mês de junho/2025",
"payment_method": "transfer",
"payment_date": "2025-06-30",
"payment_confirmation": {
"confirmation_date": "2025-06-30"
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}

Atributos da resposta

CampoTipoDescrição
dataarrayLista de objetos de despesa. Veja Atributos de cada despesa.
pageintegerNúmero da página atual.
limitintegerQuantidade de registros por página.
is_last_pagebooleanIndica se esta é a última página de resultados.

Atributos de cada despesa (objetos dentro de data)

CampoTipoDescrição
expense_keystringIdentificador único da despesa (UUID).
fund_classobjectDados da classe de fundo à qual a despesa pertence. Veja Atributos de fund_class.
statusstringStatus atual da despesa. Veja enumeradores de status.
typestringTipo da despesa. Veja enumeradores de type.
reference_datestringData de referência da despesa no formato YYYY-MM-DD.
start_deferral_datestringData de início do diferimento no formato YYYY-MM-DD.
end_deferral_datestringData de encerramento do diferimento no formato YYYY-MM-DD.
consolidated_valuenumberValor consolidado da despesa. Pode ser null quando a despesa ainda não foi consolidada.
provisioned_valuenumberValor provisionado da despesa. Pode ser null quando ainda não há provisão.
recognized_valuenumberValor reconhecido da despesa.
paymentobjectDados do pagamento associado à despesa. Pode ser null quando não há pagamento vinculado.
expense_datetimestringData e hora de criação da despesa no formato ISO 8601 (ex: 2025-06-01T00:00:00Z).
descriptionstringDescrição textual da despesa.
payment_methodstringMétodo de pagamento da despesa. Veja enumeradores de payment_method.
payment_datestringData de pagamento no formato YYYY-MM-DD. Presente somente quando a despesa possui data de pagamento definida.
payment_confirmationobjectDados de confirmação de pagamento. Presente somente quando o pagamento foi confirmado. Veja Atributos de payment_confirmation.

Atributos de fund_class

CampoTipoDescrição
namestringNome da classe de fundo.
fund_class_keystringIdentificador único da classe de fundo (UUID).
document_numberstringCNPJ da classe de fundo.
accounting_datestringData de contabilização da classe de fundo no formato YYYY-MM-DD.
managerobjectDados do gestor responsável. Veja Atributos de manager.

Atributos de manager

CampoTipoDescrição
namestringNome do gestor.
manager_keystringIdentificador único do gestor (UUID).
document_numberstringCNPJ do gestor.

Atributos de payment_confirmation

CampoTipoDescrição
confirmation_datestringData de confirmação do pagamento no formato YYYY-MM-DD.

Consulta de despesa específica

Retorna os dados completos de uma despesa específica de uma classe de fundo.

Request

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

Path params

ParâmetroTipoDescrição
fund_class_keystringIdentificador único (UUID) da classe de fundo à qual a despesa pertence.
expense_keystringIdentificador único (UUID) da despesa a ser consultada.
Exemplo de chamada
GET /expense/fund_class/{fund_class_key}/expense/{expense_key}

Response

STATUS
200
Response Body
{
"expense_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"fund_class": {
"name": "Fundo de Investimento XYZ",
"manager": {
"name": "Gestora ABC",
"manager_key": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"document_number": "12.345.678/0001-90"
},
"fund_class_key": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
"document_number": "98.765.432/0001-10",
"accounting_date": "2025-06-10"
},
"status": "consolidated",
"type": "management_tax",
"reference_date": "2025-06-10",
"start_deferral_date": "2025-06-01",
"end_deferral_date": "2025-06-30",
"consolidated_value": 1500.00,
"provisioned_value": 1500.00,
"recognized_value": 1500.00,
"payment": null,
"expense_datetime": "2025-06-01T00:00:00Z",
"description": "Taxa de gestão referente ao mês de junho/2025",
"payment_method": "transfer",
"payment_date": "2025-06-30",
"payment_confirmation": {
"confirmation_date": "2025-06-30"
}
}

Atributos da resposta

A resposta possui a mesma estrutura de cada objeto do array data retornado pela listagem de despesas.


Possíveis erros

STATUS
404
Despesa não encontrada

O expense_key informado não corresponde a nenhuma despesa cadastrada para esta classe de fundo. Verifique se os identificadores estão corretos.

{
"title": "Expense not Found",
"description": "The Expense with key {expense_key} was not found in Fund Class with key {fund_class_key}.",
"translation": "A Despesa com a chave {expense_key} nao foi encontrada na classe de fundos com a chave {fund_class_key}.",
"code": "EXP000010"
}

Enumeradores de status

ValorDescrição
createdDespesa criada, ainda não iniciou o processo de provisionamento.
in_provisionDespesa em processo de provisionamento diário.
on_demand_recognitionDespesa com reconhecimento sob demanda (manual).
consolidatedDespesa consolidada — valor total reconhecido e pronto para pagamento.
paidDespesa paga.
canceledDespesa cancelada.
completedDespesa encerrada.

Enumeradores de type

ValorDescrição
administration_taxTaxa de administração.
management_taxTaxa de gestão.
performance_feeTaxa de performance.
custody_taxTaxa de custódia.
distribution_feeTaxa de distribuição.
consulting_feeTaxa de consultoria.
audit_taxTaxa de auditoria.
cvm_taxTaxa CVM.
cetip_taxTaxa CETIP.
anbima_taxTaxa ANBIMA.
selic_taxTaxa SELIC.
notaryCartório.
bank_accountConta bancária.
bankslip_feeTaxa de boleto.
sale_commission_taxTaxa de comissão de venda.
certifier_feeTaxa de certificadora.
rating_agency_feeTaxa de agência de rating.
lawyer_feeHonorários advocatícios.
bookkeeping_feeTaxa de escrituração.
insurance_feeTaxa de seguro.
collection_agent_feeTaxa de agente cobrador.
servicing_feeTaxa de serviços.
fund_structuring_feeTaxa de estruturação do fundo.
credit_rights_registration_feeTaxa de registro de direitos creditórios.
origination_feeTaxa de originação.

Enumeradores de payment_method

ValorDescrição
transferTransferência bancária.
automatic_debitDébito automático.
bank_slipBoleto bancário.