Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create AR refund credit card

create_ar_refund_credit_card
Read-onlyIdempotent

Adds a credit card refund transaction that is linked to one or more QuickBooks credit memo transactions. You can link the credit card refund to one or more of those credit transactions.

The ar_refund_credit_card_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>",
      "refund_applied_to_txn_add": "<refund_applied_to_txn_add>"
    },
    "name": "create_ar_refund_credit_card"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAdditional information.
addressNoIf an address request fails, some combination of address fields might be too long. In a Check, BillPaymentCheck, or SalesTaxPaymentCheck message, Address is the address that will print on the check.
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.
def_macroNo`def_macro` lets you assign a reusable name to a returned `txn_id` or TxnLineID so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
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`.
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.
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.
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.
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
credit_card_txn_infoNoContains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction.
refund_from_account_refNoIn an ARRefundCreditCardAdd, the account which is the source of funds for the credit card refund. Normally this is Undeposited Funds. However, you can specify another account if you wish.
refund_applied_to_txn_addYes

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.6/5.0
Behavior1/5

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

The description explicitly describes a mutating operation ('Adds a credit card refund transaction'), while the annotations declare readOnlyHint=true and idempotentHint=true. That is a direct contradiction, and although the description does add useful behavior detail (returns the v2 request plus the webhook payload, lists error codes), the safety profile the agent will rely on is contradicted.

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 purpose and return-shape sentences are front-loaded and useful, but roughly half the text is a flat list of 24 numeric error codes whose meanings are delegated to 'the call result explains each', which is low-value token bulk rather than actionable structure.

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

Completeness2/5

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

For a 16-parameter nested mutation with an output schema, the definition should at minimum state prerequisites (existing credit memos), what permissions or QBMS/payment setup are needed, and the effect of a partially valid refund_applied_to_txn_add list. It instead leans on a generic error-code dump and never addresses these call-shape risks.

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 88%, so nearly every one of the 16 parameters (customer_ref, refund_applied_to_txn_add, credit_card_txn_info, refund_from_account_ref, etc.) is documented in the schema itself. The description adds no meaning about requiredness, constraints, or how refund_applied_to_txn_add entries must match the credit memos, so the baseline 3 applies.

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 opens with a specific verb and resource: 'Adds a credit card refund transaction that is linked to one or more QuickBooks credit memo transactions.' It also clarifies the linkage scope and notes the qbXML wrapper alias, but it never names a sibling (e.g. create_credit_card_credit or find_ar_refund_credit_cards) to distinguish when this tool is the right one.

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 explicit when-to-use or when-not-to-use statement, no prerequisite (e.g. that the referenced credit memos must exist), and no comparison with the closely related create_credit_card_credit or find_ar_refund_credit_cards tools. Usage is only inferable from the purpose sentence.

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