← InícioFleetPay / Schema

OperacaoCiot

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

idstring · uuidObrigatório

O endereço público da operação. Nasce antes da chamada ao provedor, e por isso existe mesmo quando a declaração é recusada — é o caso em que o número do CIOT nunca chegou a existir.

referencia_externastring | nullOpcional

statusstringObrigatório

registered é o único que autoriza seguir viagem. sent é declaração entregue sem veredito — consulte antes de qualquer nova tentativa. pending é declaração que nem foi transmitida.

"pending" · "sent" · "registered" · "error" · "cancelled" · "closed"

numerostring | nullOpcional

O CIOT. null até a ANTT devolver — e para sempre, se ela recusar.

codigo_verificadorstring | nullOpcional

protocolostring | nullOpcional

mensagemstring | nullOpcional

O que o provedor respondeu, ou o motivo da recusa.

tipo_operacaostringOpcional

"lotacao" · "fracionado"

declarado_emstring | null · date-timeOpcional

registrado_emstring | null · date-timeOpcional

Quando o CIOT passou a existir na ANTT. null enquanto não existir.

cteobject | nullOpcional

O CT-e ao qual a operação está amarrada, quando houver. null é o caso normal desta rota — o campo viaja sempre, mesmo nulo, para que a pergunta "isto está amarrado a um CT-e?" tenha resposta explícita.

Definição JSON Completa

{
  "type": "object",
  "required": [
    "id",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "O endereço público da operação. Nasce **antes** da chamada ao provedor, e por isso\nexiste mesmo quando a declaração é recusada — é o caso em que o número do CIOT\nnunca chegou a existir.\n"
    },
    "referencia_externa": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "sent",
        "registered",
        "error",
        "cancelled",
        "closed"
      ],
      "description": "`registered` é o único que autoriza seguir viagem. `sent` é declaração entregue sem\nveredito — consulte antes de qualquer nova tentativa. `pending` é declaração que\nnem foi transmitida.\n"
    },
    "numero": {
      "type": [
        "string",
        "null"
      ],
      "description": "O CIOT. `null` até a ANTT devolver — e para sempre, se ela recusar."
    },
    "codigo_verificador": {
      "type": [
        "string",
        "null"
      ]
    },
    "protocolo": {
      "type": [
        "string",
        "null"
      ]
    },
    "mensagem": {
      "type": [
        "string",
        "null"
      ],
      "description": "O que o provedor respondeu, ou o motivo da recusa."
    },
    "tipo_operacao": {
      "type": "string",
      "enum": [
        "lotacao",
        "fracionado"
      ]
    },
    "declarado_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "registrado_em": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Quando o CIOT passou a existir na ANTT. `null` enquanto não existir."
    },
    "cte": {
      "type": [
        "object",
        "null"
      ],
      "description": "O CT-e ao qual a operação está amarrada, quando houver. **`null` é o caso normal\ndesta rota** — o campo viaja sempre, mesmo nulo, para que a pergunta \"isto está\namarrado a um CT-e?\" tenha resposta explícita.\n",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}