Skip to main content

Expense retrieval

Lists the expenses of a fund or of all of the manager's funds. The list returns every expense of the fund: those created by the manager or consultant, including those still under analysis, and those calculated by QI Tech. For the consultant, it returns only those created by agents (expense_contract, expense, reimbursement and rebate_fee).

List the fund's expenses​

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiRead Expenses or Read Consolidations

Base URL for each host: Environments (Hosts).

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

Path parameters​

ParameterTypeDescription
fund_class_keystringFund class key (UUID).

Query parameters​

All optional. Parameters marked as list accept multiple comma-separated values.

ParameterTypeDescription
pageintegerPage, starting at 0. Default: 0.
limitintegerItems per page, from 0 to 100. Default: 10.
statuslistExpense status. An unknown value does not raise an error; it just finds nothing.
expense_status_to_ignorestringExcludes a status.
expense_typelistExpense types.
expense_type_to_ignorelistExcludes expense types.
origin_typelistExpense origins.
exclude_origin_typelistExcludes origins. Use rebate_fee to hide rebates.
reference_datestringExact reference date, YYYY-MM-DD.
from_end_deferral_datestringend_deferral_date from this date on, YYYY-MM-DD.
to_end_deferral_datestringend_deferral_date up to this date, YYYY-MM-DD.
payment_date_startstringPayment date from this date on, YYYY-MM-DD.
payment_date_endstringPayment date up to this date, YYYY-MM-DD. Cannot be earlier than payment_date_start.
ignore_paid_on_futurebooleantrue excludes expenses whose payment was confirmed after the reference date.
contract_keystringExpenses of a contract.
vendor_keystringExpenses of the contract's vendor.
recipient_namestringPart of the name of the contract's vendor or of the payment's payee.
recipient_documentstringPart of the CPF or CNPJ of the vendor or payee, with or without punctuation.
rebated_expense_keystringRebates of a management fee.
created_by_agent_typestringmanager or consultant: who created the expense.
permission_typestringowner or viewer: the requester's permission over the expense. Returns only expenses posted by the manager or consultant.
descriptionstringPart of the description.
kpistringIndicator: in_analysis, in_provision or pending_invoice. Excludes canceled expenses and rebates.
daysintegerkpi period, counting today: 1, 7 or 30.

The list goes from the most recent expense to the oldest.

Example call
GET /expense/fund_class/{fund_class_key}/expenses?status=consolidated,paid&exclude_origin_type=rebate_fee&limit=50

Response​

STATUS
200
Response body
{
"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
}

Attributes of each expense​

FieldTypeDescription
expense_keystringExpense key (UUID).
fund_classobjectFund class: name, fund_class_key, document_number, accounting_date (current accounting date, YYYY-MM-DD) and manager (name, manager_key, document_number).
statusstringExpense status. See status.
typestringExpense type. See types.
originobjectorigin_type and origin_key. See origin.
payment_valuenumberAmount to pay, or null.
created_byobjectWho created it: agent_key, agent_type (manager or consultant), name. null for expenses calculated by QI Tech.
reference_datestringDate the expense entered the portfolio, YYYY-MM-DD, or null while it is in the submission step.
start_deferral_datestringProvision start, YYYY-MM-DD, or null.
end_deferral_datestringProvision end, YYYY-MM-DD, or null.
consolidated_valuenumberConsolidated amount, or null.
provisioned_valuenumberProvisioned amount, or null.
recognized_valuenumberAmount already recognized in the portfolio.
paymentobjectPayment details: target (name, document_number) and, depending on the payment method, target_account, target_pix_key, pix_qrcode, bank_slip, source_account, vendor_bank_account_key, conciliation_metadata. May be empty ({}).
expense_datetimestringCreation, ISO 8601 in UTC (2026-11-03T14:03:21Z).
last_updatedstringLast change to the expense or the analysis, ISO 8601 in UTC.
descriptionstringDescription.
payment_methodstringtransfer, pix, bank_slip or automatic_debit, or null.
payment_datestringPayment date, YYYY-MM-DD. Present only when set.
payment_confirmationobjectconfirmation_date (YYYY-MM-DD). Present only after payment.
consolidation_analysisobjectCurrent consolidation analysis: consolidation_analysis_key, analysis_number, status. See consolidation analysis.
contractobjectThe expense's contract: contract_key, name, status, vendor (vendor_key, name). null without a contract.
rebatebooleantrue when the expense is a management fee rebate.
rebated_expense_keystringManagement fee of the rebate, or null.
permission_typestringowner when the requester created the expense; viewer when another agent created it (for the manager, the consultant). null for expenses calculated by QI Tech.
gross_provisioned_valuenumberOnly on management_tax: the fee's provisioned amount, which rebates do not reduce (0 without a provisioned amount).
approved_rebate_valuenumberOnly on management_tax: sum of the rebates with an approved analysis.

List expenses across all funds​

Lists the expenses of all of the manager's funds, with the same response as the fund list.

Available on
ProfileHostRequired permission
Managermanager-apiRead

Base URL for each host: Environments (Hosts).

ENDPOINT
/expense/expenses
METHOD
GET

It accepts the same filters as the fund list, except reference_date, from_end_deferral_date, to_end_deferral_date and ignore_paid_on_future, which are ignored. It has two extra parameters:

ParameterTypeDescription
fund_class_keystringRestricts the result to those funds. Repeatable: fund_class_key=...&fund_class_key=....
payment_datestringExact payment date, YYYY-MM-DD.
Example call
GET /expense/expenses?fund_class_key={fund_class_key_1}&fund_class_key={fund_class_key_2}&payment_date=2026-11-20

Errors​

StatuscodeWhen it happens
400EXP000069The fund class does not belong to the manager.
400EXP000186created_by_agent_type, permission_type or kpi with a value outside the list, or payment_date_end earlier than payment_date_start.
400EXP000185days other than 1, 7 and 30 (kpi filter).
404EXP000018List across all funds: the manager has no funds in the expense service.
500QIT000500limit or page out of range, a date not in the YYYY-MM-DD format, or an invalid boolean (ignore_paid_on_future). Validation of these parameters comes back as an internal error: fix the parameter and retry the call.
Example
{
"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"
}

Authentication, permission and host errors: see API Errors.