Create item inventory
create_item_inventoryAdds an inventory item: merchandise the business buys, stocks and resells. name is required; give it the accounts it posts to, income_account_ref, cogs_account_ref and asset_account_ref. For stock already on hand that no purchase will record, set quantity_on_hand and total_value; otherwise leave them at zero and add a bill, which raises both. QuickBooks values stock at its average cost.
The item_inventory_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "<name>"
},
"name": "create_item_inventory"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max | No | Maximum number of items in inventory. | |
| name | Yes | Name is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope. | |
| bar_code | No | Barcode reference information. | |
| class_ref | No | Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. | |
| is_active | No | If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. | |
| parent_ref | No | A reference to the list object that is one level above this one. | |
| request_id | No | Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`. | |
| sales_desc | No | Appears in the Description column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes). | |
| sales_price | No | Price charged for this item. | |
| total_value | No | The total value of this inventory. If `total_value` is included, `quantity_on_hand` must also be included and must be greater than zero. | |
| external_guid | No | Allows for the attachment of a user defined GUID value. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| purchase_cost | No | Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item. | |
| purchase_desc | No | Appears in the Description column of checks, bills, credit card charges, and item receipts when this item is reordered. | |
| reorder_point | No | Quantity at which QuickBooks will remind the user to reorder this inventory item. | |
| inventory_date | No | The date when an item was converted into an inventory item from some other type of item. | |
| is_tax_included | No | For future use with international versions of QuickBooks. | |
| pref_vendor_ref | No | The preferred vendor for this item. If a `pref_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. | |
| cogs_account_ref | No | Refers to the account that QuickBooks uses to track the original cost of goods that are eventually sold. (The AccountType of this account will be CostOfGoodsSold.) | |
| quantity_on_hand | No | The number of these items in inventory. `quantity_on_hand` times `average_cost` is `total_value` in an inventory item list. | |
| asset_account_ref | No | Refers to the account QuickBooks uses to track the current value of the company’s inventory. (The AccountType of this account will be FixedAsset, OtherAsset, or OtherCurrentAsset.) | |
| income_account_ref | No | Refers to an income account. If an `income_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. | |
| sales_tax_code_ref | No | `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. | |
| include_ret_element | No | ||
| purchase_tax_code_ref | No | Account used for taxes on purchases in CA or UK. | |
| unit_of_measure_set_ref | No | The unit of measure set consists of a base unit and 0-n related units. | |
| manufacturer_part_number | No | The part number used by the manufacturer of the item. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |