Get

[POST] …/v1/AccountBalance/Get

Возвращает информацию о балансе счёта.

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

Название Тип данных Обязательность Описание
ids array of int64 Необязательный массив id счетов
firm_id int64 Необязательный id предприятия
currency_ids array of int64 Необязательный массив id валют
sort_orders SortOrders Необязательный Сортировка выходных данных
search string Необязательный Строка поиска по полю name
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


SortOrders

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

Название Тип данных Описание
column enum Значение для сортировки: <Id | 1> (Id счета), <Name | 2> (Наименование счета), <Code | 3> (Код счета), <CurrencyName | 4> (Наименование валюты счета), <LastUpdate | 5> (Дата изменения)
direction enum Порядок сортировки: <ASC | 1> (по возростанию), <DESC | 2> (по убыванию)

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

{
  "ids": [
    1
  ],
  "firm_id": 23,
  "currency_ids": [
    1
  ],
  "sort_orders": [
    {
      "column": "Name",
      "direction": "desc"
    }
  ],
  "search": "John",
  "limit": 20,
  "offset": 3
}

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

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

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

{
  "ok": true,
  "result": [
    {
      "balance": 0,
      "id": 1,
      "code": "00001",
      "name": "Основной счет",
      "currency": {
        "id": 1,
        "code_num": 860,
        "code_chr": "UZS",
        "name": "Узбекский сум",
        "exchange_rate": 1,
        "is_base": true,
        "deleted": false,
        "last_update": 1664715017
      },
      "last_update": 1693395102
    }
  ],
  "next_offset": 1,
  "total": 5
}