TaxRates
Maintains sales-tax rate definitions that are applied to transactions, including jurisdiction, rate percentage, and effective dates.
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 tax-rate record. It is used to retrieve or reference the tax rate programmatically and is required for updates or deletions. | |
| SyncToken | String | True | False | False |
The version control token for this tax-rate record that is used to prevent conflicting updates. QuickBooks Online increments this sync token each time the record is modified, and only the latest sync token is accepted for edits. | |
| MetaData_CreateTime | Datetime | True | True | True |
The date and time stamp (Coordinated Universal Time) when QuickBooks Online created this tax-rate record. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time stamp (Coordinated Universal Time) when this tax-rate record was last modified in QuickBooks Online. | |
| Name | String | False | False | False |
The display name of the tax rate as it appears in QuickBooks Online user interfaces and reports. | |
| Description | String | False | False | False |
A detailed description of the purpose or usage of this tax rate. This field must not contain white space or formatting characters. | |
| Active | Boolean | False | True | False |
Indicates whether the tax rate is currently active (true) or inactive (false). Inactive tax rates can be hidden from display and are not used on financial transactions. | |
| RateValue | String | False | True | True |
The numeric value of the tax rate (for example, 7.5 for 7.5 percent) that QuickBooks Online applies to taxable transactions. | |
| AgencyRef | String | False |
TaxAgency.Id | True | False |
The unique Id of the tax agency that is responsible for collecting or receiving this tax rate. This field links the tax rate to its governing agency. |
| AgencyRef_Name | String | True |
TaxAgency.DisplayName | False | False |
The display name of the tax agency that is responsible for collecting or receiving this tax rate. |
| TaxReturnLineRef | String | False | True | False |
The unique Id of the tax-return line where this tax rate is reported. This Id helps map transactions to the correct line on a tax return. | |
| TaxReturnLineRef_Name | String | True | False | False |
The display name of the tax return line where this tax rate is reported. | |
| SpecialTaxType | String | False | False | False |
The special tax type code that QuickBooks Online uses to handle zero-rate taxes or special Value-Added Tax (VAT) rules. For example, VAT-registered businesses that receive goods, services, or acquisitions from other EU countries must calculate the VAT due but not paid on these acquisitions. The rate of VAT that is payable is the same that would be paid if the goods had been supplied by a UK supplier. | |
| DisplayType | String | False | False | False |
The display type of the tax rate as configured in QuickBooks Online. This field is used to control how the tax rate is displayed in lists and on forms. | |
| EffectiveTaxRate | Double | False | False | False |
The effective tax-rate percentage that QuickBooks Online uses to determine which tax rate is applicable on any given date. This field is especially useful for rates that change over time. | |
| OriginalTaxRate | String | True | False | False |
The unique Id of the original tax rate from which this new tax rate is derived. This field allows tracking of rate changes over time. |
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 tax-rate details that is used only for insert operations. This pseudocolumn allows you to supply detailed tax rate information when creating a new tax rate. |
| TaxCode | String |
The name of the tax code that this tax rate is to be associated with. This pseudocolumn is used only for insert operations. |
| TaxApplicableOn | String |
Specifies where this tax rate can be applied. Possible values are 'Sales' or 'Purchase'. This pseudocolumn is used only for insert operations. |