GetShort

[POST] …/v1/doccontract/getshort

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

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

Название	Тип данных	Обязательность	Описание
direction	Enum	Необязательный	Направление договора: <`Income` \| `1`> - Входящий, <`Outcome` \| `2`> - Исходящий
start_date	Int64	Необязательный	Дата начала периода в формате unix time в секундах
end_date	Int64	Необязательный	Дата окончания периода в формате unix time в секундах
ids	Array of int64	Необязательный	Массив ID документов оплаты
firm_ids	Array of int64	Необязательный	Массив ID предприятий
partner_ids	Array of int64	Необязательный	Массив ID контрагентов
attached_user_ids	Array of int64	Необязательный	Массив ID ответственных пользователей
search	String	Необязательный	Строка поиска по полям: `code` - Код документа, `Partner/name` - ФИО контрагента, `partner_inn` - ИНН контрагента, `firm_name` - Наименование предприятия, `attached_user_name` - ФИО ответственноого пользователя
sort_orders	Array of SortOrders	Необязательный	Сортировака выходных параметров
active	Boolean	Необязательный	Действительность: `true` - Действительный, `false` - Не действительный
limit	Int32	Необязательный	Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset	Int32	Необязательный	Смещение от начала выборки
deleted_mark	String	Необязательный	Поле модели запроса

SortOrders

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

Название	Тип данных	Обязательность	Описание
column	Enum	Необязательный	Значение для сортировки: <`Code` \| `1`> - Код договора, <`Date` \| `2`> - Дата заключения договора, <`FirmName` \| `3`> - Наименование предприятия, <`PartnerName` \| `4`> - ФИО контргаента, <`Dircetion` \| `5`> - Входящий/Исходящий, <`Amount` \| `6`> - Сумма, <`CurrencyName` \| `7`> - Наименование валюты, <`StartDate` \| `8`> - Дата начала договора, <`EndDate` \| `9`> - Дата окончания договора
direction	Enum	Необязательный	Порядок сортировки: <`ASC` \| `1`> - По возростанию, <`DESC` \| `2`> - По убыванию

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

{
    "direction":"Income",
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1],
    "firm_ids":[1],
    "partner_ids":[1],
    "attached_user_ids": 1,
    "search": "example",
    "sort_orders":
    [
        {
        "column":"date",
        "direction":"desc"
        }
    ],
    "active": true,
    "limit":1,
    "offset":1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "code": "example",
            "name": "example",
            "date": 1533619909,
            "start_date": 1533619909,
            "end_date": 1533619909,
            "partner_id": 1,
            "firm_id": 1,
            "direction": "Income",
            "currency_id": 1,
            "amount": 1.1,
            "details": "example",
            "description": "example",
            "attached_user_id": 1,
            "active": false,
            "deleted_mark": false,
            "last_update": 1533619909
        }
    ],
    "next_offset": 1,
    "total": 1
}