Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create payment method

create_payment_method
Read-onlyIdempotent

Adds a payment method, which is the way a customer pays for goods or services, for example, cash, check, or Master Card. A PaymentMethodRef aggregate refers to an item on the PaymentMethod list. In a request, if a PaymentMethodRef aggregate includes both FullName and list_id, FullName will be ignored.

The payment_method_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, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 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": {
      "name": "<name>"
    },
    "name": "create_payment_method"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
payment_method_typeNoThe payment method, such as check, cash, debit card, Visa, etc.

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.3/5.0
Behavior2/5

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

The description does add real behavioral context — it says the call returns the v2 request plus the webhook payload shape and enumerates 19 error codes with their meanings, which annotations cannot convey. However, it opens by asserting 'Adds a payment method', a mutation claim, while the annotations declare readOnlyHint=true and idempotentHint=true; the later 'Returns the v2 request to send' partially reconciles this, but the leading sentence still points an agent at a write operation.

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 core semantics are front-loaded in the first sentences, followed by return shape and errors. The 19-entry error-code dump is long and, since the description itself says 'the call result explains each', partially redundant — the only real cost in an otherwise tight definition.

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?

With an output schema present and 83% schema coverage, the description need not restate return values, and it still describes the v2 request/webhook split and the error surface. The one material gap is the unresolved read-vs-write framing relative to its annotations.

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 83%, so the schema already documents name, is_active, request_id, include_qbxml, include_ret_element and payment_method_type thoroughly; baseline is 3. The description adds the PaymentMethodRef precedence rule (FullName ignored when `list_id` is present), but that parameter is not actually in the input schema, so the added meaning does not map onto a callable parameter.

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 opening sentence gives a specific verb and resource ('Adds a payment method') and even defines the domain object with examples (cash, check, Master Card), so an agent knows what it produces. It also notes the qbXML `payment_method_add` alias. It never names or contrasts a sibling (e.g., find_payment_methods or update_*), so it stops short of full disambiguation.

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 only implied: the description explains that `payment_method_add` is accepted and that a PaymentMethodRef must supply FullName or `list_id`, which hints at when the tool applies. There is no explicit when-to-use versus find_payment_methods/update_* guidance and no stated prerequisites or exclusions.

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