Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update credit memo

update_credit_memo
Read-onlyIdempotent

Some fields in a CreditMemoMod request can’t be cleared. If any of the following fields is included in a credit-memo modify request, it must contain a value:

The credit_memo_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_credit_memo"
  }
}

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.
memoNoThe memo doesn’t print on the credit memo, but does appear in the account register and the customer register.
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_dateNoThe date on which payment is due.
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.
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 credit memo 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).
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.
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
credit_memo_line_modNoRepresents one line in the credit memo. Compare with CreditMemoGroupLine, which represents a previously defined group of lines in the credit memo. `credit_memo_line_mod` and `credit_memo_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `credit_memo_line_mod`, then every `credit_memo_line_group_mod`.
credit_memo_line_group_modNoRepresents a previously defined group of lines in the credit memo. Compare with CreditMemoLine, which represents just one line in the credit memo. `credit_memo_line_mod` and `credit_memo_line_group_mod` combine: any number of each. QuickBooks receives them in that order: every `credit_memo_line_mod`, then every `credit_memo_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

C2.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and idempotentHint=true, so the safety profile is covered. The description does add genuinely useful behavior beyond them — it discloses that the tool returns the v2 request to send plus the webhook payload in which QuickBooks' answer arrives, and it catalogs the error codes the caller must handle. However, the leading constraint about fields that cannot be cleared is broken (the field list is missing), which is exactly the behavioral detail an agent most needs.

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?

It is compact for a 32-parameter tool and the error catalog earns its place, but the structure is broken: it opens with a caveat and a colon that leads nowhere instead of front-loading the purpose. The core behavior (request compilation + webhook response) is buried in the middle sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, annotations cover safety, and schema coverage is near-total, so the description needn't restate fields or return shapes. What it must add — the asynchronous compile-request/receive-webhook model and the failure modes — is present, making it complete enough to call correctly despite the truncated caveat.

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 coverage is 97%, so parameters are already well documented and the baseline of 3 applies. The description adds only the note that a bare `credit_memo_mod` qbXML wrapper is accepted; it adds no meaning about the 32 top-level params, the required pair, or the line-mod arrays.

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

Purpose2/5

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

The description never plainly states that this tool modifies an existing credit memo; the operation is only implied by the phrase "credit-memo modify request," and the opening sentence is a dangling caveat that promises "the following fields" that are never listed. The tool's identity is being carried by the title, and nothing distinguishes it from the sibling create_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 Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no prerequisites (an edit_sequence and txn_id are required and the schema calls edit_sequence a concurrency token, but the description never says so), and no mention of create_credit_memo as the alternative for new memos. The agent is left to infer that this tool applies to existing records only.

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