Skip to main content

Contract Query

Retrieve the data and the current status of a specific contract.

Request​

ENDPOINT
/expense_submission/fund_class/{fund_class_key}/contract/{contract_key}
METHOD
GET

Path params​

ParameterTypeDescription
fund_class_keystringUnique key of the fund (UUID)
contract_keystringUnique key of the contract

Response​

STATUS
200
Response Body
{
"name": "Contrato de Auditoria - Exercício 2026",
"contract_key": "contrato-auditoria-2026",
"fund_class": {
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS EXEMPLO",
"manager": {
"name": "EXEMPLO GESTORA LTDA",
"manager_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"document_number": "45.585.471/0001-47"
},
"fund_class_key": "4b8377d0-58ec-479f-8ee9-9f963d5c47ad",
"document_number": "60.910.091/0001-24"
},
"vendor": {
"vendor_key": "3571e292-3a83-4011-904d-20ee963022ef",
"name": "AUDITORES EXEMPLO S.A.",
"document_number": "12.345.678/0001-90",
"requires_invoice": "True"
},
"expense_type": "audit_tax",
"status": "approved",
"contract_value": 50000.00,
"validity_date": "2026-12-31",
"submission_nature": "manual_submission"
}

Response attributes​

FieldTypeDescription
namestringContract name.
contract_keystringUnique key of the contract.
fund_classobjectData of the associated fund.
vendorobjectVendor data.
expense_typestringExpense type of the contract.
statusstringCurrent status of the contract. See the contract status table.
contract_valuenumberMaximum contract value, or null when not provided.
validity_datestringValidity date in the YYYY-MM-DD format, or null when not provided.
submission_naturestringSubmission nature of the contract.

Possible errors​

STATUS
404
Contract not found

The fund_class_key + contract_key pair does not correspond to any registered contract.

{
"title": "Contract Not Found",
"description": "Contract with key {contract_key} and fund class {fund_class_key} was not found.",
"translation": "O contrato com chave {contract_key} do fundo {fund_class_key} não foi encontrado.",
"code": "ESB000011"
}