← HomeFleetPay / Schema

CteIssueResult

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.

Cte ↗

document—Required

Cte ↗

outcomestringRequired

"accepted" · "refused" · "unknown"

messagestring | nullRequired

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "document",
    "outcome",
    "message"
  ],
  "properties": {
    "document": {
      "anyOf": [
        {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/components/schemas/Cte"
            }
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "outcome": {
      "type": "string",
      "enum": [
        "accepted",
        "refused",
        "unknown"
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}