Units of Measure

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

Retrieves a list of units of measure

Security

The requesting user must have the following permission to retrieve units of measure:

  • Food → Units of Measure → View Units of Measure
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 unit of measure entities

Expand All
object

A response containing units of measure.

items
Array of object | 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 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 (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 (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 (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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 date and time this unit of measure 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 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 | 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 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 (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 (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 (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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 date and time this unit of measure 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 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 | 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 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 (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 (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 (BrandReference)

A reference to a Brand.

id
integer (int64)

Unique identifier of the brand.

name
string | null

Display name of the brand.

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 date and time this unit of measure 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 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.

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.