Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item payment

update_item_payment
Read-onlyIdempotent

For an ItemPaymentMod request, you can “set” the “Group with undeposited funds” radio button in QuickBooks by either attempting to clear the deposit_to_account_ref, or by specifying the account whose SpecialAccountType is UndepositedFunds for the deposit_to_account_ref.

The item_payment_mod 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, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 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

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": {
      "edit_sequence": "<edit_sequence>",
      "list_id": "<list_id>"
    },
    "name": "update_item_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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`.
edit_sequenceYes`edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`.
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

B3.4/5.0
Behavior4/5

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

Beyond the annotations it discloses important behavior: the call compiles and returns the v2 request to send plus the webhook payload where QuickBooks' answer arrives, and it enumerates the error codes/types the caller must handle. This is meaningful context the readOnly/idempotent hints do not convey. It does not contradict the readOnlyHint — the tool builds a request rather than mutating directly.

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 paragraph is dense but useful and front-loaded; the second is brief. The long inline enumeration of ~20 error codes consumes roughly half the text for low marginal value, especially since it notes 'the call result explains each'.

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?

For a 12-parameter nested-object tool with an output schema, the return behavior and error surface are covered, but the core purpose — which item-payment fields this updates and under what conditions — is never stated. An agent still has to lean heavily on the schema to understand the operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 92%, so the baseline is 3, but the description adds real meaning: it explains the semantics of `deposit_to_account_ref` in terms of the undeposited-funds radio button, and notes that the qbXML `item_payment_mod` wrapper is also accepted. These are behavioral nuances not present in the schema field descriptions.

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 never states plainly that this tool updates an existing item payment record; it opens by describing one narrow effect (setting the 'Group with undeposited funds' radio button on an ItemPaymentMod request). The verb/resource are inferable from the name and the ItemPaymentMod reference, but the specific scope of what can be updated is left implicit, and no sibling update_* tool is distinguished.

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?

It gives concrete operative guidance for one parameter — clear `deposit_to_account_ref`, or supply an account whose SpecialAccountType is UndepositedFunds — which tells the agent how to achieve a particular outcome. It offers no guidance on when to choose this tool over the many sibling update_item_* tools, and no prerequisites beyond the implicit edit_sequence requirement.

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