Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item group

update_item_group
Read-onlyIdempotent

Modifies an item group.

The item_group_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_group"
  }
}

Input Schema

NameRequiredDescriptionDefault
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.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
item_descNoThe description that will appear on a sales form when the item is used.
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`.
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.
item_group_lineNoChoose at most one of: `clear_items_in_group`, or `item_group_line`.
force_uom_changeNoBy Default `force_uom_change` is false.
include_ret_elementNo
clear_items_in_groupNoSet to true to clear all the items in this group. Choose at most one of: `clear_items_in_group`, or `item_group_line`.
is_print_items_in_groupNoIf true, a list of this group’s individual items their amounts will appear on printed forms.
unit_of_measure_set_refNoThe unit of measure set consists of a base unit and 0-n related units.

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

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description does add real behavior: it returns the v2 request to send plus the webhook payload shape and status codes to handle. However, leading with "Modifies an item group" reads as a mutation and is only reconciled with the read-only annotation by inference from the later return-value sentence. The error list is comprehensive on codes but explicitly defers explanation ("the call result explains each").

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 first three sentences are front-loaded and useful, but the trailing paragraph is a 20-entry error-code dump in a single run-on sentence, which crowds out information an agent needs more (scope, prerequisites, relationship to create_item_group). Nothing is padded for its own sake, but the balance is off.

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?

An output schema exists, so return values needn't be spelled out, and the description covers the request/webhook contract and the failure surface for a 14-parameter nested mutation builder. What it omits is the operational context: that edit_sequence must be current, and how this differs from the sibling update_item_* tools on other item types.

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 93%, so the schema already carries parameter meaning (edit_sequence as revision token, list_id precedence over full_name, clear_items_in_group vs item_group_line exclusivity). The description adds only the non-parameter detail that the qbXML `item_group_mod` wrapper is accepted. 14-parameter surface is left entirely to 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?

States a specific verb and resource ("Modifies an item group") and adds the qbXML wrapper name `item_group_mod`, so an agent can map intent to the call. It does not distinguish this from create_item_group or the many other update_item_* siblings (e.g. update_item_sales_tax_group), and the opening verb sits uneasily with the later statement that the tool merely returns a request to send.

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?

No when-to-use or when-not-to-use guidance: nothing tells the agent to prefer create_item_group for new groups or update_item_sales_tax_group for tax groups. The only conditional content ("Choose at most one of: clear_items_in_group, or item_group_line") comes from the schema, not from the description.

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