Get purchase invoices filtered and paged

paging.pageSize

integer

No

Number of results per page. Minimum 1, maximum 1000. Defaults to a system value when omitted.

paging.pageNumber

integer

No

Page number to retrieve. Minimum 1, maximum 9999.

sorting.columnName

string

No

Name of the field to sort results by.

sorting.order

integer

No

Sort direction. Enum: 0 = Ascending, 1 = Descending.

filter.reference

string

No

Filters results to the purchase invoice with this internal reference.

filter.ownerReference

string

No

Filters results to invoices booked for this owner.

filter.relationReference

string

No

Filters results to invoices received from this relation (supplier).

filter.invoiceDate.from

datetime

No

Lower bound (inclusive) for invoice date. ISO 8601 format.

filter.invoiceDate.to

datetime

No

Upper bound (inclusive) for invoice date. ISO 8601 format.

filter.paymentTermName

string

No

Filters results to invoices using this payment term.

filter.dueDate.from

datetime

No

Lower bound (inclusive) for due date. ISO 8601 format.

filter.dueDate.to

datetime

No

Upper bound (inclusive) for due date. ISO 8601 format.

filter.totalAmountExcl.from

decimal

No

Lower bound (inclusive) for the invoice's total amount excluding VAT.

filter.totalAmountExcl.to

decimal

No

Upper bound (inclusive) for the invoice's total amount excluding VAT.

filter.totalAmountVAT.from

decimal

No

Lower bound (inclusive) for the invoice's total VAT amount.

filter.totalAmountVAT.to

decimal

No

Upper bound (inclusive) for the invoice's total VAT amount.

filter.totalAmountIncl.from

decimal

No

Lower bound (inclusive) for the invoice's total amount including VAT.

filter.totalAmountIncl.to

decimal

No

Upper bound (inclusive) for the invoice's total amount including VAT.

filter.outstandingAmount.from

decimal

No

Lower bound (inclusive) for the invoice's outstanding amount.

filter.outstandingAmount.to

decimal

No

Upper bound (inclusive) for the invoice's outstanding amount.

filter.outstandingAmountRecalculateDate.from

datetime

No

Lower bound (inclusive) for the last outstanding amount recalculation. ISO 8601 format.

filter.outstandingAmountRecalculateDate.to

datetime

No

Upper bound (inclusive) for the last outstanding amount recalculation. ISO 8601 format.

filter.serviceTicketReference

string

No

Filters results to invoices linked to this maintenance service ticket.

filter.purchaseOrderReference

string

No

Filters results to invoices linked to this purchase order.

filter.purchaseContractReference

string

No

Filters results to invoices linked to this purchase contract.

paging.pageSize

integer

Yes

Number of results per page, as applied to this response.

paging.pageNumber

integer

Yes

Page number returned in this response.

sorting.columnName

string

Yes

Field the results were sorted by.

sorting.order

integer

Yes

Sort direction applied. Enum: 0 = Ascending, 1 = Descending.

purchaseInvoices

array of objects

No

Collection of purchase invoices matching the filter for this page. See the fields below.

purchaseInvoices[].reference

string

No

Internal reference of the purchase invoice.

purchaseInvoices[].ownerReference

string

No

Reference to the owner the purchase invoice is booked for.

purchaseInvoices[].relationReference

string

No

Reference to the relation, the supplier the invoice was received from.

purchaseInvoices[].invoiceDate

date

Yes

Date on which the invoice was issued. Format YYYY-MM-DD.

purchaseInvoices[].paymentTermName

string

No

Name of the payment term applied to the invoice.

purchaseInvoices[].dueDate

date

Yes

Date by which the invoice must be paid. Format YYYY-MM-DD.

purchaseInvoices[].totalAmountExcl

decimal

Yes

Total invoice amount excluding VAT, the net amount.

purchaseInvoices[].totalAmountVAT

decimal

Yes

Total VAT amount charged on the invoice.

purchaseInvoices[].totalAmountIncl

decimal

Yes

Total invoice amount including VAT, the gross amount. Equal to totalAmountExcl plus totalAmountVAT.

purchaseInvoices[].outstandingAmount

decimal

No

Remaining amount still to be paid, as of outstandingAmountRecalculateDate. Null if not yet calculated.

purchaseInvoices[].outstandingAmountRecalculateDate

datetime

No

Date and time at which outstandingAmount was last recalculated. ISO 8601 format.

purchaseInvoices[].serviceTicketReference

string

No

Reference to the maintenance service ticket the invoice relates to, if applicable.

purchaseInvoices[].purchaseOrderReference

string

No

Reference to the purchase order the invoice relates to, if applicable.

purchaseInvoices[].purchaseContractReference

string

No

Reference to the purchase contract the invoice relates to, if applicable.