API
Searchโ€ฆ
Category

Category schema

id long? Category ID - cannot be null in PUT/PATCH methods ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE
_cloudId integer Cloud IDโ€‹
_defaultCourseId long? Course ID ๐Ÿ“ถ EQUALS,ENUM
_eetSubjectId long? EET Subject ID ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE
deleted boolean Category deleted - cannot be true in POST/PUT/PATCH methods ๐Ÿ“ถ EQUALS, ENUM ๐Ÿ”ฝ BOTH
display boolean Category displayed ๐Ÿ“ถ EQUALS, ENUM ๐Ÿ”ฝ BOTH
externalId string? External ID ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE
flags short Category flags ๐Ÿ“ถ BITS ๐Ÿ”ฝ NONE
hexColor string(7) Category color
margin string?(180) Category margin
maxDiscount double? Max discount
modifiedBy string?(32) Category modified by
name string(180) Category name ๐Ÿ“ถ STRING ๐Ÿ”ฝ BOTH
sortOrder long? Category sort order
tags string[]? Tags list for employee ๐Ÿ“ถ EQUALS, ENUM
vat double? Vat rate 1.21 = 21%
versionDate timestamp? Last modification date and time ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

Category response

JSON
1
{
2
"_cloudId": <integer>,
3
"_defaultCourseId": <long>,
4
"_eetSubjectId": <long>,
5
"deleted": <boolean>,
6
"display": <boolean>,
7
"externalId": <string>,
8
"flags": <short>,
9
"hexColor": <string>,
10
"id": <long>,
11
"margin": <string>,
12
"maxDiscount": <double>,
13
"modifiedBy": <string>,
14
"name": <string>,
15
"sortOrder": <long>,
16
"tags": <string[]>,
17
"vat": <double>,
18
"versionDate": <timestamp>
19
}
Copied!

Category flags

Bit
Name
8
FISCALIZATION_DISABLED
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories
Get categories
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Get category
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories
Create category
1
// Body request minimmum
2
[
3
{
4
"_cloudId": <integer>,
5
"deleted": <boolean>,
6
"display": <boolean>,
7
"flags": <short>,
8
"hexColor": <string>,
9
"name": <string>
10
... Optional is category schema
11
}
12
]
Copied!
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories
Replace or create categories
1
// Body request minimmum
2
[
3
{
4
"_cloudId": <integer>,
5
"deleted": <boolean>,
6
"display": <boolean>,
7
"flags": <short>,
8
"hexColor": <string>,
9
"id": <long>,
10
"name": <string>
11
... Optional is category schema
12
}
13
]
Copied!
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Replace or create category
1
// Body request minimmum
2
{
3
"_cloudId": <integer>,
4
"deleted": <boolean>,
5
"display": <boolean>,
6
"flags": <short>,
7
"hexColor": <string>,
8
"id": <long>,
9
"name": <string>
10
... Optional is category schema
11
}
Copied!
patch
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Partial update of category
delete
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Delete category
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories
Options categories
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Options category
โ€‹
Last modified 7d ago