cash.aggregate.getBalanceFlow
Возвращает информацию об изменении баланса за указанный период.
Параметры
-
from
GET
Дата начала периода в формате «гггг-мм-дд».
-
to
GET
Дата конца периода в формате «гггг-мм-дд».
-
group_by
GET
Способ группировки данных: 'day' (по дням), 'month' (по месяцам), 'year' (по годам). Группировка по дням доступна только для периодов не более 10 000 дней.
-
format
GET
Необязательно
Устанавливает формат ответа. Возможные значения:
json(по умолчанию),xml.
Возвращаемое значение
Набор данных для каждой из валют счетов в виде списка. Каждый элемент списка — массив со следующими ключами:
- []['currency'] string 3-буквенное обозначение валюты.
- []['balances'] array Информация об изменении баланса для данной валюты в виде массива со следующими ключами:
- []['balances']['from'] array Данные на начало периода в виде массива со следующими ключами:
- []['balances']['from']['date'] date Дата начала периода.
- []['balances']['from']['amount'] float Баланс на начало периода.
- []['balances']['from']['amountShorten'] string Локализованное сокращённое обозначение баланса на начало периода.
- []['balances']['to'] array Данные на конец периода в виде массива со следующими ключами:
- []['balances']['to']['date'] date Дата окончания периода.
- []['balances']['to']['amount'] float Баланс на конец периода.
- []['balances']['to']['amountShorten'] string Локализованное сокращённое обозначение баланса на конец периода.
- []['balances']['diff'] array Данные разности между окончанием и началом периода в виде массива со следующими ключами:
- []['balances']['diff']['amount'] float Разность баланса.
- []['balances']['diff']['amountShorten'] string Локализованное сокращённое обозначение разности баланса.
- []['balances']['now'] array Данные на текущую дату в виде массива со следующими ключами:
- []['balances']['now']['date'] date Текущая дата.
- []['balances']['now']['amount'] float Текущий баланс.
- []['balances']['now']['amountShorten'] string Локализованное сокращённое обозначение текущего баланса.
- []['data'] array Данные за каждый из отрезков времени в пределах указанного периода с учётом типа группировки в виде списка. Каждый элемент списка — массив со следующими ключами:
- []['data'][]['period'] string Обозначение отрезка времени в одном из форматов: 'гггг-дд-мм' (для начала периода, для конца периода, а также для каждого отрезка времени, если указан тип группировки
'day'), 'гггг-мм' (для каждого отрезка времени, кроме начала и конца, если указан тип группировки'month'), 'гггг' (для каждого отрезка времени, кроме начала и конца, если указан тип группировки'year'). - []['data'][]['amount'] float Баланс на конец отрезка времени.
