COconductor-is

Retrieve a sales-tax code

Changed on

Retrieves a sales-tax code by ID.

IMPORTANT: If you need to fetch multiple specific sales-tax codes 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.

get/quickbooks-desktop/sales-tax-codes/{id}

Request

Path parameters

idstring required

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

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns the specified sales-tax code.

idstring 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'qbd_sales_tax_code' required

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

createdAtstring required

The date and time when this sales-tax code 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.

updatedAtstring required

The date and time when this sales-tax code 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.

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

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

isActiveboolean required

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

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

descriptionstring nullable required

A description of this sales-tax code.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_tax_code",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Tax",
  "isActive": true,
  "isTaxable": true,
  "description": "Standard tax rate for California",
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  }
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status