Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item discount

update_item_discount
Read-onlyIdempotent

Modifies a discount item. Starting with qbXML spec 7.0, you can modify the account ref, using the account_ref aggregate and the apply_account_ref_to_existing_txns boolean. You need to use the apply_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 account_ref.

The item_discount_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_discount"
  }
}

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.
item_descNoThe description that will appear on a sales form when the item is used.
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`.
account_refNo`account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored.
discount_rateNoThe discount rate when it is given as a monetary amount. `discount_rate` will be subtracted from a total or subtotal. Choose at most one of: `discount_rate`, or `discount_rate_percent`.
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.
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
discount_rate_percentNoThe discount rate when it is given as a percent. `discount_rate_percent` will be subtracted from a total or subtotal. Choose at most one of: `discount_rate`, or `discount_rate_percent`.
apply_account_ref_to_existing_txnsNoUsed to support changing the `account_ref` 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.8/5.0
Behavior1/5

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

Annotations declare readOnlyHint=true and destructiveHint=false, while the description states the tool 'Modifies a discount item' and applies changes to existing transactions. That is a direct contradiction of the safety profile an agent relies on. The error-code list and webhook-return note are useful, but they do not offset a mislabeled mutation.

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 opening sentence is well front-loaded and the error enumeration is compact, but the second paragraph mixes qbXML wrapper jargon and nested parentheticals in a way that slows comprehension. Substantial space goes to one parameter plus a legacy qbXML note, while core mutation facts are absent.

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?

Output schema exists and the description points to response_json and the webhook payload, so return values need not be explained. However, for a 16-parameter mutation tool with nested references, it omits permission requirements, what happens to unspecified fields, and whether the update is reversible — and the readOnly annotation conflict leaves the agent's mental model incomplete.

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

Parameters4/5

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

Schema coverage is 94%, so the baseline is 3, and the description genuinely adds meaning beyond the schema for account_ref and apply_account_ref_to_existing_txns — explaining that True both dismisses the QuickBooks UI prompt and rewrites existing transactions using that account. That rationale is not derivable from the schema text alone.

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?

Opens with a specific verb+resource: "Modifies a discount item." That clearly separates it from create_item_discount and from the other update_item_* siblings by resource type. It never names an alternative explicitly, so it stops short of a 5.

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 create_item_discount or the sibling update_* tools, and no preconditions such as required permissions or the need for a current edit_sequence. The only conditional discussion is inside the account_ref paragraph and concerns a parameter, not tool selection.

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