v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Update a sales-tax group item

Updates an existing sales-tax group item.

post/quickbooks-desktop/sales-tax-group-items/{id}

Path parameters

idstring required

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

Example:80000001-1234567890

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

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Request body

revisionNumberstring required

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

namestring

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.

Maximum length: 31 characters.

isActiveboolean

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

descriptionstring

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

salesTaxItemIdsstring[]

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 request

{
  "revisionNumber": "1721172183",
  "name": "Standard Tax Group",
  "barcode": {
    "value": "012345678905"
  },
  "isActive": true,
  "description": "Combined city, county, and state sales tax",
  "salesTaxItemIds": [
    "80000001-1234567890"
  ]
}

Response

Returns the updated sales-tax group item.

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

objectType'qbd_sales_tax_group_item' required

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

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

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

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

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

barcodestring nullable required

The sales-tax group item's barcode.

isActiveboolean required

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

descriptionstring nullable required

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

externalIdstring nullable 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 response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_tax_group_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "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"
    }
  ]
}