← InicioFleetPay / Schema

OperacaoCiot

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

idstring · uuidObligatorio

Dirección pública de la operación. Se crea antes de contactar al proveedor, por lo que existe incluso cuando se rechaza la declaración: precisamente cuando nunca llegó a existir un número de CIOT.

referencia_externastring | nullOpcional

statusstringObligatorio

registered es el único estado que autoriza continuar el viaje. sent significa que se entregó la declaración sin un resultado definitivo; consulte antes de cualquier reintento. pending significa que la declaración ni siquiera se ha transmitido.

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

numerostring | nullOpcional

El CIOT. null hasta que la ANTT lo devuelva, y permanentemente si lo rechaza.

codigo_verificadorstring | nullOpcional

protocolostring | nullOpcional

mensagemstring | nullOpcional

Respuesta del proveedor o motivo del rechazo.

tipo_operacaostringOpcional

"lotacao" · "fracionado"

declarado_emstring | null · date-timeOpcional

registrado_emstring | null · date-timeOpcional

Cuándo se registró el CIOT en la ANTT. null mientras no exista.

cteobject | nullOpcional

CT-e al que está vinculada la operación, si existe. null es el caso normal de esta ruta: el campo siempre se incluye, incluso cuando es nulo, para indicar explícitamente si la operación está vinculada a un CT-e.

Definición JSON Original (Descripciones en Portugués)

{
  "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"
        }
      }
    }
  }
}