Skip to main content

Consolidated expense query

Endpoints to query the expenses of a fund class. There are two query modes: the paginated listing of all the expenses of a fund class, and the individual query of a specific expense.

When to use

Use these endpoints to track the status of the registered expenses, check provisioned and consolidated values, and query the payment data of each expense.

Expense listing​

Returns the paginated list of all the expenses of a fund class, with support for several filters.

Request​

ENDPOINT
/expense/fund_class/{fund_class_key}/expenses
METHOD
GET

Query params​

ParameterTypeRequiredDescription
pageintegeroptionalPage number (starts at 0). Default: 0.
limitintegeroptionalNumber of records per page. Minimum: 0. Maximum: 100. Default: 10.
reference_datestringoptionalFilters expenses by the exact reference date, in the YYYY-MM-DD format.
from_end_deferral_datestringoptionalFilters expenses with a deferral end date greater than or equal to the provided date, in the YYYY-MM-DD format.
to_end_deferral_datestringoptionalFilters expenses with a deferral end date less than or equal to the provided date, in the YYYY-MM-DD format.
statusstringoptionalFilters by the expense status. Accepts multiple comma-separated values (e.g. paid,consolidated). See status enumerators.
expense_typestringoptionalFilters by the expense type. Accepts multiple comma-separated values (e.g. management_tax,custody_tax). See type enumerators.
expense_status_to_ignorestringoptionalExcludes expenses with the provided status from the listing.
expense_type_to_ignorestringoptionalExcludes expenses with the provided type from the listing.
ignore_paid_on_futurebooleanoptionalWhen true, excludes expenses that have already been paid but whose confirmation date is later than the reference date.
Example call
GET /expense/fund_class/{fund_class_key}/expenses?page=0&limit=10&status=consolidated,paid

Response​

STATUS
200
Response Body
{
"data": [
{
"expense_key": "3571e292-3a83-4011-904d-20ee963022ef",
"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
}

Response attributes​

FieldTypeDescription
dataarrayList of expense objects. See Attributes of each expense.
pageintegerCurrent page number.
limitintegerNumber of records per page.
is_last_pagebooleanIndicates whether this is the last page of results.

Attributes of each expense (objects inside data)​

FieldTypeDescription
expense_keystringUnique identifier of the expense (UUID).
fund_classobjectData of the fund class the expense belongs to. See fund_class attributes.
statusstringCurrent status of the expense. See status enumerators.
typestringExpense type. See type enumerators.
reference_datestringReference date of the expense in the YYYY-MM-DD format.
start_deferral_datestringDeferral start date in the YYYY-MM-DD format.
end_deferral_datestringDeferral end date in the YYYY-MM-DD format.
consolidated_valuenumberConsolidated value of the expense. May be null when the expense has not been consolidated yet.
provisioned_valuenumberProvisioned value of the expense. May be null when there is no provision yet.
recognized_valuenumberRecognized value of the expense.
paymentobjectPayment data associated with the expense. May be null when there is no linked payment.
expense_datetimestringDate and time the expense was created, in the ISO 8601 format (e.g. 2025-06-01T00:00:00Z).
descriptionstringTextual description of the expense.
payment_methodstringPayment method of the expense. See payment_method enumerators.
payment_datestringPayment date in the YYYY-MM-DD format. Present only when the expense has a defined payment date.
payment_confirmationobjectPayment confirmation data. Present only when the payment has been confirmed. See payment_confirmation attributes.

fund_class attributes​

FieldTypeDescription
namestringName of the fund class.
fund_class_keystringUnique identifier of the fund class (UUID).
document_numberstringCNPJ of the fund class.
accounting_datestringAccounting date of the fund class in the YYYY-MM-DD format.
managerobjectData of the responsible manager. See manager attributes.

manager attributes​

FieldTypeDescription
namestringManager name.
manager_keystringUnique identifier of the manager (UUID).
document_numberstringManager's CNPJ.

payment_confirmation attributes​

FieldTypeDescription
confirmation_datestringPayment confirmation date in the YYYY-MM-DD format.

Specific expense query​

Returns the complete data of a specific expense of a fund class.

Request​

ENDPOINT
/expense/fund_class/{fund_class_key}/expense/{expense_key}
METHOD
GET

Path params​

ParameterTypeDescription
fund_class_keystringUnique identifier (UUID) of the fund class the expense belongs to.
expense_keystringUnique identifier (UUID) of the expense to be queried.
Example call
GET /expense/fund_class/{fund_class_key}/expense/{expense_key}

Response​

STATUS
200
Response Body
{
"expense_key": "3571e292-3a83-4011-904d-20ee963022ef",
"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"
}
}

Response attributes​

The response has the same structure as each object of the data array returned by the expense listing.


Possible errors​

STATUS
404
Expense not found

The provided expense_key does not correspond to any expense registered for this fund class. Check that the identifiers are correct.

{
"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"
}

status enumerators​

ValueDescription
createdExpense created, the provisioning process has not started yet.
in_provisionExpense in the daily provisioning process.
on_demand_recognitionExpense with on-demand (manual) recognition.
consolidatedConsolidated expense — total value recognized and ready for payment.
paidExpense paid.
canceledExpense canceled.
completedExpense closed.

type enumerators​

ValueDescription
administration_taxAdministration fee.
management_taxManagement fee.
performance_feePerformance fee.
custody_taxCustody fee.
distribution_feeDistribution fee.
consulting_feeConsulting fee.
audit_taxAudit fee.
cvm_taxCVM fee.
cetip_taxCETIP fee.
anbima_taxANBIMA fee.
selic_taxSELIC fee.
notaryNotary.
bank_accountBank account.
bankslip_feeBankslip fee.
sale_commission_taxSales commission fee.
certifier_feeCertifier fee.
rating_agency_feeRating agency fee.
lawyer_feeLegal fees.
bookkeeping_feeBookkeeping fee.
insurance_feeInsurance fee.
collection_agent_feeCollection agent fee.
servicing_feeServicing fee.
fund_structuring_feeFund structuring fee.
credit_rights_registration_feeCredit rights registration fee.
origination_feeOrigination fee.

payment_method enumerators​

ValueDescription
transferBank transfer.
automatic_debitAutomatic debit.
bank_slipBankslip.