Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Find receive payment to deposits

find_receive_payment_to_deposits
Read-onlyIdempotent

This query returns information about payments that have been received and are ready to deposit. You can use any returned txn_id and txn_line_id elements as PaymentTxnID and PaymentTxnLineID elements in subsequent DespositAdd requests. Note: If you include an explicit end tag in a ReceivePaymentToDepositQuery request, you will receive an error if there is any space between the opening tag and the end tag. The following table shows valid and invalid ways of constructing this request:

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, 3150 missing_element, 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, 3264 merchant_services_subscription_required

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "find_receive_payment_to_deposits"
  }
}

Input Schema

NameRequiredDescriptionDefault
meta_dataNoUse the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects).
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
queryYesThe query parameters: the arguments you passed.
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.6/5.0
Behavior4/5

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

Annotations already establish safety (readOnly, idempotent, non-destructive), and the description adds beyond them by disclosing that the response is the v2 request plus the webhook payload, and by enumerating the specific error codes and types the caller must handle. Some of the added text (the qbXML end-tag spacing quirk) is legacy-context noise and slightly muddies rather than clarifies behavior.

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 purpose is front-loaded, but the middle is broken: 'The following table shows valid and invalid ways of constructing this request:' is followed by no table, leaving a dangling reference. The nine-error-code run-on and the leftover qbXML end-tag caveat consume substantial space without helping an agent invoke the tool.

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 and the description correctly points at the v2 request, webhook payload, and status codes to handle, so return values need not be restated. However, the truncated table reference is a real completeness defect, and nothing is said about the one undocumented parameter or about result limits.

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 75%, so the schema already documents meta_data, request_id, and include_qbxml; only include_ret_element lacks a schema description. The description adds no parameter-level meaning at all, so it does not compensate for the one gap, and by the stated baseline this lands at the minimum viable level.

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 description states a specific verb and resource: a query returning payments received and ready to deposit, and it names the key returned fields (txn_id, txn_line_id). It does not explicitly distinguish this from siblings such as find_receive_payments or find_deposits, so the agent must infer the boundary from the word 'to_deposits' in the name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives a concrete downstream use case: use the returned txn_id/txn_line_id as PaymentTxnID/PaymentTxnLineID in subsequent DepositAdd requests, which tells the agent exactly why and when to call this. It stops short of naming when-not-to-use conditions or pointing at a sibling for the filtered case.

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