← InicioFleetPay / API

Cancelar CIOT

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

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

Cancela una Operación de Transporte (CIOT) registrada ante la ANTT a través del proveedor. Exige una justificación de hasta 500 caracteres.

Autenticación

Permiso Requerido
fiscal — Fiscal
Módulo
Fiscal, CT-e, MDF-e y CIOT
Perfiles Aplicables
Gestor de Transporte · Agregado Empresarial · 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

ciot_uuidpath · stringObligatorio

UUID de la operación de transporte.

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

Cuerpo de la Solicitud

Obligatorio

application/json

justificativastringObligatorio

Motivo de la cancelación del CIOT.

maxLength500

Respuestas

200 Respuesta HTTP

Cancelación completada.

application/json

202 Respuesta HTTP

Cancelación en procesamiento.

application/json

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

application/json

errorobjectOpcional
403 Respuesta HTTP

Ámbito no habilitado para esta credencial

application/json

errorobjectOpcional
404 Respuesta HTTP

Recurso no encontrado en el tenant autenticado.

application/json

Headers

X-Request-Id

Identificador de correlación de la llamada.

409 Respuesta HTTP

Acción conflictiva (acao_conflitante).

application/json

errorobjectOpcional
422 Respuesta HTTP

Falla de validación o rechazo por parte del proveedor (operacao_recusada).

application/json

errorobjectOpcional
503 Respuesta HTTP

Proveedor no disponible (servico_indisponivel).

application/json

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