Items

Prev Next
Get
/public/v1/inventory/items

Retrieves a list of purchase items

Security

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

  • Food → Purchased Items → View Purchased Items
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

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

Query parameters
modifiedOnStart
string (date-time)

Starting datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the upper bound.

modifiedOnEnd
string (date-time)

Ending datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the lower bound.

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string
Responses
200

The list of purchase items

Expand All
object

A response containing purchase items.

items
Array of object | null

Collection of public purchase items records returned in this page.

object

A purchase item.

id
string (uuid)

The unique identifier of the purchase item.

name
string | null

The name of the purchase item.

number
string | null

The number of the purchase item.

isActive
boolean

Indicates whether the purchase item is active.

costAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

wasteAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

donationAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

costUpdateMethod
string | null

The cost update method of the purchase item.

description
string | null

The description of the purchase item.

reportingUnitOfMeasure
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.

inventoryUnitOfMeasure
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.

inventoryUnitOfMeasure2
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.

inventoryUnitOfMeasure3
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.

equivalenceEachUnitOfMeasure
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.

equivalenceEachQuantity
number (double) | null

The equivalence quantity for the Each measure type.

equivalenceWeightUnitOfMeasure
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.

equivalenceWeightQuantity
number (double) | null

The equivalence quantity for the Weight measure type.

equivalenceVolumeUnitOfMeasure
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.

equivalenceVolumeQuantity
number (double) | null

The equivalence quantity for the Volume measure type.

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.

isKeyItem
boolean

Indicates whether the purchase item is a key item.

type
string | null

The type of the purchase item.

measureType
string | null

The measure type of the purchase item.

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 time at which the record 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)

The time at which the record was last modified.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object

A response containing purchase items.

items
Array of object | null

Collection of public purchase items records returned in this page.

object

A purchase item.

id
string (uuid)

The unique identifier of the purchase item.

name
string | null

The name of the purchase item.

number
string | null

The number of the purchase item.

isActive
boolean

Indicates whether the purchase item is active.

costAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

wasteAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

donationAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

costUpdateMethod
string | null

The cost update method of the purchase item.

description
string | null

The description of the purchase item.

reportingUnitOfMeasure
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.

inventoryUnitOfMeasure
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.

inventoryUnitOfMeasure2
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.

inventoryUnitOfMeasure3
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.

equivalenceEachUnitOfMeasure
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.

equivalenceEachQuantity
number (double) | null

The equivalence quantity for the Each measure type.

equivalenceWeightUnitOfMeasure
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.

equivalenceWeightQuantity
number (double) | null

The equivalence quantity for the Weight measure type.

equivalenceVolumeUnitOfMeasure
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.

equivalenceVolumeQuantity
number (double) | null

The equivalence quantity for the Volume measure type.

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.

isKeyItem
boolean

Indicates whether the purchase item is a key item.

type
string | null

The type of the purchase item.

measureType
string | null

The measure type of the purchase item.

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 time at which the record 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)

The time at which the record was last modified.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object

A response containing purchase items.

items
Array of object | null

Collection of public purchase items records returned in this page.

object

A purchase item.

id
string (uuid)

The unique identifier of the purchase item.

name
string | null

The name of the purchase item.

number
string | null

The number of the purchase item.

isActive
boolean

Indicates whether the purchase item is active.

costAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

inventoryAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

wasteAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

donationAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

costUpdateMethod
string | null

The cost update method of the purchase item.

description
string | null

The description of the purchase item.

reportingUnitOfMeasure
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.

inventoryUnitOfMeasure
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.

inventoryUnitOfMeasure2
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.

inventoryUnitOfMeasure3
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.

equivalenceEachUnitOfMeasure
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.

equivalenceEachQuantity
number (double) | null

The equivalence quantity for the Each measure type.

equivalenceWeightUnitOfMeasure
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.

equivalenceWeightQuantity
number (double) | null

The equivalence quantity for the Weight measure type.

equivalenceVolumeUnitOfMeasure
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.

equivalenceVolumeQuantity
number (double) | null

The equivalence quantity for the Volume measure type.

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.

isKeyItem
boolean

Indicates whether the purchase item is a key item.

type
string | null

The type of the purchase item.

measureType
string | null

The measure type of the purchase item.

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 time at which the record 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)

The time at which the record was last modified.

nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

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.