Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update payroll item deduction

update_payroll_item_deduction
Read-onlyIdempotent

Builds a v2 payroll_item_deduction.update request.

The payroll_item_deduction_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_deduction"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
rateNoChoose at most one of: `rate`, or `rate_percent`.
limitNo
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`.
taxabilityNo
vendor_refNo
net_or_grossNo
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.
limit_time_periodNo
calculated_based_onNo
include_ret_elementNo
payment_template_refNo
liability_account_refNo
vendor_account_numberNo
w2_tracking_type_valueNo
liability_payment_scheduleNo
payroll_item_detail_type_valueNo

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

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description is consistent with them by framing the tool as a request builder rather than a live mutation. It adds real context the annotations cannot carry: the return is a v2 request the caller must send, the QuickBooks answer arrives asynchronously in a webhook payload, and a 20-code error taxonomy (including 3200 stale_edit_sequence, 3260 insufficient_permission, 3262 payroll_subscription_required) tells the agent which failures to handle. It loses a point for never explicitly warning that this call does not itself modify QuickBooks data.

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 purpose statement is correctly front-loaded and the return/webhook sentence earns its place. However, the trailing run-on list of twenty error codes is undifferentiated bulk that dominates the description's length and is not prioritized or grouped. The qbXML alias sentence is also placed ahead of more important operational 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's return-value discussion is a bonus rather than a necessity, and the error taxonomy is genuinely useful for a request-builder that fails in many coded ways. Against that, a 21-parameter nested-object mutation request is described with essentially no field-level semantics and no statement of prerequisites or of what the caller must do with the returned request. Adequate, but with clear gaps for a tool of this complexity.

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 21 parameters and only 19% schema description coverage, the description is the main place parameter meaning could be added, and it adds almost nothing. Only `edit_sequence`, `list_id` and the mutual-exclusion of `rate`/`rate_percent` are even indirectly illuminated (the latter two by the schema itself, `edit_sequence` only obliquely via error 3200). Fields like `include_ret_element`, `include_qbxml`, `taxability`, `limit_time_period` and `net_or_gross` are left entirely to inference.

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 first sentence names a specific verb and resource: it builds a `payroll_item_deduction.update` v2 request, which is directly distinguishable from the `create_payroll_item_deduction` and other `update_payroll_item_*` siblings by resource noun. It is not a tautology of the title. It stops short of a 5 because it never states the boundary against the sibling create/update tools for adjacent payroll item types.

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?

The description gives no when-to-use guidance, no prerequisites (e.g. payroll subscription, read-only access, required permissions), and no exclusions pointing at create_payroll_item_deduction for new records. The note that a qbXML `payroll_item_deduction_mod` wrapper is accepted is input-format information, not usage guidance. An agent must infer everything about fit from the tool name alone.

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