Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update inventory site

update_inventory_site
Read-onlyIdempotent

Builds a v2 inventory_site.update request.

The inventory_site_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_inventory_site"
  }
}

Input Schema

NameRequiredDescriptionDefault
faxNoFax number.
nameNoName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
emailNoE-mail address.
phoneNoThe telephone number.
contactNoThe name of a contact person for a customer or vendor.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
site_descNoDescription of the site.
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`.
site_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
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.
parent_site_refNoA reference to the list object that is one level above this one.
include_ret_elementNo

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.4/5.0
Behavior4/5

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

The description resolves what the annotations leave surprising: despite readOnlyHint=true, this tool only *builds* a request and returns the v2 request plus the webhook payload shape where QuickBooks' answer arrives, so the caller performs the send. That framing is real added context beyond the annotations. It also catalogs the error code/type pairs to expect, though it stops short of describing rate limits, auth requirements, or what happens if the edit_sequence is stale beyond naming error 3200.

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?

Purpose is front-loaded in a single tight sentence, but the 20-entry error catalog (1030 through 3264) occupies most of the description and is largely redundant with the stated fact that "the call result explains each." It is informative but not proportionate.

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?

For a 14-parameter nested mutation builder with an output schema already present, the description covers the important unknowns: that it returns a request rather than applying it, where the answer arrives, and the failure surface. Missing is any hint about sequencing with the read/find tools to obtain edit_sequence, but the schema covers that field.

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 nearly every parameter including the nested address and parent_site_ref objects is already documented in the schema. The description adds no parameter-level meaning beyond confirming the qbXML wrapper name is accepted, so the baseline of 3 applies.

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 gives a specific verb and resource ("Builds a v2 inventory_site.update request") and notes the qbXML `inventory_site_mod` alias is accepted, which is genuinely distinguishing information. It does not, however, name or contrast any sibling such as create_inventory_site or find_inventory_sites, so the agent must infer differentiation from the tool name alone.

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 statement of when to use this tool versus alternatives, no prerequisites (e.g. that a current `edit_sequence` must first be fetched), and no exclusions. The only implicit guidance is that the name is a mutation verb, which the schema already conveys.

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