Get

[POST] …/v1/DocSetPrice/Get

Возвращает документ установки цен.

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

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
ids Array of int64 Необязательный Массив ID документов установки цен
price_type_ids Array of int64 Необязательный Массив ID видов цен
search String Необязательный Строка поиска по полям: - , - , - , - , `` -
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
performed Boolean Необязательный Проведён ли документ: true - Проведён, false - Не проведён
blocked Boolean Необязательный Заблокирован ли документ: true - Заблокирован, false - Не заблокирован
deleted_mark Boolean Необязательный Помечен ли документ на удаление: true - Помечен на удаление, false - Не помечен на удаление
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - Id документа, <Date | 2> - Дата, <Code | 3> - Код документа, <PriceTypeName | 4> - Наименование вида цены, <Blocked | 5> - Заблокирован, <Performed | 6> - Проведён, <DeletedMark | 7> - Помечен на удаление, <LastUpdate | 8> - Последнее изменение
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1],
    "price_type_ids":[1],
    "search": "example",
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "performed": false,
    "blocked": false,
    "deleted_mark": false,
    "limit":1,
    "offset":1
}

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

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

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

{
    "ok": true,
    "result": [
    {
        "id": 1,
        "date": 1583816956,
        "code": "PRC-0000041",
        "price_type": {
            "id": 1,
            "name": "example",
            "round_to": 0.00,
            "markup": 0.25,
            "max_discount": 0.2,
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1,
                "is_base": true,
                "deleted": false,
                "last_update": 1533619909
            },
            "currency_additional": {
                "id": 1,
                "code_num": 123,
                "code_chr": "USD",
                "name": "Dolar",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "last_update": 1700000000
        },
        "description": "example",
        "blocked": false,
        "performed": true,
        "deleted_mark": false,
        "current_user_blocked": false,
        "last_update": 1583819447
    }
    ],
    "next_offset": 1,
    "total": 1
}