Retrieves a list of purchase orders
Security
The requesting user must have the following permission to retrieve purchase orders:
- Food → Purchasing → View Purchase Orders
Identifies the R365 tenant the request applies to. Required on every request.
Starting datetime of 'modifiedOn' range. May be supplied alone as an open-ended range.
Ending datetime of 'modifiedOn' range. May be supplied alone as an open-ended range.
Starting date of 'orderDate' range. May be supplied alone as an open-ended range.
Ending date of 'orderDate' range. May be supplied alone as an open-ended range.
Filter for 'status' property. Allowed values: 'Open', 'Submitted', 'Invoiced'. Single-valued on this endpoint — a comma-separated list causes a server error. An unrecognised value returns 200 with an empty items array, not an error.
Filter for 'poNumber' property
Identifier of the location to filter by. At most ONE id is accepted despite the plural name; supplying more returns 422. Accepted delimiters: , ; |
Maximum number of top-level objects to return in one page.
list of purchase order entities
A response containing purchase orders.
Collection of public purchase orders records returned in this page.
A Purchase Order.
The unique identifier of the Purchase Order.
Purchase Order Number.
A reference to a purchase order template.
Unique identifier of the purchase order template.
Display name of the purchase order template.
Represents a reference to a location.
The id of the location.
The name of the location.
The location number.
A reference to a vendor.
Unique identifier of the vendor.
Display name of the vendor.
Number assigned to the vendor.
Order Date.
Delivery Date.
Purchase Order Status.
A street or shipping address.
Comment.
List of Purchase Order Details.
Purchase Order Detail
The unique identifier for the purchase order detail.
Storage Location Name.
A reference to a vendor item.
Unique identifier of the vendor item.
Display name of the vendor item.
Number assigned to the vendor item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to an item.
Unique identifier of the public item.
Display name of the public item.
Number assigned to the public item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
Quantity.
Total.
Unit Amount (Vendor Item Price)
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
Optional comment for the item, inherited from the template on order creation.
The total amount of the Purchase Order.
The total ordered item quantity of the Purchase Order.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was created.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was last modified.
URL to retrieve the next page of results, or null when this is the last page.
A response containing purchase orders.
Collection of public purchase orders records returned in this page.
A Purchase Order.
The unique identifier of the Purchase Order.
Purchase Order Number.
A reference to a purchase order template.
Unique identifier of the purchase order template.
Display name of the purchase order template.
Represents a reference to a location.
The id of the location.
The name of the location.
The location number.
A reference to a vendor.
Unique identifier of the vendor.
Display name of the vendor.
Number assigned to the vendor.
Order Date.
Delivery Date.
Purchase Order Status.
A street or shipping address.
Comment.
List of Purchase Order Details.
Purchase Order Detail
The unique identifier for the purchase order detail.
Storage Location Name.
A reference to a vendor item.
Unique identifier of the vendor item.
Display name of the vendor item.
Number assigned to the vendor item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to an item.
Unique identifier of the public item.
Display name of the public item.
Number assigned to the public item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
Quantity.
Total.
Unit Amount (Vendor Item Price)
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
Optional comment for the item, inherited from the template on order creation.
The total amount of the Purchase Order.
The total ordered item quantity of the Purchase Order.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was created.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was last modified.
URL to retrieve the next page of results, or null when this is the last page.
A response containing purchase orders.
Collection of public purchase orders records returned in this page.
A Purchase Order.
The unique identifier of the Purchase Order.
Purchase Order Number.
A reference to a purchase order template.
Unique identifier of the purchase order template.
Display name of the purchase order template.
Represents a reference to a location.
The id of the location.
The name of the location.
The location number.
A reference to a vendor.
Unique identifier of the vendor.
Display name of the vendor.
Number assigned to the vendor.
Order Date.
Delivery Date.
Purchase Order Status.
A street or shipping address.
Comment.
List of Purchase Order Details.
Purchase Order Detail
The unique identifier for the purchase order detail.
Storage Location Name.
A reference to a vendor item.
Unique identifier of the vendor item.
Display name of the vendor item.
Number assigned to the vendor item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
A reference to an item.
Unique identifier of the public item.
Display name of the public item.
Number assigned to the public item.
A reference to a unit of measure.
Unique identifier of the unit of measure.
Display name of the unit of measure.
Quantity.
Total.
Unit Amount (Vendor Item Price)
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
A reference to an item category.
Unique identifier of the item category.
Display name of the item category.
Optional comment for the item, inherited from the template on order creation.
The total amount of the Purchase Order.
The total ordered item quantity of the Purchase Order.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was created.
A reference to a user.
The unique identifier of the user.
The name of the user.
The date the purchase order was last modified.
URL to retrieve the next page of results, or null when this is the last page.
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.