Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Create sales tax payment check

create_sales_tax_payment_check
Read-onlyIdempotent

Builds a v2 sales_tax_payment_check.create request.

The sales_tax_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": {
      "bank_account_ref": "<bank_account_ref>",
      "payee_entity_ref": "<payee_entity_ref>",
      "sales_tax_payment_check_line_add": "<sales_tax_payment_check_line_add>",
      "txn_date": "<txn_date>"
    },
    "name": "create_sales_tax_payment_check"
  }
}

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_dateYesThe 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`.
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.
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.
include_ret_elementNo
sales_tax_payment_check_line_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

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, and the description productively explains why a 'create' tool is read-only: it only compiles the request and the actual write happens when the caller sends it, with the answer arriving on a webhook. It also enumerates the error codes and types the caller must handle, which is real behavioral context beyond the annotations.

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 is front-loaded in the first sentence, which is good. However, roughly half the text is a 20-entry parenthetical error-code list packed into one run-on sentence, which is heavy relative to the value it delivers and would be better structured as a table or folded into the output schema.

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?

For a 13-parameter tool with nested objects and an existing output schema, the description covers the essential contract: what is returned, that the QuickBooks answer arrives via webhook with defined status codes, and which errors to expect. The main gap is that it never explains the prerequisite flow (that the compiled request must be dispatched elsewhere), leaving the caller to infer how the mutation actually occurs.

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 85%, so the schema already documents nearly every parameter in detail (ref_number vs is_to_be_printed exclusivity, list_id precedence, txn_date prefill). The description adds nothing parameter-specific beyond the qbXML alias acceptance, so the baseline of 3 for high-coverage schemas 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?

States a specific verb and resource: 'Builds a v2 sales_tax_payment_check.create request', and clarifies the qbXML alias it also accepts. An agent knows exactly what object is produced, but the description never positions this against sibling tools such as create_check or create_bill_payment_check, so differentiation relies on the name alone.

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 when-to-use or when-not-to-use guidance. Nothing says whether this is the right tool for paying sales tax versus paying a bill (create_bill_payment_check) or writing a plain check (create_check), nor when to use update_sales_tax_payment_check instead. The only compatibility note is that a qbXML wrapper is accepted, which is syntax, not selection guidance.

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