Skip to main content
PATCH
Updates an existing tax class.

Authorizations

Authorization
string
header
required

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

Scopes

taxes.write
oauth2-authorization-code

Grants permission to create and modify tax data.

taxes.write
oauth2-client-credentials

Grants permission to create and modify tax data.

Headers

x-companyid
string

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

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

id
string<uuid>
required

Id of a tax class.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request parameters

Updates an existing tax class. - Request

isStandard
boolean

Whether this tax class is the standard tax class. Setting this to true will set all other tax classes to non-standard.

name
string

The name of the tax class, at most 255 characters. A changed name must not be empty and must differ from the names of all other tax classes, where upper and lower case and white space at the start or end do not count. This rule applies from JTL-Wawi 2.3 on; earlier releases accepted empty and duplicate names. The name is stored as sent. The current name sent exactly as it is stored is always accepted, even if it is empty or another tax class uses it too. The comparison with the stored name is exact: a name that differs from it only in case or in white space at the start or end counts as changed and has to follow the rule.

taxType
enum<integer>

The type of the tax class

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

Response

The tax class has been successfully updated.