CreateUOMInput

A new unit of measure.

input CreateUOMInput {
  allowFractional: Boolean!
  category: UOMCategory!
  code: String!
  colorCode: String
  compoundWithUOMId: String
  decimalPlaces: Int!
  description: String
  displayOrder: Int!
  iconUrl: String
  isBase: Boolean!
  name: String!
  pluralName: String
  symbol: String!
}

Fields

CreateUOMInput.allowFractional ● Boolean! non-null scalar

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

CreateUOMInput.category ● UOMCategory! non-null enum

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

CreateUOMInput.code ● String! non-null scalar

Short code that identifies the unit. It must be unique in the organization, ignoring case. At most 20 characters.

CreateUOMInput.colorCode ● String scalar

Colour code used to show the unit.

CreateUOMInput.compoundWithUOMId ● String scalar

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

CreateUOMInput.decimalPlaces ● Int! non-null scalar

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

CreateUOMInput.description ● String scalar

Free-text description of the unit.

CreateUOMInput.displayOrder ● Int! non-null scalar

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

CreateUOMInput.iconUrl ● String scalar

URL of the unit's icon image.

CreateUOMInput.isBase ● Boolean! non-null scalar

Make this the base unit of its category. It clears the flag from the category's current base unit.

CreateUOMInput.name ● String! non-null scalar

The unit's name. At most 100 characters.

CreateUOMInput.pluralName ● String scalar

Plural form of the name, when it needs one.

CreateUOMInput.symbol ● String! non-null scalar

Symbol shown next to quantities in this unit. At most 20 characters.

Member Of

createUOM mutation