IsCanDo

DocPeriodClosingCheck

Модель, описывающая возможность создания документа закрытия периода.

Название Тип данных Описание
ok Boolean Возможность создания: true - Документ можно создать, false - документ создать невозможно
cash_servers Array of CashServerStage Статусы стнхронизации серверов касс
operating_cashes Array of CashStage Статусы смен касс
copy Boolean Статус копирования операций: true - Все операции скопированы, false - Не все операции скопированы
aggregation Boolean Статус агрегации операций: true - Все операции агрегированы, false - Не все операции агрегированы
has_before_docs_in_work Boolean Есть ли документы закрытия периода ранее указанной даты, которые не выполнены: true - Есть, false - Нет
has_after_docs_done Boolean Есть ли документы закрытия периода после указанной даты, которые выполнены: true - Есть, false - Нет
CashServerStage

Модель, описывающая статус сервера касс.

Название Тип данных Описание
name String Наименование сервера касс
status Boolean Статус синхронизации: true - Синхронизация на сервере касс выполнена, false - Синхронизация на сервере касс не выполнена
CashStage

Модель, описывающая статус кассы.

Название Тип данных Описание
name String Наименование кассы
status Boolean Статус смен: true - Все смены на кассе закрыты, false - Есть незакрытые смены на кассе

[POST] …/v1/DocPeriodClosing/IsCanDo

Проверка возможности создания документа закрытия периода на указанную дату.

Входные параметры

Название Тип данных Обязательность Описание
firm_id int64 Обязательный ID предприятия
close_date int64 Обязательный Дата предполагаемого закрытия периода в формате Unix time в секундах

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

{
    "firm_id":1,
    "close_date": 1533619486
}

Выходные параметры

Название Тип данных Описание
result Array of DocPeriodClosingCheck Массив возможностей создания документов закрытия периода
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

Пример ответа - Все условия выполнены и период можно закрывать указанной датой

{
    "ok": true,
    "result": {
        "ok": true,
        "cash_servers": [
            {
                "name": "Тестовый кеш сервер",
                "status": true
            }
        ],
        "operating_cashes": [
            {
                "name": "00001",
                "status": true
            }
        ],
        "copy": true,
        "aggregation": true,
        "has_before_docs_in_work": false,
        "has_after_docs_done": false
    },
    "next_offset": 1,
    "total": 1
}

Пример ответа - Не все условия выполнены и период нельзя закрывать указанной датой

{
    "ok": true,
    "result": {
        "ok": false,
        "cash_servers": [
            {
                "name": "Тестовый кеш сервер",
                "status": false
            }
        ],
        "operating_cashes": [
            {
                "name": "00001",
                "status": false
            }
        ],
        "copy": false,
        "aggregation": true,
        "has_before_docs_in_work": false,
        "has_after_docs_done": false
    },
    "next_offset": 1,
    "total": 1
}