Get

[POST] …/v1/DocWholeSale/Get

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

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

Название Тип данных Обязательность Описание
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
ids Array of int64 Необязательный Массив ID документов отгрузки контрагенту
firm_ids Array of int64 Необязательный Массив ID предприятий
stock_ids Array of int64 Необязательный Массив ID складов
partner_ids Array of int64 Необязательный Массив ID контрагентов
contract_ids Array of int64 Необязательный Массив ID договоров
attached_user_ids Array of int64 Необязательный Массив ID ответственных пользователей
status_ids Array of int64 Необязательный Массив ID статусов
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
blocked Boolean Необязательный Метка о блокировке документа
performed Boolean Необязательный Метка о проведении документа
deleted_mark Boolean Необязательный Метка об удалении
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - Id, <Date | 2> - Дата, <Code | 3> - Код, <PartnerName | 4> - Контрагент, <StockName | 5> - Склад, <CurrencyName | 6> - Валюта, <ContractName | 7> - Договор, <Amount | 8> - Количество, <VatCalculationType | 9> - Тип расчёта НДС, <AttacheUserName | 10> - Ответственный пользователь, <PriceTypeName | 11> - Тип цены, <Blocked | 12> - Блокировка, <Performed | 13> - Проведен, <DeletedMark | 14> - Помечен на удаление, <LastUpdate | 15> - Дата изменения
direction Enum Необязательный Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "start_date":1534153454,
    "end_date":1534157896,
    "ids":[1],
    "firm_ids":[1],
    "stock_ids":[1],
    "partner_ids":[1],
    "contract_ids":[1],
    "status_ids":[1],
    "attached_user_ids":[1],
    "sort_orders":
    [
        {
            "column": "Date",
            "direction":"Desc"
        }
    ],

    "limit":1,
    "offset":1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1539784256,
            "code": "WSL-0000001",
            "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
            },
            "stock": {
                "id": 1,
                "name": "Новомосковская",
                "address": "example",
                "firm": {
                    "id": 1,
                    "group": {
                        "id": 1,
                        "parent_id": 0,
                        "name": "Предприятия",
                        "child_count": 0,
                        "last_update": 1715233269
                    },
                    "deleted_mark": false,
                    "last_update": 1715863600,
                    "name": "REGOS",
                    "fullname": "ООО \"REGOS Software\"",
                    "boss_name": "Андрей",
                    "address": "Мукими, 8А",
                    "phones": "+998987654321",
                    "description": "EasyTrade successor",
                    "inn": "305930137",
                    "bank_name": "Ипак Йули",
                    "mfo": "01101",
                    "rs": "22125489632541254782",
                    "oked": "62090",
                    "vat_index": "1325489654785"
                },
                "description": "example",
                "deleted_mark": false,
                "last_update": 1705583155
            },
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "contract": {
                "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
            },
            "description": "example",
            "amount": 1400,
            "vat_calculation_type": "No",
            "exchange_rate": 1,
            "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,
                "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"
            },
            "seller": {
                "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,
                "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"
            },
            "price_type": {
                "id": 1,
                "name": "example",
                "round_to": 0.00,
                "markup": 0.25,
                "max_discount": 0.2,
                "currency": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "UZS",
                    "name": "Узбекский сум",
                    "exchange_rate": 1,
                    "is_base": true,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "currency_additional": {
                    "id": 1,
                    "code_num": 123,
                    "code_chr": "USD",
                    "name": "Dolar",
                    "exchange_rate": 1.1,
                    "is_base": false,
                    "deleted": false,
                    "last_update": 1533619909
                },
                "last_update": 1700000000
            },
            "blocked": false,
            "current_user_blocked": false,
            "performed": true,
            "deleted_mark": false,
            "last_update": 1549398363
        }
    ],
    "next_offset": 1,
    "total": 1
}