GET v1/Companies({CompanyId})/TaxRates({TaxRateId})
Returns Tax Details for a Tax Rate
Information:
Base URL:
https://api.covasoft.net/taxes
Example of a call would be:
ttps://api.covasoft.net/taxes/v1/Companies({CompanyId})/TaxRates({TaxRateId})
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
| TaxRateId |
The Tax Id Guid for the tax you want Details |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Tax Details for a Tax Rate
TaxRate| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| CompanyId | integer |
None. |
|
| Name | string |
None. |
|
| DisplayName | string |
None. |
|
| Description | string |
None. |
|
| Rate | decimal number |
None. |
|
| TaxRateType |
Percentage or FlatRate |
string |
None. |
| TaxCalculatedOn |
Taxes calculated on SoldAtPrice or BasePriceListPrice |
string |
None. |
| Layer |
For compound taxes. Does this tax apply on top of other taxes. Currently only support single compound levels. Zero (0) is base level, one (1) is compounding tax |
integer |
None. |
| StartDateUtc | date |
None. |
|
| EndDateUtc | date |
None. |
|
| IsActive | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "f84e0fbe-28bc-4e2a-aef0-254d4813c356",
"CompanyId": 2,
"Name": "sample string 3",
"DisplayName": "sample string 4",
"Description": "sample string 5",
"Rate": 6.1,
"TaxRateType": "sample string 7",
"TaxCalculatedOn": "sample string 8",
"Layer": 9,
"StartDateUtc": "2024-11-25T11:19:34.3004716+00:00",
"EndDateUtc": "2024-11-25T11:19:34.3004716+00:00",
"IsActive": true
}