POST
/
quickbooks-desktop
/
inventory-items

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

The case-insensitive name of this inventory item. Not guaranteed to be unique because it does not include the names of its parent objects like fullName does. For example, two inventory items could both have the name "Widget", but they could have unique fullName values, such as "Products:Widget" and "Inventory:Widget". Maximum length: 31 characters.

barcode
object

The inventory item's barcode.

isActive
boolean
default: true

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

classId
string

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

parentId
string

The parent inventory item one level above this one in the hierarchy. For example, if this inventory item has a fullName of "Products:Electronics:Widgets", its parent has a fullName of "Products:Electronics". If this inventory item is at the top level, this field will be null.

sku
string

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

unitOfMeasureSetId
string

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

salesTaxCodeId
string

The sales-tax code associated with this inventory item, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this inventory item. 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.

salesDescription
string

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

salesPrice
string

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

incomeAccountId
string
required

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

purchaseDescription
string

The description of this inventory item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors.

purchaseCost
string

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

purchaseTaxCodeId
string

The tax code applied to purchases of this inventory item. Applicable in regions where purchase taxes are used, such as Canada or the UK.

cogsAccountId
string
required

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

preferredVendorId
string

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

assetAccountId
string
required

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

reorderPoint
number

The minimum quantity of this inventory item at which QuickBooks prompts for reordering.

maximumQuantityOnHand
number

The maximum quantity of this inventory item desired in inventory.

quantityOnHand
number

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

totalValue
string

The total value of this inventory item. If totalValue is provided, quantityOnHand must also be provided and must be greater than zero. If both quantityOnHand and purchaseCost are provided, then totalValue will be set to quantityOnHand times purchaseCost, regardless of what totalValue is explicitly set to.

inventoryDate
string

The date when this inventory item was converted into an inventory item from some other type of item, in ISO 8601 format (YYYY-MM-DD).

externalId
string

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

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

Response

200 - application/json
id
string
required

The unique identifier assigned by QuickBooks to this inventory item. This ID is unique across all inventory items but not across different QuickBooks object types.

objectType
string
required

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

Allowed value: "qbd_inventory_item"
createdAt
string
required

The date and time when this inventory 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.

updatedAt
string
required

The date and time when this inventory 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.

revisionNumber
string
required

The current revision number of this inventory item, 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 item. Not guaranteed to be unique because it does not include the names of its parent objects like fullName does. For example, two inventory items could both have the name "Widget", but they could have unique fullName values, such as "Products:Widget" and "Inventory:Widget". Maximum length: 31 characters.

fullName
string
required

The case-insensitive fully-qualified unique name of this inventory item, formed by combining the names of its parent objects with its own name, separated by colons. For example, if an inventory item is under "Products:Electronics" and has the name "Widgets", its fullName would be "Products:Electronics:Widgets".

Unlike name, fullName is guaranteed to be unique across all inventory item objects. However, fullName can still be arbitrarily changed by the QuickBooks user when they modify the underlying name field.

barcode
string | null
required

The inventory item's barcode.

isActive
boolean
default: truerequired

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

class
object | null
required

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

parent
object | null
required

The parent inventory item one level above this one in the hierarchy. For example, if this inventory item has a fullName of "Products:Electronics:Widgets", its parent has a fullName of "Products:Electronics". If this inventory item is at the top level, this field will be null.

sublevel
number
required

The depth level of this inventory item in the hierarchy. A top-level inventory item has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, an inventory item with a fullName of "Products:Electronics:Widgets" would have a sublevel of 2.

sku
string | null
required

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

unitOfMeasureSet
object | null
required

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

salesTaxCode
object | null
required

The sales-tax code associated with this inventory item, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this inventory item. 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.

salesDescription
string | null
required

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

salesPrice
string | null
required

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

incomeAccount
object | null
required

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

purchaseDescription
string | null
required

The description of this inventory item that appears on purchase forms (e.g., checks, bills, item receipts) when it is ordered or bought from vendors.

purchaseCost
string | null
required

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

purchaseTaxCode
object | null
required

The tax code applied to purchases of this inventory item. Applicable in regions where purchase taxes are used, such as Canada or the UK.

cogsAccount
object | null
required

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

preferredVendor
object | null
required

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

assetAccount
object | null
required

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

reorderPoint
number | null
required

The minimum quantity of this inventory item at which QuickBooks prompts for reordering.

maximumQuantityOnHand
number | null
required

The maximum quantity of this inventory item desired in inventory.

quantityOnHand
number | null
required

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

averageCost
string | null
required

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

quantityOnOrder
number | null
required

The number of units of this inventory item that have been ordered from vendors (as recorded in purchase orders) but not yet received.

quantityOnSalesOrder
number | null
required

The number of units of this inventory item that have been sold (as recorded in sales orders) but not yet fulfilled or delivered to customers.

externalId
string | null
required

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

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

customFields
object[]
required

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