← InícioFleetPay / API

Reprocessar as chaves do lote que falharam

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

POST/fiscal/cte-subcontratacao/lote/{batch_id}/reprocessamento
reprocessContraCteBatchBase 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.

Reemite, no mesmo lote e no mesmo grupo de repasse, as chaves failed, as que aguardam o cancelamento na SEFAZ (cancelling) e as que ficaram pending porque o processamento caiu no meio. Sem corpo, reprocessa todas; com chaves, só as listadas (uma chave listada que não está pendente responde 422 chave_sem_pendencia).

A chave emitted com financeiro: failed também é pendente, e não é reemitida: o contra-CT-e que já saiu é mantido (a linha volta com outcome: adotado e o mesmo counter_cte_id) e só o repasse é refeito.

Corrija a causa antes (entregue o XML do CT-e original em POST /fiscal/cte-subcontratacao, cadastre a regra de tributação…). Para mudar valor, tipo ou rota da chave, use o PATCH da chave.

Só lote 1:1 com repasse (422 lote_sem_repasse / lote_de_pernas), só quem criou o lote (a contratante que o disparou em nome da subcontratada — com a autorização ainda ativa — ou a própria emitente) e nunca durante o processamento (409 lote_em_processamento).

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Subcontratação
Perfis Aplicáveis
Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "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"
}

Corpo da Requisição

Opcional

application/json

chavesarrayOpcional

Só estas chaves (44 dígitos, com ou sem pontuação). Ausente = todas as pendentes.

minItems1

Respostas

202 Resposta HTTP

O lote depois da alteração, no mesmo formato de GET /fiscal/cte-subcontratacao/lote/{batch_id}. 202 quando há trabalho na SEFAZ em curso (status: processing — acompanhe pelo GET); 200 quando a alteração terminou na hora.

application/json

403 Resposta HTTP

lote_de_outra_transportadora (só quem criou o lote altera) ou emissao_nao_autorizada (a subcontratada revogou a autorização da contratante). Revogada a autorização, só a exclusão de chave que nunca foi emitida continua aberta.

application/json

404 Resposta HTTP

lote_nao_encontrado ou chave_nao_encontrada (a chave não faz parte do lote).

application/json

409 Resposta HTTP

lote_em_processamento (aguarde o status sair de processing), grupo_repasse_com_parcelas (o repasse do lote já gerou parcela — houve bipagem — e o lote não muda mais), cancelamento_em_andamento ou chave_duplicada (contra-CT-e emitido fora do lote: exclua, não altere).

application/json

422 Resposta HTTP

Payload inválido.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação
{
  "tags": [
    "CT-e de subcontratação"
  ],
  "summary": "Reprocessar as chaves do lote que falharam",
  "operationId": "reprocessContraCteBatch",
  "description": "Reemite, **no mesmo lote e no mesmo grupo de repasse**, as chaves `failed`, as que aguardam o\ncancelamento na SEFAZ (`cancelling`) e as que ficaram `pending` porque o processamento caiu no\nmeio. Sem corpo, reprocessa todas; com `chaves`, só as listadas (uma chave listada que não está\npendente responde `422 chave_sem_pendencia`).\n\nA chave `emitted` com `financeiro: failed` também é pendente, e **não é reemitida**: o\ncontra-CT-e que já saiu é mantido (a linha volta com `outcome: adotado` e o mesmo\n`counter_cte_id`) e só o repasse é refeito.\n\nCorrija a causa antes (entregue o XML do CT-e original em `POST /fiscal/cte-subcontratacao`,\ncadastre a regra de tributação…). Para mudar valor, tipo ou rota da chave, use o `PATCH` da chave.\n\n**Só lote 1:1 com `repasse`** (`422 lote_sem_repasse` / `lote_de_pernas`), **só quem criou o\nlote** (a contratante que o disparou em nome da subcontratada — com a autorização ainda ativa —\nou a própria emitente) e nunca durante o processamento (`409 lote_em_processamento`).\n",
  "parameters": [
    {
      "$ref": "#/components/parameters/ContraCteBatchId"
    }
  ],
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ContraCteLoteReprocessarRequest"
        }
      }
    }
  },
  "responses": {
    "202": {
      "$ref": "#/components/responses/ContraCteLoteEditado"
    },
    "403": {
      "$ref": "#/components/responses/ContraCteLoteEdicaoProibida"
    },
    "404": {
      "$ref": "#/components/responses/ContraCteLoteEdicaoNaoEncontrado"
    },
    "409": {
      "$ref": "#/components/responses/ContraCteLoteEdicaoConflito"
    },
    "422": {
      "$ref": "#/components/responses/ValidationFailed"
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "subcontratacao",
  "x-fleetpay-profiles": [
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/fiscal/cte-subcontratacao/lote/{batch_id}/reprocessamento"
}