Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payroll item company contribution

create_payroll_item_company_contribution
Read-onlyIdempotent

Builds a v2 payroll_item_company_contribution.create request.

The payroll_item_company_contribution_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_company_contribution"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
rateNoChoose at most one of: `rate`, or `rate_percent`.
limitNo
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`.
taxabilityNo
vendor_refNo
net_or_grossNo
rate_percentNoChoose at most one of: `rate`, or `rate_percent`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
limit_time_periodNo
calculated_based_onNo
expense_account_refYes
include_ret_elementNo
payment_template_refYes
liability_account_refYes
vendor_account_numberNo
is_tracked_by_cust_jobNo
w2_tracking_type_valueNo
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.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, but the description adds real context beyond them: it explains that the tool returns a v2 request to send plus a webhook payload/response_json, which resolves why a 'create' operation is marked readOnly. It also enumerates the error codes the call can surface, a behavior an agent would otherwise have to discover empirically, though each code is only named, not explained.

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 in the first sentence, but the bulk of the text is a 25-item error-code dump with no explanations, followed by a parenthetical about response_json that is dense and hard to parse. The error enumeration has some value but is disproportionate to the space it occupies relative to the missing parameter guidance.

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 need not be described, and the description does explain the build-then-send workflow. However, for a 21-parameter nested-object tool with 19% schema coverage, omitting all parameter meaning leaves a substantial hole that the definition never closes.

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 19% across 21 parameters, and the description adds nothing about any of them. Critical semantics such as the mutual exclusivity of rate and rate_percent, the role of include_qbxml, or what the four required refs must point to are either only in the schema or undocumented in both places.

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?

Names a specific verb and resource ('Builds a v2 payroll_item_company_contribution.create request') and clarifies that it composes a request rather than executing one, which an agent could not infer from the name alone. It does not distinguish itself from update_payroll_item_company_contribution or the other payroll-item create siblings, so the sibling differentiation is absent.

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 use this tool versus update_payroll_item_company_contribution, find_payroll_item_non_wages, or the sibling create_* variants. The only usage-shaped note is that the qbXML `payroll_item_company_contribution_add` wrapper is also accepted, which describes an input variant rather than a selection rule.

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