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

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

Get taxes

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

Path Parameters

NameTypeDescription

cloudId

integer

Query Parameters

NameTypeDescription

sort

string

filter

string

page

string

limit

string

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

[
 {
  // response schema
 }
]

Get tax

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

Path Parameters

NameTypeDescription

taxId

integer

cloudId

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

Create taxes

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

Path Parameters

NameTypeDescription

cloudId

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

[
 {
  // response schema
 }
]

Replace or create taxes

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

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

[
 {
  // response schema
 }

Replace or create tax

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

Path Parameters

NameTypeDescription

taxId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

Partial update of tax

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

Path Parameters

NameTypeDescription

taxId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

If-Match*

string

ETag to update only if not changed.

Delete tax

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

Path Parameters

NameTypeDescription

taxId

integer

cloudId

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

Options taxes

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

Path Parameters

NameTypeDescription

cloudId

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

Options tax

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

Path Parameters

NameTypeDescription

taxId

integer

cloudId

integer

Headers

NameTypeDescription

Authorization

string

Bearer accessToken

Last updated