Функция работы со сменами

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

Объект смены

Поле	Описание	Тип, возм. значения	листинг
id	Системный идентификатор смены	Целое число	+
salepoint_id	Системный идентификатор кассового аппарата	Целое число	+
number	Номер смены	Целое число	+
state	Состояние смены	opened closed expired	+
expired_at	Дата принудительного окончания смены	Дата YYYY-MM-DD HH:II:SS	+
closed_at	Дата закрытия смены. Если открыта то NULL	Дата YYYY-MM-DD HH:II:SS	+
opened_day	День, на который открыта смена	Дата YYYY-MM-DD	+
cash	Сумма наличных в кассе	Число
organization_name	Наименование организации	Строка	+
organization_inn	ИНН организации	Строка	+
salepoint_serial	Серийный номер кассового аппарата	Строка	+
salepoint_regnum	Регистрацинный номер кассового аппарата	Строка	+
fs_serial	Серийный номер фискального накопителя	Строка	+

Получение списка смен

GET https://vsevkassu.ru/api/v1/shift?param1=value1&param2=value2

Команда возвращает массив объектов смен, выбранных по заданным параметрам. Таблица параметров:

Параметр	Описание	Тип, возможные значения	Обяз.
salepoint_id	Системный номер кассового аппарата.	Целое число	Нет
number	Фильтр по номеру смены.	Целое число	Нет
number_from	Фильтр смен, где номер больше или равен указанному	Целое число	Нет
number_to	Фильтр смен, где номер меньше либо равен указанному	Целое число	Нет
state	Состояние смены. Возможно указание нескольких значений, например: state[]=opened&state[]=expired	opened closed expired	Нет
opened_day	Фильтр смен, открытых на указанную дату.	Дата, формат YYYY-MM-DD	Нет
opened_day_from	Фильтр смен, открытых позже указанной даты.	Дата, формат YYYY-MM-DD	Нет
opened_day_to	Фильтр смен, открытых до указанной даты	Дата, формат YYYY-MM-DD	Нет
offset	Сменещение	Целое число	Нет

По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение. Пример:

GET https://vsevkassu.ru/api/v1/shift?salepoint_id=1

[
    {
        "id": 2,
        "salepoint_id": 1,
        "number": 2,
        "state": "opened",
        "expired_at": "2021-02-05 00:00:00",
        "closed_at": null,
        "opened_day": "2021-02-04",
        "organization_name": "ИП Иванов Иван",
        "organization_inn": "000000000",
        "salepoint_serial": "000000000000",
        "salepoint_regnum": "000000000000000000",
        "fs_serial": "9999999999999999"
    },
    {
        "id": 1,
        "salepoint_id": 1,
        "number": 1,
        "state": "closed",
        "expired_at": "2021-02-04 00:00:00",
        "closed_at": "2021-02-03 00:00:00",
        "opened_day": "2021-02-03",
        "organization_name": "ИП Иванов Иван",
        "organization_inn": "000000000",
        "salepoint_serial": "000000000000",
        "salepoint_regnum": "000000000000000000",
        "fs_serial": "9999999999999999"
    }
]

Получение одной смены

GET https://vsevkassu.ru/api/v1/shift/{id}

Возвращает объект смены по его системному идентификатору

Пример:

GET https://vsevkassu.ru/api/v1/shift/1

{
    "id": 1,
    "salepoint_id": 1,
    "number": 1,
    "state": "closed",
    "expired_at": "2021-02-04 00:00:00",
    "closed_at": "2021-02-03 00:00:00",
    "opened_day": "2021-02-03",
    "cash": null,
    "organization_name": "ИП Иванов Иван",
    "organization_inn": "000000000",
     "salepoint_serial": "000000000000",
     "salepoint_regnum": "000000000000000000",
     "fs_serial": "9999999999999999"
}

Открытие и закрытие смены

POST https://vsevkassu.ru/api/v1/shift

Открывает смену для указанного кассового аппарата, с указанным кассиром, или закрывает ее, при этом кассир не передается. В POST передается JSON массив с параметрами:

Параметр	Описание	Тип, возможные значения	Обяз.
salepoint_id	Системный номер кассового аппарата.	Целое число	Да
type	Тип запроса - открытие или закрытие смены	open close	Да
cashier_id	Системный идентификатор кассира. Не обязателен, при закрытии не передается, при открытии смены если не указан, то смена открывается на кассира, установленного в системе по умолчанию.	Целое число	Нет

При успешном открытии или закрытии возвращает системный номер документа на открытие или закрытие (не смены)