v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Retrieve an unit-of-measure set

Retrieves an unit-of-measure set by ID.

IMPORTANT: If you need to fetch multiple specific unit-of-measure sets by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/unit-of-measure-sets/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the unit-of-measure set to retrieve.

Example:80000001-1234567890

The QuickBooks-assigned unique identifier of the unit-of-measure set to retrieve.

Headers

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.

Response

Returns the specified 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.

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.

isActiveboolean required

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

unitOfMeasureType'area' | 'count' | 'length' | 'other' | 'time' | 'volume' | 'weight' required

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

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_unit_of_measure_set",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Weight Units",
  "isActive": true,
  "unitOfMeasureType": "count",
  "baseUnit": {
    "name": "Each",
    "abbreviation": "ea"
  },
  "relatedUnits": [
    {
      "name": "Case",
      "abbreviation": "ea",
      "conversionRatio": "10"
    }
  ],
  "defaultUnits": [
    {
      "unitUsedFor": "purchase",
      "unit": "Each"
    }
  ]
}