TaxCodes
Contains sales tax codes and rules that determine how taxes are calculated on transactions, supporting multi-jurisdiction compliance.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Id [KEY] | String | True | True | True |
The unique identifier (Id) that is assigned by QuickBooks Online to this sales tax code record. It is used to retrieve or reference the tax code programmatically and is required for updates or deletions. | |
| SyncToken | String | True | False | False |
The version control token for this sales tax code record that is used to prevent conflicting updates. QuickBooks Online increments this sync token each time the record is modified, and only the latest token is accepted for edits. | |
| MetaData_CreateTime | Datetime | True | False | True |
The date and time stamp (Coordinated Universal Time) when QuickBooks Online created this sales tax code record. | |
| MetaData_LastUpdatedTime | Datetime | True | False | True |
The date and time stamp (Coordinated Universal Time) when this sales tax code record was last modified in QuickBooks Online. | |
| Name | String | False | False | True |
The display name of the sales tax code as it appears in QuickBooks Online user interfaces and reports. | |
| Description | String | True | False | True |
A detailed description of the purpose or usage of this sales tax code. This field must not contain white space or formatting characters. | |
| Active | Boolean | True | False | False |
Indicates whether the sales tax code entity is currently active (true) or inactive (false). Inactive sales tax codes may be hidden from display and are not used on financial transactions. | |
| Taxable | Boolean | True | False | False |
Indicates whether the sales tax code represents a taxable entity (true) or a non-taxable entity (false or null by default). This setting determines how QuickBooks Online applies the code to transactions. | |
| TaxGroup | Boolean | True | False | False |
Indicates whether the sales tax code is configured as a tax group (true) or a single tax code (false). Tax groups allow you to combine multiple rates under one code for easier reporting. | |
| SalesTaxRateList_TaxRateDetailAggregate | String | True | False | False |
An XML aggregate that is serialized into a single string containing all sales tax rate details that are associated with this sales tax code. Each TaxRateDetail element typically includes the rate name, value, and applicable tax agency. | |
| PurchaseTaxRateList_TaxRateDetailAggregate | String | True | False | False |
An XML aggregate that is serialized into a single string containing all purchase tax-rate details that are associated with this sales tax code. This field is available only in the UK, AU, and CA editions. | |
| Hidden | Boolean | True | False | False |
Indicates whether active tax codes are displayed on transactions. When this flag is set to true, the code remains active but is hidden from transaction forms. | |
| TaxCodeConfigType | String | True | False | False |
Indicates whether this sales tax code record is system defined by the Automated Sales Tax engine or is user generated. This flag helps differentiate QuickBooks Online default codes from codes that are created manually by a user. The allowed values are USER_DEFINED, SYSTEM_GENERATED. |
Pseudo-Columns
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| TaxRateDetails | String |
An aggregate of TaxRateDetails that is used only for insert operations. This pseudocolumn allows you to supply detailed tax-rate information when creating a new tax code. |
| TaxApplicableOn | String |
Specifies where this tax rate can be applied. Possible values are 'Sales' or 'Purchase'. This pseudocolumn is used only for insert operations. |
| TaxRateName | String |
The name of a new tax rate to be created under this tax code. This pseudocolumn is used only for insert operations. |
| TaxAgencyId | String |
The unique Id of the agency to whom tax is paid. This pseudocolumn is used only for insert operations. |
| RateValue | String |
The numeric value of the tax rate to be applied under this tax code. This pseudocolumn is used only for insert operations. |