Item Categories

Prev Next
Get
/public/v1/inventory/item-categories

Retrieves a list of item catgories

Security

The requesting user must have the following permission to retrieve item categories:

  • Food → Item Categories → View Item Categories
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 item category entities

Expand All
object

A response containing item categories.

items
Array of object | null

Collection of public item categories records returned in this page.

object

An item category, indicating the type of item.

id
string (uuid)

Item category identifier.

name
string | null

Item category name.

itemPrefix
string | null

Item prefix.

costVarianceThreshold
number (double) | null

Item category acceptable variance.

counted
boolean | null

Indicates whether the include in inventory count flag is set.

actualAsTheoretical
boolean | null

Indicates whether the actual as Theoretical flag is set.

varianceCapType
integer (int32)

Variance cap type.

varianceCapPercent
number (double) | null

Variance cap percent.

inventoryVarianceThreshold
number (double) | null

Inventory Variance Threshold.

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.

createdOn
string (date-time)

The time at which the record was created.

modifiedOn
string (date-time)

The time at which the record was last modified.

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.

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.

type
integer (int32)

Item category type.

brand
object (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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 item categories.

items
Array of object | null

Collection of public item categories records returned in this page.

object

An item category, indicating the type of item.

id
string (uuid)

Item category identifier.

name
string | null

Item category name.

itemPrefix
string | null

Item prefix.

costVarianceThreshold
number (double) | null

Item category acceptable variance.

counted
boolean | null

Indicates whether the include in inventory count flag is set.

actualAsTheoretical
boolean | null

Indicates whether the actual as Theoretical flag is set.

varianceCapType
integer (int32)

Variance cap type.

varianceCapPercent
number (double) | null

Variance cap percent.

inventoryVarianceThreshold
number (double) | null

Inventory Variance Threshold.

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.

createdOn
string (date-time)

The time at which the record was created.

modifiedOn
string (date-time)

The time at which the record was last modified.

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.

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.

type
integer (int32)

Item category type.

brand
object (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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 item categories.

items
Array of object | null

Collection of public item categories records returned in this page.

object

An item category, indicating the type of item.

id
string (uuid)

Item category identifier.

name
string | null

Item category name.

itemPrefix
string | null

Item prefix.

costVarianceThreshold
number (double) | null

Item category acceptable variance.

counted
boolean | null

Indicates whether the include in inventory count flag is set.

actualAsTheoretical
boolean | null

Indicates whether the actual as Theoretical flag is set.

varianceCapType
integer (int32)

Variance cap type.

varianceCapPercent
number (double) | null

Variance cap percent.

inventoryVarianceThreshold
number (double) | null

Inventory Variance Threshold.

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.

createdOn
string (date-time)

The time at which the record was created.

modifiedOn
string (date-time)

The time at which the record was last modified.

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.

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.

type
integer (int32)

Item category type.

brand
object (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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.