Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update sales receipt

update_sales_receipt
Read-onlyIdempotent

Modifies an existing Sales receipt.

The sales_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_sales_receipt"
  }
}

Input Schema

NameRequiredDescriptionDefault
fobNoQuickBooks uses the term FOB, “freight on board,” to indicate the place from which the product is shipped. The FOB has no accounting implications.
memoNoMessage that appears in reports, but not on the sales receipt.
otherNoOther, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level.
txn_idYes`txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests.
due_dateNoA sales receipt doesn’t ordinarily include a due date, because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase.
txn_dateNoThe date of the sales receipt. 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.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
ship_dateNoThe date when the product was, or will be, shipped.
is_pendingNoIf `is_pending` is set to true, the sales receipt hasn’t been completed.
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`.
bill_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
check_numberNoThe check number of a check that a QuickBooks user writes or receives from someone else.
customer_refNo`customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit.
ship_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
template_refNoQuickBooks templates specify how to print certain transactions. A template query returns the names of all templates that have been defined in QuickBooks.
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.
sales_rep_refNoA sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms.
is_tax_includedNoFor future use with international versions of QuickBooks.
ship_method_refNoA shipping method, for example, standard mail or overnight delivery. A `ship_method_ref` aggregate refers to an item on the ShipMethod list.
customer_msg_refNoA standard message such as “Thank you for your business,” or “Please sign and return this estimate to indicate your approval.” A customer message can be included at the bottom of a form.
is_to_be_emailedNoWhen enabled, QuickBooks validates the customer email at runtime before sending. If no valid email is available, the request fails.
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.
item_sales_tax_refNoAn ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead.
payment_method_refNo`payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored.
include_ret_elementNo
deposit_to_account_refNoRefers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request.
sales_receipt_line_modNoOne line of the sales receipt. Compare with SalesReceiptLineGroup, which represents a previously defined group of lines in the sales receipt. `sales_receipt_line_mod` and `sales_receipt_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `sales_receipt_line_mod`, then every `sales_receipt_line_group_mod`.
customer_sales_tax_code_refNoRefers to the sales-tax code for sales related to this customer. (That is, it refers to a member of the SalesTaxCode list.)
sales_receipt_line_group_modNoRepresents a previously defined group of lines in the sales receipt. Compare with SalesReceiptLine, which represents just one line in the sales receipt. `sales_receipt_line_mod` and `sales_receipt_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `sales_receipt_line_mod`, then every `sales_receipt_line_group_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.7/5.0
Behavior1/5

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

The description leads with "Modifies an existing Sales receipt," a state-changing operation, while the annotations declare readOnlyHint=true and destructiveHint=false. Even if the intent is that the tool only compiles a v2 request for later submission, the description never reconciles that with the word "Modifies," leaving the agent unable to tell whether data is actually written. This is a direct annotation conflict.

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 opening sentence is front-loaded and efficient, and the second sentence usefully explains the async webhook delivery model. However, the 25-code error enumeration dominates the description and largely duplicates what "the call result explains each" already covers, so it is bulky rather than wasteful.

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 a 32-parameter nested mutation tool, the description does cover error handling and how the result is delivered (v2 request plus webhook payload), and an output schema exists so return shapes need no elaboration. It still omits the edit_sequence concurrency requirement and any statement of side effects, and it conflicts with its own annotations.

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 97%, so nearly every one of the 32 parameters is already documented in the schema and baseline 3 applies. The description adds only one input-side fact — that the qbXML `sales_receipt_mod` wrapper is accepted — without explaining line-vs-group ordering, the rate/rate_percent/price_level_ref exclusivity, or the required edit_sequence.

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 Sales receipt" gives a specific verb (modify) and resource (Sales receipt), which separates it from the many create_/find_ siblings in the catalog. It does not name any sibling explicitly, and the follow-on sentence about the qbXML wrapper and returned v2 request muddies whether the tool applies the change itself or only compiles a request.

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?

The description says what it does but never says when to pick it over create_sales_receipt, find_sales_receipts, or update_sales_order. Prerequisites that select correct use — notably that the current edit_sequence must be supplied and that stale tokens fail with 3200 — are only implied by the error list, not stated as guidance.

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