POST /TaxRates
Servers
- https://api.xero.com/api.xro/2.0
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Idempotency-Key |
String | No |
This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
TaxRates[] |
Array | No | |
TaxRates[].DisplayTaxRate |
Number | No |
Tax Rate (decimal to 4dp) e.g 12.5000 |
TaxRates[].TaxComponents[] |
Array | No |
See TaxComponents |
TaxRates[].TaxComponents[].IsNonRecoverable |
Boolean | No |
Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations |
TaxRates[].TaxComponents[].Rate |
Number | No |
Tax Rate (up to 4dp) |
TaxRates[].TaxComponents[].Name |
String | No |
Name of Tax Component |
TaxRates[].TaxComponents[].IsCompound |
Boolean | No |
Boolean to describe if Tax rate is compounded. |
TaxRates[].CanApplyToEquity |
Boolean | No |
Boolean to describe if tax rate can be used for equity accounts i.e true,false |
TaxRates[].CanApplyToLiabilities |
Boolean | No |
Boolean to describe if tax rate can be used for liability accounts i.e. true,false |
TaxRates[].Name |
String | No |
Name of tax rate |
TaxRates[].CanApplyToRevenue |
Boolean | No |
Boolean to describe if tax rate can be used for revenue accounts i.e. true,false |
TaxRates[].Status |
String | No |
See Status Codes Possible values:
|
TaxRates[].CanApplyToAssets |
Boolean | No |
Boolean to describe if tax rate can be used for asset accounts i.e. true,false |
TaxRates[].ReportTaxType |
String | No |
See ReportTaxTypes Possible values:
|
TaxRates[].EffectiveRate |
Number | No |
Effective Tax Rate (decimal to 4dp) e.g 12.5000 |
TaxRates[].TaxType |
String | No |
The tax type |
TaxRates[].CanApplyToExpenses |
Boolean | No |
Boolean to describe if tax rate can be used for expense accounts i.e. true,false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.