Get

[POST] …/v1/DocPayment/Get

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

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

Название Тип данных Обязательность Описание
payment_direction Enum Необязательный Тип направления оплаты документа: <Income | 1> - Входящий платёж, <Outcome | 2> - Исходящий платёж
start_date Int64 Необязательный Дата начала периода в формате unix time в секундах
end_date Int64 Необязательный Дата окончания периода в формате unix time в секундах
ids Array of int64 Необязательный Массив ID документов оплаты
partner_ids Array of int64 Необязательный Массив ID контрагентов
firm_ids Array of int64 Необязательный Массив ID предприятий
contract_ids Array of int64 Необязательный Массив ID договоров
document_type_ids Array of int64 Необязательный Массив ID типов документов
document_ids Array of int64 Необязательный Массив ID документов
attached_user_ids Array of int64 Необязательный Массив ID ответственных пользователей
deleted_mark Boolean Необязательный Состояние пометки на удаление: true - Помечен на удаление, false - Не помечен на удаление
performed Boolean Необязательный Состояние проведение документа: true - Проведён, false - Не проведён
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Поиск про значениям параметров: code - Код документа, DocContract/code - Код договора, Partner/name - Наименование контрагента, Partner/inn - ИНН контрагента, User/name - ФИО ответственного лица, Firm/name - Наименование предприятия, Firm/inn - ИНН предприятия
limit Int32 Необязательный Лимит возвращаемых данных при запросе
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - ID документа платежа, <Date | 2> - Дата документа платежа, <Code | 3> - Код документа платежа, <TypeName | 4> - Наименование типа документа, <ContractName | 5> - , <FirmName | 6> - Наименование предприятия, <PartnerName | 7> - Наименование контрагента, <CategoryName | 8> - Категория операции, <Amount | 9> - Сумма платежа, <AttacheUserName | 10> - ФИО ответственного пользователя, <Performed | 11> - Проведён, <DeletedMark | 12> - Помечен на удаление, <LastUpdate | 13> - Последнее изменение в unix time, <Positive | 14> - Входящий/исходящий
direction Enum Необязательный Порядок сортировки: <ASC | 1> - По возростанию, <DESC | 2> - По убыванию

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

{
    "payment_direction": "Income",
    "start_date": 1534153454,
    "end_date": 1534157896,
    "ids": [1],
    "partner_ids": [1],
    "firm_ids": [1],
    "contract_ids": [1],
    "document_type_ids": [1],
    "document_ids": [1],
    "attached_user_ids": [1],
    "deleted_mark": false,
    "performed": false,
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1539335663,
            "code": "2018-0000022",
            "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"
            },
            "document_id": 1,
            "document_type_id": 1,
            "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
            },
            "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"
            },
            "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
            },
            "category": {
                "id": 3,
                "parent_id": 1,
                "child_count": 1,
                "name": "Основной",
                "positive": true,
                "last_update": 1534151629
            },
            "amount": 5000.1,
            "exchange_rate": 1.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,
                "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"
            },
            "performed": false,
            "description": "example",
            "deleted_mark": false,
            "last_update": 1539337488
        }
    ],
    "next_offset": 1,
    "total": 1
}