Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/item-categories/{id}

Prev Next
Get
/public/v1/item-categories/{id}

Retrieves the item category specified by the id

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Path parameters
id
string($uuid)Required

The identifier of the item category

Responses
200

The item category entity

Expand All
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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

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 (R365.Inventory.Shared.Contracts.Brands.BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

Expand All
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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

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 (R365.Inventory.Shared.Contracts.Brands.BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

Expand All
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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Accounting.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 (R365.Inventory.Shared.Contracts.Users.UserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedBy
object (R365.Inventory.Shared.Contracts.Users.UserReference)

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 (R365.Inventory.Shared.Contracts.Brands.BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null

Current status of the problem details.

detail
string | null
instance
string | null
422

Unprocessable Content

Expand All
object
errorCode
string | null
innerError
object (R365.Inventory.Public.Models.R365Error)
errorCode
string | null
innerError
object (R365.Inventory.Public.Models.R365Error) Recursive