Get

[POST] …/v1/DocOpeningBalance/Get

Возвращает документы начальных взаиморасчётов с контрагентоми.

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

Название Тип данных Обязательность Описание
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 предприятий
deleted_mark Boolean Необязательный Состояние пометки на удаление: true - Помечен на удаление, false - Не помечен на удаление
performed Boolean Необязательный Состояние проведение документа: true - Проведён, false - Не проведён
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Поиск про значениям параметров: code - Код документа, Firm/name - Наименование предприятия, Firm/inn - ИНН предприятия, Partner/name - Наименование контрагента, Partner/inn - ИНН контрагента
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

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

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

{
    "start_date": 1540494000,
    "end_date": 1608922799,
    "ids": [1],
    "partner_ids": [1],
    "firm_ids": [1],
    "deleted_mark": false,
    "performed": false,
    "sort_orders": [
        {
            "column": "Date",
            "direction": "ASC"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "date": 1575982758,
            "code": "OBL-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
            },
            "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"
            },
            "debit": 100.1,
            "credit": 1.1,
            "exchange_rate": 1.1,
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "performed": false,
            "deleted_mark": false,
            "last_update": 1575982820
        }
    ],
    "next_offset": 1,
    "total": 1
}