Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Record payment

record_payment
Read-onlyIdempotent

Records a customer's payment. Set customer_ref, total_amount and either is_auto_apply (true: to an invoice of that exact amount, else the oldest; false: to none) or applied_to_txn_add: each invoice's txn_id and amount, at most what it owes (more fails with 3210 invalid_value); the rest is unused_payment. A line can also apply a credit memo (set_credit); a total_amount of 0 that only does that creates no payment and answers just each invoice's txn_id and txn_type. Without ref_number a payment gets no number; without deposit_to_account_ref it goes to Undeposited Funds.

The receive_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, 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": {
      "customer_ref": "<customer_ref>"
    },
    "name": "record_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoThe beginning of this memo will appear in reports that show details of this receive payment.
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.
def_macroNo`def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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_refYes`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.
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.
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.
is_auto_applyNoIf `is_auto_apply` is true, QuickBooks applies `total_amount` to any outstanding transaction that exactly matches `total_amount`. Choose exactly one of: `is_auto_apply`, or `applied_to_txn_add`.
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_addNoChoose exactly one of: `is_auto_apply`, or `applied_to_txn_add`.
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
credit_card_txn_infoNoContains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction.
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

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=false, and the description reconciles that with the mutating-sounding name by stating it "Returns the v2 request to send, and the webhook payload" — clarifying this is a request-builder rather than an executor. On top of that it discloses non-obvious behavior: auto-apply falls back to the oldest invoice, over-allocation fails with 3210 `invalid_value`, a zero `total_amount` with only `set_credit` creates no payment, and the Undeposited Funds default. The long raw error-code list adds less value since it says the call result explains each.

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 opening is well front-loaded and the allocation rules are dense but earned. However, the second paragraph devotes most of its length to an undifferentiated dump of 28 error codes and a passing mention of the qbXML wrapper, which buries the two high-value facts (the returned v2 request and the webhook response shape) that an agent actually needs.

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 17-parameter tool with deep nesting and an output schema, the description covers the genuinely confusing parts: the exclusive choice between auto-apply and explicit application, allocation caps, credit memos, and the fact that results arrive via a webhook payload rather than a direct return. Only prerequisites and the update-versus-create decision are missing.

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 94%, so the baseline is 3, but the description adds genuine meaning beyond the schema: `is_auto_apply` false means "to none", `applied_to_txn_add` is capped at what the invoice owes (more fails with 3210), and `set_credit` combined with a zero `total_amount` creates no payment. It also documents two defaults (`ref_number` absent, `deposit_to_account_ref` absent) that the schema only partly encodes.

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 ("Records a customer's payment") and the body goes on to describe the allocation semantics precisely. It never names a sibling such as update_receive_payment or create_credit_memo, so an agent cannot tell from the description alone which tool to pick when a payment already exists.

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?

Usage is implied rather than stated: the description explains that you must choose exactly one of `is_auto_apply` or `applied_to_txn_add`, which guides invocation but is a schema constraint restated, not when-to-use guidance. There is no when-not-to-use, no prerequisite (customer must exist, permissions), and no routing to alternatives for updating versus creating a payment.

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