Get

[POST] …/v1/DocCommercialOffer/Get

Возвращает информацию о документе коммерческого предложения.

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

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате unixtime в секундах
end_date Int64 Необязательный Дата окончания периода в формате unixtime в секундах
ids Array of int64 Необязательный Массив id документов коммерческого предложения
partner_ids Array of int64 Необязательный Массив id контрагентов
currency_ids Array of int64 Необязательный Массив id валют
attached_user_ids Array of int64 Необязательный Массив id ответственных пользователей
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
vat_calculation_type Enum Необязательный Расчет НДС: <No | 1> - Не начислять, <Exclude | 2> - В сумме, <Include | 3> - Сверху
search String Необязательный Строка поиска по полям: code - код документа, partner_name - имя контрагента, partner_inn - ИНН контрагента, attached_user_name - имя ответственного пользователя
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Описание
column Enum Значение для сортировки: <Code | 1> - Код документа, <Date | 2> - Дата, <ContractName | 3> - Наименование договора, <PartnerName | 4> - Имя контрагента, <OrderStatusName | 5> - Наименование статуса, <Amount | 6> - Сумма документа, <CurrencyName | 7> - Наименование валюты
direction Enum Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1],
    "partner_ids":[1],
    "currency_ids":[1],
    "attached_user_ids":[1],
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "vat_calculation_type": "No",
    "search": "example",
    "limit":1,
    "offset":0
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1584601184,
            "code": "OFF-0000007",
            "partner": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Поставщики",
                    "child_count": 0,
                    "last_update": 1693395102
                },
                "deleted_mark": false,
                "last_update": 1728627216,
                "legal_status": "Legal",
                "name": "Coca-cola company",
                "fullname": "",
                "boss_name": "",
                "address": "ауывававуа",
                "phones": "",
                "description": "",
                "inn": "111111111",
                "bank_name": "",
                "mfo": "",
                "rs": "",
                "oked": "",
                "vat_index": ""
            },
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "description": null,
            "amount": 0.0,
            "vat_calculation_type": "No",
            "exchange_rate": 10.0,
            "attached_user": {
                "id": 1,
                "user_group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Admins",
                    "last_update": 1552326674
                },
                "first_name": "Administrator",
                "last_name": "",
                "middle_name": "",
                "sex": "none",
                "date_of_birth": "1990-01-01",
                "address": "Tashkent, Mirabad-5",
                "main_phone": "",
                "phones": "+998713456789",
                "email": "",
                "description": "",
                "login": "admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS",
                "last_update": 1583131927
            },
            "blocked": false,
            "deleted_mark": false,
            "last_update": 1584601367
        }
    ],
    "next_offset": 1,
    "total": 1
}