Listing Purchase Orders

Listing Purchase Orders¶

Listing Purchase Orders should be done through the general Query capabilities of DataAuthority Endpoints.

For all the Purchase Order List Views (lists and tables) the following properties are available for filtering and sorting:

Field	Type	Description
`eId`	String (UUID)	The entity ID of the Purchase Order
`effective_as_of`	Long	Unix Epoch (UTC) for the Last update of the Order
`created_at_effective`	Long	Unix Epoch (UTC) for the Creation of the Order
`status`	Enumerated	The status of the Purchase Order
`order_number`	String	The order number of the Purchase Order
`order_date_timestamp`	Long	Unix Epoch (UTC) for the Order
`order_date_time_zone`	String	IANA Timezone identifier for the Order
`allow_partial`	Boolean	Whether the Purchase Order allows partial fulfillment
`expedite`	Boolean	Whether the Purchase Order is expedited
`deliver_by_timestamp`	Long	The deliver by Unix Epoch of the Purchase Order
`delivery_address_*`	PostalAddress (see below)	The delivery address of the Purchase Order
`procurement_*`	Contact (see below)	The procurement contact of the Purchase Order
`supplier_name`	String	The supplier name of the Purchase Order
`supplier_address_*`	PostalAddress (see below)	The supplier address of the Purchase Order
`order_method`	Enumerated	The order method of the Purchase Order
`sales_*`	Contact (see below)	The sales contact of the Purchase Order
`goods_value_value`	Decimal	The decimal value of the goods of the Purchase Order
`goods_value_currency`	String	The currency of the goods of the Purchase Order
`accounting_reference`	String	The accounting reference of the Purchase Order
`terms_and_conditions`	String	The terms and conditions of the Purchase Order
`notes`	String	The notes of the Purchase Order
`private_notes`	String	The private notes of the Purchase Order

For composite fields marked by a *, the following sub-fields are available:

Field	Type	Description
`address_line_1`	String	The first line of the address
`address_line_2`	String	The second line of the address
`city`	String	The city of the address
`state`	String	The state of the address
`postal_code`	String	The postal code of the address
`country`	Enumerated	The country of the address
`geo_location`	GeoLocation (see below)	The geo location of the address

Field	Type	Description
`salutation`	String	The salutation of the contact
`first_name`	String	The first name of the contact
`middle_name`	String	The middle name of the contact
`last_name`	String	The last name of the contact
`job_title`	String	The job title of the contact
`email`	String	The email of the contact
`phone`	String	The phone of the contact
`postal_address`	PostalAddress (see above)	The contact’s postal address

Field	Type	Description
`latitude`	Double	The latitude of the geo location
`longitude`	Double	The longitude of the geo location
`elevation`	Double	The elevation of the geo location

For listing Draft or Receiving Purchase Orders, the following query should be used:

{
  "filter": {
    "status": {
      "in": [<VALUES>]
    }
  }
}

Where should be replaced with a list of the desired Order Status

For:

Draft orders the only valid Value is NEW
Receiving Orders can be in the states: SUBMITTED, IN_PROCESS, PARTIALLY_RECEIVED.
Completed Orders can be in the states: RECEIVED, CLOSED, ARCHIVED, CANCELLED

Other status values are not used in MVP2.