Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create bill payment credit card

create_bill_payment_credit_card
Read-onlyIdempotent

A BillPaymentCreditCardAdd request must include either payment_amount, set_credit, or discount_amount (or more than one of these). If none of these three is included, the SDK will return an error.

The bill_payment_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": {
      "applied_to_txn_add": "<applied_to_txn_add>",
      "credit_card_account_ref": "<credit_card_account_ref>",
      "payee_entity_ref": "<payee_entity_ref>"
    },
    "name": "create_bill_payment_credit_card"
  }
}

Input Schema

NameRequiredDescriptionDefault
memoNoAdditional information.
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`.
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.
ap_account_refNoRefers to an accounts payable account in the QuickBooks file. (The AccountType of this account will be AccountsPayable.)
payee_entity_refYes`payee_entity_ref` identifies the payee (customer, vendor, employee, or Other Name). If both `full_name` and `list_id` are provided, `full_name` is ignored.
applied_to_txn_addYes
include_ret_elementNo
credit_card_account_refYesRefers to the credit card account to which this payment is being charged. In a request, if a `credit_card_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.

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

B3.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world. The description adds real context beyond them: the mandatory field combination that triggers an SDK error, that a qbXML wrapper name is also accepted, that the result is a v2 request plus a webhook payload, and a full error-code/type catalog with the note that the call result explains each. What it does not say is who dispatches the returned request — the one behavioral gap left.

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?

Two tight paragraphs for the core behavior, but the twenty-item error enumeration consumes roughly half the text and largely duplicates what 'the call result explains each' already covers. The first sentence is also a constraint rather than a front-loaded purpose statement, so the reader learns what the tool is only in sentence three.

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

Completeness3/5

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

For a 13-parameter nested-payload tool with an output schema, the description covers the key validation rule and error surface, and it can legitimately defer return shape to the output schema. It is still incomplete on the lifecycle question — whether calling this performs the bill payment or merely compiles a request the caller must send — which is central for an agent deciding how to use the result.

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 high (85%), so the baseline is 3, but the description adds a conditional requirement the schema cannot express: applied_to_txn_add only marks txn_id as required, yet the description states at least one of payment_amount, set_credit, or discount_amount must be supplied. That is genuine meaning beyond the structured fields.

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

Purpose3/5

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

The name and title say 'create bill payment credit card', but the description never opens with a plain statement of that purpose. It starts with a validation rule and then mentions the qbXML wrapper and that it 'Returns the v2 request to send, and the webhook payload' — a hint that this is a request-builder rather than a direct write, but the agent must infer that.

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?

No when-to-use guidance and no routing against obvious siblings like create_bill_payment_check or create_credit_card_charge — an agent gets no help choosing between the many create_* / find_* alternatives. The only guidance is a hard validity rule (one of payment_amount, set_credit, or discount_amount must be present), which is a constraint rather than a usage decision.

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