Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update deposit

update_deposit
Read-onlyIdempotent

Modifies an existing deposit.

The deposit_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_deposit"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAdditional information.
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.
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`.
currency_refNoA currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
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.
deposit_line_modNo
cash_back_info_modNoThis aggregate is included if there is cash back from this deposit. `account_ref` indicates where the cash back Amount is going (for example, into a petty cash account).
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.1/5.0
Behavior3/5

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

The description adds real context beyond the annotations: it states the qbXML `deposit_mod` wrapper is accepted and that the call returns the v2 request plus the webhook payload/status codes rather than executing anything directly, which reconciles with readOnlyHint=true. However, the opening sentence "Modifies an existing deposit" reads as an immediate mutation, so an agent must resolve that tension itself, and permission requirements (only listed as error codes) are not explained.

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 in one short sentence, but the bulk of the text is a 30-item error-code dump plus a convoluted parenthetical about response_json. The error list is arguably useful, yet it is unstructured prose where a compact reference would communicate the same and the return-shape sentence is hard to parse.

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, deeply nested mutation wrapper, the description covers the return channel and error taxonomy well, and an output schema exists so return values need no explanation. It still leaves unanswered whether the call itself applies the change or only emits a request, and what authorization is needed, which are the questions an agent most needs answered before calling.

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 83%, so the baseline is 3 and the description does not raise it: it never mentions `edit_sequence`, `txn_id`, `deposit_line_mod` choice sets, or `cash_back_info_mod`, all of which are documented in the schema instead. The `deposit_mod` note is about request format, not parameter meaning.

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?

"Modifies an existing deposit" gives a specific verb plus resource and the qualifier "existing" implicitly separates it from create_deposit. It is not differentiated against any other sibling by name, and the sentence never says what fields or aspects of the deposit can be modified, so it stops short of a 5.

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 statement of when to use this tool versus create_deposit or the many other update_* siblings, and no prerequisites are given (the requirement for a current edit_sequence is only visible in the schema). The agent has to infer usage entirely from the tool name and the word "existing".

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