Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item sales tax

create_item_sales_tax
Read-onlyIdempotent

Adds a sales-tax item, which is an item used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. (Compare with the ItemSalesTaxGroupAdd message.) An ItemSalesTaxRef aggregate refers to an item on this list. In a request, if an ItemSalesTaxRef aggregate includes both full_name and list_id, full_name will be ignored.

The item_sales_tax_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_sales_tax"
  }
}

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.
tax_rateNoThe tax rate. If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required.
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.
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.
tax_vendor_refNoRefers to the tax agency to whom collected taxes are owed. (This will be a vendor on the Vendor list.) If a nonzero `tax_rate` is specified, then `tax_vendor_ref` is required.
include_ret_elementNo
sales_tax_return_line_refNoSales tax return line information.

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

A4.4/5.0
Behavior5/5

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

Reveals the non-obvious contract that this does not write directly: it returns the v2 request to send and the webhook payload/channel where QuickBooks' answer arrives, which explains why readOnlyHint=true is consistent despite "Adds" in the name. It also discloses wrapper compatibility, the effect of sending both full_name and list_id, and a structured error taxonomy (error.code / error.type) so the agent knows what failures to handle.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the key async-return behavior are front-loaded in the first two sentences, with mechanics and errors following. The 20-code error enumeration is long but formatted as a scannable code/type list rather than prose, so it remains usable, though it dominates the description's length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 12-parameter nested-object tool with 92% schema coverage, annotations, and an output schema, the description covers everything structural fields cannot: the compile-then-send request pattern, the webhook answer channel, wrapper acceptance, and error handling. Nothing an agent needs in order to call it correctly 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 coverage is 92%, so field meaning is largely carried by the schema itself, which already states that list_id wins over full_name. The description restates the full_name/list_id precedence and the tax_rate-requires-tax_vendor_ref dependency but adds no syntax or format detail beyond the schema. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb-plus-resource ("Adds a sales-tax item") and immediately defines what that resource is (an item that calculates a single tax at a rate paid to one agency). It explicitly distinguishes itself from the ItemSalesTaxGroupAdd path and mentions ItemSalesTaxRef referring to items on this list, so an agent can separate it from the group-creation sibling without opening schemas.

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

Usage Guidelines4/5

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

Gives clear context for when this tool is the right one: single-rate, single-agency tax, contrasted with the group message, plus the note that the qbXML `item_sales_tax_add` wrapper is accepted. It lacks explicit when-not guidance versus siblings like update_item_sales_tax or find_item_sales_taxes, and says nothing about prerequisites such as vendor existence beyond the tax_vendor_ref rule.

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