GET v1/Companies({CompanyId})/TaxCategories({TaxCategoryId}
Returns the Tax Category Details for a Tax Category
Information:
Base URL:
https://api.covasoft.net/taxes
Example of a call would be:
https://api.covasoft.net/taxes/v1/Companies({CompanyId})/TaxCategories({TaxCategoryId})
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
TaxCategoryId |
The Tax Category Id Guid for the tax you want Details |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Tax Category Details for a Tax Category
TaxCategoryName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
CompanyId | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
IsDefault | boolean |
None. |
|
ProductCatalogIds | Collection of globally unique identifier |
None. |
|
TaxMapping | TaxMapping |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "2c782572-39a2-4f7b-ab49-7780545a6f60", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "a360c218-bcf8-4327-8574-540accb208c8", "5a73ee1b-ab2d-4480-89d2-586cf1b241fd" ], "TaxMapping": { "Id": "75495932-6a80-4782-ae1a-9c3aaef30d59", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "4e8a6272-e396-4545-a904-caa6296f5d79", "CorrelationId": "e0538af1-34e6-4a54-b254-9ef4cb8de133", "TaxRateIds": [ "8498d260-492f-4e82-8c43-5f2063307316", "528dbc61-73b1-41e9-b6ee-c4e1a53141f8" ], "TaxRates": [ { "Id": "ac9bf93c-a789-47b3-83f0-20611d673255", "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": "2025-03-31T10:41:51.3732577+00:00", "EndDateUtc": "2025-03-31T10:41:51.3732577+00:00", "IsActive": true }, { "Id": "ac9bf93c-a789-47b3-83f0-20611d673255", "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": "2025-03-31T10:41:51.3732577+00:00", "EndDateUtc": "2025-03-31T10:41:51.3732577+00:00", "IsActive": true } ] } }