POST
/
quickbooks-desktop
/
sales-tax-items
/
{id}

Authorizations

Authorization
string
headerrequired

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 item to update.

Body

application/json
revisionNumber
string
required

The current revision number of the sales-tax item 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 item, unique across all sales-tax items. Maximum length: 31 characters.

barcode
object

The sales-tax item's barcode.

isActive
boolean
default: true

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

classId
string

The sales-tax item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

description
string

The sales-tax item's description that will appear on sales forms that include this item.

taxRate
string

The tax rate defined by this sales-tax item, represented as a decimal string. For example, "7.5" represents a 7.5% tax rate. This rate determines the amount of sales tax applied when this item is used in transactions. If a non-zero taxRate is specified, then the taxVendor field is required.

taxVendorId
string

The tax agency (vendor) to whom collected sales taxes are owed for this sales-tax item. This field refers to a vendor in QuickBooks that represents the tax authority. If a non-zero taxRate is specified, then taxVendor is required.

salesTaxReturnLineId
string

The specific line on the sales tax return form where the tax collected using this sales-tax item should be reported.

Response

200 - application/json
id
string
required

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

objectType
string
required

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

Allowed value: "qbd_sales_tax_item"
createdAt
string
required

The date and time when this sales-tax item 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 item 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 revision number of this sales-tax item, 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 item, unique across all sales-tax items. Maximum length: 31 characters.

barcode
string | null
required

The sales-tax item's barcode.

isActive
boolean
default: truerequired

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

class
object | null
required

The sales-tax item's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

description
string | null
required

The sales-tax item's description that will appear on sales forms that include this item.

taxRate
string | null
required

The tax rate defined by this sales-tax item, represented as a decimal string. For example, "7.5" represents a 7.5% tax rate. This rate determines the amount of sales tax applied when this item is used in transactions. If a non-zero taxRate is specified, then the taxVendor field is required.

taxVendor
object | null
required

The tax agency (vendor) to whom collected sales taxes are owed for this sales-tax item. This field refers to a vendor in QuickBooks that represents the tax authority. If a non-zero taxRate is specified, then taxVendor is required.

salesTaxReturnLine
object | null
required

The specific line on the sales tax return form where the tax collected using this sales-tax item should be reported.

externalId
string | null
required

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

customFields
object[]
required

The custom fields for the sales-tax item object, added as user-defined data extensions, not included in the standard QuickBooks object.