Get

[POST] …/DocPaymentAggregation/Get

Возвращает документы агрегированных платежей.

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

Название Тип данных Обязательность Описание
ids Array of Int64 Необязательный Массив ID документов агрегированных платежей
firm_ids Array of Int64 Необязательный Массив ID предпреятий
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
deleted_mark Boolean Необязательный Состояние пометки на удаление: true - Помечен на удаление, false - Не помечен на удаление
performed Boolean Необязательный Состояние проведение документа: true - Проведён, false - Не проведён
sort_orders Array of SortOrders Необязательный Сортировка выходных данных
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1 - ID документа, <FirmName | 2 - Наименование предприятия, <Date | 3 - Дата документа, <Code | 4 - Код документа, <TypeName | 5 - Наименование формы оплаты, <Amount | 6 - Сумма документа, <Performed | 7 - Проведён, <LastUpdate | 8 - Дата изменения в Unix time
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "ids": null,
    "firm_ids": null,
    "start_date": 1626462000,
    "end_date": 1631732399,
    "deleted_mark": false,
    "performed": false,
    "sort_orders": [
        {
            "column": 3,
            "direction": 2
        }
    ],
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 73,
            "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"
            },
            "date": 1724180400,
            "code": "PAG-0000073",
            "type": {
                "id": 1,
                "name": "Наличные",
                "account": {
                    "id": 1,
                    "code": "1",
                    "name": "Наличные касса",
                    "currency": {
                        "id": 1,
                        "code_num": 123,
                        "code_chr": "UZS",
                        "name": "Узбекский сум",
                        "exchange_rate": 1.1,
                        "is_base": false,
                        "deleted": false,
                        "last_update": 1533619909
                    },
                    "last_update": 1574150377
                },
                "shortkey": 6,
                "is_cash": true,
                "kkm_code": -1,
                "last_update": 1582629326,
                "enabled": "True",
                "image_url": "https://cdn.regos.uz/5fbc650b-6166-4e1b-8864-f93c0617bbf8/i_1678063359_905ee850-3e41-4ec9-b70a-b78b5d7d52f0.png"
            },
            "amount": 10000.1,
            "performed": true,
            "last_update": 1724359680
        }
    ],
    "next_offset": 1,
    "total": 1
}