Acompanhar um lote de contra-CT-e

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/fiscal/cte-subcontratacao/lote/{batch_id}

getContraCteBatchBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

O estado do lote e uma linha por chave (ou por perna). O relatório é gravado a cada chave processada: no meio do lote você já vê o que foi emitido. status do lote é processing, done ou failed; o de cada linha é pending, emitted, duplicated ou failed.

Cada linha emitted traz o counter_cte_id — o UUID do contra-CT-e para GET /fiscal/cte/{cte_uuid}, polling e DACTE — e, nas pernas, o documento_financeiro (o documento da perna, aceito em GET /carriers/parcelas-repasse/{documento}). Uma falha depois de o provedor aceitar o documento vem como emitted com financeiro: failed, nunca como failed sem counter_cte_id.

Autenticação

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

batch_idpath · stringObrigatório

UUID do lote devolvido pelo POST /fiscal/cte-subcontratacao/lote.

Restrições

{
  "type": "string",
  "format": "uuid"
}

Respostas

200 Resposta HTTP

O lote e o resultado por chave.

`application/json`

ContraCteLoteEnvelope ↗

dataobjectObrigatório

ContraCteLote ↗

environmentobjectOpcional

Environment ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

Lote inexistente ou de outra transportadora (lote_nao_encontrado).

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

429 Resposta HTTP

Limite por transportadora excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

Falha interna sem detalhes de integrações operacionais.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação

{
  "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}"
}