Get

[POST] …/v1/DocCommercialOffer/Get

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

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

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате Unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате Unix time в секундах
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 - ФИО ответственного пользователя
deleted_mark Boolean Необязательный Состояние пометки на удаление: true - Помечен на удаление, false - Не помечен на удаление
blocked Boolean Необязательный Состояние блокировки документа для редактирования: true - Заблокирован, false - Разблокировин
limit Int32 Необязательный Количество возвращаемых элементов выборки
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",
    "deleted_mark": "false",
    "blocked": "false",
    "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": 1,
                    "name": "Поставщики",
                    "child_count": 1,
                    "last_update": 1693395102
                },
                "legal_status": "Legal",
                "name": "Coca-cola company",
                "fullname": "Eric George Blair",
                "boss_name": "Arthur",
                "address": "100017, A.Qodiriy ko’chasi 981 uy",
                "phones": "+998987654321",
                "description": "Book Shop",
                "inn": "123456789",
                "bank_name": "Ipak Yo'li Banki",
                "mfo": "00450",
                "rs": "29802000600000444085",
                "oked": "62.03.0",
                "vat_index": "12",
                "deleted_mark": false,
                "last_update": 1728627216
            },
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "description": "examole",
            "amount": 12400.1,
            "vat_calculation_type": "No",
            "exchange_rate": 12.0,
            "attached_user": {
                "id": 1,
                "full_name": "John Fitzgerald Kennedy",
                "main_phone": "998123456789",
                "user_group": {
                    "id": 1,
                    "parent_id": 1,
                    "name": "Administrators",
                    "child_count": 1,
                    "last_update": 1529755889
                },
                "enable_hints": true,
                "system": true,
                "seller_barcode": "1010000001000000",
                "last_update": 1532276019,
                "first_name": "John",
                "last_name": "Kennedy",
                "middle_name": "Fitzgerald",
                "sex": "Male",
                "date_of_birth": "1993-12-21",
                "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
                "phones": "998123456789",
                "email": "example@example.com",
                "description": "example",
                "login": "Admin",
                "can_authorize": true,
                "active": true,
                "language_code": "RUS"
            },
            "blocked": false,
            "deleted_mark": false,
            "last_update": 1584601367
        }
    ],
    "next_offset": 1,
    "total": 1
}