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

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

Объект смены

ПолеОписаниеТип, возм. значениялистинг
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Системный идентификатор кассира. Не обязателен, при закрытии не передается, при открытии смены если не указан, то смена открывается на кассира, установленного в системе по умолчанию. Целое числоНет

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