Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update item receipt

update_item_receipt
Read-onlyIdempotent

Modifies an existing item receipt.

The item_receipt_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_item_receipt"
  }
}

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.
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`.
vendor_refNoA vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.)
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`.
ap_account_refNoRefers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.)
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
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`.

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

C2.8/5.0
Behavior1/5

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

The description opens with "Modifies an existing item receipt", a mutation claim, while the annotations declare readOnlyHint=true and idempotentHint=true. The later sentence about returning the v2 request to send partially explains the read-only framing, but the leading sentence still reads as a direct write and the definition never reconciles the two.

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?

The core purpose is front-loaded in one sentence, followed by compact notes on the return shape. The 20-entry error-code enumeration is long but well-structured and genuinely useful for handling failures, so it mostly earns its space.

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 an 18-parameter mutation with nested line objects and an output schema, the description covers return routing and error codes but omits the concurrency contract (stale_edit_sequence implies edit_sequence is required), line-clearing semantics, and permissions. Adequate but with real gaps an agent would hit on first call.

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 89%, so the schema already documents nearly every parameter including edit_sequence, txn_id, and the line-mod arrays. The description adds only that a `item_receipt_mod` qbXML wrapper is accepted; it says nothing about the clear_item_lines vs item_line_mod interplay or other parameter behavior.

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 item receipt" gives a specific verb and resource, and the qbXML alias note clarifies that an `item_receipt_mod` wrapper is accepted. It stops short of differentiating this from the adjacent create_item_receipt / update_sales_receipt siblings.

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 choose this tool over create_item_receipt or update_sales_receipt, and no mention of prerequisites such as needing the current `edit_sequence` or an existing `txn_id`. Usage must be inferred entirely from the name and schema.

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