Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update payroll item wage

update_payroll_item_wage
Read-onlyIdempotent

Builds a v2 payroll_item_wage.update request.

The payroll_item_wage_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_wage"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
rateNoChoose at most one of: `rate`, or `rate_percent`.
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`.
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
overtime_multiplierNo
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` and `idempotentHint=true`, and the description explains why that is coherent: the tool only builds and returns a request plus the webhook payload shape the answer arrives in, so no mutation happens in-call. It adds genuinely new behavior information by enumerating domain error codes (e.g. 3200 `stale_edit_sequence`, 3176 `locked`, 3262 `payroll_subscription_required`) that tell the agent what failure modes to handle. It does not state permissions or whether the caller must actually dispatch the request.

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?

Purpose and return behavior are front-loaded in two short paragraphs, which is good structure. The third block is a 25-item error-code enumeration in a single sentence that the description itself says the call result will explain, so much of it is redundant padding that dilutes the useful content.

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 detailed, and the description does mention the request and webhook payload framing. However, for a 12-parameter update with nested `expense_account_ref` and low schema coverage, it never explains the concurrency token, the idempotency semantics of `request_id`, or which fields are actually updatable. Error handling is well covered; parameter guidance is not.

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 coverage is only 33% across 12 parameters, so the description should compensate, but it explains almost nothing about them. The required `edit_sequence` and `list_id` are never described, and neither the `rate`/`rate_percent` exclusivity nor `include_ret_element` is addressed in the description (only the schema covers those). The error codes hint at amount and reference validation but give no parameter-level meaning.

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?

First sentence names a specific verb and resource: it builds a v2 `payroll_item_wage.update` request, which clarifies that the tool compiles a payload rather than performing the write itself. It also notes the qbXML `payroll_item_wage_mod` wrapper is accepted. It does not distinguish itself from the sibling `create_payroll_item_wage` or the other `update_payroll_item_*` tools beyond what the resource name implies.

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 explicit when-to-use or when-not-to-use guidance and no mention of prerequisites such as needing an `edit_sequence` or `list_id` for an existing record. The only implicit signal is that the caller must send the returned request elsewhere, which the agent has to infer rather than being told.

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