Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll prior payment

create_payroll_prior_payment
Read-onlyIdempotent

Builds a v2 payroll_prior_payment.create request.

The payroll_prior_payment_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": {
      "is_affecting_accounts": "<is_affecting_accounts>",
      "payroll_prior_payment_line_add": "<payroll_prior_payment_line_add>"
    },
    "name": "create_payroll_prior_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNo
txn_dateNo
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
payroll_dateNo
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
is_affecting_accountsYes
payroll_prior_payment_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.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description reinforces that by explaining the tool only returns a request to send plus the webhook payload shape (`response_json`) where QuickBooks' answer arrives — resolving the apparent 'create' vs. read-only tension. It also enumerates a large error taxonomy with codes and types. It does not cover auth/permission prerequisites directly (only via error codes like 3260/3262) or timeout behavior for the async webhook.

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 first two sentences are front-loaded and efficient, and the return-mechanics sentence earns its place. The trailing error catalogue is a single run-on parenthetical of ~20 code/name pairs that is hard to scan and largely reiterates what the call result is promised to explain, diluting the signal.

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 return shape needn't be restated, and the build-request/send/webhook workflow is described. For a tool this complex — 11 parameters, nested objects, 18% coverage, two required fields with non-obvious semantics — the description is not complete enough to tell an agent how to populate `is_affecting_accounts` or the required line items.

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 18% across 11 parameters (two required), yet the description adds no meaning for any of them: `is_affecting_accounts`, `payroll_date`, `payroll_prior_payment_line_add`'s required sub-fields, and the `*_ref` list_id/full_name pairs are all unexplained. The single param it touches implicitly, request_id, is already documented in the schema. This leaves most of a nested, low-coverage schema uninterpreted.

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 names a concrete verb and resource: it 'builds a v2 payroll_prior_payment.create request' and also accepts the legacy qbXML `payroll_prior_payment_add` wrapper. This reveals something the name alone would not — that the tool compiles a request rather than performing the create. It never contrasts itself with the sibling find_payroll_prior_payments or the other create_* payment tools, so it stops short of full sibling differentiation.

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 only implicit: an agent infers 'use this when you need to construct a prior-payment create call', and the mention of the two accepted input shapes (v2 and qbXML) is a helpful choice signal. There is no explicit when-to-use, no when-not-to-use, no prerequisite statements (e.g. payroll subscription) and no routing to the find_/update_ siblings.

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