Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item addition

create_payroll_item_addition
Read-onlyIdempotent

Builds a v2 payroll_item_addition.create request.

The payroll_item_addition_add 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, 3175 in_use, 3176 locked, 3180 cannot_save, 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, 3270 missing_posting_account

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": {
      "expense_account_ref": "<expense_account_ref>",
      "name": "<name>"
    },
    "name": "create_payroll_item_addition"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
rateNoChoose at most one of: `rate`, or `rate_percent`.
limitNo
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
limit_time_periodNo
calculated_based_onNo
expense_account_refYes
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

C2.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: the call yields a v2 request plus a webhook payload whose response_json carries the data shape and status codes, and it enumerates error codes to handle. What it does not disclose is whether the operation actually persists anything, when the webhook fires, or which errors are likely versus theoretical — the code dump is presented without prioritization.

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 opening two sentences are front-loaded and reasonably dense, but roughly two-thirds of the text is an undifferentiated dump of 20 error code/type pairs that reads as machine-generated boilerplate. That bulk is not weighted or explained, and it crowds out information an agent would more plausibly need, such as what the built request is for.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/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-value explanation is not strictly required, yet the description compensates poorly for a 16-parameter, deeply nested create-style tool: no parameter meaning, no prerequisite or permission context beyond raw error codes, and no clarification of whether the effect is a dry-run request build or a persisted payroll item. The agent has enough to know the tool exists but not enough to call it confidently.

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 25% across 16 parameters with nested objects, so the description must compensate and it does not. It gives zero meaning for the required `expense_account_ref` or `name`, or for `net_or_gross`, `calculated_based_on`, `payroll_item_detail_type_value`, or the `taxability` array. It only maps the tool to its qbXML wrapper name, which is about the operation, not about parameter semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/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_addition.create request") and notes the qbXML `payroll_item_addition_add` alias, which is concrete. However, it is ambiguous about the actual effect: it says it "Returns the v2 request to send" rather than stating whether a payroll item is created in QuickBooks or only a payload is assembled. It also gives no differentiation from the many sibling create_payroll_item_* tools (deduction, wage, tax) or from update_payroll_item_addition.

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 when-to-use or when-not-to-use guidance and no mention of alternatives such as create_payroll_item_deduction or update_payroll_item_addition. Nothing tells the agent which of the 16 parameters matter for a typical call, or what prerequisites (payroll subscription, posting account) must hold before invoking it.

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