Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll year to date adjustment

create_payroll_year_to_date_adjustment
Read-onlyIdempotent

Builds a v2 payroll_year_to_date_adjustment.create request.

The payroll_year_to_date_adjustment_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, 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": {
      "employee_ref": "<employee_ref>",
      "is_affecting_accounts": "<is_affecting_accounts>",
      "payroll_year_to_date_adjustment_line_add": "<payroll_year_to_date_adjustment_line_add>"
    },
    "name": "create_payroll_year_to_date_adjustment"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNo
txn_dateNo
class_refNo
def_macroNo
ref_numberNo
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`.
account_refNo
employee_refYes
payroll_dateNo
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
tax_table_versionNo
include_ret_elementNo
pay_period_end_dateNo
is_affecting_accountsYes
pay_period_begin_dateNo
payroll_year_to_date_adjustment_line_addYes

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
Behavior4/5

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

The description adds real value beyond the annotations: it discloses that nothing is executed here (consistent with readOnlyHint=true), that the return is a request to send plus a webhook payload whose shape and status codes are documented in response_json, and it enumerates the error codes the caller must handle. What it leaves implicit is the actual submit/execute path and whether retries are safe despite idempotentHint=true.

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 statement is front-loaded and efficient, but roughly half the text is a monolithic dump of 20 error codes that reads like reference material and crowds out more useful guidance. The blob is better suited to a reference or structured error documentation than inline prose.

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?

For a 16-parameter, deeply nested tool with near-zero schema documentation, the description does far too little: no parameter explanations, no guidance on the returned request's lifecycle, and no differentiation from siblings. The presence of an output schema excuses it from explaining return values, but the missing input semantics remain a significant gap.

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 13% across 16 parameters, including a nested line-item array with mutual-exclusion constraints, and the description adds no meaning for any of them. Aside from naming the qbXML wrapper alias, it contributes nothing that would help an agent populate employee_ref, payroll_date, or the line_add fields correctly.

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 uses a specific verb and resource: it 'Builds a v2 payroll_year_to_date_adjustment.create request' and returns that request plus the webhook payload for QuickBooks' answer. That framing usefully distinguishes it from an executing create, but it never explains how it relates to the many sibling create_payroll_* tools, so routing still requires guesswork.

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 guidance on when to use this builder instead of create_payroll_liability_adjustment or the other create_payroll_* siblings, and no statement of prerequisites or what to do with the returned request afterward. The only contextual note is that the qbXML `payroll_year_to_date_adjustment_add` wrapper is accepted, which is input-shape trivia rather than usage guidance.

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