---
title: "List all build assemblies"
method: GET
path: "/quickbooks-desktop/build-assemblies"
---

# List all build assemblies

`GET /quickbooks-desktop/build-assemblies`

Returns a list of build assemblies. Use the `cursor` parameter to paginate through the results.

## Query parameters

- `ids` string[] — Filter for specific build assemblies 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.
- `refNumbers` string[] — Filter for specific build assemblies by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user. **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.
- `limit` integer — The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.
- `cursor` string — The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.
- `updatedAfter` string — Filter for build assemblies 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.
- `updatedBefore` string — Filter for build assemblies 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.
- `transactionDateFrom` string, date — Filter for build assemblies whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this 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`).
- `transactionDateTo` string, date — Filter for build assemblies whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this 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`).
- `itemIds` string[] — Filter for build assemblies containing these items.
- `refNumberContains` string — Filter for build assemblies whose `refNumber` contains this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.
- `refNumberStartsWith` string — Filter for build assemblies whose `refNumber` starts with this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.
- `refNumberEndsWith` string — Filter for build assemblies whose `refNumber` ends with this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.
- `refNumberFrom` string — Filter for build assemblies whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.
- `refNumberTo` string — Filter for build assemblies whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.
- `pendingStatus` 'all' | 'not_pending' | 'pending' — Filter for build assemblies that are pending, not pending, or both.
- `includeComponentLineItems` boolean — Whether to include component line items in the response. Defaults to `true`.

## Headers

- `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request.

## Response `200`

Returns a list of build assemblies.

- object
  - `objectType` 'list', required — The type of object. This value is always `"list"`.
  - `url` string, required — The endpoint URL where this list can be accessed.
  - `data` QbdBuildAssembly[], required — The array of build assemblies.
    - `id` string, required — The unique identifier assigned by QuickBooks to this build assembly. This ID is unique across all transaction types.
    - `objectType` 'qbd_build_assembly', required — The type of object. This value is always `"qbd_build_assembly"`.
    - `createdAt` string, required — The date and time when this build assembly 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.
    - `updatedAt` string, required — The date and time when this build assembly 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.
    - `revisionNumber` string, required — The current QuickBooks-assigned revision number of this build assembly 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.
    - `inventoryAssemblyItem` object, required — The inventory assembly item associated with this build assembly. An inventory assembly item is assembled or manufactured from other inventory items, and the items and/or assemblies that make up the assembly are called components.
      - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
      - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
    - `inventorySite` object, nullable, required — The site location where inventory for the item associated with this build assembly is stored.
      - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
      - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
    - `inventorySiteLocation` object, nullable, required — The specific location (e.g., bin or shelf) within the inventory site where the item associated with this build assembly is stored.
      - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
      - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
    - `serialNumber` string, nullable, required — The serial number of the item associated with this build assembly. This is used for tracking individual units of serialized inventory items.
    - `lotNumber` string, nullable, required — The lot number of the item associated with this build assembly. Used for tracking groups of inventory items that are purchased or manufactured together.
    - `expirationDate` string, date, nullable, required — The expiration date for the serial number or lot number of the item associated with this build assembly, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.
    - `transactionDate` string, date, required — The date of this build assembly, in ISO 8601 format (YYYY-MM-DD).
    - `refNumber` string, nullable, required — The case-sensitive user-defined reference number for this build assembly, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.
    - `memo` string, nullable, required — A memo or note for this build assembly.
    - `isPending` boolean, nullable, required — Indicates whether this build assembly has not been completed.
    - `quantityToBuild` number, required — The number of build assembly to be built. The transaction will fail if the number specified here exceeds the number of on-hand components.
    - `quantityCanBuild` number, required — The number of this build assembly that can be built from the parts on hand.
    - `quantityOnHand` number, required — The number of units of this build assembly currently in inventory.
    - `quantityOnSalesOrder` number, required — The number of units of this build assembly that have been sold (as recorded in sales orders) but not yet fulfilled or delivered to customers.
    - `externalId` string, nullable, required — A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.
    - `lines` QbdComponentItemLine[], required — The component item lines in this build assembly.
      - `item` object, nullable, required — The item associated with this component item line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.
        - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
        - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
      - `inventorySite` object, nullable, required — The site location where inventory for the item associated with this component item line is stored.
        - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
        - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
      - `inventorySiteLocation` object, nullable, required — The specific location (e.g., bin or shelf) within the inventory site where the item associated with this component item line is stored.
        - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.
        - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive.
      - `serialNumber` string, nullable, required — The serial number of the item associated with this component item line. This is used for tracking individual units of serialized inventory items.
      - `lotNumber` string, nullable, required — The lot number of the item associated with this component item line. Used for tracking groups of inventory items that are purchased or manufactured together.
      - `expirationDate` string, date, nullable, required — The expiration date for the serial number or lot number of the item associated with this component item line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.
      - `description` string, nullable, required — A description of this component item line.
      - `quantityOnHand` number, nullable, required — The number of units of this component item line currently in inventory.
      - `quantityNeeded` number, nullable, required — The quantity of this component item line that is needed to build the assembly. For example, if the `itemId` references a bolt, the `quantityNeeded` field indicates how many of these bolts are used in the assembly.
    - `customFields` QbdCustomField[], required — The custom fields for the build assembly object, added as user-defined data extensions, not included in the standard QuickBooks object.
      - `ownerId` string, required — The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.
      - `name` string, required — The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.
      - `type` 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type', required — The data type of this custom field.
      - `value` string, required — The value of this custom field. The maximum length depends on the field's data type.
  - `nextCursor` string, nullable, required — The `nextCursor` is a pagination token returned in the response when you use the `limit` parameter in your request. To retrieve subsequent pages of results, include this token as the value of the `cursor` request parameter in your following API calls. **NOTE**: The `nextCursor` value remains constant throughout the pagination process for a specific list instance; continue to use the same `nextCursor` token in each request to fetch additional pages.
  - `remainingCount` number, nullable, required — The number of objects remaining to be fetched.
  - `hasMore` boolean, required — Indicates whether there are more objects to be fetched.

---

[API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/versions/0b07b3ebe160/schema)