Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create txn display

create_txn_display
Read-onlyIdempotent

A TxnDisplayAdd request opens a form within the QuickBooks UI for adding a transaction. You may optionally supply an entity reference to “prefill” certain forms.

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": {
      "txn_display_add_type": "<txn_display_add_type>"
    },
    "name": "create_txn_display"
  }
}

Input Schema

NameRequiredDescriptionDefault
entity_refNoA QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a BillToPayQuery message, `entity_ref` refers to the vendor name.
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_add_typeYesSpecifies the type of QuickBooks transaction for which to open an edit form in the QuickBooks UI.

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

A4/5.0
Behavior4/5

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

Substantial context beyond the annotations: it discloses that the call does not itself mutate data but returns a v2 request to send plus the webhook payload in which QuickBooks' answer arrives, and it enumerates 25 error codes grouped by error.code/error.type. That is consistent with readOnlyHint=true and destructiveHint=false. Minor gap: it doesn't say whether the form requires a live QuickBooks session or how long the webhook wait typically is.

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 two sentences are front-loaded and efficient, but the error-code block is a 25-item run-on that the description itself says is explained by the call result, so much of it does not earn its place. Structure is otherwise clean paragraphing.

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 present and errors documented, the description covers the non-obvious mechanics: compile-then-send, webhook arrival, and optional prefill. The main unaddressed question is which transaction types accept an entity_ref prefill, which the schema's enum of 20 types leaves ambiguous.

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 already 100%, so the baseline is 3, but the description adds real meaning the schema lacks: entity_ref is an optional 'prefill' for certain forms, and include_qbxml is explicitly scaffolding not part of the v2 request. That materially helps an agent decide what to send.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('opens a form within the QuickBooks UI for adding a transaction') and makes the crucial distinction from sibling create_* tools: this compiles a TxnDisplayAdd request rather than writing a record. The second sentence clarifies the return artifacts, so an agent can identify the tool without opening the schema.

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?

The description implies usage through the UI-form framing and notes the optional entity prefill, but never says when to choose this over create_bill/create_invoice/create_check or when a two-step request/webhook flow is appropriate. No explicit exclusions or prerequisites are given.

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