get

[POST] …/v1/DocOrderToPartner/get

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

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

Название Тип данных Обязательность Описание параметра
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids array of int64 Необязательный Массив id документов заказа от контрагента
partner_ids array of int64 Необязательный Массив id контрагентов
contract_ids array of int64 Необязательный Массив id договоров
status_ids array of int64 Необязательный Массив id статусов
attached_user_ids array of int64 Необязательный Массив id ответственных пользователей
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
blocked bool Необязательный Метка о блокировке документа
deleted_mark bool Необязательный Метка об удалении
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

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

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

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

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1540188444,
            "code": "OTP-0000001",
            "contract": {
                "id": 2,
                "code": "233-11",
                "name": "№233-11 от 12.10.2018",
                "date": 1539324619,
                "start_date": 1539324619,
                "end_date": 1542003019,
                "partner_id": 1,
                "firm_id": 1,
                "direction": "Income",
                "currency_id": 4,
                "amount": 100000,
                "details": "qwerty",
                "description": null,
                "deleted_mark": false,
                "last_update": 1541184434
            },
            "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": ""
            },
            "currency": {
                "id": 4,
                "code_num": 398,
                "code_chr": "KZT",
                "name": "Казахский тенге",
                "exchange_rate": 60,
                "is_base": false,
                "last_update": 1537471709
            },
            "exchange_rate": 60,
            "vat_calculation_type": "Include",
            "amount": 2053.2,
            "status_id": 1,
            "status": {
                "id": 8,
                "document_type_id": 13,
                "name": "В обработке",
                "order": 10,
                "last_update": 1540311075
            },
            "blocked": false,
            "deleted_mark": false,
            "last_update": 1541184434
        }
    ],
    "next_offset": 1,
    "total": 6
}