Skip to main content
GET
/
v1
/
taxClasses
Query Tax Classes
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/taxClasses \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "Name": "<string>",
    "IsDefault": true
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns all tax classes.

​
Id
integer<int32>
required

Unique ID to identify a tax class.

​
Name
string
required

Name of the tax class.

​
IsDefault
boolean
required

Indicates whether or not the tax class is the default one. There can be only one default tax class.

​
Type
enum<integer>
required

Type of the tax rate.

Available options:
0,
1,
2,
3,
4,
5