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/inventory/units-of-measure/{id}

Prev Next
Get
/public/v1/inventory/units-of-measure/{id}

Retrieves a specified unit of measure

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Path parameters
id
string($uuid)Required

The identifier of the unit of measure

Responses
200

The unit of measure entity

Expand All
object

A unit of measure, which is a way to quantify the amount of an item.

id
string (uuid)

The id of the unit of measure.

name
string | null

The name of the unit of measure.

isBase
boolean

Indicates whether this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates whether this unit of measure is a primitive unit of measure, meaning it is defined by the system and cannot be modified or deleted.

isPurchase
boolean

Indicates whether this unit of measure can be used for purchase items.

isRecipe
boolean

Indicates whether this unit of measure can be used for recipe items.

isActive
boolean

Indicates whether this unit of measure is active.

baseQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the base unit of measure.

equivalentQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the equivalent unit of measure.

measureType
integer (int32)

The available basic measurement definitions

Valid values[ 1, 2, 3 ]
equivalentUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

baseUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

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.

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.

createdOn
string (date-time)

The date and time this unit of measure was created.

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.

modifiedOn
string (date-time)

The date and time this unit of measure was last modified.

Expand All
object

A unit of measure, which is a way to quantify the amount of an item.

id
string (uuid)

The id of the unit of measure.

name
string | null

The name of the unit of measure.

isBase
boolean

Indicates whether this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates whether this unit of measure is a primitive unit of measure, meaning it is defined by the system and cannot be modified or deleted.

isPurchase
boolean

Indicates whether this unit of measure can be used for purchase items.

isRecipe
boolean

Indicates whether this unit of measure can be used for recipe items.

isActive
boolean

Indicates whether this unit of measure is active.

baseQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the base unit of measure.

equivalentQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the equivalent unit of measure.

measureType
integer (int32)

The available basic measurement definitions

Valid values[ 1, 2, 3 ]
equivalentUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

baseUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

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.

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.

createdOn
string (date-time)

The date and time this unit of measure was created.

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.

modifiedOn
string (date-time)

The date and time this unit of measure was last modified.

Expand All
object

A unit of measure, which is a way to quantify the amount of an item.

id
string (uuid)

The id of the unit of measure.

name
string | null

The name of the unit of measure.

isBase
boolean

Indicates whether this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates whether this unit of measure is a primitive unit of measure, meaning it is defined by the system and cannot be modified or deleted.

isPurchase
boolean

Indicates whether this unit of measure can be used for purchase items.

isRecipe
boolean

Indicates whether this unit of measure can be used for recipe items.

isActive
boolean

Indicates whether this unit of measure is active.

baseQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the base unit of measure.

equivalentQuantity
number (double)

The quantity multiplier for this unit of measure in relation to the equivalent unit of measure.

measureType
integer (int32)

The available basic measurement definitions

Valid values[ 1, 2, 3 ]
equivalentUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

baseUnitOfMeasure
object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasureReference)

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.

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.

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.

createdOn
string (date-time)

The date and time this unit of measure was created.

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.

modifiedOn
string (date-time)

The date and time this unit of measure was last modified.