documentopath · stringRequiredDocument identifier (numeric ID, internal_id or 44-digit access key).
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/parcelas/{documento}Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Returns the consolidated ledger of installments and invoices associated with a transport document (ID, internal_id or 44-digit fiscal key). Requires consultas scope.
consultas — Queries[
{
"oauth2": []
},
{
"chaveApi": []
}
]documentopath · stringRequiredDocument identifier (numeric ID, internal_id or 44-digit access key).
{
"type": "string"
}200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
404 HTTP ResponseDocument not found for the authenticated company.
{
"tags": [
"Parcelas"
],
"operationId": "consultarParcelasDocumento",
"summary": "Consultar parcelas de pagamento por documento",
"description": "Retorna o ledger consolidado de parcelas e faturas associadas a um documento de transporte (ID, internal_id ou chave fiscal de 44 dígitos). Exige escopo `consultas`.",
"parameters": [
{
"name": "documento",
"in": "path",
"required": true,
"description": "Identificador do documento (ID numérico, internal_id ou chave de acesso de 44 dígitos).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
},
"404": {
"description": "Documento não encontrado para a company autenticada."
}
},
"x-fleetpay-scope": "consultas",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "GET",
"path": "/parcelas/{documento}"
}