Объекты и свойства объектов

AppGroupType

Тип группы приложений

Параметр	Тип данных	Описание
APPLICATION	enum	приложение
GAME	enum	игра
DEFAULT	enum	по умолчанию

AppType

Тип приложения

Параметр	Тип данных	Описание
APPLICATION	enum	приложение
GAME	enum	игра

Booking

Информация о бронировании хоста

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор брони	+	509882
hosts	Array	массив идентификаторов забронированных хостов	+	49461
client	array	информация о клиенте	-	User
from	DateTime	дата и время начала брони	+	“2024-02-12 22:00:00”
to	DateTime	дата и время окончания брони	+	“2024-02-12 23:30:00”
comment	string	комментарий к брони	-	“тестовый комментарий”
status	array	статус брони BookingStatus	+	“REDEEMED”
startsIn	int	количество секунд до начала брони	+	3886
group	string	uuid, сгенерированный сервером для брони на группу хостов	-

BookingInput

Параметры запроса брони

Параметр	Тип данных	Описание	Обязательно	Пример
hosts	Array	массив идентификаторов бронируемых хостов	+	[49387]
client	int	идентификатор клиента	-	1478729
comment	string	комментарий брони	-	text
from	DateTime	время и дата начала брони	+	2024-03-14 20:30:00
to	DateTime	Время и дата завершения брони	+	2024-03-14 21:30:00
status	enum	статус брони BookingStatus	-	ACTIVE

BookingStatus

Статус брони

Параметр	Тип данных	Описание
ACTIVE	enum	активная
FINISHED	enum	завершенная
CANCELED	enum	отмененная
REDEEMED	enum	подтвержденная

CartEntity

Сущность, применяемая к промокоду

Параметр	Тип данных	Описание
GOOD	enum	товар
SERVICE	enum	услуга
TARIFF	enum	тариф

CashOrder

Кассовый ордер

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор кассового ордера	+	12345
workshift	Array	информация смены	+	WorkShift
type	enum	тип кассового ордера	+	CashOrderType
sum	float	сумма выдачи по ордеру	+	253.25
comment	string	комментарий к ордеру	+	текст комментария
created_at	DateTime	дата и время создания касового ордера	+	2022-12-30 15:17:38

CashOrderType

Тип кассового ордера

Значение	Описание
PKO	приходный кассовый ордер
RKO	расходный кассовый ордер

clientBooking

Бронь клиента

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор брони	+
club	Array	Данные о клубе	+	ClientClub
hosts	Array	Хосты клиента	+	ClientHost
from	DateTime	дата и время начала брони	+	2022-12-29 15:17:38
to	Date Time	дата и время окончания брони	+	2022-12-30 15:17:38
comment	string	комментарий к брони	-	текст комментария
status	string	статус брони BookingStatus	+	ACTIVE
startsIn	int	количество секунд до начала брони	+	3886
can_cancel	boolean	флаг возможности отмены брони	+	false

ClientClub

Данные о клубе

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор клуба	+	1553
name	string	название клуба	+	NewLadoga
address	string	адрес клуба	+	Санкт-Петербург, Миллионная, 1
city	string	город, в котором расположен клуб	+	Санкт-Петербург
last_visited_at	DateTime	дата и время последнего посещения клуба	+	2022-12-29 15:17:38
deposit	float	общий депозит клуба	+	10410
discount	int	скидка клуба	+	10
visits	Array	визиты в клуб	+	ClientClubVisit
accept_payments	boolean	флаг работы с онлайн-платежами	+	true
booking_enabled	boolean	флаг возможности бронирования хостов в клубе	+	true
currency	Array	Данные валюты расчетов	+	Currency

ClientClubVisit

Данные визитов в клуб

Параметр	Тип данных	Описание	Обязательно	Пример
visited_at	DateTime	дата и время визита в клуб	+	2022-11-06 19:03:57

ClientHost

Хост клиента

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор хоста	+	49751
group_id	int	идентификатор группы, в которой создается хост	+	10121
type_id	int	идентификатор зарезервированного поля	+	4692
position	int	номер позиции на странице карты клуба	-	1
alias	string	название хоста	+	first
coord_x	int	координата Х хоста на страницы карты клуба (первый хост с координатой 0)	-	1
coord_y	int	координата Y хоста на страницы карты клуба (первый хост с координатой 0)	-	0
is_occupied	boolean	флаг занятого хоста	+	true
is_booked	boolean	флаг забронированного хоста	+	true
in_service	boolean	флаг нахождения хоста в сервисе	+	false
created_at	DateTime	дата и время создания хоста	+	2024-02-17 12:01:52
info	Array	данные о хосте	-	HostInfo

ClientSession

Данные о сессии клиента

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сессии	+
client	Array	Информация о пользователе	-	User
hosts	Array	данные хоста сессии клиента	+	ClientSessionHost
duration	int	общая длительность сессии в секундах	+	58460
elapsed	int	прошедшее время сессии в секундах	+	8540
payment	Array	данные об оплате	-	Paymment
postpaid	boolean	флаг постоплаты	+	true
total_cost	float	общая стоимость сессии	+	254.85654
status	string	статус сессии клиента (ClientSesionType)	+	ACTIVE
seances	Array	информация о сеансах клиента	+	Seance
created_at	DateTime	дата и время создания сессии	+	2024-02-17 12:01:52
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52
canceled_at	DateTime	дата и время отмены сессии	-	2024-02-17 12:01:52
time_left	int	оставшееся время до завершения в секундах	-	8540

ClientSessionType

Статус сессии клиента

Параметр	Тип данных	Описание
PLANED	enum	запланирована
ACTIVE	enum	активная
FINISHED	enum	завершена
CANCELLED	enum	отменена

ClientSessions

Данные о сессиях клиентов

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сессии	+	58461
client	Array	данные о клиенте	-	User
hosts	Array	данные хоста сессии клиента	+	ClientSessionHost
duration	int	общая длительность сессии в секундах	+	58460
elapsed	int	прошедшее время сессии в секундах	+	8540
total_cost	float	общая стоимость сессии	+	254.85654
status	string	статус сессии клиента (ClientSesionType)	+	ACTIVE
seances	Array	информация о сеансах клиента	+	Seance
created_at	DateTime	дата и время создания сессии	+	2024-02-17 12:01:52
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52
canceled_at	DateTime	дата и время отмены сессии	-	2024-02-17 12:01:52
time_left	int	оставшееся время до завершения в секундах	-	8540

ClientSessionHost

Данные хоста сессии клиента

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сессии хоста	+
host	Array	Данные хоста	+	Host
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52

ClientSessionOverview

Данные о сессии клиента

Параметр	Тип данных	Описание	Обязательно	Пример
duration	int	общая длительность сессии в секундах	+	58460
elapsed	int	прошедшее время сессии в секундах	+	8540
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52
seances	Array	информация о сеансах клиента	+	Seance

ClubComment

Параметры комментария

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор комментария	+	47487
client_session	Array	данные сессии клиента	+	ClientSession
text	string	текст комментария	+	Очень хороший клуб, все понравилось!
author	Array	данные автора комментария	-	User
created_at	DateTime	дата и время создания комментария	+	2024-02-17 12:01:52
deleted_at	DateTime	дата и время удаления комментария	-	2024-02-17 13:01:52
host_alias	string	название хоста	+	Red-1
host_group_name	string	название группы хостов/зала	+	Общий зал
grade	int	оценка, оставленная с комментарием	+	5
is_read	boolean	флаг прочтения комментария	+	true

ClubCommentSearchInput

Параметры запроса комментариев

Параметр	Тип данных	Описание	Обязательно	Пример
user_uuid	string	уникальный идентификатор клиента	-	1d2f3616-8c65-4bb1-9b9b-04a84b4d19f5
sort	enum	значение сортировки комментариев	-	ClubCommentSearchSort
page	int	номер страницы	-	2
first	int	количество элементов, которые нужно вывести	-	2

ClubCommentSearchSort

Значение сортировки комментариев

Параметр	Тип данных	Описание
NEW_FIRST	enum	сортировка “сначала новые”
OLD_FIRST	enum	сортировка “сначала старые”
HIGH_GRADE_FIRST	enum	сортировка “сначала с высокой оценкой”
LOW_GRADE_FIRST	enum	сортировка “сначала с низкой оценкой”

ClubCommentSummary

Резюме комментариев

Параметр	Тип данных	Описание	Обязательно	Пример
average_grade	float	средняя оценка	+	3.777777671813965
unread_total	int	кол-во непрочтенных	+	2
five	int	кол-во оценок 5	+	2
four	int	кол-во оценок 4	+	3
three	int	кол-во оценок 3	+	2
two	int	кол-во оценок 2	+	2
one	int	кол-во оценок 1	+	1

Conditions

Условия получения достижений

Параметр	Тип данных	Описание	Обязательно	Пример
name	string	Наименование условия, при котором присваивается достижение	+	spent_hours
value	float	значение условия, при котором присваивается достижение	+	3600

CreateCommandInput

Параметры ввода данных команды

Параметр	Тип данных	Описание	Обязательно	Пример
host_id	int	идентификатор хоста, на который отправляется команда	+	50628
action	enum	команда	+	HostCommandAction
param	string	параметр команды HostCommandAction	-	5

Currency

Данные валюты расчетов

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор валюты	+	643
title	string	наименование валюты	+	Российский рубль
alias	stirng	код валюты	+	RUB
letter	string	символ валюты	+	₽

Discount

Информация о скидке

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор скидки	+	25462
author	Array	Создатель скидки	+	User
client	Array	Владелец скидки	-	User
title	string	заголовок скидки	+
value	float	процент скидки при использовании скидки	+
entity	string	сущность, применяемая к промокоду CartEntity	-	TARIFF
entity_id	int	идентификатор сущности	-
created_at	DateTime	дата и время создания скидки	+	2024-02-17 12:01:52
is_tracked	boolean	флаг отправления в телеграмм сообщения об использовании скидки (необходима подписка и настроеный телеграмм)	+	true

EventInput

Параметры запроса события

Параметр	Тип данных	Описание	Обязательно	Пример
types	Array	тип события	-	CLIENT_SESSION_STARTED
start	DateTime	дата и время начала периода выбора событий	-	“2024-02-20 22:00:00”
finish	DateTime	дата и время окончания периода выбора событий	-	“2024-03-25 22:00:00”
work_shift_id	int	идентификатор смены	-	586279
q	string	ключевое слово для поиска	-	сессия

EventListItem

Позиции списка событий

Параметр	Тип данных	Описание	Обязательно	Пример
timestamp	DateTime	временная метка события	+	2024-04-18 16:04:47
type	string	тип события	+	HOST_SESSION_FINISHED
settings	Array	объекты используемые для передачи данных об изменении параметров	-	EventListItemAliasValues
setting	Array	объект используемый для передачи данных об изменении параметров	-	EventListItemAliasValues
booking	Array	данные брони в списке событий	-	EventListItemBooking
cash_order	Array	данные кассового ордера	-	EventListItemCashOrder
client_session	Array	данные сессии клиента	-	EventListItemClientSession
promocode	Array	данные промокода	-	EventListItemIdTitleValueF
good	Array	данные товара	-	EventListItemIdTitle
service	Array	данные услуги	-	EventListItemIdTitle
tariff	Array	данные товара	-	EventListItemIdTitle
host	Array	данные хоста	-	EventListItemIdTitleValueI
host2	Array	данные хоста	-	EventListItemIdTitleValueI
hosts	Array	данные хостов	-	EventListItemIdTitleValueI
host_group	Array	данные группы хостов (зала)	-	EventListItemIdTitle
host_group2	Array	данные группы хостов (зала)	-	EventListItemIdTitle
host_command	Array	данные команды, переданной хосту	-	EventListItemIdTitle
client	Array	данные клиента	-	EventListItemUser
manager	Array	данные менеджера	-	EventListItemUser
operator	Array	данные оператора	-	EventListItemUser
worker	Array	данные работника смены	-	EventListItemUser
role	Array	данные роли	-	EventListItemIdTitle
role2	Array	данные роли	-	EventListItemIdTitle
user_group	Array	данные группы пользователей	-	EventListItemIdTitleValueI
user_group2	Array	данные группы пользователей	-	EventListItemIdTitleValueI
payment	Array	данные чека	-	EventListItemIdTitleValueF
payment_items	Array	данные позиций чека	-	EventListItemPaymentItem
warehouse_item	Array	данные позиций склада	-	EventListItemWarehouseItem
work_shift	Array	временная метка рабочей смены	-	2024-04-18 16:04:47
worker_task	Array	данные задачи сотрудника	-	EventListItemTask
goods	Array	данные товаров	-	EventListItemIdTitle
new_goods_amount	Array	данные количества новых товаров	-	EventListItemIdTitleValueF
new_devices	Array	данные обновления девайса	-	EventListItemAliasValues
cash_on_start	float	сумма наличных при открытии смены	-	0
cashback	float	сумма кэшбека	-	254.8
paused_type	string	способ приостановки клиенсткой сессии	-	(AUTO/ MANUAL)
additional_seconds	int	кол-во добавленных секунд	-	25400
send_code_method	string	метод отправки кода	-	?
penalty	int	количество секунд штрафа	-	420
value1	float	?	+
value2	float	?	+
comment	string	комментарий события	-	текст комментария
duration	int	общая длительность сессии в секундах	+	58460
deposit	float	сумма депозита	+	250
combo	Array	данные комбо-наборов	-	EventListItemCombo
combo_items	Array	данные позиций комбо-наборов	-	EventListItemComboItem

EventListItemAliasValues

Объект, используется для передачи данных об изменении параметров

Параметр	Тип данных	Описание	Обязательно	Пример
alias	string	название настройки	+	диск
value	string	старое значение	+	256
value2	string	новое значение	+	512

EventListItemBooking

Данные брони в списке событий

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор брони	+	254354
cost	float	стоимость брони	+	250.25
from	DateTime	дата и время начала брони	+	“2024-02-12 22:00:00”
to	DateTime	дата и время окончания брони	+	“2024-02-12 23:30:00”

EventListItemCashOrder

Данные кассового ордера

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор кассового ордера	+	12345
created_at	DateTime	дата и время создания касового ордера	+	2022-12-30 15:17:38
type	enum	тип кассового ордера	+	CashOrderType
sum	float	сумма выдачи по ордеру	+	253.25
comment	string	комментарий к ордеру	+	текст комментария

EventListItemClientSession

Данные сессии клиента

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сессии	+	254598
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52
time_left	int	оставшееся время до завершения в секундах	-	8540
expires_at	DateTime	дата и время истечения сессии	-	2024-02-17 12:01:52
is_per_minute	boolean	флаг поминутной сессии	-	true
total_cost	float	общая стоимость сессии	-	254.85654

EventListItemCombo

Данные комбо-набора

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор комбо-набора	-	25412
title	string	заголовок комбо-набора	-	Ром с колой
host_group_id	int	идентификатор зала	-	25422
host_group_title	string	зголовок зала	-	Общий зал
tarif_id	int	идентификатор тарифа	-	2415
tariff_title	string	Заголовок тарифа	-	Ночной пакет

EventListItemComboItem

Данные позиций комбо-набора

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор комбо-набора	-	254215
entity_id	int	идентификатор сущности комбо-набора	-	2114
entity_type	string	тип сущности комбо-набора	-
title	string	заголовок комбо-набора	-	Ром с колой
amount	int	количество комбо-наборов	-	15

EventListItemPaymentItem

Данные позици чека

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор позиции	-	254255
entity_id	int	идентификатор сущности типа позиции	- (необязательный только для DEPOSIT)	1253
entity_type	string	тип позиции	-	PaymentItemType
title	string	заголовок позиции	-	DEPOSIT
amount	int	кол-во позиций в чеке	-	1
sum	float	сумма	-	50

EventListItemIdTitle

Данные промокода

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор промокода	-	254225
title	string	заголовок промокода	-	Coca-Cola

EventListItemIdTitleValueI

Объект в ивентах, которой используется для передачи данных id, названия и целочисленного значения (int)

Пример для параметра user_group:

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор группы	-	254225
title	string	название группы	-	Best group
value	int	значение скидки для клиентов в этой группе	-	15

EventListItemIdTitleValueF

Объект в ивентах, которой используется для передачи данных id, названия и числа с плавающей запятой (float)

Пример для параметра payment:

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор платежа	-	254227
title	string	метод оплаты	-	CARD
value	float	сумма платежа	-	55.28

EventListItemUser

Данные пользователя

Параметр	Тип данных	Описание	Обязательно	Пример
uuid	string	уникальный идентификатор пользователя	-	1d2f3616-8c65-4bb1-9b9b-04a84b4d19f5
phone	string	номер телефона пользователя	-	79217445241
email	email	адрес электроннной почты пользователя	-	example@yandex.ru
nickname	string	никнейм пользователя	-	Wind
first_name	string	имя пользователя	-	Иван
last_name	string	фамилия пользователя	-	Иванов

EventListItemTask

Данные задачи сотрудника

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор задачи	-	25485
creator_uuid	string	уникальный идентификатор создателя задачи	-	1d2f3616-8c65-4bb1-9b9b-04a84b4d19f5
title	string	заголовок задачи	+	Поднять тестовый сервер
assigned_to	int	идентификатор сотрудника, ответственного за выполнение задачи	-	1325
deadline_at	Datetime	дата и время срока исполнения задачи	+	2024-02-01 10:26:06

EventListItemWarehouseItem

Данные позиций склада

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор позиции	-	254255
entity_id	int	идентификатор связанной сущности (на данный момент только id товара (GOOD))	- (необязательный только для DEPOSIT)	1253
entity_type	string	тип связанной сущности (на данный момент это только товары - GOODS)	-	GOODS
title	string	название связанной сущности (на данный момент это только товара)	-	GOOD
value	float	старое значение	-	54
value2	float	новое значение	-	50

Event

Событие. К событиям относится любая активность в компьютерном клубе.

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор события	+	167722558
type	string	тип события	+	ACHIEVEMENT_CREATED
created_at	DateTime	дата и время создания события	+	2024-02-12 17:50:39
relations	string	связь с сущностями, создавшими данное событие	-	{\"host\":{\"id\":48975,\"alias\":\"01\",\"info\":{},\"groupId\":1236,\"typeId\":869,\"createdAt\":\"2024-02-07 15:23:19\",\"companyId\":1872,\"deviceUpdatedAt\":\"0001-01-01 00:00:00\",\"deviceChangeConfirmedAt\":\"0001-01-01 00:00:00\"}}
workShift	Array	данные рабочей смены администратора	-	workShift
initiator	Array	данные инициатора события	-	User
initiatorHost	Array	данные о хосте	-	Host
description	string	описание события	-	Создан новый хост 01

GameAccount

Игровой аккаунт

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор аккаунта	+	15354
login	string	логин аккаунта	+	login
password	string	пароль от аккаунта	+	password
group	Array	группа аккаунтов игры	+	GameAccountGroup
host	Array	параметры хоста	-	Host
active	boolean	флаг активности аккаунта	+	true
status	enum	статус аккаунта	+	GameAccoutStatus
busy	boolean	флаг занятости аккаунта	+	true

GameAccountGroup

Группа аккаунтов игры

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор группы	+
title	string	заголовок группы	+
launcher	enum	лаунчер игрового аккаунта GameAccountLauncher	+	STEAM
accounts	Array	игровой аккаунт	+	GameAccount
shortcuts	Array	ярлык	+	Shortcut

GameAccountLauncher

Лаунчер игрового аккаунта

Параметр	Тип данных	Описание
STEAM	enaum	Steam
EGS	enum	EGS
BATTLENET	enum	BattleNet
ORIGIN	enum	Origin
EA	enum	EA Games
VKPLAY	enum	VKPlay

GameAccoutStatus

Статус аккаунта

Параметр	Тип данных	Описание
OFFLINE	enum	Оффлайн
ONLINE	enum	Ондайн
IN_GAME	enum	В игре

Good

Товар

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор товара	+	37924
title	string	заголовок товара	+	009. Кола 0,33
subtitle	string	подзаголовок товара	+
comment	string	комментарий к товару	+
cost	float	стоимость товара	+	70
wholesale_cost	cost	себестоимость товара	+	45
tax_percent	float	размер налога в процентах	+	0
unit_name	string	единица товара	+	(штука, литр…)
unit_value	float	единица измерения товара (0,33 литра)	+	0
amount	int	количетство	+	9
image	string	URL изображения товара	+	path/to/image
use_global_discount	boolean	возможность использования скидки на товар	+	false
created_at	DateTime	дата и время создания товара	+	2024-02-17 12:01:52
state	Array	состояние товара на складе	-	WarehouseState
tax_system	string	система налогообложения TaxSystem	-	MAIN
vat	string	тип налога Vat	-	NO_NDS
ean	string	штрихкод	-
use_fair_sign	boolean	Использование маркировки честный знак	+	true
is_excise	boolean	подакцизный товар	+	false

Host

Данные хоста

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор хоста	+	49751
group_id	int	идентификатор группы, в которой создается хоста	+	10121
group	Array	информация о зале (группе хостов)	+	HostGroup
type_id	int	идентификатор зарезервированного поля	+	4692
position	int	номер позиции на странице карты клуба	-	1
alias	string	название хоста	+	first
comment	string	комментарий к хосту	-	текст комментария
mac_addr	MacAddress	МАС-адрес хоста	-
ip_addr	IpAddress	IP-адрес хоста	-
dns_name	string	доменное имя	-
coord_x	int	координата Х хоста на страницы карты клуба (первый хост с координатой 0)	-	1
coord_y	int	координата Y хоста на страницы карты клуба (первый хост с координатой 0)	-	0
is_deleted	boolean	был ли удален хост	+	true
in_service	boolean	нахождение хоста в сервисе	+	false
created_at	DateTime	дата и время создания хоста	+	2024-02-17 12:01:52
info	Array	данные о хосте	-	HostInfo
counters	Array	метрики хоста	-	HostCounters
sessions	Array	данные о сессии хоста	+	HostSession
client_sessions	Array	данные о сессий клиентов	+	Client_sessions
shell_mode	Array	статус Shell: NORMAL; DISABLED; HIGH_ACCESS	+	NORMAL
last_online	DateTime	дата и время последнего выхода хоста в онлайн	-	2024-02-17 12:01:52
online	boolean	нахождение хоста онлайн	+	true
bookings	Array	информация о бронировании хоста	+	Booking
device_has_changed	Boolean	состояние обновления хоста	+	false
device_updated_at	DateTime	дата и время обноления хоста	-	2024-02-17 12:01:52
device_changes_	Array	данные об изменениях хоста	+	HostDevice
locked	boolean	блокирован ли хост	+	true
admin_called_at	DateTime	Время вызова администратора	-	2024-02-17 12:01:52

HostCommand

Параметры команды, отправленной на хост

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор команды	+	75821498
action	enum	команда (HostCommandAction)	+	REBOOT
status	string	состояние исполнения команды	-	Статусы команд
param	string	аргументы/параметры/доп инфа по команде, зависит от самой команды (HostCommandAction)	-	5

Статусы команд

Статус	Описание
new	создана
sent	отправлена на хост
failed	выполнить не удалось
success	успешно выполнена
expired	просрочена

HostCommandAction

Описание и параметры команд

Команда	Описание	Параметры
WAKE_UP	“разбудить” другой хост	MAC хоста (a4:2e:99:0a:43:4a)
SHUTDOWN	выключить	id работника, отправившего команду
REBOOT	перезагрузить	id работника, отправившего команду
ALLOW_ADMIN_MODE	включить режим администратора	id работника, отправившего команду
DISABLE_SHELL	снять шелл на хосте	id работника, отправившего команду
SHOW_MESSAGE	показать сообщение	сообщение для отображения на экране
LOGOFF	выйти из аккаунта	id работника, отправившего команду
RUN	выполнить файл на хосте	путь к исполняемому файлу
SEND_LOGS	отправить логи с хоста разработчикам	без параметра
SHELL_UPDATE	запустить обновление SmartShell на хосте	без параметра

HostCounters

Метрики хоста

Параметр	Тип данных	Описание	Обязательно	Пример
cpu_temp	float	температура ЦПУ	+
disk_temp	float	темпаратура диска	+
disk_status	Array	данные диска хоста HostDiskInfo	+
active_window	string	активность окна	-

HostDiskInfo

Данные диска хоста

Параметр	Тип данных	Описание	Обязательно	Пример
letter	string	имя диска (буква)	+
total	int	общий размер диска	+
used	int	кол-во занятой памяти диска	+

HostGroup

Информация о зале (группе хостов)

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор группы
title	int	название группы	+	Общий зал
created_at	DateTime	дата и время создания группы	+	2024-02-17 12:01:52
updated_at	DateTime	дата и время обновления группы	+	2024-02-17 12:01:52
hosts	Array	информация о хостах в группе	+	Host
customization	Array	информация о кастомизации группы	-	HostGroupCustomization

HostGroupCustomization

Информация о кастомизации группы

Параметр	Тип данных	Описание	Обязательно	Пример
color	string	цвет метки группы	-	red
background	string	цвет фона	-	green
screensaver	string	путь до изображения скринсейвера	-	path/to/img

HostInfo

Конфигурация хоста

Параметр	Тип данных	Описание	Обязательно	Пример
processor	string	процессор	-
ram	string	объем памяти RAM	-
video	string	информация о видео карте	-
disc	string	объем HDD	-
shell_version	string	информация о версии SHELL	-

HostInput

Параметры создания нового хоста

Параметр	Тип данных	Описание	Обязательно	Пример
group_id	int	идентификатор группы, в которой создается хост	+	10121
type_id	int	идентификатор зарезервированного поля	+	4692
position	int	номер позиции на странице карты клуба	-	1
alias	string	название хоста	+	first
comment	string	Комментарий к хосту	-	текст комментария
mac_addr	MacAddress	МАС-адрес хоста	-
ip_addr	IpAddress	IP-адрес хоста	-
dns_name	string	доменное имя	-
coord_x	int	координата Х хоста на страницы карты клуба (первый хост с координатой 0)	-	1
coord_y	int	координата Y хоста на страницы карты клуба (первый хост с координатой 0)	-	0

HostSession

Данные о сессии хоста

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сессии	+	54874
host_id	int	идентификатор хоста	+	49387
alias	string	название хоста	-	first
user	Array	информация о пользователе	-	User
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время завершения сессии	-	2024-02-17 12:01:52

MoneyByTypes

Описание денежных средств

Параметр	Тип данных	Описание	Обязательно	Пример
cash	float	сумма средств опалченных наличными	+	429
card	float	сумма средств опалченных картой	+	100
deposit	float	остаток средств на депозите	+	3.4000000953674316
bonus	float	сумма бонусов	+	0
total	float	сумма средств оплаченных картой и наличными	+	529
currency	Array	данные валюты расчетов	-	Currency

MoneyData

Сумма продаж

Параметр	Тип данных	Описание	Обязательно	Пример
good	float	сумма продаж товаров	+	80.52
service	float	сумма продаж услуг	+	512.20
tariff	float	сумма продаж тарифов	+	125.04
deposit	float	сумма депозита	+	1500

Payment

Данные платежа (Чек)

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор платежа	+
client	Array	данные клиента, внесшего платеж	-	User
client_session	Array	информация о сессии клиента	-	ClientSession
work_shift	Array	информация смены	-	WorkShift
promo_code	Array	информация промокода	-	PromoCode
discount	Array	Информация о скидке	-	Discount
method	string	способ оплаты PaymentMethod	+	CASH
status	string	статус платежа PaymentsStatus	+	PAID
sum	float	сумма платежа	+	253.26
created_at	DateTime	дата и время создания платежа	+	2024-02-17 12:01:52
items	Array	позиции чека	+	PaymentItem
is_refunded	boolean	флаг возврата	+	true
not_refundable	boolean	флаг безвозвратного платежа	+	false
card_sum	float	сумма оплаты картой	+	0
cash_sum	float	сумма оплаты наличными	+	0
comment	string	комментарий к платежу	-	текст комментария
cashback	float	размер кэшбэка в процентах	+	5

PaymentHistory

История покупок

Параметр	Тип данных	Описание	Обязательно	Пример
created_at	DateTime	дата и время создания платежа	+	2024-02-17 12:01:52
title	string	заголовок	+	Пополнение депозита
amount	int	количество единиц товара/сервиса в покупке	+	25
sum	float	итоговая сумма за товары	+	1000
card_sum	float	сумма оплаты картой	+	0
cash_sum	float	сумма оплаты наличными	+	0
worker	Array	сотрудник, который провел платеж	-	User
items	Array	позиции чека	+	PaymentItem
is_refunded	boolean	возврат	+	false
paymentmethod	Array	тип оплаты	+	PaymentMethod

PaymentInput

Параметры ввода данных чека

Параметр	Тип данных	Описание	Обязательно	Пример
method	Array	Метод оплаты покупки	+	PaymentMethod
client_uuid	string	уникальный идентификатор клиента	-	1d2f3616-8c65-4bb1-9b9b-04a84b4d19f5
client_session_id	int	идентификатор сессии клиента	-	12546
promo_code_id	int	идентификатор промокода	-	5214
discount_id	int	идентификатор скидки	-	3524
items	Array	ввод позиций чека	+	PaymentItemInput
card_sum	float	сумма оплаты картой	-	0
comment	string	комментарий	-	текст комментария

Параметр client_uuid обязателен для методов оплаты:

• DEPOSIT;
• BONUS.

Параметры promo_code_id и discount_id НЕ используются для методов оплаты BONUS.

Параметр card_sum обязателен для метода оплаты COMPOSITE, указывается сумма наличными и картой.

PaymentItem

Позиции чека

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор позиции	+
payment_id	int	идентификатор платежа, в котором была продана эта позиция (совпадает с id Payment)	+
combo_id	int	идентификатор набора	-
type	string	тип позиции PaymentItemType	+	GOOD
entity	Array	сущность типа позиции	-	PaymentItemEntity
amount	int	кол-во позиций в чеке	+	1
sum	float	сумма	+	50

PaymentItemInput

Параметры ввода позиции чека

Параметр	Тип данных	Описание	Обязательно	Пример
type	Array	Тип позиции (покупки)	+	PaymentItemType
entity_id	int	идентификатор сущности типа позиции	-	1253
host_id	int	идентификатор хоста	-	2533
amount	int	кол-во позиций в чеке	+	1
sum	float	сумма	-	50

PaymentItemEntity

Cущность типа позиции

Параметр	Тип данных	Описание
GOOD	enum	товар
SERVICE	enum	услуга
TARIFF	enum	тариф
COMBO	enum	набор товаров

PaymentItemType

Тип позиции (покупки)

Параметр	Тип данных	Описание
DEPOSIT	enum	депозит
GOOD	enum	товар
SERVICE	enum	услуга
TARIFF	enum	тариф
COMBO	enum	набор

PaymentMethod

Тип оплаты

Параметр	Тип данных	Описание
CARD	enum	Оплата картой
CASH	enum	Оплата наличными
DEPOSIT	enum	Оплата депозитом
BONUS	enum	Оплата боусами
COMPOSITE	enum	раздельный платёж (карта + наличные)
CLOUD_PAYMENTS	enum	онлайн оплата с сайта gamer.smartshell.gg
POST_PAY	enum	постоплата (оплата после сеанса)

PaymentsReport

Диапазон дат для формирования отчета продаж

Параметр	Тип данных	Описание	Обязательно	Пример
from	DateTime	дата и время начала диапазона продаж	-	2024-02-01 12:20:06
to	DateTime	дата и время окончания диапазона продаж	-	2024-03-01 23:59:00

PaymentStatus

Cтатус платежа

Параметр	Тип данных	Описание
PENDING	enum	в ожидании
PAID	enum	оплачен
UNPAID	enum	не оплачен

Permission

Разрешения роли

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор разрешения	+	1
alias	string	Название разрешения	+	event_browse
title	string	Заголовок разрешения	+	Просмотр логов
description	string	Описание разрешения	-	Текстовое описание

Перечень разрешений

Роль “Менеджер”

id	alias	title
1	event_browse	Просмотр логов
2	comment_read	Просмотр комментариев
3	client_browse	Просмотр клиентов (включая поиск)
4	client_manage	Управление клиентами
5	game_account_manage	Управление клубными аккаунтами
7	promo_code_browse	Просмотр промокодов
8	public_key	Доступ к публичному ключу
9	comment_delete	Удаление комментариев
10	reports_manage	Управление отчетами
11	game_account_browse	Просмотр клубных аккаунтов
12	host_browse	Просмотр хостов
13	service_manage	Управление услугами
14	worker_task_complete	Выполнение задачи
15	client_session_manage	Управление клиентскими сессиями
16	good_manage	Управление товарами
17	shortcut_manage	Управление иконками
18	worker_task_manage	Управление задачами
19	worker_manage	Управление сотрудниками
20	good_manage_dispose	Списание товара со склада
22	cash_order_delete	Удаление кассового ордера
23	discount_browse	Просмотр скидок
24	host_manage	Управление хостами
25	setting_browse	Просмотр настроек
26	work_shift_active	Просмотр данных активной смены
27	good_browse	Просмотр товаров
28	payment_browse	Просмотр платежей
29	setting_manage	Управление настройками
30	shortcut_browse	Просмотр ярлыков контента
31	worker_task_browse	Просмотр своих задач
32	promo_code_manage	Управление промокодами
34	user_phone_view	Просмотр телефона пользователя
35	worker_task_all_browse	Просмотр задач сотрудников
36	good_manage_add	Добавление товара на склад
37	work_shift_open	Открытие рабочей смены
38	comment_create	Создание комментариев
39	discount_manage	Управление скидками
40	game_account_password_view	Управление паролем от клубного аккаунта
41	refund_create	Оформление возврата
42	role_browse	Просмотр ролей
43	tariff_manage	Управление тарифами
44	user_creator_view	Просмотр создателя пользователя
45	can_login_into_work_shift	Вход во время активной смены
47	service_browse	Просмотр услуг
48	tariff_browse	Просмотр тарифов
49	work_shift_browse	Просмотр рабочих смен
50	work_shift_close	Закрытие рабочей смены
51	host_command_manage	Создание команд для хоста
52	booking_manage	Управление бронированием
86	combo_browse	Просмотр комбо наборов
87	combo_manage	Продажа комбо наборов
88	loyalty_program_browse	Просмотр системы лояльности
89	loyalty_program_manage	Настройка системы лояльности
90	shop_browse	Просмотр тарифов\товаров\услуг\комбо
91	shop_manage	Настройка тарифов\товаров\услуг\комбо

Роль “Оператор”

id	alias	title
12	host_browse	Просмотр хостов
25	setting_browse	Просмотр настроек
26	work_shift_active	Просмотр данных активной смены
37	work_shift_open	Открытие рабочей смены
86	combo_browse	Просмотр комбо наборов

PromoCode

Информация промокода

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор промокода	+
author	Array	Создатель промокода	+	User
client	Array	Владелец промокода	-	User
code	string	код	+	PROMO50
value	float	процент скидки при использовании промокода	+	50
amount	int	количество промокодов	-	0
entity	string	сущность, применяемая к промокоду	-	CartEntity
entity_id	int	идентификатор сущности	-	12354
created_at	DateTime	дата и время создания промокода	+	2024-02-17 12:01:52
is_tracked	boolean	флаг отправления в телеграмм сообщения об использовании промокода (необходима подписка и настроеный телеграмм)	+	true

PromoCodeInput

Параметры создания промокода

Параметр	Тип данных	Описание	Обязательно	Пример
client_id	int	идентификатор клиента, для которого создан промокод	-	5
code	string	код	+	PROMO50
value	float	процент скидки при использовании промокода	+	50
amount	int	количество промокодов	-	0
entity	string	сущность, применяемая к промокоду	-	CartEntity
entity_id	int	идентификатор сущности	-	12354
created_at	DateTime	дата и время создания промокода	+	2024-02-17 12:01:52
is_tracked	boolean	флаг отправления в телеграмм сообщения об использовании промокода (необходима подписка и настроеный телеграмм)	+	true

Rewards

Информация о награде

Параметр	Тип данных	Описание	Обязательно	Пример
name	string	Наименование награды	+	add_discount
value	float	значение условия, при котором присваивается награда	+	3

Role

Возвращает данные роли пользователя

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор роли	+	2
alias	string	название роли	+	manager
title	string	заголовок роли	+	Менеджер
description	string	описание роли	-	Текстовое описание роли
is_service	boolean	флаг обслуживания роли	+	false
priority	int	значение приоритета роли	+	20
permissions	Array	разрешения роли	+	(Permission)

Seance

Данные о сеансе

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор сеанса	+	12548
client_sessions	Array	данные о сессии клиента	+	Client_sessions
tariff	Array	данные тарифа	+	Tariff
duration	int	общая длительность сессии в секундах	+	58460
elapsed	int	прошедшее время сессии в секундах	+	8540
payment	Array	платежная информация	-	Payment
payment_item	Array	позиция платежа, к которому относится сеанс	-	PaymentItem
status	string	статус сессии клиента(ClientSesionType)	+	ACTIVE
created_at	DateTime	дата и время создания сессии	+	2024-02-17 12:01:52
started_at	DateTime	дата и время начала сессии	+	2024-02-17 12:01:52
finished_at	DateTime	дата и время окончания сессии	-	2024-02-17 12:01:52
canceled_at	DateTime	дата и время отмены сессии	-	2024-02-17 12:01:52

Service

Услуга

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор услуги	+	37924
title	string	заголовок услуги	+	009. Кола 0,33
cost	float	стоимость услуги	+	70
wholesale_cost	cost	себестоимость услуги	+	45
tax_percent	float	размер налога в процентах	+	0
use_global_discount	boolean	возможность использования скидки на услугу	+	false
created_at	DateTime	дата и время создания услуги	+	2024-02-17 12:01:52
tax_system	string	система налогообложения TaxSystem	-	MAIN
vat	string	тип налога Vat	-	NO_NDS
ean	string	штрихкод	-

SettingPair

Параметры настроек

Параметр	Тип данных	Описание	Обязательно	Пример
alias	sring	имя настройки	+	cashbox.tax.type.goods
value	string	значение настройки	+	NO_NDS
updated_at	DateTime	дата и время обновления значений настройки	+	2024-02-17 12:01:52

Shortcut

Ярлык и параметры приложения, длступных для запуска.

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор ярлыка	+	66634
title	string	заголовок приложения	+	Roblox
path	string	пути до исполняемого файла	+	["shell:AppsFolder/ROBLOXCORPORATION.ROBLOX_55nm5eh3cm0pr!App"]
group_id	int	идентификатор группы приложений	+	1932
group	Array	группа ярлыков	+	ShortcutGroup
type	enum	тип приложения AppType	+	GAME
popular	boolean	флаг популярности приложения	+	true
sort	float	сортировка	+	2
args	string	аргументы, для запуска приложения, управляет менеджер/владелец клуба	-
icon_path	string	путь до иконки	-	path/to/icon.png
password	string	пароль для запуска приложения	-	password
main_picture	string	путь до изображения приложения	-	path/to/main_picture.png
game_account_group	Array	группа аккаунтов игры	-	GameAccountGroup
run_as_admin	boolean	фдаг запуска от имени администратора	+	true
work_dir	string	путь до рабочей директории	-	C:\\Program Files\\Registrar Registry Manager\\
only_for_registred	boolean	флаг доступности только для зарегистрированных пользователей	-	true
age_rating	int	возрастной ценз приложения	-	18
free_run	boolean	флаг бесплатного запуска приложения	-	false

ShortcutGroup

Группа ярлыков

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор группы	+	1932
title	string	заголовок группы	+	default
sort	int	сортировка	+	10
groupType	enum	тип группы приложения (AppGroupType)	+	DEFAULT

StartClientSessionInput

Параметры запуска сессии определенного клиента

Параметр	Тип данных	Описание	Обязательно	Пример
user_id	int	идентификатор клиента	-	5
host_id	int	идентификатор хоста	-	32003
post_paid	boolean	флаг постоплаты	-	true

Идентификатор клиента (id) можно узнать методом clients.

Идентификатор хоста (host_id) можно узнать методом hostsOverview.

Tariff

Параметры тарифа

Параметр	Тип данных	Описание	Обязательность	Пример
id	int	идентификатор тарифа	+	144404
title	string	Заголовок тарифа	+	Ночной пакет
duration	int	длительность тарифа в секундах	+	35999
use_global_discounts	boolean	флаг использования скидки на этом тарифе	+	true
has_fixed_finish_time	boolean	флаг изменения времени окончния тарифа для пакетного и фиксированного тарифов разница во времени	+	true
created_at	DateTime	Дата и время создания тарифа	+	2024-02-17 12:01:52
is_active	boolean	активность тарифа	-	true
per_minute	boolean	тариф поминутный	+	true
show_in_shell	boolean	отображение в Shell	+	true
show_in_billing	boolean	отображение в биллинге	+	true
shedules	Array	период действия тарифа	+	TarffPeriod
sell_shedules	Array	временные рамки, когда можно продать тариф в виде пары чисел, которые сопоставялются с началом недели	+	TarffPeriod
price_list	Array	Прайс лист тарифа	+	TariffPricelist
pausable	boolean	приостановка действия тарифа	+	true
lifetime	int	время действия тарифа	+	0
ean	string	штрихкод	-
highlighted	boolean	подсветка тарифа	-	true
description	string	описание тарифа	-
sort	int	значение сортировки тарифа	+
is_tracked	boolean	флаг отправления в телеграмм сообщения об использовании скидки (необходима подписка и настроеный телеграмм)	+	true
online_booking_enabled	boolean	флаг онлайн бронирования тарифа	+	true
use_on_holidays	boolean	флаг действия по праздничным дням	+	true

TariffPeriod

Период действия тарифа

Параметр	Тип данных	Описание	Обязательно	Пример
start	int	время в секундах до начала действия тарифа	+	79201
end	int	время в секундах до окончания действия тарифа	+	115200

TariffPricelist

Прайс-лист тарифа для зала

Параметр	Тип данных	Описание	Обязательно	Пример
host_groups	Array	Залы клуба, в которых дейстует тариф	+	HostGroup
cost_map	Array	данные тарифа для конкретного зала	+	TariffPricelistCostMap

TariffPricelistCostMap

Цены для конкретного TariffPricelist

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	заголовок	+	DEFAULT
value	float	?	+	500
currency	Array	Данные валюты расчетов	+	Currency

Заголовок может приниммать 2 значения:

• DEFAULT - цена для гостей;
• USER_COST - цена для зарегистрированных пользователей.

TaxSystem

Налоговая система

Параметр	Тип данных	Описание
SIMPLE_INCOME	enum	упрощенная система налогообложения (доходы)
SIMPLE_INCOME_EXPENSES	enum	упращенная система налогообложения (доходы - расходы)
PATENT	enum	патентная система налогообложения
MAIN	enum	основная система налогообложения

UnifiedReport

?

Параметр	Тип данных	Описание	Обязательно	Пример
labels	string	обозначение полей	+	“Смена”, “Сотрудник”, “Начало”, “Конец”
extraLabels	string	?	+	“admin admin admin”, “admin admin admin”
extraLabels2	string	?	+	“2024-03-19 14:01:20”, “2024-03-11 16:36:25”
extraLabels3	string	?	+	“2024-03-26 10:20:57”, “2024-03-19 14:00:10”
keys	string	столбец, по которму строится график	+	“586279”, “576500”
points	int	?	+	4
data	Array	data ?	+	UnifiedReportData
url	string	путь до файла с отчетом	-	https://storage.yandexcloud.net/smartshell-static/report/work_shifts/1872/UfXokHGLjBowork_shifts.csv
summary	Array	?	+	UnifiedSummaryData

UnifiedReportData

?

Параметр	Тип данных	Описание	Обязательно	Пример
values	float	?	+	604912, 0, 0, 0, 50

UnifiedSummaryData

Сведенная информация по отчету

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	заголовок	+	tariff sum
values	float	?	+	329

UpdateSettingInput

Параметры обновления настроек

Параметр	Тип данных	Описание	Обязательно	Пример
alias	string	имя настройки	+	shell.club_name
values	string	значение настройки	-	NewPortal2

Имя настройки можно получить методом settingValues

User

Информация пользователя

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор пользователя	+	2
uuid	string	уникальный идентификатор пользователя	+	1d2f3616-8c65-4bb1-9b9b-04a84b4d19f5
group	Array	группа, к которой принадлежит пользователь (UserGroup)	-
creator	Array	информация о создателе пользователя (User)	-
login	string	логин пользователя (номер телефона)	+	79217445241
nickname	string	никнейм пользователя	+	Wind
phone	string	номер телефона пользователя	+	79217445241
email	email	адрес электроннной почты пользователя	-	example@yandex.ru
phone_suffix	string	код страны номера телефона	+	2357
dob	date	дата рождения пользователя	+	1970-01-01
country_code	string	код страны пользователя	-	RU
roles	Array	роли пользователя (Role)	+
first_name	string	имя пользователя	-	Иван
last_name	string	фамилия пользователя	-	Иванов
middle_name	string	отчество пользователя	-	Иванович
deposit	float	остаток средств пользовтаеля	+	27937.7
last_client_activity	DateTime	дата последней активности клиента	-	2024-02-06 15:08:49
last_worker_activity	DateTime	дата последней активности сотрудника клуба	-	2024-02-06 15:08:49
last_comment	Array	последний комментарий пользователя (Comment)	-
user_discount	int	размер скидки пользователя	-	15
created_at	DateTime	дата создания пользователя	+	2022-11-12 11:34:53
updated_at	DateTime	дата обновления данных пользователя	+	2024-02-06 15:08:49
disabled_at	DateTime	дата отключения пользователя	-	2024-02-08 22:08:49
banned_at	DateTime	дата блокировки пользователя	-	2024-02-08 22:08:49
total_hours	int	количество часов, проведенных пользователем в системе	+	43
pausable_info	Array	информация о паузах пользователя	-
city	string	название города	-	Москва
avatar_url	string	путь к аватару пользователя	+	path/to/avatar.png

Vat

Тип налога

Параметр	Тип данных	Описание
NO_NDS	enum	без НДС
NDS_0	enum	НДС 0%
NDS_10	enum	НДС 10%
NDS_20	enum	НДС 20%
NDS_110	enum	НДС 110%
NDS_120	enum	НДС 120%

WarehouseState

Состояние товара на складе

Параметр	Тип данных	Описание	Обязательно	Пример
received	int	кол-во полученного товара	+	8
income	int	приход товара	+	8
sold	int	кол-во проданного товара	+	5
disposal	int	кол-во списанного товара	+	2

WorkShift

Данные рабочей смены администратора

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор смены	+	530036
comment	string	комментарий к смене	-	текст комментария
worker	Array	данные работника смены	+	User
created_at	Datetime	дата и время создания смены	+	2024-02-01 10:26:06
finished_at	DateTime	дата и время окончания смены	-	2024-02-07 22:13:50
money	Array	финансовые данные смены	-	WorkShiftMoney
payments	Array	платежная информация	-	Payment
cashOrders	Array	данные чека	-	CashOrder

WorkShiftEvent

Событие смены

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор события смены	+
type	string	тип события смены	-
created_at	DateTime	дата и время создания события смены	-	2024-02-01 12:20:06

WorkShiftInput

Параметры диапазона выбора дат смен

Параметр	Тип данных	Описание	Обязательно	Пример
created_from	DateTime	дата и время начала диапазона выбора смен	-	2024-02-01 12:20:06
created_to	DateTime	дата и время окончания диапазона выбора смен	-	2024-03-01 23:59:00
worker_id	int	идентификатор пользователя	+	5

WorkShiftMoney

Финансовые данные смены

Параметр	Тип данных	Описание	Обязательно	Пример
sum	Array	описание денежных средств	-	MoneyByTypes
cash_on_start	сумма наличных средств на начало смены	-	0

WorkShiftPaymentOverviewData

Данные по чекам за выбранную смену

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор выбранной смены	+	586279
worker	Array	данные работника смены	+	User
cash_on_start	float	сумма наличных в кассе при открытии смены	+	0
total	float	итговая сумма за смену	+	1080
deposit	float	сумма, внесенная на депозит	+	150
bonus	float	сумма выданных бонусов	+	0
refunded	float	сумма вовзрата	+	585
cash	float	сумма оплат наличными	+	80
card	float	сумма оплат картами	+	1000
cash_orders	Array	данные кассовых ордеров	-	CashOrder
sum	Arrary	Сумма продаж	+	MoneyData
currency	Array	Данные валюты расчетов	-	Currency
created_at	DateTime	дата и время начала смены	+	2024-02-01 12:20:06
finished_at	DateTime	дата и время окончания смены	-	2024-02-01 12:20:06
goods	Array	данные продаж товаров	-	WorkShiftPaymentOverviewGoodData
services	Array	данные продаж услуг	-	WorkShiftPaymentOverviewServiceData
combos	Array	данные продаж комбо-товаров	-	WorkShiftPaymentOverviewComboData

WorkShiftPaymentOverviewComboData

Данные продаж комбо-наборов

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	название комбо-набора	+	Ром с колой
amount	int	количество проданных комбо-набора	+	2
sum	float	сумма за продажи комбо-набора	+	1500

WorkShiftPaymentOverviewGoodData

Данные продаж товаров

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	название товара	+	Капучино
cost	float	цена за единицу товара	+	80
amount	int	количество проданных товаров	+	1
in_stock	int	количество оставшегося товара	+	5
sum	float	сумма за продажи комбо-набора	+	1500

WorkShiftPaymentOverviewServiceData

Данные продаж услуг

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	название услуги	+	Печать А4
amount	int	количество проданных услуг	+	2
sum	float	сумма за продажи услуг	+	25

WorkShiftsReport

Массив смен за указанный диапазон

Параметр	Тип данных	Описание	Обязательно	Пример
from	DateTime	дата и время начала диапазона выбора смен	+	2024-02-01 12:20:06
to	DateTime	дата и время окончания диапазона выбора смен	+	2024-03-01 23:59:00
workerUuid	string	уникальный идентификатор сотрудника	-	c9ffdc47-d337-4849-ac36-cf8ceb0c086b

WorkerTaskInput

Параметры для создания задачи

Параметр	Тип данных	Описание	Обязательно	Пример
title	string	заголовок задачи	+	Поднять тестовый сервер
assigned_to	int	идентификатор сотрудника, ответственного за выполнение	-	1325
deadline_at	Datetime	дата и время срока исполнения задачи	+	2024-02-01 10:26:06

WorkerTask

Данные задачи, заведенной на сотрудника

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор задачи	+	14312
creator	Array	создатель задачи	+	User
title	string	заголовок задачи	+	Новая задача
assigned_to	Array	данные сотрудника, ответственного за выполнение	-	User
executor	Array	исполнитель задачи	-	User
created_at	Datetime	дата и время создания задачи	+	2024-02-01 10:26:06
updates_at	Datetime	дата и время обновления задачи	+	2024-02-01 10:26:06
deadline_at	Datetime	дата и время срока исполнения задачи	+	2024-02-01 10:26:06
finished_at	DateTime	время окончания смены	-	2024-02-07 22:13:50

WorkerTaskPaginated

Данные задач сотрудников

Параметр	Тип данных	Описание	Обязательно	Пример
id	int	идентификатор задачи	+	14312
creator	Array	создатель задачи	+	User
title	string	заголовок задачи	+	Новая задача
assigned_to	Array	данные пользователя, на кого назначена задача	-	User
executor	Array	исполнитель задачи	-	User
created_at	Datetime	дата и время создания задачи	+	2024-02-01 10:26:06
updates_at	Datetime	дата и время обновления задачи	+	2024-02-01 10:26:06
deadline_at	Datetime	дата и время срока исполнения задачи	+	2024-02-01 10:26:06
finished_at	DateTime	время окончания смены	-	2024-02-07 22:13:50