Skip to main content

UnitOfMeasure

A unit of measure in the organization's catalog, with its category, decimal rules and display settings.

type UnitOfMeasure {
  allowFractional: Boolean!
  category: UOMCategory!
  code: String!
  colorCode: String
  compoundWithUOMId: String
  conversionFrom: [UOMConversion!]
  conversionTo: [UOMConversion!]
  createdAt: DateTime!
  decimalPlaces: Int!
  deletedAt: DateTime
  deletedBy: String
  description: String
  displayOrder: Int!
  enteredBy: String!
  iconUrl: String
  id: ID!
  isActive: Boolean!
  isBase: Boolean!
  name: String!
  organizationId: String!
  pluralName: String
  showInCompound: Boolean!
  symbol: String!
  updatedAt: DateTime!
  updatedBy: String!
}

Fields

`UnitOfMeasure.allowFractional` ● `Boolean!` non-null scalar

Whether quantities in this unit may be fractional. Always false for a COUNT unit.

`UnitOfMeasure.category` ● `UOMCategory!` non-null enum

The kind of quantity the unit measures. Units convert only within a category.

`UnitOfMeasure.code` ● `String!` non-null scalar

Short code that identifies the unit. It is unique in the organization, ignoring case.

`UnitOfMeasure.colorCode` ● `String` scalar

Colour code used to show the unit.

`UnitOfMeasure.compoundWithUOMId` ● `String` scalar

The ID of the unit this unit combines with in compound quantities.

`UnitOfMeasure.conversionFrom` ● `[UOMConversion!]` list object

Conversions that start at this unit.

`UnitOfMeasure.conversionTo` ● `[UOMConversion!]` list object

Conversions that end at this unit.

`UnitOfMeasure.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`UnitOfMeasure.decimalPlaces` ● `Int!` non-null scalar

How many decimal places quantities in this unit show, from 0 to 6. Always 0 for a COUNT unit.

`UnitOfMeasure.deletedAt` ● `DateTime` scalar

When the record was deleted. Empty while the record is live.

`UnitOfMeasure.deletedBy` ● `String` scalar

The ID of the user who deleted the record.

`UnitOfMeasure.description` ● `String` scalar

Free-text description of the unit.

`UnitOfMeasure.displayOrder` ● `Int!` non-null scalar

Position of the unit in lists. Lower numbers come first.

`UnitOfMeasure.enteredBy` ● `String!` non-null scalar

The ID of the user who created the record.

`UnitOfMeasure.iconUrl` ● `String` scalar

URL of the unit's icon image.

`UnitOfMeasure.id` ● `ID!` non-null scalar

The unique ID of this record.

`UnitOfMeasure.isActive` ● `Boolean!` non-null scalar

Whether the record is active.

`UnitOfMeasure.isBase` ● `Boolean!` non-null scalar

Whether this is the base unit of its category. A category has one base unit.

`UnitOfMeasure.name` ● `String!` non-null scalar

The unit's name.

`UnitOfMeasure.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`UnitOfMeasure.pluralName` ● `String` scalar

Plural form of the name, when it needs one.

`UnitOfMeasure.showInCompound` ● `Boolean!` non-null scalar

Whether the unit is shown in compound quantities.

`UnitOfMeasure.symbol` ● `String!` non-null scalar

Symbol shown next to quantities in this unit.

`UnitOfMeasure.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`UnitOfMeasure.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

Returned By

createUOM mutation ● findOrCreateUOM mutation ● getBaseUOM query ● getUOM query ● getUOMs query ● getUOMsByCategory query ● organizationDefaultUOM query ● updateUOM mutation

Member Of

ConvertQuantityResult object ● Inventory object ● Product object ● ProductUOM object ● ProductUOMEntry object ● ProductVariant object ● QuoteItem object ● StockMovement object ● UOMConversion object ● UOMSummary object

Fields
Returned By
Member Of