POST
/
quickbooks-desktop
/
sales-tax-codes
/
{id}
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  const salesTaxCode = await client.qbd.salesTaxCodes.update('80000001-1234567890', {
    revisionNumber: '1721172183',
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(salesTaxCode.id);
}

main();
{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_tax_code",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "name": "Tax",
  "isActive": true,
  "isTaxable": true,
  "description": "Standard tax rate for California",
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  }
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the sales-tax code to update.

Body

application/json
​
revisionNumber
string
required

The current QuickBooks-assigned revision number of the sales-tax code 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.

​
name
string

The case-insensitive unique name of this sales-tax code, unique across all sales-tax codes. This short name will appear on sales forms to identify the tax status of an item.

NOTE: Sales-tax codes do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

Maximum length: 3 characters.

Maximum length: 3
​
isActive
boolean

Indicates whether this sales-tax code is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

​
isTaxable
boolean

Indicates whether this sales-tax code is tracking taxable sales. This field cannot be modified once the sales-tax code has been used in a transaction.

​
description
string

A description of this sales-tax code.

​
salesTaxItemId
string

The sales-tax item used to calculate the actual tax amount for this sales-tax code's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Response

200 - application/json
Returns the updated sales-tax code.
​
id
string
required

The unique identifier assigned by QuickBooks to this sales-tax code. This ID is unique across all sales-tax codes but not across different QuickBooks object types.

​
objectType
string
required

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

Allowed value: "qbd_sales_tax_code"
​
createdAt
string
required

The date and time when this sales-tax code was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

​
updatedAt
string
required

The date and time when this sales-tax code was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this sales-tax code 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.

​
name
string
required

The case-insensitive unique name of this sales-tax code, unique across all sales-tax codes. This short name will appear on sales forms to identify the tax status of an item.

NOTE: Sales-tax codes do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.

​
isActive
boolean
required

Indicates whether this sales-tax code is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

​
isTaxable
boolean
required

Indicates whether this sales-tax code is tracking taxable sales. This field cannot be modified once the sales-tax code has been used in a transaction.

​
description
string | null
required

A description of this sales-tax code.

​
salesTaxItem
object | null
required

The sales-tax item used to calculate the actual tax amount for this sales-tax code's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Create a sales-tax codeRetrieve a sales-tax code