Получение списка Списаний конечных клиентов Реселлера
Метод Get a List of the Reseller end-customers Charges используется для получения списка Списаний конечных клиентов для текущего Реселлера или любого из его нижестоящих Реселлеров.
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
GET {base_url}/api/v3/resellers/{reseller_id}/charges
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||||||||||
Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности | ||||||||||
Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) | ||||||||||
reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) | ||||||||||
page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) | ||||||||||
page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа | ||||||||||
filter[close_date] | query | date | Опциональный | Предназначен для фильтрации Списаний по дате закрытия в формате ГГГГ-ММ-ДД. Для указания диапазона дат используются следующие фильтры:
| ||||||||||
filter[subscription_id] | query | integer | Опциональный | Фильтрация списка по ID Подписки | ||||||||||
filter[status] | query | string | Опциональный | Фильтрация списка по статусу Списания (список статусов см. в Атрибуты списаний) | ||||||||||
filter[created_at] | query | string | Опциональный | Предназначен для фильтрации Списаний по дате и времени создания в формате RFC 3339 (например, 2017-10-04T15:12:01.558009%2B03:00). Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[updated_at] | query | string | Опциональный | Предназначен для фильтрации Списаний по дате дате и времени последнего обновления в формате RFC 3339 (например, 2017-10-04T15:12:01.558009%2B03:00). Для указания диапазона используются следующие фильтры:
| ||||||||||
filter[plan_class_ids] | query | string | Опциональный | Предназначен для фильтрации Списаний по ID Правила предоставления (см. Просмотр списка правил предоставления). Поддерживается указание списка из нескольких ID Правил предоставления, разделенных запятыми | ||||||||||
include | query | string | Опциональный | Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:
|
Модель ответа
Название | Тип данных | Описание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | array | Данные ответа | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | integer | ID Списания | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Тип данных | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes | object | Информация о Списании | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at | date | Дата и время создания Списания | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at | date | Дата и время последнего изменения Списания | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_id | integer | ID Подписки | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_resource_id | integer | ID Ресурса в клиентской Подписке | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | Количество заказанных единиц Услуги или Ресурса | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operate_from | date | Дата начала периода, оплаченного Списанием | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | float | Период Списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Подробное описание Списания | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_price | float | Стоимость единицы Ресурса или Услуги у выбранного Реселлера в валюте Тарифного плана | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount | float | Общая сумма Списания (с учетом Скидки) в валюте выбранного Реселлера | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | Статус Списания (список статусов см. в Атрибуты списаний) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Тип Списания (см. также Атрибуты списаний):
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
net_cost | float | Себестоимость Списания для выбранного Реселлера в валюте Тарифного плана. Величина рассчитывается только для делегированных Тарифных планов и формируется исходя из цены вышестоящего Реселлера | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taxes_amount | float | Сумма налогов для данного Списания в валюте выбранного Реселлера | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_resource_name | string | Имя Ресурса в Подписке, которая была заказана Клиентом | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plan_resource_id | integer | ID Ресурса в Тарифном плане, который был заказан Клиентом | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resource_id | integer | ID Ресурса в Шаблоне услуги | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_id | integer | ID Заказа, по которому произведено Списание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operate_to | date | Дата окончания периода, оплаченного Списанием | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
close_date | date | Дата, когда Cписание должно быть закрыто | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_date | date | Дата начала Финансового периода, к которому относится Списание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
application_template_key | string | Ключ Шаблона услуги, на основе которого создано приложение для Подписки (см. Просмотр и обновление информации о коннекторе) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additional_params | array of objects | Дополнительные параметры Списания для Услуг на основе следующих модулей:
В остальных случаях возвращается пустой массив | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | float | Размер Скидки для данного Списания в валюте выбранного Реселлера | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
original_amount | string | Размер Списания в валюте Тарифного плана | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
original_amount_currency | string | Код валюты Тарифного плана | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_rate | string | Курс, по которому сформировано Списание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency_unit | integer | Номинал валюты, который использовался при расчете величины Cписания | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relationships | array | Перечень объектов, связанных со Списанием | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taxes | array | Информация о налогах | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reseller | array | Информация о Реселлере | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
account | array | Информация о Клиенте | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription | array | Информация о Подписке | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plan | array | Информация о Тарифном плане | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | array | Информация о Скидке | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | array | Информация о связанном объекте:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
included | array | Дополнительная информация о связанных объектах, указанных в запросе:
Атрибуты:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
links | array | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
self | string | Ссылка на текущую страницу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
first | string | Ссылка на первую страницу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
prev | string | Ссылка на предыдущую страницу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
next | string | Ссылка на следующую страницу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last | string | Ссылка на последнюю страницу | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
meta | array | Дополнительная информация о Списании | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | Код валюты Реселлера |
Пример запроса
GET /api/v3/resellers/1/charges?page[size]=2&page[number]=70&filter[close_date][gte]=2019-10-01&filter[close_date][lte]=2019-10-31&filter[status]=closed&filter[plan_class_ids]=1,5&include=reseller,account,subscription,plan
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": [
{
"id": "73083",
"type": "charges",
"attributes": {
"created_at": "2019-08-21T11:50:21.263342+0300",
"updated_at": "2019-11-16T01:18:26.253966+0300",
"subscription_id": 3005638,
"subscription_resource_id": 30146,
"quantity": 1,
"operate_from": "2019-09-01",
"duration": 0.667,
"description": "Upgrade resource (recurring fee) \"res3\" for Subscription #3005638 \"Auto provisioning with resources\"",
"unit_price": "2.0",
"amount": "1.27",
"status": "closed",
"type": "Charge::Recurring",
"net_cost": null,
"taxes_amount": 0,
"subscription_resource_name": "res3",
"plan_resource_id": 2158,
"resource_id": 10,
"order_id": 8025,
"operate_to": "2019-09-20",
"close_date": "2019-09-30",
"billing_date": "2019-09-01",
"application_template_key": "",
"additional_params": [],
"discount": "0.06",
"original_amount": "1.27",
"original_amount_currency": "BYN",
"currency_rate": "1.0",
"currency_unit": 1
},
"relationships": {
"taxes": {
"data": []
},
"reseller": {
"data": {
"id": "1",
"type": "resellers"
}
},
"account": {
"data": {
"id": "494",
"type": "accounts"
}
},
"subscription": {
"data": {
"id": "3005638",
"type": "subscriptions"
}
},
"plan": {
"data": {
"id": "5",
"type": "plans"
}
},
"plan_resource": {
"data": null
},
"discount": {
"data": {
"id": "89",
"type": "discounts"
}
}
}
},
{
"id": "73109",
"type": "charges",
"attributes": {
"created_at": "2019-08-22T15:59:54.376771+0300",
"updated_at": "2019-10-12T01:15:30.459665+0300",
"subscription_id": 3005649,
"subscription_resource_id": null,
"quantity": 1,
"operate_from": "2019-09-01",
"duration": 1,
"description": "Switch resource (recurring fee) #3005649 \"Auto provisioning with resources\"",
"unit_price": "1.0",
"amount": "1.0",
"status": "closed",
"type": "Charge::Recurring",
"net_cost": null,
"taxes_amount": 0,
"subscription_resource_name": null,
"plan_resource_id": null,
"resource_id": null,
"order_id": 8036,
"operate_to": "2019-09-30",
"close_date": "2019-09-30",
"billing_date": "2019-09-01",
"application_template_key": "",
"additional_params": [],
"discount": "0.00",
"original_amount": "1.0",
"original_amount_currency": "BYN",
"currency_rate": "1.0",
"currency_unit": 1
},
"relationships": {
"taxes": {
"data": []
},
"reseller": {
"data": {
"id": "1",
"type": "resellers"
}
},
"account": {
"data": {
"id": "503",
"type": "accounts"
}
},
"subscription": {
"data": {
"id": "3005649",
"type": "subscriptions"
}
},
"plan": {
"data": {
"id": "5",
"type": "plans"
}
},
"plan_resource": {
"data": null
},
"discount": {
"data": null
}
}
}
],
"included": [
{
"id": "1",
"type": "resellers",
"attributes": {...
}
},
{
"id": "494",
"type": "accounts",
"attributes": {...
},
"relationships": {...
}
},
{
"id": "3005638",
"type": "subscriptions",
"attributes": {
"created_at": "2019-08-21T11:50:21.083490+0300",
"updated_at": "2019-11-16T01:18:26.153891+0300",
"auto_renewal": false,
"billing_from": "2019-08-21",
"expiration_date": "2019-09-21",
"name": "Auto provisioning with resources",
"renew_point_days": 1,
"start_date": "2019-08-21",
"status": "deleted",
"payment_model": "postpay",
"payment_model_parameters": {
"credit_limit": 100,
"current_debt": 0
}
}
},
{
"id": "5",
"type": "plans",
"attributes": {...
}
},
{
"id": "503",
"type": "accounts",
"attributes": {...
},
"relationships": {...
}
},
{
"id": "3005649",
"type": "subscriptions",
"attributes": {
"created_at": "2019-08-22T15:59:54.138703+0300",
"updated_at": "2019-09-20T10:47:07.896382+0300",
"auto_renewal": false,
"billing_from": "2019-08-22",
"expiration_date": "2019-12-22",
"name": "Auto provisioning with resources",
"renew_point_days": 1,
"start_date": "2019-08-22",
"status": "waiting_for_manual_approve",
"payment_model": "postpay",
"payment_model_parameters": {
"credit_limit": 0,
"current_debt": 0
}
}
}
],
"links": {
"self": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=70&page%5Bsize%5D=2",
"first": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=69&page%5Bsize%5D=2",
"next": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=71&page%5Bsize%5D=2",
"last": "https://test.activeplatform.com/api/v3/resellers/1/charges?filter%5Bclose_date%5D%5Bgte%5D=2019-10-01&filter%5Bclose_date%5D%5Blte%5D=2019-10-31&filter%5Bplan_class_ids%5D=1%2C5&filter%5Bstatus%5D=closed&include=reseller%2Caccount%2Csubscription%2Cplan&page%5Bnumber%5D=79&page%5Bsize%5D=2"
},
"meta": {
"currency": "BYN"
}
}