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": "37859519-3435-4fcc-b064-c64a832decef", "CompanyId": 2, "Name": "sample string 3", "Description": "sample string 4", "IsDefault": true, "ProductCatalogIds": [ "d8ac35a8-7d01-46d6-aad1-cf5de106dd1e", "382b9fd9-0222-45aa-bb4c-64f5404448cf" ], "TaxMapping": { "Id": "3384b2e7-2ac0-4740-bceb-6a8f78245a82", "CompanyId": 2, "TaxCategory": "sample string 3", "TaxCategoryId": "19e4235a-7b8c-4779-91fc-d94f203be9f2", "CorrelationId": "e43ebcf2-8373-40bc-bcfa-a6a4e9a65eb6", "TaxRateIds": [ "04355d71-5e9f-4c21-8a72-de0b24f9db81", "7b47af16-2426-4413-87a5-4bd4ea972901" ], "TaxRates": [ { "Id": "073edf52-792f-4fd5-bb59-b510e178090d", "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-25T11:34:52.5177868+00:00", "EndDateUtc": "2024-11-25T11:34:52.5333559+00:00", "IsActive": true }, { "Id": "073edf52-792f-4fd5-bb59-b510e178090d", "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-25T11:34:52.5177868+00:00", "EndDateUtc": "2024-11-25T11:34:52.5333559+00:00", "IsActive": true } ] } }