Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item service

update_item_service
Read-onlyIdempotent

About sales_or_purchase_mod versus sales_and_purchase_mod in an ItemServiceMod request:

The item_service_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_service"
  }
}

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.
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`.
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.
is_tax_includedNoFor future use with international versions of QuickBooks.
force_uom_changeNoBy Default `force_uom_change` is false.
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
sales_or_purchase_modNoA `sales_or_purchase` aggregate is used for items that are meant to be either purchased or sold, but not both. Choose at most one of: `sales_or_purchase_mod`, or `sales_and_purchase_mod`.
sales_and_purchase_modNoA `sales_and_purchase` aggregate is used for items that are meant to be both purchased and sold, such as an “other charge” item that is reimbursable. Choose at most one of: `sales_or_purchase_mod`, or `sales_and_purchase_mod`.
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

C2.7/5.0
Behavior3/5

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

The description adds real context beyond the annotations: it discloses that the call compiles and returns a v2 request plus the webhook/response_json shape and status codes rather than performing the mutation itself, and it enumerates the error taxonomy including stale_edit_sequence and cannot_modify. That said, it never explicitly reconciles the update semantics with readOnlyHint=true, nor does it say anything about retry or concurrency behavior when edit_sequence is stale.

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

Conciseness2/5

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

The most prominent sentence is an orphaned topic label that ends in a colon and is never followed by the promised comparison, which is poor front-loading for the tool's main use case. The remainder is a long error-code dump that is largely redundant with 'the call result explains each', while the single most useful fact (that this compiles a request instead of applying it) is buried mid-paragraph.

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?

For a 16-parameter mutation builder with full annotations and an output schema, the description covers the return/webhook contract and the error surface adequately, and the schema carries nearly all parameter meaning. It is still incomplete on the essentials an agent needs before calling: what a 'service' item is versus the sibling item types, and how the readOnly annotation squares with an update operation.

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 94%, so the baseline is 3 and the schema already explains edit_sequence, force_uom_change, include_qbxml, and the mutually exclusive sales aggregates. The description's only parameter-level contribution is the dangling sales_or_purchase_mod vs sales_and_purchase_mod heading and the note that an item_service_mod qbXML wrapper is also accepted; it adds no syntax or format detail of its own.

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

Purpose3/5

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

The definition never states plainly that this tool updates an existing QuickBooks service item; the closest it gets is referring to an 'ItemServiceMod request' and saying it 'Returns the v2 request to send'. The verb/resource must be inferred from the name and title, and nothing distinguishes it from the many sibling update_item_* tools.

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 use this tool rather than update_item_other_charge, update_item_non_inventory, or create_item_service, and no prerequisites for modifying an existing record. The opening line promises a comparison ('About `sales_or_purchase_mod` versus `sales_and_purchase_mod`') but never delivers it, so even the parameter-level choice is left to the schema.

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