GET
/
quickbooks-desktop
/
unit-of-measure-sets
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const unitOfMeasureSet = await conductor.qbd.unitOfMeasureSets.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(unitOfMeasureSet.id);
{
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

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

Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified unit-of-measure set.

​
id
string
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.

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_unit_of_measure_set"
Example:

"qbd_unit_of_measure_set"

​
createdAt
string
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.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
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.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
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.

Example:

"1721172183"

​
name
string
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.

Example:

"Weight Units"

​
isActive
boolean
required

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

Example:

true

​
unitOfMeasureType
enum<string>
required

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

Available options:
area,
count,
length,
other,
time,
volume,
weight
Example:

"count"

​
baseUnit
object
required

The unit-of-measure set's base unit used to track and price item quantities. If the company file is enabled for a single unit of measure per item, the base unit is the only unit available on transaction line items. If enabled for multiple units per item, the base unit is the default unless overridden by the set's default units.

​
relatedUnits
The Related Unit object · object[]
required

The unit-of-measure set's related units, each specifying how many base units they represent (conversion ratio).

​
defaultUnits
The Default Unit object · object[]
required

The unit-of-measure set's default units to appear in the U/M field on transaction line items. You can specify separate defaults for purchases, sales, and shipping.