get

[POST] …/v1/DocSetPrice/get

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

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

Название Тип данных Обязательность Описание параметра
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов установки цен
price_type_ids array of int64 Необязательный Массив id видов цен
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Id (Id документа), Code (Код документа), Date (Дата), PriceTypeName (Вид цены), Blocked (Блокировка), Performed (Проведен), DeletedMark (Метка на удаление), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1,2,3],
    "sort_orders":
    [
        {
        "column":'date',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

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

Название Тип данных Обязательность Описание параметра
Result Array of DocSetPrice Обязательный Массив объектов DocSetPrice

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

{
    "ok": true,
    "result": [
    {
        "id": 41,
        "date": 1583816956,
        "code": "PRC-0000041",
        "price_type": {
            "id": 1,
            "name": "Розничная",
            "round_to": 1.0,
            "markup": 0.0,
            "max_discount": 100.0,
            "last_update": 1582624301
        },
        "description": null,
        "blocked": false,
        "performed": true,
        "deleted_mark": false,
        "last_update": 1583819447
    }
    ]
    "next_offset": 1,
    "total": 5
}