Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
ActiveJSONOptionalIf true, this object is currently enabled for use by QuickBooks.
Read only: true
Active (anyOf 1)booleanAlternative
Active (anyOf 2)stringAlternativeKnown values: true, false
AgencyRefModelOptionalExpand Read an item — response body — Item Class Ref
Reference to the tax agency associated with this object.
Read only: true
DescriptionstringOptionalUser entered description for the tax rate.
Read only: true
DisplayTypestringOptionalTaxRate DisplayType enum which acts as display config.
Read only: true
EffectiveTaxRateModelOptionalExpand 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
IdstringOptionalUnique identifier for this object.
Read only: true
MetaDataModelOptionalExpand 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.
NamestringOptionalUser recognizable name for the tax rate.
Read only: true
OriginalTaxRatestringOptionalID 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
RateValueJSONOptionalValue of the tax rate.
Decimal string
Read only: true
RateValue (anyOf 1)JSONAlternative
RateValue (anyOf 1) (anyOf 1)numberAlternative
RateValue (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
RateValue (anyOf 2)stringAlternative
SpecialTaxTypestringOptionalSpecial 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
SyncTokenstringOptionalVersion 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
TaxReturnLineRefModelOptionalExpand 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.