Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update payroll item workers compensation

update_payroll_item_workers_compensation
Read-onlyIdempotent

Builds a v2 payroll_item_workers_compensation.update request.

The payroll_item_workers_compensation_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_workers_compensation"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
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
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
is_tracked_by_cust_jobNo
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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, and the description stays consistent with them by explaining that the tool builds and returns a request rather than performing the write itself. Beyond annotations it adds genuinely useful behavior: the response contains the v2 request to send plus the webhook payload where QuickBooks' answer arrives, and it enumerates the error codes (e.g. 3200 stale_edit_sequence, 3170 cannot_modify) an agent must handle. It still doesn't say whether the built request expires or how long the webhook wait is.

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?

The purpose is front-loaded in the first sentence, followed by return-shape context and then the error catalog. The long inline error enumeration is dense but each code is actionable; it could have been trimmed to the code/type plus a pointer rather than an exhaustive list.

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 re-explain return values, and the mention of the webhook response_json and status codes is a helpful addition. However, for a 15-parameter, nested-object update builder, omitting any parameter-level guidance leaves a real gap that neither the schema descriptions nor the annotations fill.

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?

Schema description coverage is only 13% across 15 parameters, including nested ref objects and a liability_payment_schedule enum that the description never touches. The description adds no meaning for edit_sequence, list_id, the *_ref objects, or the include_ret_element/include_qbxml switches, so the agent is left to infer required-vs-optional update semantics from bare schema types.

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 names a specific operation ("Builds a v2 payroll_item_workers_compensation.update request") and clarifies that this is a request builder rather than an in-place mutation, which is a meaningful distinction from the sibling create_* tools. It also notes that the qbXML `payroll_item_workers_compensation_mod` wrapper is accepted, disambiguating the two accepted input shapes. It stops short of explicitly contrasting itself with the other update_payroll_item_* siblings.

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: you call it to produce an update request for a workers-comp payroll item. There is no explicit statement of when to prefer it over create_payroll_item_workers_compensation or the other update_payroll_item_* variants, and no mention that an existing `edit_sequence`/`list_id` from a prior read is required to build a valid update.

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