← HomeFleetPay / Schema

CteEvent

Structure preserved from the versioned API contract.

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

idstringRequired

Opaque public identifier used to reconcile the event.

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

typestringRequired

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

statusstringRequired

"pending" · "registered" · "rejected"

sequenceintegerRequired

minimum1

referencestring | nullRequired

protocolstring | nullRequired

reasonstring | nullRequired

registered_atstring | null · date-timeRequired

created_atstring | null · date-timeRequired

Original JSON Definition (Portuguese Descriptions)

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