Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item deduction

create_payroll_item_deduction
Read-onlyIdempotent

Builds a v2 payroll_item_deduction.create request.

The payroll_item_deduction_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": {
      "liability_account_ref": "<liability_account_ref>",
      "name": "<name>",
      "payment_template_ref": "<payment_template_ref>"
    },
    "name": "create_payroll_item_deduction"
  }
}

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
vendor_refNo
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
include_ret_elementNo
payment_template_refYes
liability_account_refYes
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?

The description resolves the otherwise alarming `readOnlyHint: true` on a "create" tool by explaining this is a request builder: it returns the v2 request to send and the webhook payload in which QuickBooks' answer arrives, so no mutation happens locally. That two-phase async contract plus a concrete error-code taxonomy (invalid_amount, in_use, locked, insufficient_permission, payroll_subscription_required) is meaningful behavior beyond the annotations. It stops short of describing auth requirements, rate limits, or whether the built request expires.

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 is front-loaded in one clear sentence, but roughly half the text is a 20-item error-code enumeration whose values the tool result apparently explains anyway. Space spent there is space not spent on the required-parameter guidance an agent actually needs before calling.

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 brief note about the returned request and webhook payload is adequate on the return side. For a tool with 19 mostly undocumented parameters and deep nesting, though, the absence of any field-level guidance leaves the most error-prone part of the invocation uncovered.

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 19 parameters, three required (liability_account_ref, name, payment_template_ref), nested ref objects, and only 21% schema description coverage, the description should carry parameter meaning but says nothing about any field. It does not explain what a liability_account_ref or payment_template_ref must point to, nor the semantics of enums like limit_time_period, calculated_based_on, or net_or_gross, leaving the two mutually exclusive rate fields documented only by the schema itself.

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?

"Builds a v2 payroll_item_deduction.create request" is a specific verb plus resource plus API surface, and the second sentence clarifies that the qbXML `payroll_item_deduction_add` form is also accepted. It never distinguishes itself from the many siblings, notably `update_payroll_item_deduction` or `create_payroll_item_addition`, so an agent must infer from the name alone when to pick this one.

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 states what it produces but never says when to use it versus `update_payroll_item_deduction` or the addition/contribution siblings, nor what prerequisites exist. The only usage-adjacent content is that an alternative qbXML wrapper name is tolerated, which is about input format, not selection between tools.

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