Cancelar CT-e

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

POST/fiscal/cte/{cte_uuid}/eventos/cancelamento

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

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

cte_uuidpath · stringObrigatório

UUID público do CT-e.

Restrições

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

Corpo da Requisição

Obrigatório

`application/json`

JustificationInput ↗

justificationstringObrigatório

minLength15

maxLength255

Respostas

200 Resposta HTTP

Evento concluído.

`application/json`

CteEventEnvelope ↗

dataobjectObrigatório

CteEvent ↗

environmentobjectObrigatório

Environment ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

202 Resposta HTTP

Evento registrado localmente e pendente de reconciliação.

`application/json`

CteEventEnvelope ↗

dataobjectObrigatório

CteEvent ↗

environmentobjectObrigatório

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

Recurso não encontrado no tenant autenticado.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

422 Resposta HTTP

Payload inválido, pendência ou regra de negócio.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

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": [
    "Eventos CT-e"
  ],
  "summary": "Cancelar CT-e",
  "operationId": "cancelCte",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/JustificationInput"
        }
      }
    }
  },
  "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/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/cte/{cte_uuid}/eventos/cancelamento",
  "parameters": [
    {
      "$ref": "#/components/parameters/CteUuid"
    }
  ]
}