List all sales-tax items

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}}").

Query Parameters

ids

string[]

Filter for specific sales-tax items by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

names

string[]

Filter for specific sales-tax items by their name(s), case-insensitive. Like id, name is a unique identifier for a sales-tax item.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

limit

integer

default:

150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Required range: 1 < x < 150

cursor

string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

status

enum<string>

default:

active

Filter for sales-tax items that are active, inactive, or both.

Available options:

active,

all,

inactive

updatedAfter

string

Filter for sales-tax items updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

updatedBefore

string

Filter for sales-tax items updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

nameContains

string

Filter for sales-tax items whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

nameStartsWith

string

Filter for sales-tax items whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

nameEndsWith

string

Filter for sales-tax items whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

nameFrom

string

Filter for sales-tax items whose name is alphabetically greater than or equal to this value.

nameTo

string

Filter for sales-tax items whose name is alphabetically less than or equal to this value.

classIds

string[]

Filter for sales-tax items of these classes. A class is a way end-users can categorize sales-tax items in QuickBooks.

Response

200 - application/json

data

object[]

required

The array of sales-tax items.

data.barcode

string | null

required

The sales-tax item's barcode.

data.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.

data.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.

data.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.

data.description

string | null

required

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

data.externalId

string | null

required

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

data.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.

data.isActive

boolean

required

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

data.name

string

required

The case-insensitive unique name of this sales-tax item, unique across all sales-tax items.

NOTE: Sales-tax items 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: 31 characters.

data.objectType

string

required

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

Allowed value: "qbd_sales_tax_item"

data.revisionNumber

string

required

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

data.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.

data.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.

data.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.

data.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.

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

nextCursor

string | null

required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

objectType

string

required

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

Allowed value: "list"

remainingCount

number | null

required

The number of objects remaining to be fetched.

url

string

required

The endpoint URL where this list can be accessed.

QuickBooks Desktop API

Core Resources

Transactions

Items

Authorizations

Headers

Query Parameters

Response