Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item inventory

update_item_inventory
Read-onlyIdempotent

Modifies an inventory item. Starting with qbXML spec 7.0, you can modify the income account ref, using the income_account_ref aggregate and the apply_income_account_ref_to_existing_txns boolean. You need to use the apply_income_account_ref_to_existing_txns boolean because the QuickBooks UI displays a prompt asking whether the change should apply to existing transactions or not. Specifying True for the boolean basically dismisses this with a “Yes” answer, allowing your changes to be made and changes any existing transactions that use the item with that AccountRef.

The item_inventory_mod 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, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 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

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": {
      "edit_sequence": "<edit_sequence>",
      "list_id": "<list_id>"
    },
    "name": "update_item_inventory"
  }
}

Input Schema

NameRequiredDescriptionDefault
maxNoMaximum number of items in inventory.
nameNoName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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.
edit_sequenceYes`edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`.
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.
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.)
force_uom_changeNoBy Default `force_uom_change` is false.
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.
apply_cogs_account_ref_to_existing_txnsNoEffectively suppresses the UI prompt that is displayed upon a COGS account change when existing transactions use the account.
apply_income_account_ref_to_existing_txnsNoUsed to support changing the AccountRef in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not.

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

C2.7/5.0
Behavior1/5

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

The description opens by stating the tool "Modifies an inventory item" and that changes will be applied to existing transactions, while annotations declare readOnlyHint=true and destructiveHint=false. The description never reconciles this by explaining that the call only compiles and returns a v2 request plus a webhook payload, so an agent reading the description would believe it performs a write. This is a direct conflict with the supplied annotations.

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

Conciseness3/5

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

The purpose is front-loaded, but the second paragraph is a large verbatim dump of twenty error codes with terse type labels, which crowds out information an agent actually needs to select and call the tool. The mid-section explaining the response_json/webhook flow is useful but buried between unrelated blocks.

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

Completeness3/5

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

The description covers the error surface and mentions that a v2 request and webhook payload are returned, and an output schema exists so return shape needn't be restated. However, for a 28-parameter mutation-shaped tool it omits the crucial framing that this builds a request rather than executing the update, leaving the tool's actual operation ambiguous.

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

Parameters3/5

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

Schema description coverage is 96%, so nearly every one of the 28 parameters is already documented in the schema, and the description's explanation of income_account_ref plus the apply boolean largely restates what the schema says. It does add the business rationale (the QuickBooks UI prompt being dismissed with "Yes"), which is modest value beyond the schema.

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

Purpose4/5

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

The first sentence, "Modifies an inventory item," gives a specific verb and resource that clearly separates this tool from siblings such as update_item_non_inventory and update_item_inventory_assembly. The rest of the description drifts into qbXML spec details and error codes rather than reinforcing the core purpose, but the opening line is unambiguous.

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

Usage Guidelines2/5

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

There is no guidance on when to choose this tool over the many update_* siblings, nor any statement of prerequisites such as needing a current edit_sequence before calling. The only conditional advice is about when the apply_income_account_ref_to_existing_txns boolean is required, which is a single-parameter tip rather than overall usage guidance.

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