Conciliar un evento pendiente del CT-e

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

POST/fiscal/cte/{cte_uuid}/eventos/{event_key}/reconciliacao

reconcileCteEventBase 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.

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

cte_uuidpath · stringObligatorio

UUID público del CT-e.

Restricciones

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

event_keypath · stringObligatorio

Identificador público opaco del evento, devuelto en data.id.

Restricciones

{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$"
}

Respuestas

200 Respuesta HTTP

Evento concluido.

`application/json`

CteEventEnvelope ↗

dataobjectObligatorio

CteEvent ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

202 Respuesta HTTP

Evento registrado localmente y pendiente de conciliación.

`application/json`

CteEventEnvelope ↗

dataobjectObligatorio

CteEvent ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

Recurso no encontrado en el tenant autenticado.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

422 Respuesta HTTP

Un requisito pendiente o una regla de negocio impidió la operación.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

Fallo interno sin detalles de las integraciones operativas.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "tags": [
    "Eventos CT-e"
  ],
  "summary": "Reconciliar evento pendente do CT-e",
  "operationId": "reconcileCteEvent",
  "responses": {
    "200": {
      "$ref": "#/components/responses/CteEventOk"
    },
    "202": {
      "$ref": "#/components/responses/CteEventPending"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/BusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/cte/{cte_uuid}/eventos/{event_key}/reconciliacao",
  "parameters": [
    {
      "$ref": "#/components/parameters/CteUuid"
    },
    {
      "$ref": "#/components/parameters/EventKey"
    }
  ]
}