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": "eaa2202d-6edc-4f06-a746-0fc63df0808d", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "8861f1ba-595b-46c8-ae55-9527eac24694", "5b01b05b-ebab-463a-a2aa-61f7a5b967fd" ], "TaxMapping": { "Id": "d9e40b21-7432-4a01-b443-e54495141b72", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "8e6e1c73-540d-4a45-b84b-8a9d953c9e6d", "CorrelationId": "ee20d0af-5e9a-4b0a-87f5-eb803355c3a1", "TaxRateIds": [ "821794da-7c81-4100-bf9a-af5d6d3af59c", "dd092725-aa6e-4314-8dfb-0b54cc5866ed" ], "TaxRates": [ { "Id": "627b5e35-c489-440c-b47c-eebb6bc44b4e", "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-05-20T16:27:29.9906055+00:00", "EndDateUtc": "2025-05-20T16:27:29.9906055+00:00", "IsActive": true }, { "Id": "627b5e35-c489-440c-b47c-eebb6bc44b4e", "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-05-20T16:27:29.9906055+00:00", "EndDateUtc": "2025-05-20T16:27:29.9906055+00:00", "IsActive": true } ] } }, { "Id": "eaa2202d-6edc-4f06-a746-0fc63df0808d", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "8861f1ba-595b-46c8-ae55-9527eac24694", "5b01b05b-ebab-463a-a2aa-61f7a5b967fd" ], "TaxMapping": { "Id": "d9e40b21-7432-4a01-b443-e54495141b72", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "8e6e1c73-540d-4a45-b84b-8a9d953c9e6d", "CorrelationId": "ee20d0af-5e9a-4b0a-87f5-eb803355c3a1", "TaxRateIds": [ "821794da-7c81-4100-bf9a-af5d6d3af59c", "dd092725-aa6e-4314-8dfb-0b54cc5866ed" ], "TaxRates": [ { "Id": "627b5e35-c489-440c-b47c-eebb6bc44b4e", "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-05-20T16:27:29.9906055+00:00", "EndDateUtc": "2025-05-20T16:27:29.9906055+00:00", "IsActive": true }, { "Id": "627b5e35-c489-440c-b47c-eebb6bc44b4e", "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-05-20T16:27:29.9906055+00:00", "EndDateUtc": "2025-05-20T16:27:29.9906055+00:00", "IsActive": true } ] } } ]