Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create item payment

create_item_payment
Read-onlyIdempotent

For an ItemPaymentAdd request, you can “set” the “Group with undeposited funds” radio button in QuickBooks either by not specifying deposit_to_account_ref at all, or by specifying the special UndepositedFunds account for the deposit_to_account_ref.

The item_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, 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": {
      "name": "<name>"
    },
    "name": "create_item_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
bar_codeNoBarcode reference information.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
item_descNoThe description that will appear on a sales form when the item is used.
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`.
external_guidNoAllows for the attachment of a user defined GUID value.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
payment_method_refNo`payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
include_ret_elementNo
deposit_to_account_refNoRefers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request.

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

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

Beyond the annotations, the description discloses the key mechanic that this tool compiles and returns a v2 request plus the webhook payload shape in which QuickBooks' answer arrives — that reconciles with readOnlyHint=true since no synchronous write happens. It also enumerates the concrete error codes/types the caller must handle, which is genuinely useful behavioral context. It stops short of stating whether the prepared request is sent automatically or by the caller.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The paragraph is not front-loaded: it leads with an obscure field-level edge case instead of what the tool does. Roughly half the text is a twenty-entry error-code dump that dominates the definition, and useful mechanics (return shape, webhook) are buried after it.

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?

With an output schema present and 91% parameter coverage, the remaining burden on the description is small, and it does cover the request/webhook round-trip and error surface. However, for a create tool named create_item_payment it never clarifies the actual object being created or how it relates to the many sibling create_item_* tools.

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 coverage is 91%, so the schema already carries most parameter meaning and the baseline is a 3. The description adds a nuance about `deposit_to_account_ref` (omitting it versus passing UndepositedFunds both set the same radio button) and notes the qbXML wrapper acceptance, but this largely restates what the schema's own description says about the Undeposited Funds default.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description references an 'ItemPaymentAdd request' and the `item_payment_add` qbXML wrapper, which implies a create operation for an item payment, but it never states plainly what the tool produces at the business level (an item-based payment record). The opening sentence is a niche edge case about the 'Group with undeposited funds' radio button rather than a purpose statement, so the agent must infer intent. Sibling tools like record_payment and create_item_* are neither mentioned nor differentiated.

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 guidance: nothing says under what circumstances to pick this over record_payment or update_item_payment, and no prerequisites or exclusions are given. The only conditional guidance is about the `deposit_to_account_ref` field, which is parameter-level, not tool-selection-level.

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