Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update check

update_check
Read-onlyIdempotent

Modifies an existing Check. Notice that you can’t use this to modify BillPaymentChecks.

The check_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_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoThe memo that is printed on the check itself.
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
addressNoIf an address request fails, some combination of address fields might be too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the address that will print on the check.
txn_dateNoThe date written on the check. 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.
ref_numberNo`ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique.
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`.
account_refNo`account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored.
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.
item_line_modNoAn ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” `item_line_mod` and `item_group_line_mod` combine: any number of each. QuickBooks receives them in that order: every `item_line_mod`, then every `item_group_line_mod`.
is_tax_includedNoFor future use with international versions of QuickBooks.
clear_item_linesNoSet `clear_item_lines` to true to clear all the item lines. To modify individual lines, use `item_line_mod`.
expense_line_modNo
is_to_be_printedNoIf `is_to_be_printed` is true, QuickBooks queues the form for later printing. It does not print immediately; printing is still a user action in QuickBooks.
payee_entity_refNo`payee_entity_ref` identifies the payee (customer, vendor, employee, or Other Name). If both `full_name` and `list_id` are provided, `full_name` is ignored.
sales_tax_code_refNo`sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it.
clear_expense_linesNoSet `clear_expense_lines` to true to clear all the expense lines. To modify individual lines, use `expense_line_mod`.
include_ret_elementNo
item_group_line_modNoRefers to items that are grouped together in QuickBooks for fast entry. `item_line_mod` and `item_group_line_mod` combine: any number of each. QuickBooks receives them in that order: every `item_line_mod`, then every `item_group_line_mod`.
apply_check_to_txn_modNo

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.5/5.0
Behavior3/5

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

The description adds genuinely useful behavior beyond the annotations: it explains that the call compiles a v2 request and that the QuickBooks answer arrives via webhook in response_json, that the qbXML check_mod wrapper is accepted as an alias, and it enumerates the error codes to handle (notably 3200 stale_edit_sequence and 3176 locked). However, the stated purpose ("Modifies an existing Check") sits in tension with readOnlyHint=true; the request-builder framing partially reconciles this, but the description never explicitly says the mutation is deferred to the caller, and it does not say whether omitted fields are left untouched or cleared.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and well-structured: mutation scope first, then the exclusion, then the response flow, then errors. The only cost is the long enumeration of twenty error codes, which is dense but scannable and does map to the promised response handling.

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?

For a 21-parameter mutation tool with nested line-modification aggregates, the description covers scope, the sibling exclusion, the qbXML alias, the asynchronous response path, and an error catalog; the output schema means return shape need not be restated. Remaining gaps are the read-only-versus-mutation ambiguity and no statement about partial-update semantics for lines and fields.

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 86%, so the schema already carries nearly all parameter meaning, including edit_sequence's role as a revision token and the clear_item_lines/clear_expense_lines semantics. The description contributes nothing parameter-specific beyond the qbXML alias note, so the baseline of 3 applies.

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 pairs a specific verb with a specific resource ("Modifies an existing Check") and immediately carves out the closely related BillPaymentCheck type, which is exactly the sibling confusion an agent would have given update_bill_payment_check and update_sales_tax_payment_check exist. It stops short of naming the tool to use instead for those types, but the operation and its boundary are unambiguous.

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?

There is a clear exclusion (no BillPaymentChecks) but no positive when-to-use guidance, no mention that an existing txn_id plus current edit_sequence is a prerequisite, and no routing to create_check versus this tool. The agent must infer from the name and schema that this is the modify path for an already-existing check.

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