getShort

[POST] …/v1/DocContract/getShort

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

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

Название Тип данных Обязательность Описание параметра
direction enum Необязательный Направление договора: income (входящий),outcome (исходящий)
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов оплаты
partner_ids array of int64 Необязательный Массив id контрагентов
firm_ids array of int64 Необязательный Массив id предприятий
attached_user_ids array of int64 Необязательный Массив id ответственных пользователей
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Оrders
sort_orders:column enum Необязательный Значение для сортировки: Default (без сортировки), Code (Код документа), Date (Дата), FirmName (Наименование предприятия), PartnerName (Наименование контргаента), Direction (Входящий/Исходящий),Amount (Количество), CurrencyName (Валюта), StartDate (Дата начала договора), EndDate (Дата окончания договора)
sort_orders:direction enum Необязательный Порядок сортировки: Default (Без сортировки), ASC (По возрастанию), DESC (По убыванию)
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки

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

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

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

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

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

{
    "ok": true,
    "result": [
        {
        "id": 1,
        "code": "01",
        "name": "№01 ...dan Пт 06.12.19",
        "date": 1575618443,
        "start_date": 1575618443,
        "end_date": 1575618443,
        "partner_id": 1,
        "firm_id": 1,
        "direction": "Income",
        "currency_id": 1,
        "amount": 100000.0,
        "details": "12",
        "description": "",
        "attached_user_id": 1,
        "deleted_mark": false,
        "last_update": 1576241933
    }
    ],
    "next_offset": 1,
    "total": 5
}