← HomeFleetPay / Schema

CtePreview

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.

access_keystringRequired
pattern"^\\d{44}$"
numberintegerRequired
seriesstringRequired
content—Required

Fiscal content assembled for inspection.

Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "access_key",
    "number",
    "series",
    "content",
    "document"
  ],
  "properties": {
    "access_key": {
      "type": "string",
      "pattern": "^\\d{44}$"
    },
    "number": {
      "type": "integer"
    },
    "series": {
      "type": "string"
    },
    "content": {
      "description": "Conteúdo fiscal montado para inspeção.",
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "string"
        }
      ]
    },
    "document": {
      "$ref": "#/components/schemas/Cte"
    }
  }
}