Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item sales tax group

create_item_sales_tax_group
Read-onlyIdempotent

Adds a sales-tax group item, which is an item used for calculating two or more sales taxes grouped together and applied to the same sale. For example, local and state taxes could be tracked separately but applied to a sale as one tax. (Compare with the ItemSalesTaxAdd message.)

The item_sales_tax_group_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": {
      "item_sales_tax_ref": "<item_sales_tax_ref>",
      "name": "<name>"
    },
    "name": "create_item_sales_tax_group"
  }
}

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.
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.
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`.
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.
item_sales_tax_refYes
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

A3.6/5.0
Behavior4/5

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

The description goes well past the annotations by disclosing the request-compiler behavior: it returns the v2 request to send plus the webhook payload the QuickBooks answer arrives in, and it accepts the qbXML `item_sales_tax_group_add` wrapper as an alias. It also enumerates the error codes to handle. The apparent tension between "Adds…" and readOnlyHint=true is resolved by that explicit statement that the tool compiles a request rather than performing the write, so this is not a contradiction — but the opening verb could have been clearer about that.

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 and return behavior are front-loaded in a well-ordered way, but the second half is a ~20-entry error-code dump that the description itself says "the call result explains each," making it largely duplicated reference material. The parenthetical asides make the sentences long and dense where a short structured list would read better.

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 create-style tool with nested objects, rich annotations and an output schema, the definition covers what is needed: what it produces (request + webhook payload), the alternate wrapper name, and the failure modes. Return-value details are partly redundant given the output schema, but nothing critical for correct invocation is missing.

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 78%, just under the high-coverage baseline, so the schema carries most parameter meaning (name uniqueness, barcode flags, item_sales_tax_ref list_id-vs-full_name precedence, include_ret_element enum). The description adds little parameter-level detail beyond noting that include_qbxml is for debugging and not part of the v2 request, which the schema already states. It does not clarify the required item_sales_tax_ref semantics or when to populate request_id.

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 and resource ("Adds a sales-tax group item") and defines the resource well: a group of two or more sales taxes applied to the same sale. It even contrasts conceptually with the ItemSalesTaxAdd message. It never names the closest sibling alternatives (create_item_sales_tax, create_item_group), so the agent must infer the boundary between a tax *group* item and a single tax item.

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?

Usage is implied by the definition of a grouped tax ("two or more sales taxes grouped together") and by the comparison note to ItemSalesTaxAdd, which hints that a single tax uses the other message. There is no explicit when-to-use/when-not and no routing to the sibling tools an agent would realistically choose between, so guidance is inferential rather than stated.

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