Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item wage

create_payroll_item_wage
Read-onlyIdempotent

Adds a payroll wage item. Each payroll wage item describes and names a payment scheme, for example, Regular Pay or Overtime Pay. A PayrollItemWageRef aggregate refers to one of these wage items. In a request, if a PayrollItemWageRef aggregate includes both full_name and list_id, full_name will be ignored.

The payroll_item_wage_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>",
      "wage_type": "<wage_type>"
    },
    "name": "create_payroll_item_wage"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesDescription of the wage: for example, Regular Pay or Overtime Pay.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
wage_typeYesThe type of pay.
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
expense_account_refYesRefers to an expense account. If an `expense_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
include_ret_elementNo

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.9/5.0
Behavior2/5

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

Annotations declare readOnlyHint=true, yet the description opens with "Adds a payroll wage item," a clear mutation claim, and then says the tool "Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in" plus "the call result explains each" error — leaving it genuinely unclear whether this call mutates QuickBooks or only compiles a request. That ambiguity is exactly what an agent needs resolved before invoking a payroll write. On the positive side, the long enumerated error surface is useful behavioral context that the annotations do not provide.

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 correctly front-loaded and the full_name/list_id rule is stated early. However, the second half is a dense run-on block mixing wrapper notes, return contract, and a 23-item error-code dump that largely duplicates what "the call result explains," and the full_name precedence rule is stated twice in nearly identical words.

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?

Because an output schema and annotations exist, the description need not explain return values, and it does explain the request/webhook roundtrip and error codes. What is missing is decisive for a payroll mutation tool: whether the call actually writes to QuickBooks or merely returns a request body, and whether the referenced expense_account_ref must already exist.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 86%, so the schema already documents nearly every parameter, including the full_name/list_id precedence rule that the description repeats. The description adds only the qbXML-wrapper acceptance and request-shape notes, not material semantics for the seven parameters. Baseline 3 applies when the schema does the heavy lifting.

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 gives a specific verb and resource ("Adds a payroll wage item") and the second defines the domain concept ("describes and names a payment scheme, for example, Regular Pay or Overtime Pay"). It does not distinguish the tool from the many sibling creators (create_payroll_item_addition, create_payroll_item_deduction, update_payroll_item_wage), so an agent must infer the boundary from the naming convention alone.

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, no mention of update vs create, and no named alternative. The definition of what a wage item is implicitly helps, but nothing tells an agent whether to call this versus create_payroll_item_addition or update_payroll_item_wage for a given need.

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