Cancelar CIOT

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

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

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

Modo simulado em homologação. Esta operação não tem provedor de CIOT contratado por trás: em homologação a resposta é gerada pela FleetPay, é determinística e não tem efeito regulatório — nada é registrado na ANTT e nenhum CIOT tratado por aqui tem valor legal.

O contrato de request e response já é o definitivo: integre agora. Quando o provedor real entrar, o comportamento deixa de ser simulado sem mudança de contrato.

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`

justificationstringObrigatório

maxLength500

Respostas

200 Resposta HTTP

Operação de CIOT concluída.

`application/json`

CiotOperationEnvelope ↗

dataobjectObrigatório

CiotOperationData ↗

environmentobjectObrigatório

Environment ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

202 Resposta HTTP

Operação de CIOT ainda pendente ou ambígua; consulte novamente.

`application/json`

CiotOperationEnvelope ↗

dataobjectObrigatório

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": [
    "CIOT"
  ],
  "summary": "Cancelar CIOT",
  "operationId": "cancelCiot",
  "description": "**Modo simulado em homologação.** Esta operação não tem provedor de CIOT contratado por\ntrás: em homologação a resposta é gerada pela FleetPay, é determinística e **não tem\nefeito regulatório** — nada é registrado na ANTT e nenhum CIOT tratado por aqui tem\nvalor legal.\n\nO contrato de request e response já é o definitivo: integre agora. Quando o provedor real\nentrar, o comportamento deixa de ser simulado **sem mudança de contrato**.\n",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "justification"
          ],
          "properties": {
            "justification": {
              "type": "string",
              "maxLength": 500
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/CiotOk"
    },
    "202": {
      "$ref": "#/components/responses/CiotPending"
    },
    "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}/ciot/cancelamento",
  "parameters": [
    {
      "$ref": "#/components/parameters/CteUuid"
    }
  ]
}