← InicioFleetPay / API

Reprocesar las claves fallidas del lote

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/fiscal/cte-subcontratacao/lote/{batch_id}/reprocessamento
reprocessContraCteBatchBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Reemite, en el mismo lote y mismo grupo de pago, las claves failed, las que esperan cancelación en SEFAZ (cancelling) y las que quedaron pending por caída en mitad del proceso. Sin cuerpo, reprocesa todas; con chaves, solo las listadas (una clave sin pendiente responde 422 chave_sem_pendencia).

La clave emitted con financeiro: failed también está pendiente y no se reemite: se conserva el contra-CT-e emitido (vuelve con outcome: adotado y mismo counter_cte_id) y solo se rehace el pago al conductor.

Corrija la causa antes (entregue el XML original en POST /fiscal/cte-subcontratacao, registre la regla tributaria...). Para cambiar valor, tipo o ruta de la clave, use PATCH en la clave.

Solo lote 1:1 con repasse (422 lote_sem_repasse / lote_de_pernas), solo quien creó el lote (la contratante que lo disparó en nombre de la subcontratada — con autorización activa — o la propia emisora) y nunca durante el procesamiento (409 lote_em_processamento).

Autenticación

Permiso Requerido
fiscal — Fiscal
Módulo
Subcontratación
Perfiles Aplicables
Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

batch_idpath · stringObligatorio

UUID del lote devuelto por POST /fiscal/cte-subcontratacao/lote.

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

Cuerpo de la Solicitud

Opcional

application/json

chavesarrayOpcional

Solo estas claves (44 dígitos, con o sin puntuación). Ausente = todas las pendientes.

minItems1

Respuestas

202 Respuesta HTTP

El lote después de la modificación, en el mismo formato que GET /fiscal/cte-subcontratacao/lote/{batch_id}. 202 cuando hay trabajo en curso en SEFAZ (status: processing — siga vía GET); 200 cuando la modificación terminó al instante.

application/json

403 Respuesta HTTP

lote_de_outra_transportadora (solo quien creó el lote modifica) o emissao_nao_autorizada (la subcontratada revocó la autorización de la contratante). Revocada la autorización, solo sigue abierta la eliminación de una clave que nunca fue emitida.

application/json

404 Respuesta HTTP

lote_nao_encontrado o chave_nao_encontrada (la clave no forma parte del lote).

application/json

409 Respuesta HTTP

lote_em_processamento (espere a que status salga de processing), grupo_repasse_com_parcelas (el grupo de pago al conductor del lote ya generó cuota — hubo escaneo — y el lote ya no cambia), cancelamento_em_andamento o chave_duplicada (contra-CT-e emitido fuera del lote: elimine, no modifique).

application/json

422 Respuesta HTTP

Payload inválido.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación
{
  "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"
}