Get sales invoices filtered and paged

paging.pageSize

integer, 1 to 1000, nullable

Optional

The number of sales invoices to return per page. Defaults to 100 when not given.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number to retrieve. Defaults to 1 when not given.

sorting.columnName

string, nullable

Optional

The name of the field to sort the results by.

sorting.order

integer (enum), nullable

Optional

The sort direction. Allowed values: 0 = Ascending, 1 = Descending.

filter.reference

string, nullable

Optional

Filters on the sales invoice's internal identifier (Reference/Code).

filter.ownerReference

string, nullable

Optional

Filters on the owner whose financial administration the invoice belongs to.

filter.relationReference

string, nullable

Optional

Filters on the relation this invoice was sent to.

filter.invoiceDate.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on invoice date, formatted as ISO 8601. If omitted, there is no lower bound.

filter.invoiceDate.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on invoice date, formatted as ISO 8601. If omitted, there is no upper bound.

filter.paymentTermName

string, nullable

Optional

Filters on the payment term applied to the invoice.

filter.dueDate.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on due date, formatted as ISO 8601. If omitted, there is no lower bound.

filter.dueDate.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on due date, formatted as ISO 8601. If omitted, there is no upper bound.

filter.totalAmountExcl.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total amount excluding VAT. If omitted, there is no lower bound.

filter.totalAmountExcl.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total amount excluding VAT. If omitted, there is no upper bound.

filter.totalAmountVAT.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total VAT amount. If omitted, there is no lower bound.

filter.totalAmountVAT.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total VAT amount. If omitted, there is no upper bound.

filter.totalAmountIncl.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total amount including VAT. If omitted, there is no lower bound.

filter.totalAmountIncl.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total amount including VAT. If omitted, there is no upper bound.

filter.outstandingAmount.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the outstanding (unpaid) amount. If omitted, there is no lower bound.

filter.outstandingAmount.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the outstanding (unpaid) amount. If omitted, there is no upper bound.

filter.outstandingAmountRecalculateDate.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on when the outstanding amount was last recalculated, formatted as ISO 8601. If omitted, there is no lower bound.

filter.outstandingAmountRecalculateDate.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on when the outstanding amount was last recalculated, formatted as ISO 8601. If omitted, there is no upper bound.

filter.salesContractReference

string, nullable

Optional

Filters on the sales contract the invoice is linked to, if applicable.

filter.serviceReference

string, nullable

Optional

Filters on the sales invoice service the invoice originated from, if applicable.

paging.pageSize

integer, 1 to 1000, nullable

Optional

The page size used to produce this result set.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number returned in this result set.

sorting.columnName

string, nullable

Optional

The field the results are sorted by.

sorting.order

integer (enum), nullable

Optional

The sort direction applied. Allowed values: 0 = Ascending, 1 = Descending.

salesInvoices

array of objects, nullable

Optional

The list of sales invoices matching the filter for this page. See sub-fields below.

salesInvoices.reference

string, nullable

Optional

The internal identifier (Reference/Code) of the sales invoice.

salesInvoices.ownerReference

string, nullable

Optional

The internal identifier of the owner whose financial administration this invoice belongs to.

salesInvoices.relationReference

string, nullable

Optional

The internal identifier of the relation this invoice was sent to.

salesInvoices.invoiceDate

string (date)

Optional

The date on the invoice, formatted as ISO 8601 (YYYY-MM-DD).

salesInvoices.paymentTermName

string, nullable

Optional

The payment term applied to this invoice.

salesInvoices.dueDate

string (date)

Optional

The date by which the invoice is due for payment, formatted as ISO 8601 (YYYY-MM-DD).

salesInvoices.totalAmountExcl

number (double)

Optional

The total invoice amount excluding VAT, in the administration's base currency (major units).

salesInvoices.totalAmountVAT

number (double)

Optional

The total VAT amount on the invoice, in the administration's base currency (major units).

salesInvoices.totalAmountIncl

number (double)

Optional

The total invoice amount including VAT, in the administration's base currency (major units).

salesInvoices.outstandingAmount

number (double), nullable

Optional

The amount still outstanding (unpaid) on this invoice, in the administration's base currency (major units).

salesInvoices.outstandingAmountRecalculateDate

string (date-time), nullable

Optional

The date and time outstandingAmount was last recalculated, formatted as ISO 8601.

salesInvoices.salesContractReference

string, nullable

Optional

The internal identifier of the sales contract this invoice is linked to, if applicable.

salesInvoices.serviceReference

string, nullable

Optional

The internal identifier of the sales invoice service this invoice originated from, if applicable.