Получение списка Списаний

См. также методы API v3, которые позволяют получить список Списаний текущего Реселлера или любого из его нижестоящих Реселлеров по указанному ID Реселлера (см. Списания Реселлеров).

Метод Get List of Charges API v1 позволяет получить список Списаний для текущего Реселлера.

Список Cписаний может быть показан в рамках конкретной страницы. Для этого необходимо передать следующие аргументы:

номер страницы (page);
количество элементов на странице (per_page).

Список Cписаний может быть отсортирован по любому полю. Для этого необходимо передать следующие аргументы:

название поля для сортировки по нему (sorting[field]).
режим сортировки: по возрастанию или по убыванию (sorting[reversed]).

Список Списаний может быть отфильтрован по:

дате создания (filters[created_at]).
дате обновления (filters[updated_at]).
id Подписки (filters[subscription_id]).
статусу (filters[status]).

Метод {base_url}/api/vendor/v1/charges устарел. Рекомендуется использовать:

GET {base_url}/api/reseller/v1/charges.json?api_token={api_token}

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
api_token	query	string	Обязательный	API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике). Текущий Реселлер определяется по данному токену
page	query	integer	Опциональный	Возвращается список Списаний по указанному номеру страницы
per_page	query	integer	Опциональный	Установка числа элементов на странице
sorting[field]	query	string	Опциональный	Сортировка списка по указанному полю
sorting[reversed]	query	bool	Опциональный	Установка режима сортировки: по возрастанию или по убыванию: true — список будет отсортирован по убыванию. false — список будет отсортирован по возрастанию (используется по умолчанию).
filters[created_at]	query	string	Опциональный	Фильтрация списка по дате создания
filters[updated_at]	query	string	Опциональный	Фильтрация списка по дате обновления
filters[subscription_id]	query	integer	Опциональный	Фильтрация списка по ID Подписки
filters[status]	query	string	Опциональный	Фильтрация списка по статусу

Модель ответа

Название	Тип данных	Описание
id	integer	ID Cписания
subscription_id	integer	ID Подписки
subscription_resource_id	integer	ID Ресурса в Подписке
subscription_resource_name	string	Имя Ресурса в Подписке
plan_resource_id	integer	ID ресурса в Тарифном плане
resource_id	integer	ID Ресурса в Шаблоне услуги
quantity	integer	Количество заказанных единиц Услуги или Ресурса
operate_from	date	Дата начала периода, оплаченного Списанием
operate_to	date	Дата окончания периода, оплаченного Списанием
duration	float	Период Списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24
description	string	Подробная информация о Списании
unit_price	float	Стоимость одной единицы Услуги или Ресурса
amount	float	Общая сумма Списания
status	string	Текущий статус Списания (список статусов см. в Атрибуты списаний)
type	string	Тип Списания (см. также Атрибуты списаний) Charge::Setup — Списание за установку Подписки. Charge::Recurring — Списание за абонентскую плату Подписки. Charge::RecurringResource — Списание за абонентскую плату ресурса Подписки. Charge::Renewal — Списание за продление Подписки. Charge::RenewalResource — Списание за продление Ресурса. Charge::ExternalResource — Списание за использование внешнего Ресурса. Charge::SetupResource — Списание за установку Ресурсов Подписки. Charge::Transfer — списание за перенос Домена.
order_id	integer	ID Заказа, по которому произведено Cписание
close_date	date	Дата, когда Cписание должно быть закрыто
original_amount	string	Размер Списания в валюте Тарифного плана
original_amount_currency	string	Код валюты Тарифного плана
currency_rate	string	Курс, по которому сформировано Списание
currency_unit	integer	Номинал валюты, который использовался при расчете величины Cписания
created_at	date	Дата и время создания Списания
updated_at	date	Дата и время последнего изменения Списания

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

GET https://test.activeplatform.com/api/reseller/v1/charges.json?api_token=Y5fwetest3gJXZH5uHCw&page=10&per_page=2&sorting[field]=amount&sorting[reversed]=true

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

[
    {
        "id": 75632,
        "subscription_id": 3005821,
        "subscription_resource_id": 31417,
        "subscription_resource_name": "Ресурс4",
        "plan_resource_id": 5833,
        "resource_id": 272,
        "quantity": 1,
        "operate_from": "2020-11-01",
        "operate_to": "2020-11-14",
        "duration": 0.467,
        "description": "Upgrade resource (recurring fee) \"Ресурс4\" for Subscription #3005821 \"Clean Reservation\"",
        "unit_price": "10000000.0",
        "amount": "2335000.0",
        "status": "new",
        "type": "Charge::Recurring",
        "order_id": 8224,
        "close_date": "2020-11-14",
        "original_amount": "2335000.0",
        "original_amount_currency": "BYN",
        "currency_rate": "1.0",
        "currency_unit": 1,
        "created_at": "2019-11-15T12:22:01.318042+0300",
        "updated_at": "2019-11-15T12:22:01.318042+0300"
    },
    {
        "id": 17296,
        "subscription_id": 3002088,
        "subscription_resource_id": 10990,
        "subscription_resource_name": "Max Storage Size (GB)",
        "plan_resource_id": 2051,
        "resource_id": 1016,
        "quantity": 10011,
        "operate_from": "2017-09-01",
        "operate_to": "2017-09-22",
        "duration": 0.733,
        "description": "Upgrade resource (recurring fee) \"Max Storage Size (GB)\" for Subscription #3002088 \"OnlyOffice\"",
        "unit_price": "100.0",
        "amount": "733806.3",
        "status": "closed",
        "type": "Charge::Recurring",
        "order_id": 1773,
        "close_date": "2017-09-22",
        "original_amount": "733806.3",
        "original_amount_currency": "BYN",
        "currency_rate": "1.0",
        "currency_unit": 1,
        "created_at": "2017-08-24T16:17:29.707136+0300",
        "updated_at": "2017-10-19T01:03:44.803022+0300"
    }
]