Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item discount

create_item_discount
Read-onlyIdempotent

Adds a discount item. A discount item is a percentage or a fixed amount that will be subtracted from a total or subtotal. Items should be subtotaled (using an ItemSubtotal item) before a discount item is applied to them, because a discount only acts on the line that is directly above it.

The item_discount_add 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, 3175 in_use, 3176 locked, 3180 cannot_save, 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, 3270 missing_posting_account

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": {
      "name": "<name>"
    },
    "name": "create_item_discount"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
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`.
external_guidNoAllows for the attachment of a user defined GUID value.
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`.

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 adds substantial behavior beyond the annotations: the async two-step model ("Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in"), the qbXML wrapper alias `item_discount_add`, and the full error surface, which partially reconciles the surprising readOnlyHint=true for an "Adds" tool. It still doesn't state permissions needed, whether retries are safe, or what the webhook payload contains beyond pointing at response_json, and the read-only-vs-creation tension is resolved only obliquely rather than up front.

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 is well front-loaded: purpose, then object definition, then the critical subtotal-ordering constraint. But the closing block is a 19-code error dump that the text itself concedes is redundant ("the call result explains each"), which is a long, unprioritized tail that dilutes the actionable guidance.

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 create tool with an output schema and rich schema descriptions, the description covers the unusual parts an agent actually needs: async request/webhook mechanics, the alternate qbXML wrapper name, and the failure surface. The main remaining gap is that it never explains what happens to the created discount (scope, uniqueness, permissions), leaving the create semantics partly implicit.

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 documents names, refs, barcode fields, and the discount_rate vs discount_rate_percent exclusivity; the description's restatement that a discount is "a percentage or a fixed amount" adds little. No parameter is made more meaningful by the description than by the schema (e.g., parent_ref scoping or the include_ret_element list are untouched). Baseline 3 applies when the schema carries the semantics.

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 description gives a specific verb and resource ("Adds a discount item") and then defines the object domain: "a percentage or a fixed amount that will be subtracted from a total or subtotal." It implicitly distinguishes itself from subtotal creation by stating items must be subtotaled first, but it never names a sibling such as update_item_discount or create_item_subtotal, so an agent must infer create-vs-update on its own.

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?

There is real usage guidance, but it is about ordering semantics rather than tool selection: "Items should be subtotaled (using an ItemSubtotal item) before a discount item is applied to them, because a discount only acts on the line that is directly above it." That is valuable context for correct invocation. However, the description never says when to choose this over update_item_discount, or when a discount item is inappropriate versus create_item_other_charge/create_item_subtotal.

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