Xero Accounting Endpoint: TaxRates
Overview
The Xero TaxRates endpoint allows you to access the list of tax rates defined within Xero.
Fields
The following fields are available for the TaxRates endpoint.
- TaxType
- A text field that provides the unique tax type.
- This field can be used to link to other endpoints.
- See TaxTypes for more information.
- Name
- A text field provides the name of the tax rate.
- TaxComponents
- A table field that provides the list of all tax components that make up the tax rate.
- Most tax rates will have a single component but some apply multiple rates at once.
- See TaxComponents Fields for more information.
- Status
- A text field that indicates the status of the account.
- Possible values are:
- ACTIVE: Indicate the tax rate can be used on transaction.
- ARCHIVE: Indicates the tax rate cannot be used on transaction any longer but may have had historical transactions.
- DELETED: Indicates the tax rate has been deleted and no longer exists.
- ReportTaxType
- A text field that indicates the more detailed tax type of a tax rate.
- Possible values are are dependant on the region of your Xero Data File. See ReportTaxTypes for more information.
- CanApplyToAssets
- A true/false value that indicates if this tax rate can apply to asset accounts.
- CanApplyToEquity
- A true/false value that indicates if this tax rate can apply to equity accounts.
- CanApplyToExpenses
- A true/false value that indicates if this tax rate can apply to expense accounts.
- CanApplyToLiabilities
- A true/false value that indicates if this tax rate can apply to liability accounts.
- CanApplyToRevenue
- A true/false value that indicates if this tax rate can apply to revenue accounts.
- DisplayTaxRate
- A decimal field that provides the tax rate for display purposes.
- EffectiveRate
- A decimal field that provides the effecive tax rate for calculation purposes.
TaxComponents Fields
The TaxComponents Fields includes the following sub-fields.
- Name
- A text field provides the name of the tax component.
- Rate
- A decimal field that provides the tax rate for calculation purposes for this tax component.
- IsCompound
- A true/false value that indicates if this tax rate is compounded (e.g. tax-on-tax).
- IsNonRecoverable
- A true/false value that indicates if this tax rate is non-recoverable (Canada Only).
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields