Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update cleared status

update_cleared_status
Read-onlyIdempotent

Changes the cleared status of a transaction.

The cleared_status_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, 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": {
      "cleared_status": "<cleared_status>",
      "txn_id": "<txn_id>"
    },
    "name": "update_cleared_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
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`.
txn_line_idNoIdentification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.)
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
cleared_statusYesIndicates whether a transaction or transaction line has been cleared.

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?

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so safety is covered; the description adds real value beyond that by disclosing that it returns a compiled v2 request plus the webhook payload the QuickBooks answer arrives in, and that a qbXML wrapper alias is accepted. It also enumerates the concrete failure codes (stale_edit_sequence, locked, in_use, not_authorized, etc.) an agent may encounter. The opening 'Changes the cleared status' reads like a write against readOnlyHint=true, but the following paragraph clarifies the tool only compiles a request, so this is a tension rather than a contradiction.

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 purpose and the request/webhook mechanics are front-loaded and useful, but roughly half the text is a flat list of seventeen error codes that the description itself says are explained by the call result, so the list earns little of its length. The phrasing of the return-value sentence ('the webhook payload QuickBooks' answer arrives in') is also awkward and requires re-reading.

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?

An output schema exists, so the description needn't explain return values, and it still sketches the request/webhook delivery model and enumerates error codes. Combined with thorough annotations and fully described parameters, an agent has enough to call it correctly, with the main remaining gap being preconditions such as required authorization or edit-sequence state.

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 100%, with all five parameters documented and the cleared_status enum spelled out, so the baseline is 3. The description adds no parameter-level meaning beyond mentioning the `cleared_status_mod` alias, leaving the schema to carry the parameter burden entirely.

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 is a specific verb+resource: changes the cleared status of a transaction, scoped narrowly to one field of one entity type. That distinguishes it from the many sibling update_* tools, which target different resources (accounts, bills, invoices). It stops short of 5 because it never states that the tool only builds a request rather than performing the write, which is the real purpose implied by the second paragraph.

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 when-to-use, when-not-to-use, or prerequisite guidance: nothing about needing an existing txn_id, about edit-sequence/conflict handling, or about how this differs from any sibling update tool. The only usable guidance is a note that the qbXML `cleared_status_mod` wrapper alias is accepted. An agent must infer everything about invocation context from the name.

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