← InícioFleetPay / Schema

CteEvent

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.

idstringObrigatório

Identificador público opaco usado para reconciliar o evento.

pattern"^[a-f0-9]{64}$"

typestringObrigatório

"cancellation" · "correction" · "delivery_confirmation" · "delivery_cancellation"

statusstringObrigatório

"pending" · "registered" · "rejected"

sequenceintegerObrigatório

minimum1

referencestring | nullObrigatório

protocolstring | nullObrigatório

reasonstring | nullObrigatório

registered_atstring | null · date-timeObrigatório

created_atstring | null · date-timeObrigatório

Definição JSON Completa

{
  "type": "object",
  "required": [
    "id",
    "type",
    "status",
    "sequence",
    "reference",
    "protocol",
    "reason",
    "registered_at",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "Identificador público opaco usado para reconciliar o evento."
    },
    "type": {
      "type": "string",
      "enum": [
        "cancellation",
        "correction",
        "delivery_confirmation",
        "delivery_cancellation"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "registered",
        "rejected"
      ]
    },
    "sequence": {
      "type": "integer",
      "minimum": 1
    },
    "reference": {
      "type": [
        "string",
        "null"
      ]
    },
    "protocol": {
      "type": [
        "string",
        "null"
      ]
    },
    "reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "registered_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}