Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item direct deposit

create_payroll_item_direct_deposit
Read-onlyIdempotent

Builds a v2 payroll_item_direct_deposit.create request.

The payroll_item_direct_deposit_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>"
    },
    "name": "create_payroll_item_direct_deposit"
  }
}

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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
liability_account_refYes
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.1/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true and destructiveHint=false, and the description is consistent with that: the tool builds a request rather than performing the write, so nothing is mutated server-side. It goes meaningfully beyond the annotations by disclosing that it returns both the v2 request and the webhook payload shape QuickBooks' answer arrives in, plus a detailed error-code catalog — though it leaves idempotentHint unaddressed and does not say whether an outbound call is ever made.

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 lead sentences are front-loaded and efficient, and the request/webhook framing is well placed. The 20-plus-entry error-code enumeration, however, consumes most of the text and would be better surfaced in the output schema or linked documentation, so the piece is longer than its decision-relevant content warrants.

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 values needn't be re-explained, and the error enumeration plus the webhook-payload hint cover the failure and response sides well. The gap is on the input side: for a 7-parameter tool with nested objects and thin schema coverage, the description supplies no field-level semantics, leaving an agent to guess at required references and the meaning of payroll_item_detail_type_value.

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 29% (7 parameters, only request_id and include_qbxml documented in the schema), so the description carries the burden of explaining the rest and does not. It never mentions liability_account_ref, name, is_active, payroll_item_detail_type_value, or the nested list_id/full_name structure of the account reference, all of which an agent must infer from the schema alone.

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?

Opens with a specific verb and resource: 'Builds a v2 payroll_item_direct_deposit.create request,' which tells an agent exactly what artifact is produced and for which QuickBooks entity. It stops short of distinguishing this from the update_payroll_item_direct_deposit sibling or explaining the create-vs-update split.

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 statement of when to reach for this tool versus update_payroll_item_direct_deposit or the other payroll item creators. The only usage-adjacent note is that the qbXML `payroll_item_direct_deposit_add` wrapper is also accepted, which is an input-compatibility remark rather than selection 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