Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item workers compensation

create_payroll_item_workers_compensation
Read-onlyIdempotent

Builds a v2 payroll_item_workers_compensation.create request.

The payroll_item_workers_compensation_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>",
      "liability_account_ref": "<liability_account_ref>",
      "name": "<name>",
      "payment_template_ref": "<payment_template_ref>"
    },
    "name": "create_payroll_item_workers_compensation"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
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
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
expense_account_refYes
include_ret_elementNo
payment_template_refYes
liability_account_refYes
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/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; the description usefully explains why a 'create' tool is read-only, namely that it only compiles a request and returns the webhook payload shape. Beyond that it adds little behavioral context: no note on whether the actual create happens elsewhere, no auth/permission requirements, and the 24-code error list is enumerated while deferring all meaning to 'the call result explains each'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose is front-loaded in the first sentence, but roughly two thirds of the text is a raw enumeration of 24 numeric error codes that self-admittedly carry no information ('the call result explains each'). That bulk crowds out parameter and usage guidance that would have been more valuable.

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?

The description does resolve the tool's most confusing aspect, that a 'create' tool is read-only and merely compiles a request whose real answer arrives via webhook, and an output schema exists so return values needn't be spelled out. However, for a 13-parameter nested-payload builder at 15% schema coverage, the absence of any parameter guidance leaves it incomplete for correct invocation.

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 15% across 13 parameters (4 required, several nested objects), and the description says nothing about any of them. It never mentions required refs such as expense_account_ref, liability_account_ref, name or payment_template_ref, nor the nested liability_payment_schedule enum set, so it leaves the parameter burden entirely on an under-documented schema.

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 states a specific verb and resource: it 'builds a v2 payroll_item_workers_compensation.create request' rather than executing one, and it notes the qbXML `_add` wrapper is also accepted. That distinguishes it from a plain create and from the sibling update_/find_ tools by naming the exact v2 operation, though no sibling is named for contrast.

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 by the two-step flow described ('returns the v2 request to send, and the webhook payload'), so an agent can infer it must build here and send elsewhere. There is no explicit when-to-use vs update_payroll_item_workers_compensation, and no prerequisites such as required payroll feature or subscription state, despite error 3262 payroll_subscription_required hinting at one.

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