Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item inventory

create_item_inventory
Read-onlyIdempotent

Adds 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

NameRequiredDescriptionDefault
maxNoMaximum number of items in inventory.
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
bar_codeNoBarcode reference information.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
parent_refNoA reference to the list object that is one level above this one.
request_idNoYour 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_descNoAppears 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_priceNoPrice charged for this item.
total_valueNoThe total value of this inventory. If `total_value` is included, `quantity_on_hand` must also be included and must be greater than zero.
external_guidNoAllows for the attachment of a user defined GUID value.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
purchase_costNoAmount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item.
purchase_descNoAppears in the Description column of checks, bills, credit card charges, and item receipts when this item is reordered.
reorder_pointNoQuantity at which QuickBooks will remind the user to reorder this inventory item.
inventory_dateNoThe date when an item was converted into an inventory item from some other type of item.
is_tax_includedNoFor future use with international versions of QuickBooks.
pref_vendor_refNoThe 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_refNoRefers 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_handNoThe number of these items in inventory. `quantity_on_hand` times `average_cost` is `total_value` in an inventory item list.
asset_account_refNoRefers 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_refNoRefers 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_refNo`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_elementNo
purchase_tax_code_refNoAccount used for taxes on purchases in CA or UK.
unit_of_measure_set_refNoThe unit of measure set consists of a base unit and 0-n related units.
manufacturer_part_numberNoThe part number used by the manufacturer of the item.

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description clearly describes a create operation ('Adds an inventory item'), yet annotations declare readOnlyHint=true and idempotentHint=true. This directly contradicts the stated behavior and could lead an agent to treat a mutating call as a safe read. Annotation Contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose then the key parameter branch, which is well ordered. The trailing block of twenty error codes and types is bulky, though it is at least classified by code and type rather than left to discovery.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers what is returned (the v2 request plus the webhook payload and response_json shape), the alternate qbXML wrapper name, valuation semantics (average cost), and the failure modes, which is substantial for a 27-parameter tool. An output schema exists, so return values need no more detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 96%, so the baseline is 3. The description still adds value by naming the three account references (`income_account_ref`, `cogs_account_ref`, `asset_account_ref`) as the practical posting setup and by explaining the coupling between `quantity_on_hand` and `total_value` in operational terms.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource plus the defining scope: 'merchandise the business buys, stocks and resells'. That scope phrase is what separates it from the sibling create_item_non_inventory / create_item_service style tools without needing their schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit branch: set `quantity_on_hand` and `total_value` only for stock already on hand that no purchase will record; otherwise leave at zero and add a bill. That is real when-to-do-what guidance. It stops short of naming sibling alternatives for the other item types.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources