Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update receive payment

update_receive_payment
Read-onlyIdempotent

Modifies a receive payment transaction. If you save QBMS credit card data in your ReceivePayments, this Mod request allows you to capture a previously authorized credit card charge. The way this works is that the ReceivePaymentAdd would contain the QBMS credit_card_txn_info aggregate with the credit_card_txn_type set to “Authorization,” which causes QB to internally mark the transaction as pending.

The receive_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, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3171 closing_date_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>",
      "txn_id": "<txn_id>"
    },
    "name": "update_receive_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoThe beginning of this memo will appear in reports that show details of this receive payment.
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
txn_dateNoThe date of the transaction. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type.
ref_numberNo`ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique.
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`.
customer_refNo`customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit.
total_amountNoTotal amount of money received.
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`.
exchange_rateNo`exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
ar_account_refNo`ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
applied_to_txn_modNo
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.
credit_card_txn_info_modNoContains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction.

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.2/5.0
Behavior2/5

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

The description's opening claim that it "Modifies a receive payment transaction" conflicts with the supplied readOnlyHint=true. It does partially reconcile by explaining that the tool returns the v2 request to send plus the webhook payload shape and status codes, which is genuinely useful context, but the mutation framing in the first sentence leaves an agent uncertain whether state changes on invocation.

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?

Purpose is front-loaded and the deferred-execution model is stated compactly, but the description then spends most of its length on a 22-item error-code enumeration that it immediately declares redundant ("the call result explains each"). That list crowds out guidance that would have been more valuable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 16-parameter, deeply nested mutation-style tool with an output schema, the description covers the two things the schema cannot: the deferred request/webhook roundtrip and the error surface. Remaining gaps are behavioral (permission requirements, what happens to unspecified fields on mod) rather than structural.

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 description coverage is 88%, so the schema already documents nearly every field, including required edit_sequence and txn_id. The description adds domain context for the credit_card_txn_info_mod path (setting credit_card_txn_type to Authorization marks the transaction pending) but says nothing about the other 15 parameters, so it does not meaningfully exceed the schema baseline.

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 first sentence names a specific verb and resource ("Modifies a receive payment transaction") and the rest explains the QBMS capture scenario concretely, so an agent knows exactly what the tool operates on. It does not, however, distinguish itself from siblings like record_payment, update_deposit, or find_receive_payments, leaving that routing to inference.

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 supplies one clear usage scenario: when QBMS credit card data is stored on a ReceivePayment, this Mod request captures a previously authorized charge. There are no exclusions, no prerequisites (e.g. needing the current edit_sequence), and no pointer to an alternative tool for ordinary payment edits, so guidance is implied rather than explicit.

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