Get tax rates

Use when listing tax rates (e.g. tax config UI). Returns tax rates with optional filters.

GET /taxes/rates

Get tax rates

cURL

curl --request GET \
  --url https://api.tirdad.ai/v1/taxes/rates \
  --header 'x-api-key: <api-key>'

200

[
  {
    "code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "description": "<string>",
    "environment_id": "<string>",
    "fixed_value": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "percentage_value": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  }
]

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

end_time · string

expand · string

limit · integer

Required range: 1 <= x <= 1000

offset · integer

Required range: x >= 0

order · enum<string>

Available options: asc, desc

scope · enum<string>

Available options: INTERNAL, EXTERNAL, ONETIME

start_time · string

status · enum<string>

Available options: published, deleted, archived

taxrate_codes · string[]

taxrate_ids · string[]

Response

200

application/json

OK

code · string

created_at · string<date-time>

created_by · string

description · string

environment_id · string

fixed_value · string

id · string

metadata · object

Show child attributes

name · string

percentage_value · string

scope · enum<string>

Available options: INTERNAL, EXTERNAL, ONETIME

status · enum<string>

Available options: published, deleted, archived

tax_rate_status · enum<string>

Available options: ACTIVE, INACTIVE

tax_rate_type · enum<string>

Available options: percentage, fixed

tenant_id · string

updated_at · string<date-time>

updated_by · string