--- title: "List all inventory assembly items" method: GET path: "/quickbooks-desktop/inventory-assembly-items" --- # List all inventory assembly items `GET /quickbooks-desktop/inventory-assembly-items` Returns a list of inventory assembly items. Use the `cursor` parameter to paginate through the results. ## Query parameters - `ids` string[] — Filter for specific inventory assembly items 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. - `fullNames` string[] — Filter for specific inventory assembly items by their full-name(s), case-insensitive. Like `id`, `fullName` is a unique identifier for an inventory assembly item, formed by by combining the names of its parent objects with its own `name`, separated by colons. For example, if an inventory assembly item is under "Assemblies" and has the `name` "Deluxe Kit", its `fullName` would be "Assemblies:Deluxe Kit". **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. - `status` 'active' | 'all' | 'inactive' — Filter for inventory assembly items that are active, inactive, or both. - `updatedAfter` string — Filter for inventory assembly items 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 inventory assembly items 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. - `nameContains` string — Filter for inventory assembly items whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`. - `nameStartsWith` string — Filter for inventory assembly items whose `name` starts with this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`. - `nameEndsWith` string — Filter for inventory assembly items whose `name` ends with this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`. - `nameFrom` string — Filter for inventory assembly items whose `name` is alphabetically greater than or equal to this value. - `nameTo` string — Filter for inventory assembly items whose `name` is alphabetically less than or equal to this value. - `classIds` string[] — Filter for inventory assembly items of these classes. A class is a way end-users can categorize inventory assembly items in QuickBooks. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns a list of inventory assembly items. - 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` QbdInventoryAssemblyItem[], required — The array of inventory assembly items. - `id` string, required — The unique identifier assigned by QuickBooks to this inventory assembly item. This ID is unique across all inventory assembly items but not across different QuickBooks object types. - `objectType` 'qbd_inventory_assembly_item', required — The type of object. This value is always `"qbd_inventory_assembly_item"`. - `createdAt` string, required — The date and time when this inventory assembly item 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 inventory assembly item 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 inventory assembly item 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. - `name` string, required — The case-insensitive name of this inventory assembly item. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like `fullName` does. For example, two inventory assembly items could both have the `name` "Deluxe Kit", but they could have unique `fullName` values, such as "Assemblies:Deluxe Kit" and "Inventory:Deluxe Kit". - `fullName` string, required — The case-insensitive fully-qualified unique name of this inventory assembly item, formed by combining the names of its hierarchical parent objects with its own `name`, separated by colons. For example, if an inventory assembly item is under "Assemblies" and has the `name` "Deluxe Kit", its `fullName` would be "Assemblies:Deluxe Kit". **NOTE**: Unlike `name`, `fullName` is guaranteed to be unique across all inventory assembly item objects. However, `fullName` can still be arbitrarily changed by the QuickBooks user when they modify the underlying `name` field. - `barcode` string, nullable, required — The inventory assembly item's barcode. - `isActive` boolean, required — Indicates whether this inventory assembly item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`. - `class` object, nullable, required — The inventory assembly item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. - `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. - `parent` object, nullable, required — The parent inventory assembly item one level above this one in the hierarchy. For example, if this inventory assembly item has a `fullName` of "Assemblies:Deluxe Kit", its parent has a `fullName` of "Assemblies". If this inventory assembly item is at the top level, this field will be `null`. - `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. - `sublevel` number, required — The depth level of this inventory assembly item in the hierarchy. A top-level inventory assembly item has a `sublevel` of 0; each subsequent sublevel increases this number by 1. For example, an inventory assembly item with a `fullName` of "Assemblies:Deluxe Kit" would have a `sublevel` of 1. - `sku` string, nullable, required — The inventory assembly item's stock keeping unit (SKU), which is sometimes the manufacturer's part number. - `unitOfMeasureSet` object, nullable, required — The unit-of-measure set associated with this inventory assembly item, which consists of a base unit and related units. - `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. - `salesTaxCode` object, nullable, required — The default sales-tax code for this inventory assembly item, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales. - `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. - `salesDescription` string, nullable, required — The description of this inventory assembly item that appears on sales forms (e.g., invoices, sales receipts) when sold to customers. - `salesPrice` string, nullable, required — The price at which this inventory assembly item is sold to customers, represented as a decimal string. - `incomeAccount` object, nullable, required — The income account used to track revenue from sales of this inventory assembly 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. - `purchaseDescription` string, nullable, required — The description of this inventory assembly item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors. - `purchaseCost` string, nullable, required — The cost at which this inventory assembly item is purchased from vendors, represented as a decimal string. - `purchaseTaxCode` object, nullable, required — The tax code applied to purchases of this inventory assembly item. Applicable in regions where purchase taxes are used, such as Canada or the UK. - `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. - `cogsAccount` object, required — The Cost of Goods Sold (COGS) account for this inventory assembly item, tracking the original direct costs of producing goods sold. - `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. - `preferredVendor` object, nullable, required — The preferred vendor from whom this inventory assembly item is typically purchased. - `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. - `assetAccount` object, required — The asset account used to track the current value of this inventory assembly item in inventory. - `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. - `buildNotificationThreshold` number, nullable, required — The inventory assembly item's minimum quantity threshold that triggers a build notification in QuickBooks. When the sum of `quantityOnHand` (current inventory) and `quantityOnOrder` (pending purchase orders) drops below this threshold, QuickBooks will notify users that more units need to be built or assembled. This helps ensure adequate inventory levels for inventory assembly items. - `maximumQuantityOnHand` number, nullable, required — The maximum quantity of this inventory assembly item desired in inventory. - `quantityOnHand` number, nullable, required — The number of units of this inventory assembly item currently in inventory. `quantityOnHand` multiplied by `averageCost` equals `totalValue` for inventory item lists. To change the `quantityOnHand` for an inventory assembly item, you must use an inventory-adjustment instead of updating the inventory assembly item directly. - `averageCost` string, nullable, required — The average cost per unit of this inventory assembly item, represented as a decimal string. - `quantityOnPurchaseOrder` number, nullable, required — The number of units of this inventory assembly item that have been ordered from vendors (as recorded in purchase orders) but not yet received. - `quantityOnSalesOrder` number, nullable, required — The number of units of this inventory assembly item 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` QbdInventoryAssemblyItemLine[], required — The inventory assembly item's lines. - `inventoryItem` object, nullable, required — The inventory item associated with this inventory assembly item line. - `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. - `quantity` number, nullable, required — The quantity of the item associated with this inventory assembly item line. This field cannot be cleared. **NOTE**: Do not use this field if the associated item is a discount item. - `customFields` QbdCustomField[], required — The custom fields for the inventory assembly item 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/revisions/0b07b3ebe160/schema)