cash.aggregate.getBreakDown

Возвращает сводную информацию о расходах, доходах и прибыли за указанный период.

Параметры

  • from GET

    Дата начала периода в формате «гггг-мм-дд».

  • to GET

    Дата окончания периода в формате «гггг-мм-дд».

  • filter GET

    Хеш-строка для фильтрации списка финансовых операций. Пустой хеш обозначает отсутствие фильтрации.
    Примеры хешей:
    - account/1: Получение операций для счёта, ID которого — 1.
    - currency/RUB: Получение операций, код валюты которых — RUB.

  • format GET Необязательно

    Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

Возвращаемое значение

Набор данных для каждой из валют счетов в виде списка. Каждый элемент списка — массив со следующими ключами:

  • []['currency'] string 3-буквенное обозначение валюты.
  • []['expense'] array Информация о затратах в виде массива со следующими ключами:
  • []['expense']['data'] array Список информации о статьях затрат. Каждый элемент списка — массив со следующими ключами:
  • []['expense'][]['amount'] float Сумма затрат в рамках статьи.
  • []['expense'][]['category_id'] int ID статьи затрат.
  • []['expense'][]['category_name'] string Название статьи затрат.
  • []['expense'][]['category_color'] string HTML-обозначение цвета статьи затрат.
  • []['expense']['totalAmount'] float Общая сумма затрат.
  • []['income'] array Информация о доходах в виде массива со следующими ключами:
  • []['income']['data'] array Список информации о статьях доходов. Каждый элемент списка — массив со следующими ключами:
  • []['income'][]['amount'] float Сумма доходов в рамках статьи.
  • []['income'][]['category_id'] int ID статьи доходов.
  • []['income'][]['category_name'] string Название статьи доходов.
  • []['income'][]['category_color'] string HTML-обозначение цвета статьи доходов.
  • []['income']['totalAmount'] float Общая сумма дохода.
  • []['profit'] array Информация о прибыли в виде массива со следующими ключами:
  • []['profit']['data'] array Список информации о статьях прибыли. Каждый элемент списка — массив со следующими ключами:
  • []['profit'][]['amount'] float Сумма прибыли в рамках статьи.
  • []['profit'][]['category_id'] int ID статьи прибыли.
  • []['profit'][]['category_name'] string Название статьи прибыли.
  • []['profit'][]['category_color'] string HTML-обозначение цвета статьи прибыли.
  • []['profit']['totalAmount'] float Общая сумма прибыли.

Пример

https://demo1-ru.webasyst.com/api.php/cash.aggregate.getBreakDown?