List all inventory assembly items

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}}").

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.

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.

limit

integer

default:

150

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.

Required range: 1 < x < 150

cursor

string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

status

enum<string>

default:

active

Filter for inventory assembly items that are active, inactive, or both.

Available options:

active,

all,

inactive

updatedAfter

string

Filter for inventory assembly items updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

WARNING: Due to a known issue in QuickBooks Desktop, the updatedAfter parameter may not correctly filter inventory assembly items by their updated dates. To accurately retrieve the desired inventory assembly items, we recommend avoiding this parameter and instead fetching a broader dataset, then filtering the results locally using the updatedAt property.

updatedBefore

string

Filter for inventory assembly items updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

WARNING: Due to a known issue in QuickBooks Desktop, the updatedBefore parameter may not correctly filter inventory assembly items by their updated dates. To accurately retrieve the desired inventory assembly items, we recommend avoiding this parameter and instead fetching a broader dataset, then filtering the results locally using the updatedAt property.

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.

Response

200 - application/json

data

object[]

required

The array of inventory assembly items.

data.assetAccount

object

required

The asset account used to track the current value of this inventory assembly item in inventory.

data.averageCost

string | null

required

The average cost per unit of this inventory assembly item, represented as a decimal string.

data.barcode

string | null

required

The inventory assembly item's barcode.

data.buildNotificationThreshold

number | null

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.

data.class

object | null

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.

data.cogsAccount

object

required

The Cost of Goods Sold (COGS) account for this inventory assembly item, tracking the original direct costs of producing goods sold.

data.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). The time zone is the same as the user's time zone in QuickBooks.

data.customFields

object[]

required

The custom fields for the inventory assembly item object, added as user-defined data extensions, not included in the standard QuickBooks object.

data.externalId

string | null

required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.

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

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

data.incomeAccount

object

required

The income account used to track revenue from sales of this inventory assembly item.

data.isActive

boolean

required

Indicates whether this inventory assembly item is active. Inactive objects are typically hidden from views and reports in QuickBooks.

data.lines

object[]

required

The inventory assembly item's lines.

data.maximumQuantityOnHand

number | null

required

The maximum quantity of this inventory assembly item desired in inventory.

data.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". Maximum length: 31 characters.

data.objectType

string

required

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

Allowed value: "qbd_inventory_assembly_item"

data.parent

object | null

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.

data.preferredVendor

object | null

required

The preferred vendor from whom this inventory assembly item is typically purchased.

data.purchaseCost

string | null

required

The cost at which this inventory assembly item is purchased from vendors, represented as a decimal string.

data.purchaseDescription

string | null

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.

data.purchaseTaxCode

object | null

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.

data.quantityOnHand

number | null

required

The current quantity of this inventory assembly item available in inventory. To change the quantityOnHand for an inventory assembly item, you must create an inventory-adjustment instead of updating this inventory assembly item directly.

data.quantityOnOrder

number | null

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.

data.quantityOnSalesOrder

number | null

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.

data.revisionNumber

string

required

The current 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.

data.salesDescription

string | null

required

The description of this inventory assembly item that appears on sales forms (e.g., invoices, sales receipts) when sold to customers.

data.salesPrice

string | null

required

The price at which this inventory assembly item is sold to customers, represented as a decimal string.

data.salesTaxCode

object | null

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. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

data.sku

string | null

required

The inventory assembly item's stock keeping unit (SKU), which is sometimes the manufacturer's part number.

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

data.unitOfMeasureSet

object | null

required

The unit-of-measure set associated with this inventory assembly item, which consists of a base unit and related units.

data.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). The time zone is the same as the user's time zone in QuickBooks.

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

nextCursor

string | null

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.

objectType

string

required

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

Allowed value: "list"

remainingCount

number | null

required

The number of objects remaining to be fetched.

url

string

required

The endpoint URL where this list can be accessed.

QuickBooks Desktop API

Core Resources

Transactions

Items

List all inventory assembly items

Authorizations

Headers

Query Parameters

Response