Get concept purchase invoices filtered and paged

paging.pageSize

Integer

Optional

Maximum number of concept purchase invoices returned per page. Minimum 1, maximum 1000.

paging.pageNumber

Integer

Optional

Page number to retrieve, starting at 1. Minimum 1, maximum 9999.

sorting.sortBy

String

Optional

Name of the field to sort the results by.

sorting.ascending

Boolean

Optional

Sort direction. True sorts the results in ascending order, false in descending order.

filter.reference

String

Optional

Filters on the internal identifier of the concept purchase invoice.

filter.externalIdentifier

String

Optional

Filters on the external identifier of the invoice, as supplied by the caller on creation.

filter.ownerReference

String

Optional

Filters on the owner, the administration the invoice is booked against.

filter.relationReference

String

Optional

Filters on the relation, the supplier the invoice was received from.

filter.subject

String

Optional

Filters on the subject describing the invoice as a whole.

filter.invoiceDate.from

Datetime (ISO 8601)

Optional

Lower bound of the invoice date range to filter on, inclusive.

filter.invoiceDate.to

Datetime (ISO 8601)

Optional

Upper bound of the invoice date range to filter on, inclusive.

filter.paymentTermName

String

Optional

Filters on the name of the payment term applied to the invoice.

filter.expiryDate.from

Datetime (ISO 8601)

Optional

Lower bound of the expiry date range to filter on, inclusive.

filter.expiryDate.to

Datetime (ISO 8601)

Optional

Upper bound of the expiry date range to filter on, inclusive.

filter.paymentMethod

Integer (enum)

Optional

Filters on how the invoice is settled. Allowed values: 1 = DirectDebit, 2 = BankTransfer, 3 = Withdrawal, 4 = Cash, 5 = iDEAL.

filter.fromBankAccountIban

String

Optional

Filters on the IBAN of the account the payment is made from.

filter.toBankAccountIban

String

Optional

Filters on the IBAN of the account the payment is made to, typically the supplier's account.

paging.pageSize

Integer

Optional

Maximum number of concept purchase invoices returned per page, as applied to this result.

paging.pageNumber

Integer

Optional

Page number returned, as applied to this result.

sorting.sortBy

String

Optional

Name of the field the results are sorted by, as applied to this result.

sorting.ascending

Boolean

Optional

Sort direction applied to this result. True indicates ascending order, false indicates descending order.

purchaseInvoices

Array of objects

Optional

The concept purchase invoices matching the filter, for the requested page.

purchaseInvoices[].reference

String

Optional

Internal identifier of the concept purchase invoice.

purchaseInvoices[].externalIdentifier

String

Optional

External identifier of the invoice, as supplied by the caller on creation.

purchaseInvoices[].ownerReference

String

Optional

Reference to the owner, the administration the invoice is booked against.

purchaseInvoices[].relationReference

String

Optional

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

purchaseInvoices[].subject

String

Optional

Subject describing the invoice as a whole.

purchaseInvoices[].invoiceDate

Date (ISO 8601, format YYYY-MM-DD)

Optional

Date on the invoice.

purchaseInvoices[].paymentTermName

String

Optional

Name of the payment term applied to the invoice.

purchaseInvoices[].expiryDate

Date (ISO 8601, format YYYY-MM-DD)

Optional

Date by which the invoice is expected to be paid or settled.

purchaseInvoices[].paymentMethod

Integer (enum)

Optional

How the invoice is settled. Allowed values: 1 = DirectDebit, 2 = BankTransfer, 3 = Withdrawal, 4 = Cash, 5 = iDEAL.

purchaseInvoices[].fromBankAccountIban

String

Optional

IBAN of the account the payment is made from.

purchaseInvoices[].toBankAccountIban

String

Optional

IBAN of the account the payment is made to, typically the supplier's account.