get

[POST] …/v1/DocContract/get

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

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

Название Тип данных Обязательность Описание параметра
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 Необязательный Сортировка выходных данных - Объект класса Sort_orders
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Code (Код документа), Date (Дата), FirmName (Наименование предприятия), PartnerName (Наименование контргаента), Direction (Входящий/Исходящий), Amount (Количество), CurrencyName (Валюта), StartDate (Дата начала договора), EndDate (Дата окончания договора)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "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 DocContract Обязательный Массив объектов DocContract

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "code": "1",
            "name": "№1 от 08.10.2018",
            "date": 1539014177,
            "start_date": 1539014177,
            "end_date": 1539014177,
            "partner": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Поставщики",
                    "last_update": 1539013744
                },
                "deleted_mark": false,
                "last_update": 1548936070,
                "legal_status": "Legal",
                "name": "OOO NEW HORIZON",
                "fullname": "OOO NEW HORIZON  Trade Inc.",
                "address": "",
                "phones": "",
                "description": null,
                "inn": "",
                "bank_name": "",
                "mfo": "",
                "rs": "",
                "oked": ""
            },
            "firm": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Предприятия",
                    "last_update": 1539013844
                },
                "deleted_mark": false,
                "last_update": 1539013863,
                "name": "OOO Retail",
                "fullname": "",
                "address": "",
                "phones": "",
                "description": null,
                "inn": "",
                "bank_name": "",
                "mfo": "",
                "rs": "",
                "oked": ""
            },
            "direction": "Income",
            "amount": 250000,
            "currency": {
                "id": 1,
                "code_num": 860,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1,
                "is_base": true,
                "last_update": 1537706844
            },
            "details": "Поставка товаров",
            "description": null,
            "deleted_mark": false,
            "last_update": 1539285239
        }
    ],
    "next_offset": 1,
    "total": 5
}