Purchase Order by ID

Prev Next
Get
/public/v1/inventory/purchase-orders/{id}

Retrieves a specified purchase order

Security

The requesting user must have the following permission to retrieve a purchase order:

  • Food → Purchasing → View Purchase Orders
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Path parameters
id
string (uuid) Required

Identifier of the purchase order

Responses
200

purchase order entity

Expand All
object

A Purchase Order.

id
string (uuid)

The unique identifier of the Purchase Order.

number
string | null

Purchase Order Number.

template
object (PurchaseOrderTemplateReference)

A reference to a purchase order template.

id
string (uuid)

Unique identifier of the purchase order template.

name
string | null

Display name of the purchase order template.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

orderDate
string (date)

Order Date.

deliveryDate
string (date)

Delivery Date.

status
string | null

Purchase Order Status.

shipToAddress
object (Address)

A street or shipping address.

addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
state
string | null
country
string | null
postalCode
string | null
comment
string | null

Comment.

details
Array of object | null

List of Purchase Order Details.

object

Purchase Order Detail

id
string (uuid)

The unique identifier for the purchase order detail.

storageLocationName
string | null

Storage Location Name.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

total
number (double)

Total.

unitAmount
number (double)

Unit Amount (Vendor Item Price)

itemCategory1
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

comment
string | null

Optional comment for the item, inherited from the template on order creation.

totalAmount
number (double)

The total amount of the Purchase Order.

totalQuantity
number (double)

The total ordered item quantity of the Purchase Order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date the purchase order was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the purchase order was last modified.

Expand All
object

A Purchase Order.

id
string (uuid)

The unique identifier of the Purchase Order.

number
string | null

Purchase Order Number.

template
object (PurchaseOrderTemplateReference)

A reference to a purchase order template.

id
string (uuid)

Unique identifier of the purchase order template.

name
string | null

Display name of the purchase order template.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

orderDate
string (date)

Order Date.

deliveryDate
string (date)

Delivery Date.

status
string | null

Purchase Order Status.

shipToAddress
object (Address)

A street or shipping address.

addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
state
string | null
country
string | null
postalCode
string | null
comment
string | null

Comment.

details
Array of object | null

List of Purchase Order Details.

object

Purchase Order Detail

id
string (uuid)

The unique identifier for the purchase order detail.

storageLocationName
string | null

Storage Location Name.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

total
number (double)

Total.

unitAmount
number (double)

Unit Amount (Vendor Item Price)

itemCategory1
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

comment
string | null

Optional comment for the item, inherited from the template on order creation.

totalAmount
number (double)

The total amount of the Purchase Order.

totalQuantity
number (double)

The total ordered item quantity of the Purchase Order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date the purchase order was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the purchase order was last modified.

Expand All
object

A Purchase Order.

id
string (uuid)

The unique identifier of the Purchase Order.

number
string | null

Purchase Order Number.

template
object (PurchaseOrderTemplateReference)

A reference to a purchase order template.

id
string (uuid)

Unique identifier of the purchase order template.

name
string | null

Display name of the purchase order template.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

orderDate
string (date)

Order Date.

deliveryDate
string (date)

Delivery Date.

status
string | null

Purchase Order Status.

shipToAddress
object (Address)

A street or shipping address.

addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
state
string | null
country
string | null
postalCode
string | null
comment
string | null

Comment.

details
Array of object | null

List of Purchase Order Details.

object

Purchase Order Detail

id
string (uuid)

The unique identifier for the purchase order detail.

storageLocationName
string | null

Storage Location Name.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

total
number (double)

Total.

unitAmount
number (double)

Unit Amount (Vendor Item Price)

itemCategory1
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory2
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

itemCategory3
object (ItemCategoryReference)

A reference to an item category.

id
string (uuid)

Unique identifier of the item category.

name
string | null

Display name of the item category.

comment
string | null

Optional comment for the item, inherited from the template on order creation.

totalAmount
number (double)

The total amount of the Purchase Order.

totalQuantity
number (double)

The total ordered item quantity of the Purchase Order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date the purchase order was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the purchase order was last modified.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.