> ## Documentation Index > Fetch the complete documentation index at: https://docs.conductor.is/llms.txt > Use this file to discover all available pages before exploring further. # Update a sales-tax payment check > Updates an existing sales-tax payment check. ## OpenAPI ````yaml POST /quickbooks-desktop/sales-tax-payment-checks/{id} openapi: 3.1.0 info: title: Conductor API version: 0.0.1 servers: - url: https://api.conductor.is/v1 security: - BearerAuth: [] paths: /quickbooks-desktop/sales-tax-payment-checks/{id}: post: summary: Update a sales-tax payment check description: Updates an existing sales-tax payment check. parameters: - in: header name: Conductor-End-User-Id schema: type: string description: The ID of the End-User to receive this request. example: end_usr_1234567abcdefg x-stainless-naming: typescript: method_argument: conductorEndUserId mcp: method_argument: conductorEndUserId required: true description: The ID of the End-User to receive this request. - in: path name: id schema: type: string maxLength: 36 description: >- The QuickBooks-assigned unique identifier of the sales-tax payment check to update. example: 123ABC-1234567890 required: true description: >- The QuickBooks-assigned unique identifier of the sales-tax payment check to update. requestBody: required: true content: application/json: schema: type: object properties: revisionNumber: type: string description: >- The current QuickBooks-assigned revision number of the sales-tax payment check object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error. example: '1721172183' transactionDate: type: string format: date description: >- The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' bankAccountId: description: >- 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. example: 80000001-1234567890 type: string maxLength: 36 isQueuedForPrint: type: boolean description: >- Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print. example: true refNumber: description: >- 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. Maximum length: 11 characters. example: TAXPMT-1234 type: string maxLength: 11 memo: description: A memo or note for this sales-tax payment check. example: Sales tax payment for Q3 2024 type: string address: description: The address that is printed on the sales-tax payment check. type: object properties: line1: description: >- The first line of the address (e.g., street, PO Box, or company name). Maximum length: 41 characters. example: Conductor Labs Inc. type: string maxLength: 41 line2: description: >- The second line of the address, if needed (e.g., apartment, suite, unit, or building). Maximum length: 41 characters. example: 540 Market St. type: string maxLength: 41 line3: description: |- The third line of the address, if needed. Maximum length: 41 characters. example: Suite 100 type: string maxLength: 41 line4: description: |- The fourth line of the address, if needed. Maximum length: 41 characters. example: '' type: string maxLength: 41 line5: description: |- The fifth line of the address, if needed. Maximum length: 41 characters. example: '' type: string maxLength: 41 city: description: >- The city, district, suburb, town, or village name of the address. Maximum length: 31 characters. example: San Francisco type: string maxLength: 31 state: description: >- The state, county, province, or region name of the address. Maximum length: 21 characters. example: CA type: string maxLength: 21 postalCode: description: |- The postal code or ZIP code of the address. Maximum length: 13 characters. example: '94110' type: string maxLength: 13 country: description: The country name of the address. example: United States type: string note: description: >- A note written at the bottom of the address in the form in which it appears, such as the invoice form. example: Conductor HQ type: string additionalProperties: false required: - revisionNumber additionalProperties: false responses: '200': description: Returns the updated sales-tax payment check. headers: Conductor-Request-Id: required: true description: The unique identifier for this API request. schema: type: string description: The unique identifier for this API request. example: req_1234567abcdefg content: application/json: schema: $ref: '#/components/schemas/qbd_sales_tax_payment_check' security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: >- import Conductor from 'conductor-node'; const conductor = new Conductor({ apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted }); const salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.update('123ABC-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg', }); console.log(salesTaxPaymentCheck.id); - lang: Python source: >- import os from conductor import Conductor conductor = Conductor( api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted ) sales_tax_payment_check = conductor.qbd.sales_tax_payment_checks.update( id="123ABC-1234567890", revision_number="1721172183", conductor_end_user_id="end_usr_1234567abcdefg", ) print(sales_tax_payment_check.id) components: schemas: qbd_sales_tax_payment_check: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this sales-tax payment check. This ID is unique across all transaction types. example: 123ABC-1234567890 objectType: description: >- The type of object. This value is always `"qbd_sales_tax_payment_check"`. example: qbd_sales_tax_payment_check type: string const: qbd_sales_tax_payment_check createdAt: type: string description: >- 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. example: '2025-01-01T12:34:56.000Z' updatedAt: type: string description: >- 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. example: '2025-02-01T12:34:56.000Z' revisionNumber: type: string description: >- 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. example: '1721172183' vendor: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- 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. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- 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. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- 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. example: id: 80000001-1234567890 fullName: State Tax Agency transactionDate: type: string format: date description: >- The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' bankAccount: type: object properties: id: anyOf: - type: string - type: 'null' description: >- 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. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- 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. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- 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. example: id: 80000001-1234567890 fullName: Checking amount: type: string description: >- 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. example: '1000.00' refNumber: anyOf: - type: string - type: 'null' description: >- 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. example: TAXPMT-1234 memo: anyOf: - type: string - type: 'null' description: A memo or note for this sales-tax payment check. example: Sales tax payment for Q3 2024 address: anyOf: - $ref: '#/components/schemas/qbd_address' - type: 'null' description: The address that is printed on the sales-tax payment check. isQueuedForPrint: anyOf: - type: boolean description: >- Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print. example: true - type: 'null' externalId: anyOf: - type: string description: >- 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: 12345678-abcd-1234-abcd-1234567890ab - type: 'null' lines: type: array items: $ref: '#/components/schemas/qbd_sales_tax_payment_check_line' description: >- The payment lines in this sales-tax payment check, each recording an amount paid toward a sales-tax item. customFields: type: array items: $ref: '#/components/schemas/qbd_custom_field' description: >- The custom fields for the sales-tax payment check object, added as user-defined data extensions, not included in the standard QuickBooks object. required: - id - objectType - createdAt - updatedAt - revisionNumber - vendor - transactionDate - bankAccount - amount - refNumber - memo - address - isQueuedForPrint - externalId - lines - customFields additionalProperties: false title: The Sales-Tax Payment Check object x-conductor-object-type: transaction summary: >- A sales-tax payment check records a check written from a bank account to pay collected sales taxes to a tax agency. It allocates the payment across one or more sales-tax items so QuickBooks Desktop can reduce the sales-tax payable amounts for those items. qbd_address: type: object properties: line1: anyOf: - type: string - type: 'null' description: >- The first line of the address (e.g., street, PO Box, or company name). example: Conductor Labs Inc. line2: anyOf: - type: string - type: 'null' description: >- The second line of the address, if needed (e.g., apartment, suite, unit, or building). example: 540 Market St. line3: anyOf: - type: string - type: 'null' description: The third line of the address, if needed. example: Suite 100 line4: anyOf: - type: string - type: 'null' description: The fourth line of the address, if needed. example: '' line5: anyOf: - type: string - type: 'null' description: The fifth line of the address, if needed. example: '' city: anyOf: - type: string - type: 'null' description: The city, district, suburb, town, or village name of the address. example: San Francisco state: anyOf: - type: string - type: 'null' description: The state, county, province, or region name of the address. example: CA postalCode: anyOf: - type: string - type: 'null' description: The postal code or ZIP code of the address. example: '94110' country: anyOf: - type: string - type: 'null' description: The country name of the address. example: United States note: anyOf: - type: string - type: 'null' description: >- A note written at the bottom of the address in the form in which it appears, such as the invoice form. example: Conductor HQ required: - line1 - line2 - line3 - line4 - line5 - city - state - postalCode - country - note additionalProperties: false title: The Address object x-conductor-object-type: nested qbd_sales_tax_payment_check_line: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this sales-tax payment check line. This ID is unique across all transaction line types. example: 456DEF-1234567890 objectType: description: >- The type of object. This value is always `"qbd_sales_tax_payment_check_line"`. example: qbd_sales_tax_payment_check_line type: string const: qbd_sales_tax_payment_check_line salesTaxItem: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- 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. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- 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. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- The sales-tax item whose payable balance this sales-tax payment check line is paying. example: id: 80000001-1234567890 fullName: State Sales Tax amount: anyOf: - type: string - type: 'null' description: >- The sales-tax payment amount paid toward this line's sales-tax item, represented as a decimal string. example: '1000.00' taxAmount: anyOf: - type: string - type: 'null' description: >- 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. example: '10.00' required: - id - objectType - salesTaxItem - amount - taxAmount additionalProperties: false title: The Sales-Tax Payment Check Line object x-conductor-object-type: nested qbd_custom_field: type: object properties: ownerId: type: string description: >- 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. example: '0' name: type: string description: >- 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. example: Customer Rating type: type: string enum: - amount_type - date_time_type - integer_type - percent_type - price_type - quantity_type - string_1024_type - string_255_type description: The data type of this custom field. example: string_1024_type value: type: string description: >- The value of this custom field. The maximum length depends on the field's data type. example: Premium required: - ownerId - name - type - value additionalProperties: false title: The Custom Field object x-conductor-object-type: nested securitySchemes: BearerAuth: type: http scheme: bearer description: >- Your Conductor secret key using Bearer auth (e.g., `"Authorization: Bearer {{YOUR_SECRET_KEY}}"`). ````