Purchase order

Definition

Information about a purchase order.

InboundShipment

Constraints

You must supply either an id or a number of a supplier. It is not posible to have more than 1000 lines on an purchase order.

Fields

Id

Unique identification of this purchase order across all subscribers.

id Long Read only

No.

Unique identification of purchase order within the context.

inboundShipmentNumber String Unique Pattern [^\t^\n^\x0B^\f^\r]* Length 1 to 36 Not Blank

Delivery date

The agreed upon date of delivery at the delivery address.

deliveryDate Date Format yyyy-MM-dd

Expected arrival

Time when the goods are expected to arrive.

expectedTimeOfArrival Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Delivery address

DeliveryAddress.

deliveryAddress Address

Supplier address

Address of the supplier of the purchase order.

supplierAddress Address Read only

Incoterms

Incoterms.

incoterms Incoterms

Created

The date of creation of this purchase order.

timeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Delivery note no.

The number of the delivery note that came with the goods on this purchase order.

deliveryNoteNumber String Length 0 to 250

Invoice number.

The number of a possible invoice that relates to this purchase order.

invoiceNumber String Length 0 to 250

Order conf. no.

The number of the order confirmation sent by the supplier.

orderConfirmationNumber String Length 0 to 250

Supplier no.

Unique identification of the supplier within the context.

supplierNumber String Not Null Supplier

Supplier ID

Unique identification of the supplier of this delivery.

supplierId Long Not Null Supplier

Currency code

Currency code for all amounts on this purchase order.

currencyCode CurrencyCode

Exchange rate

The price used to calculate the cost.

currencyExchangeRate BigDecimal Min 0.000001 Max 999999.999999 Integer 6, Fraction 6

inboundShipment.purchaseOrderTimeCreated

inboundShipment.purchaseOrderTimeCreated.description

purchaseOrderTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Purchase order no.

The number of the purchase order used when ordering this purchase order.

purchaseOrderNumber Long Read only

inboundShipment.purchaseOrderId

inboundShipment.purchaseOrderId.description

purchaseOrderId Long Read only Document

Request for quotation created

The date and time for the creation of the request for quotation.

requestForQuotationTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Request for quotation no.

The number of the request for quotation related to this purchase order.

requestForQuotationNumber Long Read only

Request for quotation id

Unique identification of the request for quotation made for this purchase order.

requestForQuotationId Long Read only Document

Goods receipt created

Time the goods receipt for this purchase order was created.

goodsReceiptTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Goods receipt number

Number of the goods receipt created for this purchase order.

goodsReceiptNumber Long Read only

Goods receipt id

Unique identification of the goods receipt made for this purchase order.

goodsReceiptId Long Read only Document

Cost variance list created

Time of the creation of the cost variance list.

costVarianceListTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Cost variance list number

The number of the cost variance list made for this purchase order.

costVarianceListNumber Long Read only

Cost variance list id

Unique identifikation of the cost variance list made for this purchase order.

costVarianceListId Long Read only Document

Purchase order lines

Lines describing which items are expected to be received on this purchase order.

inboundShipmentLines List InboundShipmentLine

Context id

Unique identification of the context within which the purchase order is created.

contextId Long Context

Created event id

Unique identification of the creation of this purchase order. Messages regarding the creation are attached to this id.

inboundShipmentCreatedEventId String Read only

On-hold

Indicates that this purchase order is on-hold and therefore not yet ready to be received.

onHold Boolean

Cancelled

Indicates that this purchase order is cancelled and will never be received.

cancelled Boolean

Notes on reception

Notes relevant to the reception of the items.

notesOnReception String

Notes on ordering

Notes relevant to the ordering of the items.

notesOnOrdering String

Data document

JSON document containing additional information about this purchase order.

dataDocument String JSON

Filter

Delivery number

A search term that the delivery number should match for a delivery to pass the filter.

inboundShipmentNumberMatch String

Supplier number

Search terms that the supplier of the purchase order should match.

supplierNumberMatch String

Supplier Address

An expression to be found in the supplier's address information.

supplierAddressMatch String

Only without receipt

Only show the purchase orders that have not yet been received.

onlyNoGoodsReceipt Boolean

Only without cost variance list

Only show the purchase orders where no cost variance list has yet been made.

onlyNoCostVarianceList Boolean

Only expected today

Show only the purchase orders that are expected to be received today.

onlyExpectedToday Boolean

Delivery note number

Search terms as the delivery's tracking number must match.

deliveryNoteNumberMatch String

Invoice number

A search term that the invoice number should match.

invoiceNumberMatch String

Date receipt

Only show purchase orders where receipt was printed on this date.

dateGoodsReceiptCreated Date

Delivery address

Delivery address.

deliveryAddressMatch String

Delivery horizon

Delivery horizon.

deliveryHorizon Integer

Created

Only show purchase orders created within this time interval.

createdWithinCommonTimeInterval CommonTimeInterval