magento · Schema

Invoice

An invoice record associated with a sales order.

Properties

Name	Type	Description
entity_id	integer	Numeric invoice entity ID.
order_id	integer	Numeric entity ID of the parent order.
increment_id	string	Human-readable invoice number.
state	integer	Invoice state. 1 = open, 2 = paid, 3 = cancelled.
grand_total	number	Invoice grand total.
subtotal	number	Invoice subtotal.
created_at	string	ISO 8601 timestamp when the invoice was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Invoice",
  "title": "Invoice",
  "type": "object",
  "description": "An invoice record associated with a sales order.",
  "properties": {
    "entity_id": {
      "type": "integer",
      "description": "Numeric invoice entity ID."
    },
    "order_id": {
      "type": "integer",
      "description": "Numeric entity ID of the parent order."
    },
    "increment_id": {
      "type": "string",
      "description": "Human-readable invoice number."
    },
    "state": {
      "type": "integer",
      "description": "Invoice state. 1 = open, 2 = paid, 3 = cancelled.",
      "enum": [
        1,
        2,
        3
      ]
    },
    "grand_total": {
      "type": "number",
      "description": "Invoice grand total."
    },
    "subtotal": {
      "type": "number",
      "description": "Invoice subtotal."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the invoice was created."
    }
  }
}