v48

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

Create a sales-tax item

Creates a new sales-tax item.

post/quickbooks-desktop/sales-tax-items

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

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

isActiveboolean

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

classIdstring

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.

descriptionstring

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

taxRatestring

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.

taxVendorIdstring

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.

salesTaxReturnLineIdstring

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

externalIdstring uuid

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example request

{
  "name": "Standard Tax",
  "barcode": {
    "value": "012345678905"
  },
  "isActive": true,
  "classId": "80000001-1234567890",
  "description": "Standard rate sales tax for California",
  "taxRate": "7.5",
  "taxVendorId": "80000001-1234567890",
  "salesTaxReturnLineId": "80000001-1234567890",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab"
}

Response

Returns the newly created sales-tax item.

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

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

createdAtstring required

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

barcodestring nullable required

The sales-tax item's barcode.

isActiveboolean required

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

descriptionstring nullable required

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

taxRatestring nullable required

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_item",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Standard Tax",
  "barcode": "012345678905",
  "isActive": true,
  "class": {
    "id": "80000001-1234567890",
    "fullName": "State-Sales-Tax"
  },
  "description": "Standard rate sales tax for California",
  "taxRate": "7.5",
  "taxVendor": {
    "id": "80000001-1234567890",
    "fullName": "State Tax Agency"
  },
  "salesTaxReturnLine": {
    "id": "80000001-1234567890",
    "fullName": "Line 1: State Sales Tax"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}