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": "28cdd2c0-64d6-4a3d-b2ac-e5edad9235bc", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "5bbcc852-81e2-49be-92c3-bc4962c0a381", "44a89c25-ba3b-4fe2-9f59-819e18ef419c" ], "TaxMapping": { "Id": "f88dd762-c0e6-4f2f-bba1-a7b7f98d9a92", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "109e482e-0f53-4226-99c2-79ec52cd843c", "CorrelationId": "41ebf861-df7c-4b5d-837b-8d68bd78519e", "TaxRateIds": [ "2a1267a7-5a45-4915-a4da-cf9e39b96875", "8426e291-644f-4005-8ced-7cbbc52488d4" ], "TaxRates": [ { "Id": "fa71e04c-a040-4c51-bb6e-9f76fc56a307", "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": "2024-11-07T08:39:13.1064609+00:00", "EndDateUtc": "2024-11-07T08:39:13.1064609+00:00", "IsActive": true }, { "Id": "fa71e04c-a040-4c51-bb6e-9f76fc56a307", "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": "2024-11-07T08:39:13.1064609+00:00", "EndDateUtc": "2024-11-07T08:39:13.1064609+00:00", "IsActive": true } ] } }, { "Id": "28cdd2c0-64d6-4a3d-b2ac-e5edad9235bc", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "5bbcc852-81e2-49be-92c3-bc4962c0a381", "44a89c25-ba3b-4fe2-9f59-819e18ef419c" ], "TaxMapping": { "Id": "f88dd762-c0e6-4f2f-bba1-a7b7f98d9a92", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "109e482e-0f53-4226-99c2-79ec52cd843c", "CorrelationId": "41ebf861-df7c-4b5d-837b-8d68bd78519e", "TaxRateIds": [ "2a1267a7-5a45-4915-a4da-cf9e39b96875", "8426e291-644f-4005-8ced-7cbbc52488d4" ], "TaxRates": [ { "Id": "fa71e04c-a040-4c51-bb6e-9f76fc56a307", "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": "2024-11-07T08:39:13.1064609+00:00", "EndDateUtc": "2024-11-07T08:39:13.1064609+00:00", "IsActive": true }, { "Id": "fa71e04c-a040-4c51-bb6e-9f76fc56a307", "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": "2024-11-07T08:39:13.1064609+00:00", "EndDateUtc": "2024-11-07T08:39:13.1064609+00:00", "IsActive": true } ] } } ]