cash.aggregate.getChartData
Возвращает информацию о расходах, доходах и прибыли за указанный период с группировкой по дням, месяцам или годам.
Параметры
-
from
GET
Дата начала периода в формате «гггг-мм-дд».
-
to
GET
Дата окончания периода в формате «гггг-мм-дд».
-
filter
GET
Хеш-строка для фильтрации списка финансовых операций. Пустой хеш обозначает отсутствие фильтрации.
Примеры хешей:
- account/1: Получение операций для счёта, ID которого — 1.
- currency/RUB: Получение операций, код валюты которых — RUB. -
group_by
GET
Способ группировки данных: 'day' (по дням), 'month' (по месяцам), 'year' (по годам). Группировка по дням доступна только для периодов не более 10 000 дней.
-
format
GET
Необязательно
Устанавливает формат ответа. Возможные значения:
json
(по умолчанию),xml
.
Возвращаемое значение
Набор данных для каждой из валют счетов в виде списка. Каждый элемент списка — массив со следующими ключами:
- []['currency'] string 3-буквенное обозначение валюты.
- []['data'] array Список данных для каждого интервала времени, соответствующего способу группировки. Каждый элемент списка — массив со следующими ключами:
- []['data'][]['period'] string Обозначение отрезка времени в одном из форматов: 'гггг-дд-мм' (для начала периода, для конца периода, а также для каждого отрезка времени, если указан тип группировки
'day'
), 'гггг-мм' (для каждого отрезка времени, кроме начала и конца, если указан тип группировки'month'
), 'гггг' (для каждого отрезка времени, кроме начала и конца, если указан тип группировки'year'
). - []['data'][]['amountExpense'] float Сумма расходов.
- []['data'][]['amountIncome'] float Сумма доходов.
- []['data'][]['amountProfit'] float Сумма прибыли.
- []['data'][]['balance'] float Баланс на окончание периода.