← HomeFleetPay / Schema

Nfe

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.

FiscalParty ↗NfeCargo ↗NfeStatus ↗

idstringRequired

NF-e access key; it is the resource's public identifier.

pattern"^\\d{44}$"

access_keystringRequired

pattern"^\\d{44}$"

numberintegerRequired

seriesstringRequired

issued_atstring | null · date-timeRequired

issuerobjectRequired

FiscalParty ↗

recipientobjectRequired

FiscalParty ↗

cargoobjectRequired

NfeCargo ↗

statusobjectRequired

NfeStatus ↗

linked_cte_countintegerRequired

minimum0

created_atstring | null · date-timeRequired

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "id",
    "access_key",
    "number",
    "series",
    "issued_at",
    "issuer",
    "recipient",
    "cargo",
    "status",
    "linked_cte_count",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^\\d{44}$",
      "description": "Chave de acesso da NF-e; é o identificador público do recurso."
    },
    "access_key": {
      "type": "string",
      "pattern": "^\\d{44}$"
    },
    "number": {
      "type": "integer"
    },
    "series": {
      "type": "string"
    },
    "issued_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "issuer": {
      "$ref": "#/components/schemas/FiscalParty"
    },
    "recipient": {
      "$ref": "#/components/schemas/FiscalParty"
    },
    "cargo": {
      "$ref": "#/components/schemas/NfeCargo"
    },
    "status": {
      "$ref": "#/components/schemas/NfeStatus"
    },
    "linked_cte_count": {
      "type": "integer",
      "minimum": 0
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}