Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update payroll item addition

update_payroll_item_addition
Read-onlyIdempotent

Builds a v2 payroll_item_addition.update request.

The payroll_item_addition_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_addition"
  }
}

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
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
expense_account_refNo
include_ret_elementNo
is_tracked_by_cust_jobNo
w2_tracking_type_valueNo
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 usefully reconciles this by explaining that the tool only builds a request rather than performing the write. It adds real behavioral context beyond annotations: the return is the v2 request plus the webhook payload shape that QuickBooks' answer arrives in, plus the status codes to handle. The enumerated error semantics (including 3200 stale_edit_sequence and 3263 read_only_access) are a genuine addition, though each is deferred to the call result rather than explained.

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 core statement and return/webhook explanation are front-loaded and efficient. However, the twenty-item error-code catalogue occupies most of the text while simultaneously telling the reader 'the call result explains each', which weakens its claim on space. Some of that volume could be traded for the missing parameter guidance.

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 return values need not be spelled out, and the description nevertheless sketches the request/webhook split well. For a tool with 18 parameters, nested objects, and only 22% schema coverage, though, the absence of any guidance on required identifiers and optimistic-locking via edit_sequence leaves a real gap for an agent trying to call it correctly.

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 18 parameters and only 22% schema description coverage, the description carries a heavy burden but adds essentially no parameter meaning. Critical inputs such as `edit_sequence` (required, and the source of the 3200 stale_edit_sequence error), `list_id`, `taxability`, and the three enum fields are never explained in the description. The only parameter-adjacent remarks concern `request_id`/`include_qbxml` echoes, which the schema already documents.

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 opening sentence names a specific verb and resource ('Builds a v2 payroll_item_addition.update request'), which makes the operation identifiable and separates it from the create_* siblings by the 'update' verb. It also states that the qbXML `payroll_item_addition_mod` wrapper is accepted as an alternate input form. It stops short of explicitly contrasting this with sibling tools such as update_payroll_item_wage or update_payroll_item_deduction.

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?

There is no statement of when to choose this tool over update_payroll_item_wage, update_payroll_item_deduction, or the create_* variants, nor any prerequisite guidance. The only conditional information is that the `payroll_item_addition_mod` wrapper is also accepted as input, which is input-format guidance rather than selection guidance. An agent must infer the use case entirely from the name.

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