GET v1/Companies({CompanyId})/TaxCategories
Returns all Tax Categories for a Company
Information:
Base URL:
https://api.covasoft.net/taxes
Example of a call would be:
https://api.covasoft.net/taxes/v1/Companies({CompanyId})/TaxCategories
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
All the Tax Categories for a Company
Collection of 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": "a4837c33-bb05-46ad-a2fa-9b64b477adb4", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "805d13a2-dd12-4a76-93a8-e71e34055af4", "3cfbd10c-3829-4ca0-a79e-26b49acd52d7" ], "TaxMapping": { "Id": "45d92ed4-f7a9-4441-a228-ef6c7cd3070d", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "8ede30d0-148f-44e5-8814-dc1dfecf6c95", "CorrelationId": "80163720-c005-4879-9569-cc3bcf99e9dc", "TaxRateIds": [ "dd652098-35f0-43e5-a193-112833f18213", "d7aea165-c81d-49a6-80f3-c5fa95f4ea73" ], "TaxRates": [ { "Id": "62a7db62-9d91-4e08-88ff-f51a6561fd5c", "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-02-20T19:19:59.0984695+00:00", "EndDateUtc": "2025-02-20T19:19:59.0984695+00:00", "IsActive": true }, { "Id": "62a7db62-9d91-4e08-88ff-f51a6561fd5c", "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-02-20T19:19:59.0984695+00:00", "EndDateUtc": "2025-02-20T19:19:59.0984695+00:00", "IsActive": true } ] } }, { "Id": "a4837c33-bb05-46ad-a2fa-9b64b477adb4", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "805d13a2-dd12-4a76-93a8-e71e34055af4", "3cfbd10c-3829-4ca0-a79e-26b49acd52d7" ], "TaxMapping": { "Id": "45d92ed4-f7a9-4441-a228-ef6c7cd3070d", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "8ede30d0-148f-44e5-8814-dc1dfecf6c95", "CorrelationId": "80163720-c005-4879-9569-cc3bcf99e9dc", "TaxRateIds": [ "dd652098-35f0-43e5-a193-112833f18213", "d7aea165-c81d-49a6-80f3-c5fa95f4ea73" ], "TaxRates": [ { "Id": "62a7db62-9d91-4e08-88ff-f51a6561fd5c", "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-02-20T19:19:59.0984695+00:00", "EndDateUtc": "2025-02-20T19:19:59.0984695+00:00", "IsActive": true }, { "Id": "62a7db62-9d91-4e08-88ff-f51a6561fd5c", "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-02-20T19:19:59.0984695+00:00", "EndDateUtc": "2025-02-20T19:19:59.0984695+00:00", "IsActive": true } ] } } ]