Skip to content

InvoiceDetail ​

Type: schema

Description ​

InvoiceDetail model

TypeScript Definition ​

typescript
InvoiceDetail: {components["schemas"]["Invoice"] & {
            items?: components["schemas"]["InvoiceItem"][]
}

Component References ​

ReferenceResolves To
components["schemas"]["Invoice"]Invoice
components["schemas"]["InvoiceItem"]InvoiceItem

OpenAPI Schema ​

json
{
  "description": "InvoiceDetail model",
  "allOf": [
    {
      "$ref": "#/components/schemas/Invoice"
    },
    {
      "type": "object",
      "description": "Detail response extends InvoiceListSerializer: these fields are emitted alongside the Invoice financials.",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/InvoiceItem"
          }
        },
        "invoice_source": {
          "type": "string",
          "readOnly": true
        },
        "items_count": {
          "type": "integer",
          "readOnly": true
        },
        "order_number": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "customer_id": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "customer_name": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "shipment_id": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "seller_id": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "invoice_amount_excluding_tax": {
          "type": "number",
          "readOnly": true
        },
        "invoice_amount_including_tax": {
          "type": "number",
          "readOnly": true
        },
        "shipping_amount_excluding_tax": {
          "type": "number",
          "readOnly": true
        },
        "shipping_tax_amount": {
          "type": "number",
          "readOnly": true
        },
        "shipping_tax_rate": {
          "type": "number",
          "readOnly": true
        },
        "subtotal_including_tax": {
          "type": "number",
          "readOnly": true
        }
      }
    }
  ],
  "title": "InvoiceDetail",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: