Get a purchase order

reference

string

Required (at least one of reference or externalIdentifier must be given)

The internal identifier of the purchase order.

externalIdentifier

string

Required (at least one of reference or externalIdentifier must be given)

The external API identifier of the purchase order.

reference

string, max 100

Required

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

externalIdentifier

string, max 100

Required

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

ownerReference

string, max 100

Required

The internal identifier (Reference/Code) of the owner whose financial administration this purchase order belongs to.

relationReference

string, max 100

Required

The internal identifier (Reference/Code) of the supplier this purchase order was issued to.

proposalReference

string, max 100

Required

The reference of the externally supplied quote (proposal) from the supplier that this purchase order is based on.

proposalTotalAmountExcl

number (double), nullable

Optional

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

subject

string, max 512, nullable

Optional

The subject or description line of the purchase order.

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.

finalizationState

integer (enum)

Optional

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

totalAmountExcl

number (double)

Optional

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

invoicedAmount

number (double), nullable

Optional

The amount already invoiced against this purchase order, calculated by Bloxs from purchase invoices referencing it, in the administration's base currency (major units).

outstandingAmount

number (double), nullable

Optional

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

lines

array of objects, nullable

Optional

The purchase order's line items. See sub-fields below.

lines.lineIndex

integer

Optional

The position of this line within the purchase order.

lines.expectedDate

string (date)

Required (within each line)

The expected date for this line, formatted as ISO 8601 (YYYY-MM-DD).

lines.description

string, max 512, nullable

Optional

The description text for this line.

lines.ledgerAccountCode

string, max 12

Required (within each line)

The general ledger account code this line is booked to.

lines.realEstateObjectReference

string, max 100, nullable

Optional

The internal identifier of the real estate object this line is allocated to, if applicable.

lines.taxRateCode

string, max 100, nullable

Optional

The VAT/tax rate applied to this line, represented as a descriptive label rather than a short code.

lines.amountExcl

number (double)

Required (within each line)

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