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": "a9a83d72-de6b-4bf2-978e-bf43c629764e", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "d0aae9fd-6fc6-4370-86b2-8a68b89c6840", "2f41bdb5-9b23-467d-a0c4-7bf3c63d66ea" ], "TaxMapping": { "Id": "4751667f-ed01-426d-a308-fd1d5540f8df", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "df34e373-c1e2-4de1-9cd2-28d4f2502496", "CorrelationId": "43070032-169b-4b46-9bcf-f63388dcef33", "TaxRateIds": [ "efc56046-cb41-4322-a3bc-7414095608a5", "7a6b2d9e-e48c-4af8-ac6d-7c1abd7804c8" ], "TaxRates": [ { "Id": "fd9daca3-edff-48e5-89ba-d155a7219992", "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-02-20T19:02:09.6657749+00:00", "EndDateUtc": "2025-02-20T19:02:09.6657749+00:00", "IsActive": true }, { "Id": "fd9daca3-edff-48e5-89ba-d155a7219992", "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-02-20T19:02:09.6657749+00:00", "EndDateUtc": "2025-02-20T19:02:09.6657749+00:00", "IsActive": true } ] } }