Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Tax Rate

List tax rates

This endpoint returns the tax rate for a given country code. The country code is a two-letter ISO 3166-1 alpha-2 code. The response is a list of applicable tax rates for the given country code. To get a more granular response you can use the query parameters to filter the response, for example by product or project.

The applicable tax rate is determined in the following order:

  1. If a custom tax rate is defined for the product, it is returned.
  2. If a tax rate is defined in the taxRates module for that country, it is returned.
  3. If a tax rate is defined in the taxRates module for the project, or a generic tax Rate without country or project it is returned.
  4. If a tax rate is defined for the applicable project it is returned.
  5. If a tax rate is defined for the system it is returned.
  6. If no tax rate is defined anywhere we will return an empty list.

To see which step was used to determine the tax rate, the source field is returned in the response.

get/api/v1/taxRates/{countryCode}

Path parameters

countryCodestring required

This is the country code for which the tax rates are requested

Query parameters

key'productId' | 'date' | 'type' | 'projectId'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "rate": "Support Request",
      "type": "Support Request",
      "date": "2023-09-09",
      "name": "Support Request",
      "product": {
        "id": "1337"
      },
      "project": {
        "id": "1337"
      },
      "source": "Support Request"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}