Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update invoice

update_invoice
Read-onlyIdempotent

Changes an invoice. Send its txn_id and the edit_sequence QuickBooks last returned for it. To change a line, send it in invoice_line_mod with its txn_line_id; to add a line, send txn_line_id -1. Some fields can't be cleared: if you send customer_ref, txn_date, due_date, or a line's item_ref, quantity, rate or amount, it must have a value.

The invoice_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_invoice"
  }
}

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 invoice.
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_dateNoIf `due_date` isn’t included in an InvoiceAdd request, QuickBooks might determine the due date according to the terms set for this customer.
txn_dateNoThe date of the invoice. If you leave `txn_date` out of an InvoiceAdd message, QuickBooks might prefill it with the date of the invoice that was most recently saved.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
po_numberNoPurchase order number.
ship_dateNoThe date when the product was, or will be, shipped.
terms_refNoRefers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms list.)
is_pendingNoIf `is_pending` is set to true, the invoice hasn’t been completed. Pending sales might include unpaid orders, estimates, tracked hours that haven’t yet been billed, or sales of back-ordered items.
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`.
set_creditNo
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).
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.
ar_account_refNo`ar_account_ref` points to an Accounts Receivable account. If both `full_name` and `list_id` are provided, `full_name` is ignored.
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.
invoice_line_modNoRepresents one line in the invoice. Compare with InvoiceLineGroup, which represents a previously defined group of lines in the invoice. `invoice_line_mod` and `invoice_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `invoice_line_mod`, then every `invoice_line_group_mod`.
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.
include_ret_elementNo
invoice_line_group_modNoRepresents a previously defined group of lines in the invoice. Compare with InvoiceLine, which represents just one line in the invoice. `invoice_line_mod` and `invoice_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `invoice_line_mod`, then every `invoice_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.)

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

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

The description adds substantial behavior beyond the annotations: it names non-clearable fields (`customer_ref`, `txn_date`, `due_date`, and line `item_ref`/`quantity`/`rate`/`amount`), explains the `-1` convention for adding lines, notes the `invoice_mod` wrapper is accepted, and enumerates 28 concrete error codes. One tension: annotations declare `readOnlyHint: true` while the prose says "Changes an invoice," though "Returns the v2 request to send" clarifies the tool compiles a request rather than mutating directly, so this is an ambiguity rather than a contradiction.

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 guidance is front-loaded in the first two sentences, and the return-value explanation follows before the error list. The 28-item error enumeration is the longest block and is arguably reference material that could be compressed, but it is still scannable and each item is a real call outcome.

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 33-parameter tool with nested line aggregates, the description covers the parts most likely to cause a failed call: required revision token, line addressing, non-clearable fields, and error taxonomy. An output schema exists and the description still correctly frames the return as a v2 request plus a webhook payload, so little is missing beyond explicit sibling routing.

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 94%, so the baseline is 3, and the description earns above that by explaining the two required identity parameters' roles (`edit_sequence` as the revision token QuickBooks returned) and the line-level conventions that the flattened schema does not make obvious (`txn_line_id` per line, `-1` to add). It does not attempt to cover the many optional top-level fields, which is acceptable given the schema descriptions.

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 ("Changes an invoice") and immediately narrows to the mechanics: `txn_id` plus `edit_sequence`, line modification via `invoice_line_mod`, and adding a line with `txn_line_id` `-1`. That distinguishes it from `create_invoice` implicitly, but it never explicitly contrasts with sibling update tools such as `update_credit_memo`.

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: you send an `edit_sequence` "QuickBooks last returned for it," which tells the agent this is for modifying an existing invoice. There is no explicit when-not guidance, no mention of prerequisites (locking, permissions, closing dates) as selection criteria, and no reference to an alternative tool for a different case.

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