Get purchase orders filtered and paged

paging.pageSize

integer, 1 to 1000, nullable

Optional

The number of purchase orders 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 purchase order's internal identifier (Reference/Code).

filter.externalIdentifier

string, nullable

Optional

Filters on the purchase order's external API identifier.

filter.ownerReference

string, nullable

Optional

Filters on the owner whose financial administration the purchase order belongs to.

filter.relationReference

string, nullable

Optional

Filters on the supplier the purchase order was issued to.

filter.proposalReference

string, nullable

Optional

Filters on the reference of the supplier's quote (proposal) the purchase order is based on.

filter.proposalTotalAmountExcl.from

number (double), nullable

Optional

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

filter.proposalTotalAmountExcl.to

number (double), nullable

Optional

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

filter.totalAmountExcl.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the purchase order's 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 purchase order's total amount excluding VAT. If omitted, there is no upper bound.

filter.invoicedAmount.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the amount already invoiced against the purchase order. If omitted, there is no lower bound.

filter.invoicedAmount.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the amount already invoiced against the purchase order. If omitted, there is no upper bound.

filter.outstandingAmount.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the amount not yet invoiced. If omitted, there is no lower bound.

filter.outstandingAmount.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the amount not yet invoiced. If omitted, there is no upper bound.

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.

purchaseOrders

array of objects, nullable

Optional

The list of purchase orders matching the filter for this page. See sub-fields below.

purchaseOrders.reference

string, nullable

Optional

The internal identifier (Reference/Code) of the purchase order.

purchaseOrders.externalIdentifier

string, nullable

Optional

The external API identifier of the purchase order, if any.

purchaseOrders.ownerReference

string, nullable

Optional

The internal identifier of the owner whose financial administration the purchase order belongs to.

purchaseOrders.relationReference

string, nullable

Optional

The internal identifier of the supplier the purchase order was issued to.

purchaseOrders.proposalReference

string, nullable

Optional

The reference of the supplier's quote (proposal) the purchase order is based on.

purchaseOrders.subject

string, nullable

Optional

The subject or description line of the purchase order.

purchaseOrders.proposalTotalAmountExcl

number (double), nullable

Optional

The total amount excluding VAT stated on the supplier's quote, in the administration's base currency (major units).

purchaseOrders.workflowState

integer (enum)

Optional

The approval workflow state of this purchase order. Allowed values: 1 = Draft, 2 = OnHold, 3 = Cancelled, 4 = ApprovalWorkflow, 7 = Final, 9 = Disapproved, 10 = OwnerApprovalWorkflow, 11 = DisapprovedByOwner.

purchaseOrders.finalizationState

integer (enum)

Optional

The invoicing progress of this purchase order, independent of workflowState. Allowed values: 0 = Open, 1 = Completed, 2 = Closed.

purchaseOrders.totalAmountExcl

number (double)

Optional

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

purchaseOrders.invoicedAmount

number (double), nullable

Optional

The amount already invoiced against this purchase order, in the administration's base currency (major units).

purchaseOrders.outstandingAmount

number (double), nullable

Optional

The amount of this purchase order not yet invoiced, in the administration's base currency (major units).