API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Tax schema
  • JSON response
  • Tax flags
  • Get taxes
  • Get tax
  • Create taxes
  • Replace or create taxes
  • Replace or create tax
  • Partial update of tax
  • Delete tax
  • Options taxes
  • Options tax

Was this helpful?

Export as PDF
  1. Entity

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

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

[
 {
  // 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

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

[
 {
  // 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.

[
 {
  // 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.

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.

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

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

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

PreviousTagNextWarehouse

Last updated 1 year ago

Was this helpful?