--- title: "Create an inventory item" method: POST path: "/quickbooks-desktop/inventory-items" --- # Create an inventory item `POST /quickbooks-desktop/inventory-items` Creates a new inventory item. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Request body - object - `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 hierarchical parent objects like `fullName` does. For example, two inventory items could both have the `name` "Cabinet", but they could have unique `fullName` values, such as "Kitchen:Cabinet" and "Inventory:Cabinet". Maximum length: 31 characters. - `barcode` object — The inventory item's barcode. - `value` string — The item's barcode value. - `assignEvenIfUsed` boolean — Indicates whether to assign the barcode even if it is already used. - `allowOverride` boolean — Indicates whether to allow the barcode to be overridden. - `isActive` boolean — Indicates whether this inventory item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`. - `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 "Kitchen:Cabinet", its parent has a `fullName` of "Kitchen". 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 default sales-tax code for this inventory 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. - `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 number of units of this inventory item currently in inventory. `quantityOnHand` multiplied by `averageCost` equals `totalValue` for inventory item lists. To change the `quantityOnHand` for an inventory item, you must use an inventory-adjustment instead of updating the inventory item directly. - `totalValue` string — The total value of this inventory item, represented as a decimal string. 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. Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45"). - `inventoryDate` string, date — 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, uuid — 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. **IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error. ## Response `200` Returns the newly created inventory item. - QbdInventoryItem - `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` 'qbd_inventory_item', required — The type of object. This value is always `"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), which QuickBooks Desktop interprets in the local timezone of the end-user's computer. - `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), 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 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 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 items could both have the `name` "Cabinet", but they could have unique `fullName` values, such as "Kitchen:Cabinet" and "Inventory:Cabinet". - `fullName` string, required — The case-insensitive fully-qualified unique name of this inventory item, formed by combining the names of its hierarchical parent objects with its own `name`, separated by colons. For example, if an inventory item is under "Kitchen" and has the `name` "Cabinet", its `fullName` would be "Kitchen:Cabinet". **NOTE**: 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, nullable, required — The inventory item's barcode. - `isActive` boolean, required — Indicates whether this inventory item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`. - `class` object, nullable, 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. - `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 item one level above this one in the hierarchy. For example, if this inventory item has a `fullName` of "Kitchen:Cabinet", its parent has a `fullName` of "Kitchen". If this inventory 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 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 "Kitchen:Cabinet" would have a `sublevel` of 1. - `sku` string, nullable, required — The inventory 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 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 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 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 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 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 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 item is purchased from vendors, represented as a decimal string. - `purchaseTaxCode` object, nullable, 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. - `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 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 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 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. - `reorderPoint` number, nullable, required — The minimum quantity of this inventory item at which QuickBooks prompts for reordering. - `maximumQuantityOnHand` number, nullable, required — The maximum quantity of this inventory item desired in inventory. - `quantityOnHand` number, nullable, required — The number of units of this inventory item currently in inventory. `quantityOnHand` multiplied by `averageCost` equals `totalValue` for inventory item lists. To change the `quantityOnHand` for an inventory item, you must use an inventory-adjustment instead of updating the inventory item directly. - `averageCost` string, nullable, required — The average cost per unit of this inventory item, represented as a decimal string. - `quantityOnPurchaseOrder` number, nullable, 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, nullable, 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, 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. - `customFields` QbdCustomField[], required — The custom fields for the inventory 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. --- [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)