EarningsByAgreements

Доходы с договоров

Получить перечисление денежных сумм, вырученных от продажи занятий по выбранным договорам в виде планируется/оказано за период, по произвольному списку договоров. Расходы, понесённые на проведение занятий, не учитываются, т.к. выборка не обязательно ведётся по всем доходам от занятия.

Входные параметры
aIdList
Список agreements id, через запятую
Строка, обязательный параметр
startDate
Дата начала для сбора данных отчёта
Дата (Y-m-d, например 2017-01-26), обязательный параметр
endDate
Дата завершения для сбора данных отчёта
Дата (Y-m-d, например 2017-01-26), обязательный параметр
Результат:
В результате в поле items возвращается массив группированный по именам учеников, в котором "name" - имя ученика, а transactions - массив объектов, описывающий список операций. В объекте transaction:
Поле type - обозначает тип операции:
  1. Операция "проведение занятия"
Поле planStatus обозначает статус операции в плане:
  1. Операция запланирована
  2. Операция выполнена в соответствии с планом
  3. Операция выполнена вне плана
Поле cacheStoreId содержит идентификатор выборки, позволяющий обратиться к получившейся выборке позднее, используя метод CacheStore/GetByStoreId.
Пример результата (json):
{
    "items": [
        {
            "name": "Иванов Иван Иванович",
            "transactions": [
                {
                    "type": 1,
                    "cost": 213.125,
                    "date": "2016-09-13",
                    "comment": "Запланированное занятие в группе 105-4",
                    "planStatus": 1
                },
                {
                    "type": 1,
                    "cost": "213.125",
                    "date": "2016-09-13",
                    "comment": "Внеплановое занятие в группе 105-4",
                    "planStatus": 3
                }
            ]
        }
    ],
    "reportData": {
        "reportFrom": "2018-02-01",
        "reportTo": "2018-02-11",
        "reportMoment": "2018-03-01",
        "reportType": 1
    },
    "cacheStoreId": "5a8ab184169743.946303701"
}

Результат данного запроса может быть закеширован на несколько секунд.