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": "6d82d54b-5bc1-4575-9272-8f626083e1ad", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "f0c4bbb6-831b-4a08-a218-3e7bae37f0d8", "b1e5222e-33ba-4d65-bc6b-2bfe9d43838f" ], "TaxMapping": { "Id": "ba1f6c1a-2654-4582-bb53-00e0f6db03f4", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "09a02a57-aa7f-4dbe-abd4-ebee5e53c11b", "CorrelationId": "c9b771da-fb61-4e8e-b00d-afb0ed4747ad", "TaxRateIds": [ "bb5c4081-25a7-48f7-b1ad-020186c12b41", "9c8bfef2-cdde-48b5-80c9-5a8cb1a29f7b" ], "TaxRates": [ { "Id": "2762e50a-2db3-4a50-9666-8998b8f37102", "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:53:53.7769918+00:00", "EndDateUtc": "2024-11-07T08:53:53.7769918+00:00", "IsActive": true }, { "Id": "2762e50a-2db3-4a50-9666-8998b8f37102", "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:53:53.7769918+00:00", "EndDateUtc": "2024-11-07T08:53:53.7769918+00:00", "IsActive": true } ] } }