Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create credit memo

create_credit_memo
Read-onlyIdempotent

Adds a credit memo: an amount the business owes a customer, for returned goods, an overpayment or a prepayment. It lowers the customer's balance, but isn't set against an invoice until a payment or the invoice applies it. customer_ref is required, and lines go in credit_memo_line_add. What a vendor owes the business is a vendor credit, not a credit memo.

The credit_memo_add 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, 3175 in_use, 3176 locked, 3180 cannot_save, 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, 3270 missing_posting_account

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": {
      "customer_ref": "<customer_ref>"
    },
    "name": "create_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.
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.
def_macroNo`def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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_refYes`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.
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.
external_guidNoAllows for the attachment of a user defined GUID value.
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.
discount_line_addNo
shipping_line_addNo
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.
sales_tax_line_addNo
include_ret_elementNo
credit_memo_line_addNoRepresents one line in the credit memo. Compare with CreditMemoGroupLine, which represents a previously defined group of lines in the credit memo. At least one entry is required across `credit_memo_line_add` and `credit_memo_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `credit_memo_line_add`, then every `credit_memo_line_group_add`.
credit_memo_line_group_addNoRepresents a previously defined group of lines in the credit memo. Compare with CreditMemoLine, which represents just one line in the credit memo. At least one entry is required across `credit_memo_line_add` and `credit_memo_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `credit_memo_line_add`, then every `credit_memo_line_group_add`.
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

A4.2/5.0
Behavior4/5

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

With readOnlyHint/idempotentHint already supplied, the description still adds real behavioral content: the memo lowers the customer's balance but is not applied to an invoice until payment or the invoice applies it, the qbXML credit_memo_add wrapper is accepted, and a 20-code error taxonomy (1030 unsupported_request, 3180 cannot_save, 3263 read_only_access, etc.) is disclosed. The residual tension is that 'Adds a credit memo' reads as a write while annotations declare readOnlyHint=true; the second paragraph's 'Returns the v2 request to send' partially reconciles this, but the description never states outright whether it commits the write or only compiles the request.

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 first paragraph is front-loaded and dense with the highest-value information: definition, balance effect, deferral semantics, required param, and the vendor-credit disambiguation. The second paragraph is well organized around wrapper aliases, return shape, and errors, though the flat enumeration of twenty error codes is long relative to the rest and could have been summarized into categories.

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?

For a 35-parameter tool with deep nested objects, only customer_ref required, an output schema, and full annotations, the definition covers every axis an agent needs: what it creates, the required minimum, where lines go, the accepted legacy wrapper name, and the failure modes to handle. Return values need no explanation because the output schema exists.

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 89%, so the schema already documents nearly all 35 parameters, making 3 the baseline. The description adds only two facts beyond it: customer_ref is mandatory and line items go in credit_memo_line_add, while other meaningful semantics (the discount_line_add/sales_tax_line_add amount-vs-rate exclusivity, the 'at least one line across line_add and line_group_add' rule) are left entirely to the schema.

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

Purpose5/5

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

Names a specific verb and resource ('Adds a credit memo'), then defines the accounting object precisely: an amount the business owes a customer for returns, overpayment, or prepayment. It also draws an explicit boundary against the sibling concept 'what a vendor owes the business is a vendor credit, not a credit memo', so an agent can route between create_credit_memo and create_vendor_credit without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

Gives concrete call-shaping conditions: customer_ref is required, lines belong in credit_memo_line_add, and vendor-side credits use a different tool. It does not say when to prefer this over update_credit_memo or how it relates to a preceding invoice, and it omits that credit_memo_line_group_add is an alternative line source, so the routing guidance is clear but not exhaustive.

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