Get Invoice

Returns a single invoice with the full totals breakdown, the order/customer context, the billing & shipping addresses, and the invoiced line items — no follow-up calls required. Requires the sales.invoices.view permission.

Endpoint

Endpoint	Method
/api/admin/invoices/{id}	GET

Response fields

Field	Type	Description
id	Integer	Numeric invoice id.
incrementId	String	Human-facing invoice number.
orderId	Integer	Id of the parent order.
orderIncrementId	String	Human-facing number of the parent order.
state	String	Invoice state — pending, pending_payment, paid, overdue.
emailSent	Boolean	Whether the invoice email was sent to the customer.
totalQty	Integer	Total quantity invoiced.

Currency codes

Field	Type	Description
orderCurrencyCode	String	Currency the order/invoice was placed in.
baseCurrencyCode	String	The store's base currency.
channelCurrencyCode	String	The sales channel's currency.

Totals

Each money total is provided in the order currency and the store's base currency, with a formatted* string carrying the currency symbol. Sub-total and shipping additionally expose an incl-tax variant.

Field	Type	Description
subTotal / formattedSubTotal	Number / String	Line-items subtotal (order currency).
baseSubTotal / formattedBaseSubTotal	Number / String	Subtotal (base currency).
subTotalInclTax / formattedSubTotalInclTax	Number / String	Subtotal incl. tax (order currency).
baseSubTotalInclTax / formattedBaseSubTotalInclTax	Number / String	Subtotal incl. tax (base currency).
grandTotal / formattedGrandTotal	Number / String	Invoice total (order currency).
baseGrandTotal / formattedBaseGrandTotal	Number / String	Invoice total (base currency).
taxAmount / formattedTaxAmount	Number / String	Tax total (order currency).
baseTaxAmount / formattedBaseTaxAmount	Number / String	Tax total (base currency).
discountAmount / formattedDiscountAmount	Number / String	Discount total (order currency).
baseDiscountAmount / formattedBaseDiscountAmount	Number / String	Discount total (base currency).
shippingAmount / formattedShippingAmount	Number / String	Shipping total (order currency).
baseShippingAmount / formattedBaseShippingAmount	Number / String	Shipping total (base currency).
shippingAmountInclTax / formattedShippingAmountInclTax	Number / String	Shipping incl. tax (order currency).
baseShippingAmountInclTax / formattedBaseShippingAmountInclTax	Number / String	Shipping incl. tax (base currency).
shippingTaxAmount / formattedShippingTaxAmount	Number / String	Tax on shipping (order currency).
baseShippingTaxAmount / formattedBaseShippingTaxAmount	Number / String	Tax on shipping (base currency).

Status & timestamps

Field	Type	Description
transactionId	String	Payment transaction reference (null until captured).
reminders	Integer	Number of payment reminders sent (for pending invoices).
nextReminderAt	String	When the next payment reminder is scheduled (null if none).
createdAt	String	When the invoice was created.
updatedAt	String	When the invoice was last updated.

Order & customer context

Resolved from the parent order so the invoice can be rendered without a second call.

Field	Type	Description
orderStatus	String	Parent order status code.
orderStatusLabel	String	Human-readable order status.
orderDate	String	When the parent order was placed.
channelName	String	Sales channel the order belongs to.
customerName	String	Customer's full name.
customerEmail	String	Customer's email.

Addresses (billingAddress, shippingAddress)

Objects with: id, addressType (order_billing / order_shipping), firstName, lastName, companyName (nullable), address, city, state, country, postcode, email, phone.

Line items (items)

Array of objects, each with:

Field	Type	Description
id	Integer	Invoice-item id.
orderItemId	Integer	Id of the order item this line was invoiced from.
sku	String	Product SKU.
name	String	Product name as ordered.
qty	Integer	Quantity invoiced for this line.
price / formattedPrice	Number / String	Unit price (order currency).
basePrice	Number	Unit price (base currency).
basePriceInclTax	Number	Unit price incl. tax (base currency).
total / formattedTotal	Number / String	Line total (order currency).
baseTotal	Number	Line total (base currency).
baseTotalInclTax	Number	Line total incl. tax (base currency).
taxAmount / formattedTaxAmount	Number / String	Tax for this line.
discountAmount / formattedDiscountAmount	Number / String	Discount for this line.
productId	Integer	Id of the product.
productType	String	Product type — simple, configurable, bundle, etc.
baseImageUrl	String	URL of the product's base image (null if none).
additional	Object	Extra item data (selected options, configurable attributes, etc.).