Tax (VAT rates)

Configuration of various taxes. Currently the only supported type is VAT.

Tax schema

_cloudId long
Cloud ID

created timestamp?
Timestamp of entity creation
📶 EQUALS,ENUM,NUMBER 🔽 BOTH

deleted boolean
If entity is deleted
📶 EQUALS,ENUM

flags short
Flags for the tax
📶 BITS

id long?
Entity ID - cannot be null in PUT/PATCH methods
📶 EQUALS,ENUM

name string?
Name of the tax
📶 STRING 🔽 BOTH

value double
Value of tax in percent, f.e. 20 = 20%. Must be in range <0; 100> and it must be unique - having two entities with the same value is not allowed (exempted rate is an exception).
🔽 BOTH

versionDate timestamp?
Last modification date and time
📶 EQUALS,ENUM,NUMBER 🔽 BOTH

JSON response

{
    "_cloudId": <integer>,
    "created": <timestamp>,
    "deleted": <boolean>,
    "flags": <integer>,
    "id": <long>,
    "name": <string>,
    "value": <double>,
    "versionDate": <timestamp>
}

Tax flags

Bit	Name
0	TAKE_AWAY_RATE
1	EXEMPTED_RATE
2	DELIVERY_DEFAULT_RATE

Info

If flag EXEMPTED_RATE is set, the value must be 0.

Get taxes

GET https://api.dotykacka.cz/v2/clouds/:cloudId/taxes

Path Parameters

Name	Type	Description
cloudId	integer

Query Parameters

Name	Type	Description
sort	string
filter	string
page	string
limit	string

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200

[
 {
  // response schema
 }
]

Get tax

GET https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name	Type	Description
taxId	integer
cloudId	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200

Create taxes

POST https://api.dotykacka.cz/v2/clouds/:cloudId/taxes

Path Parameters

Name	Type	Description
cloudId	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200

[
 {
  // response schema
 }
]

Replace or create taxes

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/taxes

Path Parameters

Name	Type	Description
cloudId*	integer

Headers

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match	string	ETag to update only if not changed.

200

[
 {
  // response schema
 }

Replace or create tax

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name	Type	Description
taxId*	integer
cloudId*	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken
If-Match	string	ETag to update only if not changed.

200

Partial update of tax

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name	Type	Description
taxId*	integer
cloudId*	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken
If-Match*	string	ETag to update only if not changed.

200

Delete tax

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name	Type	Description
taxId	integer
cloudId	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200

Options taxes

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/taxes

Path Parameters

Name	Type	Description
cloudId	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200

Options tax

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/taxes/:taxId

Path Parameters

Name	Type	Description
taxId	integer
cloudId	integer

Headers

Name	Type	Description
Authorization	string	Bearer accessToken

200