batch_idpath · stringObligatorioUUID del lote devuelto por POST /fiscal/cte-subcontratacao/lote.
Restricciones
{
"type": "string",
"format": "uuid"
}← InicioFleetPay / API
Consultar un lote de contra-CT-e
Parámetros, estructura de datos y respuestas del contrato versionado.
GET
/fiscal/cte-subcontratacao/lote/{batch_id}Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Estado del lote y una fila por clave de acceso (o tramo). El informe se guarda después de procesar cada clave, por lo que puedes ver los documentos emitidos mientras el lote sigue en ejecución. El status del lote es processing, done o failed; el de cada fila es pending, emitted, duplicated o failed.
Cada fila emitted incluye counter_cte_id, el UUID del contra-CT-e para GET /fiscal/cte/{cte_uuid}, consulta periódica y DACTE, y, en tramos, documento_financeiro (documento del tramo aceptado en GET /carriers/parcelas-repasse/{documento}). Un fallo después de que el proveedor acepte el documento se devuelve como emitted con financeiro: failed, nunca como failed sin counter_cte_id.
Autenticación
[
{
"oauth2": []
},
{
"chaveApi": []
}
]La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.
Parámetros
Respuestas
200 Respuesta HTTP
El lote y el resultado por clave de acceso.
application/json
dataobjectObligatorioenvironmentobjectOpcionalHeaders
X-Request-IdIdentificador de correlación de la llamada.
401 Respuesta HTTP
Clave de API FleetPay ausente o no válida.
Headers
X-Request-IdIdentificador de correlación de la llamada.
403 Respuesta HTTP
Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.
Headers
X-Request-IdIdentificador de correlación de la llamada.
404 Respuesta HTTP
El lote no existe o pertenece a otro transportista (lote_nao_encontrado).
429 Respuesta HTTP
Límite por transportista excedido.
Headers
X-Request-IdIdentificador de correlación de la llamada.
Retry-AfterSegundos hasta un nuevo intento.
500 Respuesta HTTP
Fallo interno sin detalles de las integraciones operativas.
Headers
X-Request-IdIdentificador de correlación de la llamada.
Definición Completa de la Operación
{
"tags": [
"CT-e de subcontratação"
],
"summary": "Acompanhar um lote de contra-CT-e",
"operationId": "getContraCteBatch",
"description": "O estado do lote e **uma linha por chave** (ou por perna). O relatório é gravado a cada\nchave processada: no meio do lote você já vê o que foi emitido. `status` do lote é\n`processing`, `done` ou `failed`; o de cada linha é `pending`, `emitted`, `duplicated` ou\n`failed`.\n\nCada linha `emitted` traz o `counter_cte_id` — o UUID do contra-CT-e para\n`GET /fiscal/cte/{cte_uuid}`, polling e DACTE — e, nas pernas, o `documento_financeiro`\n(o documento da perna, aceito em `GET /carriers/parcelas-repasse/{documento}`). Uma falha\n**depois** de o provedor aceitar o documento vem como `emitted` com `financeiro: failed`,\nnunca como `failed` sem `counter_cte_id`.\n",
"parameters": [
{
"$ref": "#/components/parameters/ContraCteBatchId"
}
],
"responses": {
"200": {
"description": "O lote e o resultado por chave.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/RequestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContraCteLoteEnvelope"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"description": "Lote inexistente ou de outra transportadora (`lote_nao_encontrado`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "GET",
"path": "/fiscal/cte-subcontratacao/lote/{batch_id}"
}