Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Create a sales-tax payment check

Creates a new sales-tax payment check.

post/quickbooks-desktop/sales-tax-payment-checks

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Request body

vendorIdstring required

The sales-tax agency, represented as a QuickBooks vendor, receiving this sales-tax payment check. This must match the tax vendor associated with the sales-tax items in the payment lines.

transactionDatestring date required

The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD).

bankAccountIdstring required

The bank account from which the funds are being drawn for this sales-tax payment check; e.g., Checking or Savings. This sales-tax payment check will decrease the balance of this account.

isQueuedForPrintboolean

Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print.

refNumberstring

The case-sensitive user-defined reference number for this sales-tax payment check, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

IMPORTANT: For checks, this field is the check number.

Maximum length: 11 characters.

memostring

A memo or note for this sales-tax payment check.

externalIdstring uuid

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example request

{
  "vendorId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "bankAccountId": "80000001-1234567890",
  "isQueuedForPrint": true,
  "refNumber": "TAXPMT-1234",
  "memo": "Sales tax payment for Q3 2024",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "salesTaxItemId": "80000001-1234567890",
      "amount": "1000.00"
    }
  ]
}

Response

Returns the newly created sales-tax payment check.

idstring required

The unique identifier assigned by QuickBooks to this sales-tax payment check. This ID is unique across all transaction types.

objectType'qbd_sales_tax_payment_check' required

The type of object. This value is always "qbd_sales_tax_payment_check".

createdAtstring required

The date and time when this sales-tax payment check was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this sales-tax payment check was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this sales-tax payment check object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDatestring date required

The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD).

amountstring required

The total monetary amount of this sales-tax payment check, represented as a decimal string. This equals the sum of the amounts in the sales-tax payment check lines.

refNumberstring nullable required

The case-sensitive user-defined reference number for this sales-tax payment check, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: For checks, this field is the check number.

memostring nullable required

A memo or note for this sales-tax payment check.

isQueuedForPrintboolean nullable required

Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_sales_tax_payment_check",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "vendor": {
    "id": "80000001-1234567890",
    "fullName": "State Tax Agency"
  },
  "transactionDate": "2024-10-01",
  "bankAccount": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "amount": "1000.00",
  "refNumber": "TAXPMT-1234",
  "memo": "Sales tax payment for Q3 2024",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "isQueuedForPrint": true,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_sales_tax_payment_check_line",
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "amount": "1000.00",
      "taxAmount": "10.00"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}