GET v1/Companies({CompanyId})/TaxCategories({TaxCategoryId}
Returns the Tax Category Details for a Tax Category
Information:
Base URL:
https://api.covasoft.net/taxes
Example of a call would be:
https://api.covasoft.net/taxes/v1/Companies({CompanyId})/TaxCategories({TaxCategoryId})
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
TaxCategoryId |
The Tax Category Id Guid for the tax you want Details |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Tax Category Details for a Tax Category
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": "ede6c0a3-f737-4e80-9726-e005be61c913", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "e9eaf0b5-6334-42f3-82a1-ef5d6cc82980", "a353e88f-2510-4a86-8bf8-9227033a7ce9" ], "TaxMapping": { "Id": "1bdbb0af-41e7-4347-af3a-a2b137828602", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "5fef8158-b2a1-424c-bd9d-0db8936bfac2", "CorrelationId": "97f7dfb5-04ec-40b7-8da5-385cf9029568", "TaxRateIds": [ "7a77332f-4477-445f-87ea-1f18efec2c48", "1ffd9d24-f6e8-46ea-8c5b-96ce11ab7e79" ], "TaxRates": [ { "Id": "83469221-77e3-4fe1-b0a2-adddb0eebf9b", "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-18T04:51:02.0000772+00:00", "EndDateUtc": "2025-01-18T04:51:02.0000772+00:00", "IsActive": true }, { "Id": "83469221-77e3-4fe1-b0a2-adddb0eebf9b", "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-18T04:51:02.0000772+00:00", "EndDateUtc": "2025-01-18T04:51:02.0000772+00:00", "IsActive": true } ] } }