documentopath · stringObligatorioIdentificador del documento (ID numérico, internal_id o clave de acceso de 44 dígitos).
Restricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/parcelas/{documento}Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Devuelve el libro mayor consolidado de cuotas y facturas asociadas a un documento de transporte (ID, internal_id o clave fiscal de 44 dígitos). Requiere el permiso consultas.
consultas — Consultas[
{
"oauth2": []
},
{
"chaveApi": []
}
]documentopath · stringObligatorioIdentificador del documento (ID numérico, internal_id o clave de acceso de 44 dígitos).
{
"type": "string"
}200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
404 Respuesta HTTPDocumento no encontrado para la company autenticada.
{
"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}"
}