List all unit-of-measure sets

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}}"). The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Query Parameters

ids

string[]

Filter for specific unit-of-measure sets by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error. Filter for specific unit-of-measure sets by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:

["80000001-1234567890"]

names

string[]

Filter for specific unit-of-measure sets by their name(s), case-insensitive. Like id, name is a unique identifier for an unit-of-measure set.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error. Filter for specific unit-of-measure sets by their name(s), case-insensitive. Like id, name is a unique identifier for an unit-of-measure set.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:

["Weight Units"]

limit

integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for unit-of-measure sets. This parameter will limit the response size, but you cannot fetch subsequent results using a cursor. For pagination, use the name-range parameters instead (e.g., nameFrom=A&nameTo=B).

When this parameter is omitted, the endpoint returns all unit-of-measure sets without limit, unlike paginated endpoints which default to 150 records. This is acceptable because unit-of-measure sets typically have low record counts. The maximum number of objects to return.

Required range: x >= 1

Example:

10

status

enum<string>

default:active

Filter for unit-of-measure sets that are active, inactive, or both. Filter for unit-of-measure sets that are active, inactive, or both.

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

Filter for unit-of-measure sets updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. Filter for unit-of-measure sets updated on or after this date/time. Accepts the following ISO 8601 formats:
date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:

"2025-01-01T12:34:56.000Z"

updatedBefore

string

Filter for unit-of-measure sets updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. Filter for unit-of-measure sets updated on or before this date/time. Accepts the following ISO 8601 formats:
date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:

"2025-02-01T12:34:56.000Z"

nameContains

string

Filter for unit-of-measure sets whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith. Filter for unit-of-measure sets whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:

"ABC"

nameStartsWith

string

Filter for unit-of-measure sets whose name starts with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith. Filter for unit-of-measure sets whose name starts with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:

"ABC"

nameEndsWith

string

Filter for unit-of-measure sets whose name ends with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith. Filter for unit-of-measure sets whose name ends with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:

"ABC"

nameFrom

string

Filter for unit-of-measure sets whose name is alphabetically greater than or equal to this value. Filter for unit-of-measure sets whose name is alphabetically greater than or equal to this value.

Example:

"A"

nameTo

string

Filter for unit-of-measure sets whose name is alphabetically less than or equal to this value. Filter for unit-of-measure sets whose name is alphabetically less than or equal to this value.

Example:

"Z"

Response

200 - application/json

Returns a list of unit-of-measure sets.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/unit-of-measure-sets"

data

The Unit-Of-Measure Set object · object[]

required

The array of unit-of-measure sets.

Show child attributes

data.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"

data.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"

data.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.000Z"

data.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.000Z"

data.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"

data.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"

data.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

data.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"

data.baseUnit

The Base Unit object · 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.

Show child attributes

data.baseUnit.name

string

required

The case-insensitive unique name of this base unit, unique across all base units.

NOTE: Base units 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:

"Each"

data.baseUnit.abbreviation

string

required

The base unit's short identifier shown in the QuickBooks U/M field on transaction line items.

Example:

"ea"

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

Show child attributes

The case-insensitive unique name of this related unit, unique across all related units.

NOTE: Related units 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:

"Case"

The related unit's short identifier shown in the QuickBooks U/M field on transaction line items.

Example:

"ea"

The number of base units in this related unit, represented as a decimal string. For example, if the base unit is "box" and this related unit is "case" with conversionRatio = "10", that means there are 10 boxes in one case.

Example:

"10"

data.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.

Show child attributes

data.defaultUnits.unitUsedFor

enum<string>

required

Where this default unit is used as the default: purchase line items, sales line items, or shipping lines.

Available options:

purchase,

sales,

shipping

Example:

"purchase"

data.defaultUnits.unit

string

required

The unit name for this default unit, as displayed in the U/M field. If the company file is enabled for multiple units per item, this appears as an available unit for the item. Must correspond to the base unit or a related unit defined in this set.

Example:

"Each"

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

List all unit-of-measure sets

Authorizations

Headers

Query Parameters

Response