Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item tax

create_payroll_item_tax
Read-onlyIdempotent

Builds a v2 payroll_item_tax.create request.

The payroll_item_tax_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>",
      "payroll_item_detail_type_value": "<payroll_item_detail_type_value>"
    },
    "name": "create_payroll_item_tax"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
rateNoChoose at most one of: `rate`, or `rate_percent`.
limitNo
stateNo
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
rate_changeNo
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.
expense_account_refNo
include_ret_elementNo
payment_template_refYes
liability_account_refYes
vendor_account_numberNo
w2_tracking_type_valueNo
tax_calculated_based_onNo
liability_payment_scheduleNo
payroll_item_detail_type_valueYes

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 declare readOnlyHint=true and idempotentHint=true, and the description is consistent with them: it explains this compiles a request rather than mutating state, and that the real answer arrives via a webhook payload in response_json. It goes beyond the annotations by enumerating the domain-specific error codes (e.g. 3262 payroll_subscription_required, 3175 in_use, 3263 read_only_access), which tells the agent what failure modes to handle.

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 and the wrapper note is well placed, but the full enumeration of roughly 25 error codes occupies most of the text and is low-density relative to the useful content. Nothing is misleading, but the error dump is bulkier than an agent typically needs inline.

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 return-shape burden is light, and the error catalog plus the webhook note give useful operational context for a 19-parameter, heavily nested tool. What is missing is the harder half: guidance on the four required references and the nested scheduling object, leaving an agent with undocumented required inputs.

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 21% across 19 parameters, many of them nested objects (vendor_ref, liability_payment_schedule, rate_change), so the description is expected to compensate and does not. It adds nothing about required-field meaning, the rate vs rate_percent mutual exclusion, or how liability_payment_schedule interacts with payment_schedule_type; the error names only hint at validation constraints.

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 first sentence states a specific verb and resource: 'Builds a v2 payroll_item_tax.create request,' which is precise and implicitly distinguishes it from the sibling update_payroll_item_tax. It also discloses the notable behavior that a qbXML wrapper name is accepted, but it never explicitly names a sibling as an alternative.

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 the referenced liability account, payment template, or payroll subscription to exist. The qbXML wrapper note is an input-acceptance detail rather than routing guidance, leaving the agent to infer when this tool is the right choice over update_payroll_item_tax or the other create_payroll_item_* 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