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": "b717fa46-36c6-4a28-b68e-207bf5967934", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "115c6a74-1de9-4050-9648-e634622d39b5", "1fa6e27d-6e8e-48c5-acb0-e28321abd2e0" ], "TaxMapping": { "Id": "00abea6b-d8e6-44e1-9a7c-26347d1c07cb", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "49d5129a-8ada-4e3b-93ec-10377f914073", "CorrelationId": "ff1d25c8-7c79-43a7-ab5a-bfa3e730f04c", "TaxRateIds": [ "8399b910-7b46-45d5-952e-33166a15b109", "02f1b83a-054f-4ca8-9945-048e2936b29d" ], "TaxRates": [ { "Id": "48ce5317-aee0-4e70-9ce3-574ad36ff599", "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:32:12.0624762+00:00", "EndDateUtc": "2025-03-31T10:32:12.0624762+00:00", "IsActive": true }, { "Id": "48ce5317-aee0-4e70-9ce3-574ad36ff599", "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:32:12.0624762+00:00", "EndDateUtc": "2025-03-31T10:32:12.0624762+00:00", "IsActive": true } ] } }, { "Id": "b717fa46-36c6-4a28-b68e-207bf5967934", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "115c6a74-1de9-4050-9648-e634622d39b5", "1fa6e27d-6e8e-48c5-acb0-e28321abd2e0" ], "TaxMapping": { "Id": "00abea6b-d8e6-44e1-9a7c-26347d1c07cb", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "49d5129a-8ada-4e3b-93ec-10377f914073", "CorrelationId": "ff1d25c8-7c79-43a7-ab5a-bfa3e730f04c", "TaxRateIds": [ "8399b910-7b46-45d5-952e-33166a15b109", "02f1b83a-054f-4ca8-9945-048e2936b29d" ], "TaxRates": [ { "Id": "48ce5317-aee0-4e70-9ce3-574ad36ff599", "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:32:12.0624762+00:00", "EndDateUtc": "2025-03-31T10:32:12.0624762+00:00", "IsActive": true }, { "Id": "48ce5317-aee0-4e70-9ce3-574ad36ff599", "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:32:12.0624762+00:00", "EndDateUtc": "2025-03-31T10:32:12.0624762+00:00", "IsActive": true } ] } } ]