Create invoice

currency

string

enum

required

The three-letter ISO 4217 currency code used for all monetary amounts in this invoice.

Allowed:

lineItems

array of objects

required

length between 1 and 100

A list of line items to include in the invoice. Must contain at least 1 item and no more than 100.

lineItems*

description

string

required

A short description of the product or service.

quantity

float

required

The quantity of the line item. Can have up to 2 decimal places.

price

float

required

The unit price for a single quantity of this line item, before tax or discounts.

taxAmount

float

The tax amount for this line item.

discountAmount

float

The discount amount applied to this line item.

sku

string

The stock keeping unit (SKU) code for this product (or service).

customerId

integer

Defaults to 0

Unique customer ID to associate with this invoice.

billingAddress

object

The billing address for this invoice.

shipping

object

The shipping details for this invoice, including shipping cost, method, and destination address.

pickup

object

The pickup details for this invoice, including the pickup date and the name of the person collecting the order.

tax

object

The invoice-level tax details.

discount

object

The invoice-level discount details.

type

string

enum

Defaults to INVOICE

The invoice type. Allowed values: ESTIMATE, QUOTE, ORDER, PURCHASE_ORDER, INVOICE, STATEMENT, REGISTRATION, CREDIT. Defaults to INVOICE if omitted.

status

string

enum

Defaults to DUE

The initial status of the invoice. Allowed values: CANCELLED, DUE, PAID, SHIPPED, COMPLETED, REFUNDED, IN_PROGRESS. Defaults to DUE if omitted.

Allowed:

convenienceFeeEnabled

boolean

Indicates whether a convenience fee is enabled for this invoice. If not provided, the system will use the merchant's global Fee Saver settings to determine this value.

tipAmount

float

Optional tip amount to include. Must be greater than zero if provided.

invoiceNumber

string

Optional custom invoice number. If omitted or blank, the system will generate one automatically based on the Invoice Settings.

notes

string

Optional notes to display at the bottom of the invoice, visible to the customer.

200Successful

defaultFailed