Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update sales tax code

update_sales_tax_code
Read-onlyIdempotent

This modifies the specified sales tax code, subject to a few limitations. You can’t use it to change a tax code’s is_taxable property after the code has been used in any transaction. For the default QuickBooks taxable (Tax) and exempt (Non) tax codes, you can’t use this request to change the is_taxable property at all, even before any transactions.

The sales_tax_code_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_sales_tax_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
descNoDesc gives a longer explanation of Name.
nameNoShort name that will appear on sales forms to identify the tax status of an item. The Desc element gives a longer explanation of Name. Name must be unique, and it isn’t case-sensitive.
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.
is_taxableNoIndicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, `is_taxable` can’t be modified once the sales-tax code has been used in a transaction.
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_sales_tax_refNoAn ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead.
include_ret_elementNo
item_purchase_tax_refNoFor future use with international versions of QuickBooks.

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
Behavior3/5

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

The description goes well beyond the annotations by disclosing the immutable-field rules, the reason `edit_sequence` must be supplied, acceptance of the qbXML `sales_tax_code_mod` wrapper, and the fact that the result is a request/webhook payload rather than an applied change. The leading sentence 'This modifies the specified sales tax code' reads as a mutation and sits awkwardly against readOnlyHint=true, but the later clause stating it returns the v2 request to send partially reconciles the two, so this is a clarity gap rather than a flat contradiction.

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 substantive content (limitation on `is_taxable`, request/webhook return shape) is front-loaded in two sentences and earns its place. The remaining bulk is an 18-item error-code enumeration that the description itself says the call result already explains, which is padding that dilutes the signal.

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?

With an output schema present, the description needn't explain return values, yet it still summarizes the request/webhook output, and it covers failure modes and the key modification constraint for an 11-parameter nested payload. The main gap is routing: nothing tells the agent when this is the wrong tool versus the create/find siblings.

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 coverage is 91%, so the schema already carries almost all parameter meaning and the baseline is 3. The description adds only marginal parameter-level value: the `is_taxable` immutability rule (which the schema also states) and the qbXML wrapper alternative; most params, including `include_ret_element`, `request_id`, and the nested tax refs, get nothing new from the description.

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 opening states a specific verb and resource: 'This modifies the specified sales tax code,' and adds a second sentence clarifying it returns the v2 request plus the webhook payload, which distinguishes it from an executor. It does not name or contrast with the obvious siblings (create_sales_tax_code, find_sales_tax_codes), so an agent must infer the boundary.

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

Usage Guidelines3/5

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

It provides real when-not conditions: `is_taxable` cannot be changed after the code is used in a transaction, and never for the default 'Tax'/'Non' codes. However there is no guidance on when to reach for this versus `create_sales_tax_code` or `find_sales_tax_codes`, and no stated prerequisites (e.g., needing a current `edit_sequence` before calling) framed as usage advice.

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