Create sales tax payment check
create_sales_tax_payment_checkBuilds 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
| Name | Required | Description | Default |
|---|---|---|---|
| memo | No | Additional information. | |
| address | No | If 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_date | Yes | The 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_macro | No | `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_number | No | `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_id | No | Your 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_guid | No | Allows for the attachment of a user defined GUID value. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| bank_account_ref | Yes | Refers to the account from which the funds are being drawn for this check, for example, Checking or Savings. | |
| is_to_be_printed | No | If `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_ref | Yes | `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_element | No | ||
| sales_tax_payment_check_line_add | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |