ServiceUomListResponse

successbooleanrequired

Always true on a 2xx response.

Example: true

data object[]required

Every active unit of measure.

Array [

idstring<uuid>required

Unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringrequired

Unit code, unique within the workspace.

Example: EA

namestringrequired

Unit name.

Example: Each

symbolstringnullablerequired

Display symbol.

Example: ea

categorystringnullablerequired

What the unit measures.

Possible values: [COUNT, WEIGHT, LENGTH, VOLUME, AREA, TIME, TEMPERATURE, CUSTOM, null]

isBasebooleanrequired

True for the base unit of its category.

Example: false

isActivebooleanrequired

False once the unit is retired.

Example: true

decimalPlacesnumbernullablerequired

Decimal places quantities in this unit are kept to.

Example: 0

allowFractionalbooleanrequired

True when quantities in this unit may be fractional.

Example: false

]

ServiceUomListResponse

{
  "success": true,
  "data": [
    {
      "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
      "code": "EA",
      "name": "Each",
      "symbol": "ea",
      "category": "COUNT",
      "isBase": false,
      "isActive": true,
      "decimalPlaces": 0,
      "allowFractional": false
    }
  ]
}