documentopath · stringObligatorioID, internal_id o clave fiscal del documento.
Restricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamentoLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Devuelve el estado de liquidación bancaria y evidencias de pago de una cuota específica (posicao) del documento.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]documentopath · stringObligatorioID, internal_id o clave fiscal del documento.
{
"type": "string"
}posicaopath · integerObligatorioNúmero ordinal de la cuota.
{
"type": "integer"
}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 o cuota no encontrada.
{
"tags": [
"Parcelas"
],
"operationId": "consultarPagamentoParcelaEspecifica",
"summary": "Consultar pagamento de parcela específica por posição",
"description": "Retorna o status de liquidação bancária e evidências de pagamento de uma parcela específica (`posicao`) do documento.",
"parameters": [
{
"name": "documento",
"in": "path",
"required": true,
"description": "ID, internal_id ou chave fiscal do documento.",
"schema": {
"type": "string"
}
},
{
"name": "posicao",
"in": "path",
"required": true,
"description": "Número ordinal da parcela.",
"schema": {
"type": "integer"
}
}
],
"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 ou parcela não encontrada."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "GET",
"path": "/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamento"
}