--- title: "Retrieve a sales-tax payment check" method: GET path: "/quickbooks-desktop/sales-tax-payment-checks/{id}" --- # Retrieve a sales-tax payment check `GET /quickbooks-desktop/sales-tax-payment-checks/{id}` Retrieves a sales-tax payment check by ID. **IMPORTANT:** If you need to fetch multiple specific sales-tax payment checks by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster. ## Path parameters - `id` string, required — The QuickBooks-assigned unique identifier of the sales-tax payment check to retrieve. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns the specified sales-tax payment check. - QbdSalesTaxPaymentCheck - `id` string, 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"`. - `createdAt` string, 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. - `updatedAt` string, 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. - `revisionNumber` string, 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. - `vendor` object, nullable, 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. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `transactionDate` string, date, required — The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD). - `bankAccount` object, 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. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `amount` string, 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. - `refNumber` string, 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. - `memo` string, nullable, required — A memo or note for this sales-tax payment check. - `address` QbdAddress, required - `line1` string, nullable, required — The first line of the address (e.g., street, PO Box, or company name). - `line2` string, nullable, required — The second line of the address, if needed (e.g., apartment, suite, unit, or building). - `line3` string, nullable, required — The third line of the address, if needed. - `line4` string, nullable, required — The fourth line of the address, if needed. - `line5` string, nullable, required — The fifth line of the address, if needed. - `city` string, nullable, required — The city, district, suburb, town, or village name of the address. - `state` string, nullable, required — The state, county, province, or region name of the address. - `postalCode` string, nullable, required — The postal code or ZIP code of the address. - `country` string, nullable, required — The country name of the address. - `note` string, nullable, required — A note written at the bottom of the address in the form in which it appears, such as the invoice form. - `isQueuedForPrint` boolean, nullable, required — Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print. - `externalId` string, 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. - `lines` QbdSalesTaxPaymentCheckLine[], required — The payment lines in this sales-tax payment check, each recording an amount paid toward a sales-tax item. - `id` string, required — The unique identifier assigned by QuickBooks to this sales-tax payment check line. This ID is unique across all transaction line types. - `objectType` 'qbd_sales_tax_payment_check_line', required — The type of object. This value is always `"qbd_sales_tax_payment_check_line"`. - `salesTaxItem` object, nullable, required — The sales-tax item whose payable balance this sales-tax payment check line is paying. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `amount` string, nullable, required — The sales-tax payment amount paid toward this line's sales-tax item, represented as a decimal string. - `taxAmount` string, nullable, required — The sales-tax amount due on this sales-tax payment check line, represented as a decimal string. QuickBooks Desktop returns this field only for Australian company files. - `customFields` QbdCustomField[], required — The custom fields for the sales-tax payment check object, added as user-defined data extensions, not included in the standard QuickBooks object. - `ownerId` string, required — The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. - `name` string, required — The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. - `type` 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type', required — The data type of this custom field. - `value` string, required — The value of this custom field. The maximum length depends on the field's data type. --- [API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)