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/units-of-measure

Prev Next
Get
/public/v1/units-of-measure

Retrieves all units of measure

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Query parameters
modifiedOnStart
string (date-time)

Starting datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnEnd'

modifiedOnEnd
string (date-time)

Ending datetime of 'modifiedOn' range; must be accompanied by 'modifiedOnStart'

pageSize
integer (int32)

Maximum number of top level objects in the response, max value 250; if there are more objects matching the criteria, a link with a continuation token will be included in the response

continuationToken
string
Responses
200

The list of unit of measure entities

Expand All
object

A response containing units of measure.

items
Array of object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasurePublicDto) | null

Collection of public units of measure records returned in this page.

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 if this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates if 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 if this unit of measure can be used for purchase items.

isRecipe
boolean

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

isActive
boolean

Indicates if 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.

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 units of measure.

items
Array of object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasurePublicDto) | null

Collection of public units of measure records returned in this page.

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 if this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates if 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 if this unit of measure can be used for purchase items.

isRecipe
boolean

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

isActive
boolean

Indicates if 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.

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 units of measure.

items
Array of object (R365.Inventory.Public.Contracts.UnitsOfMeasure.Models.UnitOfMeasurePublicDto) | null

Collection of public units of measure records returned in this page.

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 if this unit of measure is a base unit of measure.

isPrimitive
boolean

Indicates if 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 if this unit of measure can be used for purchase items.

isRecipe
boolean

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

isActive
boolean

Indicates if 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.

nextLink
string | null

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

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