Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create vendor credit

create_vendor_credit
Read-onlyIdempotent

Adds a vendor credit. A vendor credit is also known as a “bill credit”. That is, it is a credit that a vendor owes you because you overpaid your bill, returned merchandise, or for some other reason. The VendorCredit is referenced in a BilPayment transaction, inside the SetCredit aggregate. A VendorCredit shouldn’t be confused with a Credit Memo, which is something you owe your customer and which is referenced in a ReceivePayment request.

The vendor_credit_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": {
      "vendor_ref": "<vendor_ref>"
    },
    "name": "create_vendor_credit"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAppears in the A/P register and in reports that include this credit.
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 `txn_line_id` 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`.
vendor_refYesA vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.)
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.
item_line_addNoAn ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” `item_line_add` and `item_group_line_add` combine: any number of each. QuickBooks receives them in that order: every `item_line_add`, then every `item_group_line_add`.
ap_account_refNoRefers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.)
is_tax_includedNoFor future use with international versions of QuickBooks.
expense_line_addNo
sales_tax_code_refNo`sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it.
include_ret_elementNo
item_group_line_addNoRefers to items that are grouped together in QuickBooks for fast entry. `item_line_add` and `item_group_line_add` combine: any number of each. QuickBooks receives them in that order: every `item_line_add`, then every `item_group_line_add`.

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 annotations declare readOnly/idempotent/non-destructive, and the description explains why: the call returns the v2 request to send plus the webhook payload that carries QuickBooks' answer, which is critical, non-obvious behavior beyond the annotations. It also enumerates concrete error codes (3176 locked, 3260 insufficient_permission, 3270 missing_posting_account), though it does not state auth requirements or payload sizes/limits.

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 operational second paragraph (returns the v2 request, webhook payload, error codes) earns its place, but the opening tutorial on what a bill credit is runs long, and the 20-code error dump duplicates what the tool result reportedly explains itself. Front-loading is reasonable but the text is bloated.

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?

Given a 16-parameter nested schema and an output schema, the description supplies the essential missing piece: that this is a request compiler with an async webhook answer. It could go further by naming sibling alternatives and stating permission prerequisites, but an agent has enough to call it correctly.

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% across 16 parameters, so the schema already carries nearly all semantic load. The description adds only the qbXML wrapper acceptance and the two-phase response shape, not per-parameter meaning such as when vendor_ref.list_id beats full_name or how item_line_add and expense_line_add interact.

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?

"Adds a vendor credit" gives a concrete verb and resource, and the description then defines the object and explicitly separates it from a Credit Memo, which maps to a real sibling (create_credit_memo). An agent can pick between the two without opening either schema.

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 through the vendor-credit vs credit-memo definition and the note that the qbXML `vendor_credit_add` wrapper is accepted. However, it never names the sibling tools to use instead (create_credit_memo, update_vendor_credit, find_vendor_credits) or states prerequisites such as required permissions or an existing vendor.

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