Create an unit-of-measure set

Creates a new unit-of-measure set.

NOTE: The QuickBooks company file must have unit-of-measure enabled (either a single unit per item or multiple units per item). To support both configurations, prefix all UOM set names with "By the" (for example, "By the Barrel"); otherwise, the set may not appear in the QuickBooks UI when the company file is configured for a single unit per item.

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Request body

namestring required

The case-insensitive unique name of this unit-of-measure set, unique across all unit-of-measure sets. To ensure this set appears in the QuickBooks UI for companies configured with a single unit per item, prefix the name with "By the" (e.g., "By the Barrel").

NOTE: Unit-of-measure sets do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Maximum length: 31 characters.

isActiveboolean

Indicates whether this unit-of-measure set is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

The unit-of-measure set's type. Use "other" for a custom type defined in QuickBooks.

Example request

{
  "name": "Weight Units",
  "isActive": true,
  "unitOfMeasureType": "count",
  "baseUnit": {
    "name": "Each",
    "abbreviation": "ea"
  },
  "relatedUnits": [
    {
      "name": "Case",
      "abbreviation": "ea",
      "conversionRatio": "10"
    }
  ],
  "defaultUnits": [
    {
      "unitUsedFor": "purchase",
      "unit": "Each"
    }
  ]
}

Response

Returns the newly created unit-of-measure set.

idstring required

The unique identifier assigned by QuickBooks to this unit-of-measure set. This ID is unique across all unit-of-measure sets but not across different QuickBooks object types.

objectType'qbd_unit_of_measure_set' required

The type of object. This value is always "qbd_unit_of_measure_set".

createdAtstring required

The date and time when this unit-of-measure set was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this unit-of-measure set was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this unit-of-measure set object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.