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": "d8756549-c062-4dd4-b164-5045ee7a2572", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "2b1c7f3b-8a91-4e5b-a012-629f059d3682", "06c1f2bc-ba0f-460e-bd49-fefccaee57f8" ], "TaxMapping": { "Id": "163e10b2-a5f7-426f-9404-f7644d5d917f", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "c948a319-d112-40e5-87a0-d9ab7d8c5bb3", "CorrelationId": "95f1efa4-7419-4918-8e93-50bf571e6ecf", "TaxRateIds": [ "b6052f72-bf50-4693-bb60-9904445975e2", "62fd2864-928c-4def-8224-1bc0b4c98315" ], "TaxRates": [ { "Id": "d7953cf6-9a36-4956-abb3-8c9103db539a", "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-01-18T05:19:45.4100403+00:00", "EndDateUtc": "2025-01-18T05:19:45.4100403+00:00", "IsActive": true }, { "Id": "d7953cf6-9a36-4956-abb3-8c9103db539a", "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-01-18T05:19:45.4100403+00:00", "EndDateUtc": "2025-01-18T05:19:45.4100403+00:00", "IsActive": true } ] } }, { "Id": "d8756549-c062-4dd4-b164-5045ee7a2572", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "2b1c7f3b-8a91-4e5b-a012-629f059d3682", "06c1f2bc-ba0f-460e-bd49-fefccaee57f8" ], "TaxMapping": { "Id": "163e10b2-a5f7-426f-9404-f7644d5d917f", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "c948a319-d112-40e5-87a0-d9ab7d8c5bb3", "CorrelationId": "95f1efa4-7419-4918-8e93-50bf571e6ecf", "TaxRateIds": [ "b6052f72-bf50-4693-bb60-9904445975e2", "62fd2864-928c-4def-8224-1bc0b4c98315" ], "TaxRates": [ { "Id": "d7953cf6-9a36-4956-abb3-8c9103db539a", "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-01-18T05:19:45.4100403+00:00", "EndDateUtc": "2025-01-18T05:19:45.4100403+00:00", "IsActive": true }, { "Id": "d7953cf6-9a36-4956-abb3-8c9103db539a", "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-01-18T05:19:45.4100403+00:00", "EndDateUtc": "2025-01-18T05:19:45.4100403+00:00", "IsActive": true } ] } } ]