Skip to main content
GET
/
quickbooks-desktop
/
sales-tax-group-items
/
{id}
JavaScript
import Conductor from 'conductor-node';

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

const salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(salesTaxGroupItem.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_tax_group_item",
  "createdAt": "2025-01-01T12:34:56.000Z",
  "updatedAt": "2025-02-01T12:34:56.000Z",
  "revisionNumber": "1721172183",
  "name": "Standard Tax Group",
  "barcode": "012345678905",
  "isActive": true,
  "description": "Combined city, county, and state sales tax",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "salesTaxItems": [
    {
      "id": "80000001-1234567890",
      "fullName": "State Sales Tax"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

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 End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

​
id
string
required

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

Maximum string length: 36
Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified sales-tax group item.

​
id
string
required

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

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_sales_tax_group_item"
Example:

"qbd_sales_tax_group_item"

​
createdAt
string
required

The date and time when this sales-tax group item 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
string
required

The date and time when this sales-tax group item 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
string
required

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

Example:

"1721172183"

​
name
string
required

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

NOTE: Sales-tax group 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.

Example:

"Standard Tax Group"

​
barcode
string | null
required

The sales-tax group item's barcode.

Example:

"012345678905"

​
isActive
boolean
required

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

Example:

true

​
description
string | null
required

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

Example:

"Combined city, county, and state sales tax"

​
externalId
string | null
required

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"

​
salesTaxItems
object[]
required

The sales-tax items that make up this sales-tax group item. QuickBooks Desktop applies these sales-tax items together as one tax selection while tracking each sales tax separately.

Example:
[
  {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  }
]
​
customFields
The Custom Field object · object[]
required

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