Skip to main content

Invoice

A billing document sent to a customer for goods delivered.

invoiceNumberstring

Human-readable invoice identifier displayed in Keychain OS.

Example: INV-2025-0073
salesOrderNumberstring

The sales order this invoice is for.

Example: SO-2025-0189
customerNamestring

Display name of the invoiced customer.

Example: Sunrise Craft Beverages
statusstring

Current status of the invoice: draft — created, not yet sent. sent — delivered to customer. viewed — customer has opened it. paid — payment received. voided — cancelled after sending. archived — filed away.

Possible values: [draft, sent, viewed, paid, voided, archived]

Example: sent
invoiceDatestring<date>

Date the invoice was issued (ISO 8601).

Example: 2025-03-12
dueDatestring<date>

Payment due date (ISO 8601).

Example: 2025-04-11
paymentTermsstring

Payment terms for this invoice.

Example: Net 30
subtotalnumber

Sum of all line item totals before discounts, tax, and shipping.

Example: 6250
discountAmountnumber

Total discount applied. 0 means no discount.

Example: 0
taxAmountnumber

Total tax applied.

Example: 500
shippingChargesnumber

Shipping charges.

Example: 275
totalAmountnumber

Final amount due (subtotal - discount + tax + shipping).

Example: 7025
paymentMethodstring

Payment method, if recorded.

Example: bank_transfer
shipmentNumberstring

Linked shipment number, if applicable.

Example: SHP-2025-0042
notesstring

Free-text notes attached to the invoice.

lineItems object[]

The line items on this invoice.

  • Array [
    • skuIdstring

    Reference to the SKU being invoiced.

    Example: 1042
    skuNamestring

    Display name of the SKU.

    Example: Roasted Garlic Hummus
    descriptionstring

    Line item description.

    Example: Roasted Garlic Hummus - 16oz
    quantitynumber

    Quantity invoiced.

    Example: 500
    unitstring

    Unit of measure.

    Example: lbs
    unitPricenumber

    Price per unit.

    Example: 12.5
    amountnumber

    Line total (quantity x unit price).

    Example: 6250
  • ]
    • Invoice
    {
      "invoiceNumber": "INV-2025-0073",
      "salesOrderNumber": "SO-2025-0189",
      "customerName": "Sunrise Craft Beverages",
      "status": "sent",
      "invoiceDate": "2025-03-12",
      "dueDate": "2025-04-11",
      "paymentTerms": "Net 30",
      "subtotal": 6250,
      "discountAmount": 0,
      "taxAmount": 500,
      "shippingCharges": 275,
      "totalAmount": 7025,
      "paymentMethod": "bank_transfer",
      "shipmentNumber": "SHP-2025-0042",
      "notes": "string",
      "lineItems": [
        {
          "skuId": "1042",
          "skuName": "Roasted Garlic Hummus",
          "description": "Roasted Garlic Hummus - 16oz",
          "quantity": 500,
          "unit": "lbs",
          "unitPrice": 12.5,
          "amount": 6250
        }
      ]
    }