← InícioFleetPay / API

Cancelar CIOT

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

POST/fiscal/ciot/{ciot_uuid}/cancelamento
cancelarOperacaoCiotBase 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.

Cancela uma Operação de Transporte (CIOT) registrada junto à ANTT via provedor. Exige uma justificativa com até 500 caracteres.

Autenticação

Escopo Necessário
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e e CIOT
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · 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

ciot_uuidpath · stringObrigatório

UUID da operação de transporte.

Restrições
{
  "type": "string",
  "format": "uuid"
}

Corpo da Requisição

Obrigatório

application/json

justificativastringObrigatório

Motivo do cancelamento do CIOT.

maxLength500

Respostas

200 Resposta HTTP

Cancelamento concluído.

application/json

202 Resposta HTTP

Cancelamento em processamento.

application/json

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

application/json

errorobjectOpcional
403 Resposta HTTP

Escopo não habilitado para esta credencial

application/json

errorobjectOpcional
404 Resposta HTTP

Recurso não encontrado no tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlação da chamada.

409 Resposta HTTP

Ação conflitante (acao_conflitante).

application/json

errorobjectOpcional
422 Resposta HTTP

Falha de validação ou recusa pelo provedor (operacao_recusada).

application/json

errorobjectOpcional
503 Resposta HTTP

Provedor indisponível (servico_indisponivel).

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "tags": [
    "CIOT"
  ],
  "summary": "Cancelar CIOT",
  "operationId": "cancelarOperacaoCiot",
  "description": "Cancela uma Operação de Transporte (CIOT) registrada junto à ANTT via provedor.\nExige uma justificativa com até 500 caracteres.\n",
  "parameters": [
    {
      "name": "ciot_uuid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "UUID da operação de transporte."
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "justificativa"
          ],
          "properties": {
            "justificativa": {
              "type": "string",
              "maxLength": 500,
              "description": "Motivo do cancelamento do CIOT."
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Cancelamento concluído.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiot"
          }
        }
      }
    },
    "202": {
      "description": "Cancelamento em processamento.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiot"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "409": {
      "description": "Ação conflitante (`acao_conflitante`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "Falha de validação ou recusa pelo provedor (`operacao_recusada`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "503": {
      "description": "Provedor indisponível (`servico_indisponivel`).",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "fiscal",
  "x-fleetpay-module": "fiscal-ciot",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/fiscal/ciot/{ciot_uuid}/cancelamento"
}