Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update payroll item tax

update_payroll_item_tax
Read-onlyIdempotent

Builds a v2 payroll_item_tax.update request.

The payroll_item_tax_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_payroll_item_tax"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
rateNoChoose at most one of: `rate`, or `rate_percent`.
limitNo
stateNo
list_idYes
is_activeNo
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`.
vendor_refNo
rate_changeNo
rate_percentNoChoose at most one of: `rate`, or `rate_percent`.
edit_sequenceYes
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
expense_account_refNo
include_ret_elementNo
payment_template_refNo
liability_account_refNo
vendor_account_numberNo
w2_tracking_type_valueNo
tax_calculated_based_onNo
liability_payment_scheduleNo

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.3/5.0
Behavior4/5

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

Beyond the annotations, the description discloses something essential: this tool does not mutate anything itself, it compiles a v2 request to be sent and describes the webhook payload shape in which QuickBooks' answer arrives. That explains why a tool named 'update' carries readOnlyHint=true and tells the agent where the real side effect happens. It also enumerates the error surface (e.g., 3200 stale_edit_sequence, 3262 payroll_subscription_required), though it adds no auth or permission context beyond the error codes.

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 first two sentences are front-loaded and dense with real information, which is good structure. However, the bulk of the text is a 30-item error-code dump with bare names and no actionable guidance, which crowds out more valuable parameter and usage information.

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?

An output schema exists, so the description needn't detail return values, and it nonetheless usefully points at the webhook/response_json shape and error taxonomy. For a 20-parameter, nested-object tool with heavy schema under-coverage and no sibling differentiation, though, the field-level guidance an agent needs to fill this request correctly is missing.

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

Parameters2/5

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

With 20 parameters and only 20% schema description coverage, the description carries the burden of explaining fields and does not do so. It never mentions the required edit_sequence/list_id pair, the rate vs. rate_percent mutual exclusion, include_qbxml, include_ret_element, or any ref/date fields; the only parameter-adjacent remark is that a qbXML wrapper is accepted.

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 opens with a specific verb and resource: 'Builds a v2 payroll_item_tax.update request,' which tells an agent exactly which object and operation this covers. It does not explicitly contrast with siblings such as create_payroll_item_tax or the other update_payroll_item_* tools, but the name-plus-first-sentence combination is unambiguous.

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 only implied: 'update' versus the sibling 'create_*' tools, plus the note that the qbXML `payroll_item_tax_mod` wrapper is accepted. There is no explicit statement of when to pick this tool over an alternative, no prerequisites (e.g., needing a current edit_sequence), and no exclusions.

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