Get

[POST] …/v1/DocPeriodClosing/Get

Возвращает информацию о документе закрытия периода.

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

Название Тип данных Обязательность Описание
ids Array of int64 Необязательный Массив ID документов закрытия периода
status_ids Array of int64 Необязательный Массив ID статусов документов закрытия периода
firm_ids Array of int64 Необязательный Массив ID предприятий
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полям: id - Id документа, Firm/name - Наименование предприятия, Firm/inn - ИНН пердприятия
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

Модель сортировки выходных параметров.

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - Id документа, <CloseDate | 2> - Дата закрытия периода, <RunDate | 3> - Дата обработки документа, <StatusName | 4> - Статус документа, <FirmName | 5> - Наименование предприятия
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "ids":[1],
    "status_ids":[1],
    "firm_ids":[1],
    "sort_orders": [
        {
          "column": "Id",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":1,
    "offset":1
}

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

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

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "close_date": 1539014177,
            "run_date": 1539014177,
            "status": "Closed",
            "firm": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Предприятия",
                    "child_count": 0,
                    "last_update": 1715233269
                },
                "deleted_mark": false,
                "last_update": 1715863600,
                "name": "REGOS",
                "fullname": "ООО \"REGOS Software\"",
                "boss_name": "Андрей",
                "address": "Мукими, 8А",
                "phones": "+998987654321",
                "description": "EasyTrade successor",
                "inn": "305930137",
                "bank_name": "Ипак Йули",
                "mfo": "01101",
                "rs": "22125489632541254782",
                "oked": "62090",
                "vat_index": "1325489654785"
            },
            "description": "example",
            "last_update": 1539285239,
            "status_id": 4
        }
    ],
    "next_offset": 1,
    "total": 1
}