Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Invoice

Find invoices based on search parameters.

post/api/invoices/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip.

Takeinteger

Number of records to return (maximum)

Request body

numbersinteger[] nullable

Filter invoices to only given numbers

status'new' | 'needsApproval' | 'approved' | 'issued' | 'paid'

Invoice status

Response

List of invoices matching the filters

idstring required

Unique id associated to this entity.

numberinteger required

Number

status'new' | 'needsApproval' | 'approved' | 'issued' | 'paid' required

Invoice status

customerIdstring required

The id of the customer that the invoice is for. Please reference /api/customers endpoint.

issueDatestring date-time nullable

Invoice issued date indicates when the invoice was sent to the customer.

externalReferencesobject nullable

External references associated with this entity.

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

companyInfoIdstring nullable

Company Information Id;

salesOrderIdstring nullable

Sales order identifier. Please reference /api/sales-orders endpoint.

customerPONumberstring nullable

Customer PO number.

dueDatestring date-time nullable

Invoice due date.

totalnumber double required

The final amount due, calculated as the sum of all item costs, taxes, fees, and any discounts applied in primary currency.

subtotalnumber double required

The sum of all item costs before taxes and discounts are applied in primary currency.

lineItemsTotalnumber double

The summation of the line item amounts due.

notesToCustomerstring nullable

A field for the seller to provide additional details or instructions for the customer relating to the order.

customFieldsobject nullable

Custom fields that have been defined on this entity.

isDepositboolean

Is deposit invoice

deletedboolean

Indicates whether this invoice has been deleted