QuickBooks: Read a taxrate — response body — Tax Rate
Read a taxrate: response body, field TaxRate. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read a taxrate — response body — Tax Rate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Active | JSON | Optional | If true, this object is currently enabled for use by QuickBooks. Read only: true |
Active (anyOf 1) | boolean | Alternative | |
Active (anyOf 2) | string | Alternative | Known values: true, false |
AgencyRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the tax agency associated with this object. Read only: true |
Description | string | Optional | User entered description for the tax rate. Read only: true |
DisplayType | string | Optional | TaxRate DisplayType enum which acts as display config. Read only: true |
EffectiveTaxRate | Model | Optional | Expand Read a taxrate — response body — Tax Rate Effective Tax Rate List of EffectiveTaxRate. An EffectiveTaxRate is used to know which taxrate is applicable on any date. Read only: true |
Id | string | Optional | Unique identifier for this object. Read only: true |
MetaData | Model | Optional | Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. |
Name | string | Optional | User recognizable name for the tax rate. Read only: true |
OriginalTaxRate | string | Optional | ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities. Read only: true |
RateValue | JSON | Optional | Value of the tax rate. Decimal string Read only: true |
RateValue (anyOf 1) | JSON | Alternative | |
RateValue (anyOf 1) (anyOf 1) | number | Alternative | |
RateValue (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
RateValue (anyOf 2) | string | Alternative | |
SpecialTaxType | string | Optional | Special tax type to handle zero rate taxes. Used with VAT registered Businesses who receive goods/services (acquisitions) from other EU countries, will need to calculate the VAT due, but not paid, on these acquisitions. The rate of VAT payable is the same that would have been paid if the goods had been supplied by a UK supplier. Read only: true |
SyncToken | string | Optional | Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true |
TaxReturnLineRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the tax return line associated with this object. Read only: true |
Referenced models: Read a taxrate — response body — Tax Rate Effective Tax Rate, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref