batchIdpath · stringObligatorioUUID o identificador del lote de contra-CT-e.
Restricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/carriers/parcelas-repasse/lote/{batchId}Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Lista todas las cuotas de transferencia y sus respectivos estados financieros derivados de un lote de contra-CT-e.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]batchIdpath · stringObligatorioUUID o identificador del lote de contra-CT-e.
{
"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 HTTPLote no encontrado.
{
"tags": [
"CT-e de subcontratação",
"Parcelas"
],
"operationId": "consultarParcelasLoteContraCte",
"summary": "Consultar parcelas de repasse de um lote de contra-CT-e",
"description": "Lista todas as parcelas de repasse e respectivos status financeiros derivadas de um lote de contra-CT-e.",
"parameters": [
{
"name": "batchId",
"in": "path",
"required": true,
"description": "UUID ou identificador do lote de contra-CT-e.",
"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": "Lote não encontrado."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "subcontratacao",
"x-fleetpay-profiles": [
"transportador_frotista"
],
"method": "GET",
"path": "/carriers/parcelas-repasse/lote/{batchId}"
}