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

NameDescriptionTypeAdditional 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 TaxCategory
NameDescriptionTypeAdditional 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": "c8e7cf20-2306-41c1-b63a-dc98381d5872",
    "CompanyId": 2,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "IsDefault": true,
    "ProductCatalogIds": [
      "e8649134-6020-4b61-b83b-c75fb1b7891d",
      "1e0e4e97-3a87-4192-8890-9f6ac4c6268e"
    ],
    "TaxMapping": {
      "Id": "69c798ff-6db9-4573-a137-534f35b79e72",
      "CompanyId": 2,
      "TaxCategory": "sample string 3",
      "TaxCategoryId": "828f6cf8-c073-4c59-b696-054a1250151f",
      "CorrelationId": "8761e1a6-eb70-4d5d-b1c6-524839a5fad5",
      "TaxRateIds": [
        "7344548e-035d-4888-889a-5bdaccaf6dc4",
        "1cb90c9b-9243-4507-89f4-6cb1a24a8ca2"
      ],
      "TaxRates": [
        {
          "Id": "4c4bf3ee-5d60-40be-9d54-9fe89834deeb",
          "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:28:53.4824972+00:00",
          "EndDateUtc": "2024-11-25T11:28:53.4824972+00:00",
          "IsActive": true
        },
        {
          "Id": "4c4bf3ee-5d60-40be-9d54-9fe89834deeb",
          "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:28:53.4824972+00:00",
          "EndDateUtc": "2024-11-25T11:28:53.4824972+00:00",
          "IsActive": true
        }
      ]
    }
  },
  {
    "Id": "c8e7cf20-2306-41c1-b63a-dc98381d5872",
    "CompanyId": 2,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "IsDefault": true,
    "ProductCatalogIds": [
      "e8649134-6020-4b61-b83b-c75fb1b7891d",
      "1e0e4e97-3a87-4192-8890-9f6ac4c6268e"
    ],
    "TaxMapping": {
      "Id": "69c798ff-6db9-4573-a137-534f35b79e72",
      "CompanyId": 2,
      "TaxCategory": "sample string 3",
      "TaxCategoryId": "828f6cf8-c073-4c59-b696-054a1250151f",
      "CorrelationId": "8761e1a6-eb70-4d5d-b1c6-524839a5fad5",
      "TaxRateIds": [
        "7344548e-035d-4888-889a-5bdaccaf6dc4",
        "1cb90c9b-9243-4507-89f4-6cb1a24a8ca2"
      ],
      "TaxRates": [
        {
          "Id": "4c4bf3ee-5d60-40be-9d54-9fe89834deeb",
          "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:28:53.4824972+00:00",
          "EndDateUtc": "2024-11-25T11:28:53.4824972+00:00",
          "IsActive": true
        },
        {
          "Id": "4c4bf3ee-5d60-40be-9d54-9fe89834deeb",
          "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:28:53.4824972+00:00",
          "EndDateUtc": "2024-11-25T11:28:53.4824972+00:00",
          "IsActive": true
        }
      ]
    }
  }
]