Кассовые смены

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

Ключ

Тип

Описание

id

ObjectId

ID смены.

user

User

Сотрудник.

unit

Unit

Точка, на которой открыта смена.

open

datetime

Дата открытия смены.

open_comment

Optional[str]

Комментарий при открытии смены.

close

Optional[datetime]

Дата закрытия смены. Если значение null - смена ещё открыта.

close_comment

Optional[str]

Комментарий закрытия смены.

Дополнительные поля при запросе смены по ID

Ключ

Тип

Описание

duration

Optional[int]

Продолжительность смены в минутах.

cash_open_condition

Optional[number]

Сумма наличных в кассе на открытие смены, указанная пользователем.

cash_close_condition

Optional[number]

Сумма наличных в кассе на закрытие смены, указанная пользователем.

encashment

Optional[number]

Сумма инкассации при закрытии смены.

verification_terminal

Optional[number]

Сумма операций по терминалу за смену, указанная пользователем.

Запрос списка кассовых смен

Для просмотра списка кассовых смен используется API GET /api/workshift.

В query-параметрах запроса допустимо использование следующих фильтров:

Ключ

Тип

Описание

begin

date, datetime

Время/дата начала интервала фильтрации.

end

date, datetime

Время/дата конца интервала фильтрации.

users

List[ObjectId]

Список менеджеров для фильтрации.

users_ne

List[ObjectId]

Список менеджеров для исключения из фильтрации.

units

List[ObjectId]

Список точек для фильтрации.

units_ne

List[ObjectId]

Список точек для исключения из фильтрации.

franchisees

List[ObjectId]

Список франчайзи для фильтрации.

franchisees_ne

List[ObjectId]

Список франчайзи для исключения из фильтрации.

ids

List[ObjectId]

Список ID смен.

Запрос данных смены по ID

Для запроса данных смены по её ID используется API GET /api/workshift/<id>.

Пример запроса

curl -X GET \
     https://demo.idealist.one/api/workshift/59b8e8e0ed98749cb26ff87d \
     -H 'Authorization: Bearer persistent 2adbd5dc-38c4-4963-8930-6d75827ff0fe'