Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update txn display

update_txn_display
Read-onlyIdempotent

A TxnDisplayMod request opens a QuickBooks transaction within the QuickBooks UI for modification.

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, 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": {
      "txn_display_mod_type": "<txn_display_mod_type>",
      "txn_id": "<txn_id>"
    },
    "name": "update_txn_display"
  }
}

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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
txn_display_mod_typeYesThe type of QuickBooks transaction to open for modification in the QuickBooks UI. (`txn_id` specifies the particular 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

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuinely new behavior: the call does not perform the update itself but returns a v2 request to send and identifies response_json as the webhook payload where QuickBooks' answer arrives, plus a full error taxonomy with codes and types. It stops short of saying whether a human must complete the edit in the UI or what auth/permissions are implied beyond the 3260/3263 error names.

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 first sentence is well front-loaded and states the core action, but the parenthetical about response_json and status codes is awkwardly worded, and the tail is a 20-item error-code dump that mixes essential codes (3170 cannot_modify, 3200 stale_edit_sequence) with obscure subscription errors. Much of that list would read better as a pointer to the error reference.

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?

With an output schema and full annotation coverage, the description does what structured fields cannot: it explains the two-phase request/webhook flow and enumerates failure modes an agent must handle. The remaining gap is the interaction model — whether a user must be present in the QuickBooks UI for the modification to actually occur.

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% and the enum for txn_display_mod_type is self-explanatory, so the schema carries parameter meaning. The description adds nothing specific about any of the four parameters — notably it never explains include_qbxml's debugging role or how request_id relates to the webhook id it mentions. Baseline 3 applies when the schema does the heavy lifting.

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: it opens a QuickBooks transaction in the QuickBooks UI for modification via a TxnDisplayMod request, and returns the v2 request plus the webhook payload for the answer. That is far clearer than the title alone. It does not, however, distinguish this from the sibling create_txn_display or explain why you would pick this over a direct update_invoice/update_bill mutation tool, so it falls 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 Guidelines3/5

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

Usage is implied rather than stated: naming the QuickBooks UI as the place the modification happens tells an agent this is a display/interactive flow rather than a direct data mutation. There is no explicit when-to-use, no when-not-to-use, and no alternative sibling named (create_txn_display is the obvious contrast and is never mentioned).

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