API
Ask or search…
K
Links

Category

Please see the Breaking changes page for more info on the planned changes in validation.

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 long 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 🔽 BOTH
tags string[]? Tags list for employee 📶 EQUALS, ENUM
vat double? VAT value (a multiplier from range <1.0; 2.0>, f.e. vat=1.234 corresponds to VAT 23.4%)
For VAT payers this value is validated and it must correspond to one of the configured VAT rates.
versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

Category response

JSON
{
"_cloudId": <integer>,
"_defaultCourseId": <long>,
"_eetSubjectId": <long>,
"deleted": <boolean>,
"display": <boolean>,
"externalId": <string>,
"flags": <long>,
"hexColor": <string>,
"id": <long>,
"margin": <string>,
"maxDiscount": <double>,
"modifiedBy": <string>,
"name": <string>,
"sortOrder": <long>,
"tags": <string[]>,
"vat": <double>,
"versionDate": <timestamp>
}

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
// Body request minimmum
[
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"name": <string>
... Optional is category schema
}
]
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories
Replace or create categories
// Body request minimmum
[
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"id": <long>,
"name": <string>
... Optional is category schema
}
]
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/categories/:categoryId
Replace or create category
// Body request minimmum
{
"_cloudId": <integer>,
"deleted": <boolean>,
"display": <boolean>,
"flags": <short>,
"hexColor": <string>,
"id": <long>,
"name": <string>
... Optional is category schema
}
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