GET Invoice by external (legacy)
⚠️ Deprecated — Use
GET /invoices/externalOrderId/{externalOrderId}instead. This endpoint will be removed in a future release.
path Parameters
externalOrderIdThe external order number associated with the invoice.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Invoice by external (legacy) › Responses
Returns the invoice details.
invoiceNumberUnique invoice number.
orderNumberOrder number associated with this invoice.
invoiceDateDate the invoice was created.
taxAmountTax amount applied to this invoice.
taxableAmountGets or sets the amount that is subject to taxation.
discountAmountDiscount amount applied to this invoice.
subtotalAmountSubtotal amount before tax and discount.
List of invoice line items.
registerNumberRegister number where the invoice was created.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
customerIdCustomer identifier associated with this invoice.
totalAmountGets the calculated total amount (subtotal + tax - discount).
memoMemo/remark for this invoice.
Represents a delivery address with contact information.
List of payments associated with this invoice.
GET Invoice by externalInvoiceId
Looks up an invoice by the externalInvoiceId your application supplied when creating the invoice via POST /invoices.
path Parameters
externalInvoiceIdThe external invoice identifier.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Invoice by externalInvoiceId › Responses
Returns the invoice details.
invoiceNumberUnique invoice number.
orderNumberOrder number associated with this invoice.
invoiceDateDate the invoice was created.
taxAmountTax amount applied to this invoice.
taxableAmountGets or sets the amount that is subject to taxation.
discountAmountDiscount amount applied to this invoice.
subtotalAmountSubtotal amount before tax and discount.
List of invoice line items.
registerNumberRegister number where the invoice was created.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
customerIdCustomer identifier associated with this invoice.
totalAmountGets the calculated total amount (subtotal + tax - discount).
memoMemo/remark for this invoice.
Represents a delivery address with contact information.
List of payments associated with this invoice.
GET Invoice by externalOrderId.
Looks up the invoice generated from the order matching the supplied externalOrderId. This is the canonical replacement for the legacy /invoices/external/{externalOrderId} route.
path Parameters
externalOrderIdThe external order number associated with the invoice.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Invoice by externalOrderId. › Responses
Returns the invoice details.
invoiceNumberUnique invoice number.
orderNumberOrder number associated with this invoice.
invoiceDateDate the invoice was created.
taxAmountTax amount applied to this invoice.
taxableAmountGets or sets the amount that is subject to taxation.
discountAmountDiscount amount applied to this invoice.
subtotalAmountSubtotal amount before tax and discount.
List of invoice line items.
registerNumberRegister number where the invoice was created.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
customerIdCustomer identifier associated with this invoice.
totalAmountGets the calculated total amount (subtotal + tax - discount).
memoMemo/remark for this invoice.
Represents a delivery address with contact information.
List of payments associated with this invoice.
GET Invoice by id.
Looks up an invoice by its internal invoice number — assigned when an order is checked out and converted to an invoice.
path Parameters
idThe unique identifier of the invoice.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Invoice by id. › Responses
Returns the invoice details.
invoiceNumberUnique invoice number.
orderNumberOrder number associated with this invoice.
invoiceDateDate the invoice was created.
taxAmountTax amount applied to this invoice.
taxableAmountGets or sets the amount that is subject to taxation.
discountAmountDiscount amount applied to this invoice.
subtotalAmountSubtotal amount before tax and discount.
List of invoice line items.
registerNumberRegister number where the invoice was created.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
customerIdCustomer identifier associated with this invoice.
totalAmountGets the calculated total amount (subtotal + tax - discount).
memoMemo/remark for this invoice.
Represents a delivery address with contact information.
List of payments associated with this invoice.
GET Invoice by order id.
Looks up the invoice generated from a given order's internal ID. Returns 404 if the order has not yet been checked out into an invoice.
path Parameters
orderIdThe order identifier associated with the invoice.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
GET Invoice by order id. › Responses
Returns the invoice details.
invoiceNumberUnique invoice number.
orderNumberOrder number associated with this invoice.
invoiceDateDate the invoice was created.
taxAmountTax amount applied to this invoice.
taxableAmountGets or sets the amount that is subject to taxation.
discountAmountDiscount amount applied to this invoice.
subtotalAmountSubtotal amount before tax and discount.
List of invoice line items.
registerNumberRegister number where the invoice was created.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
customerIdCustomer identifier associated with this invoice.
totalAmountGets the calculated total amount (subtotal + tax - discount).
memoMemo/remark for this invoice.
Represents a delivery address with contact information.
List of payments associated with this invoice.
POST Create a new invoice.
Create an invoice directly, outside the normal order-to-invoice checkout flow. Provide either customerId (for an existing customer) or customer (to create a new customer inline) — not both.
Creation is idempotent on externalInvoiceId: re-submitting with an ID already in use returns 409 Conflict. Payment entries support APICreditCard and APIFoodStamp — other payment types are not currently accepted on this endpoint.
Headers
x-api-keyThe x-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
POST Create a new invoice. › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: customerId | |
| type = object · requires: customer |
customerIdExisting customer ID. If provided, the customer object is ignored.
externalInvoiceIdExternal invoice identifier (maximum 20 characters).
Request model for creating a new customer.
invoiceDateDate the invoice was created.
List of payments associated with this invoice.
List of invoice line items.
taxAmountGets or sets the total amount of tax applicable to the transaction.
taxableAmountGets or sets the total taxable amount (sum of taxable line items before tax).
orderMethodRepresents the method by which an order will be fulfilled.
memoGets or sets the memo associated with the Invoice
POST Create a new invoice. › Responses
Invoice created successfully.