Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create bill payment check

create_bill_payment_check
Read-onlyIdempotent

A BillPaymentCheckAdd 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_check_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>",
      "bank_account_ref": "<bank_account_ref>",
      "payee_entity_ref": "<payee_entity_ref>"
    },
    "name": "create_bill_payment_check"
  }
}

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. Choose exactly one of: `is_to_be_printed`, or `ref_number`.
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.)
bank_account_refYesRefers to the account from which the funds are being drawn for this check, for example, Checking or Savings.
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. Choose exactly one of: `is_to_be_printed`, or `ref_number`.
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

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 read-only and idempotent behavior, but the description adds meaningful context: the nested payment_amount/set_credit/discount_amount requirement, the accepted qbXML wrapper, the returned v2 request/webhook payload, and a detailed error taxonomy. It does not explicitly reconcile the 'create' name with the read-only annotation, but it does not directly contradict it.

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 first paragraph carries the most important constraint, but the description starts with a nested-field rule rather than a plain purpose statement. The long error-code catalog is informative but dominates the definition, and parts of the return explanation are wordy.

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?

The schema and output schema cover much of the parameter and return surface, and the description adds error codes plus a key validation rule. However, it leaves unresolved whether this tool performs the actual creation or merely returns a v2 request, and it gives no context for choosing among related create/update/find tools.

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 at 86%, so the schema carries most parameter documentation. The description still adds important meaning by explaining that one of payment_amount, set_credit, or discount_amount must appear in the request, which is a cross-field constraint not expressed by the schema's required list.

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 description identifies a BillPaymentCheckAdd request and a key validation rule, but it never plainly states that this tool creates or builds a bill payment check. The agent must infer the core purpose from the name/title, and no sibling differentiation is provided.

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 guidance, no prerequisites, and no comparison to alternatives such as update_bill_payment_check, find_bill_payment_checks, or create_check. The only guidance is a field-level validation constraint, which is useful but not usage direction.

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