← HomeFleetPay / API

Cancel a CIOT

Parameters, data structure and responses from the versioned contract.

POST/fiscal/cte/{cte_uuid}/ciot/cancelamento
cancelCiotSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Simulated sandbox mode. This operation has no contracted CIOT provider behind it: in the sandbox environment, FleetPay generates a deterministic response with no regulatory effect — nothing is registered with ANTT, and no CIOT handled here has legal validity.

The request and response contract is already final: you can integrate now. When the real provider is introduced, behavior stops being simulated without a contract change.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

cte_uuidpath · stringRequired

Public CT-e UUID.

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

Request Body

Required

application/json

justificationstringRequired
maxLength500

Responses

200 HTTP Response

CIOT operation completed.

application/json

Headers

X-Request-Id

Call correlation identifier.

202 HTTP Response

CIOT operation still pending or ambiguous; query again.

application/json

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

application/json

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

application/json

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

Resource not found in the authenticated tenant.

application/json

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

Invalid payload, outstanding requirement or business rule.

application/json

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

application/json

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

application/json

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition
{
  "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"
    }
  ]
}