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

Метод Get list of reseller charges используется для получения списка реселлер-списаний для текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен сотрудника. API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/reseller_charges

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
page[size]queryintegerОпциональныйПараметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]queryintegerОпциональныйПараметр постраничной навигации. Номер страницы ответа
includequerystringОпциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:

ОбъектЗначение параметра

Реселлер

reseller

Клиент

account

Подписка

subscription

Тарифный план

plan

Скидка

discount

Ресурс тарифного плана

plan_resource

account_typesquerystringОпциональныйПредназначен для фильтрации списка по типу клиента (см. Типы клиентов). Допускается указание нескольких значений, разделенных запятой
plan_class_idsquerystringОпциональныйПредназначен для фильтрации списка по ID правила предоставления (см. Просмотр списка правил предоставления). Допускается указание нескольких значений, разделенных запятой
date_fromquerystringОпциональный

Предназначен для фильтрации списка по минимальной дате закрытия (в формате ГГГГ-ММ-ДД) связанного клиентского списания или реселлер-списания нижестоящего реселлера. По модели Предоплата и Постоплата включаются все списания, для которых дата закрытия связанного списания больше или равна указанной дате

date_toquerystringОпциональный

Предназначен для фильтрации списка по максимальной дате закрытия (в формате ГГГГ-ММ-ДД) связанного клиентского списания или реселлер-списания нижестоящего реселлера. По модели Предоплата и Постоплата включаются все списания, для которых дата закрытия связанного списания меньше указанной даты

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

Название

Тип данных

Описание

dataarrayДанные ответа


id

integerID списания

typestringТип данных

attributesobjectИнформация о списании


created_atdateДата и время создания списания


updated_atdateДата и время последнего изменения списания


charge_idinteger

ID связанного списания. Возможные варианты:

  • ID клиентского списания, закрытие которого инициировало генерацию реселлер-списания.
  • ID реселлер-списания нижестоящего реселлера, создание которого инициировало генерацию реселлер-списания.


subscription_idintegerID клиентской подписки


unit_pricefloatСтоимость единицы ресурса или услуги у выбранного реселлера в валюте тарифного плана


amountfloatОбщая сумма списания (с учетом скидки) в валюте выбранного реселлера


net_costfloat

Себестоимость списания для выбранного реселлера в валюте тарифного плана. Величина рассчитывается только для делегированных тарифных планов.

net_cost = license_fee × duration × quantity

где license_fee — стоимость лицензии для ресурса или периода тарифного плана на уровне лицензора (не хранится в реселлер-списании, см. Создание лицензии)



subscription_resource_idintegerID ресурса в клиентской подписке


subscription_resource_namestringИмя ресурса в подписке, которая была заказана клиентом


plan_resource_idintegerID ресурса в тарифном плане, который был заказан клиентом


resource_idintegerID ресурса


quantityintegerКоличество заказанных единиц услуги или ресурса


operate_from

dateДата начала периода, оплаченного списанием


operate_todateДата окончания периода, оплаченного списанием


durationfloatПериод списания, измеряемый в месяцах. Например, период 1 день = 0.033, 2 года = 24


descriptionstringПодробное описание списания


typestring

Тип списания (см. также Атрибуты списаний):

  • Charge::Setup — списание за установку подписки.
  • Charge::Recurring — списание за абонентскую плату подписки.
  • Charge::RecurringResource — списание за абонентскую плату ресурса подписки.
  • Charge::Renewal — списание за продление подписки.
  • Charge::RenewalResource — списание за продление ресурса.
  • Charge::ExternalResource — списание за использование внешнего ресурса.
  • Charge::SetupResource — списание за установку ресурсов подписки.
  • Charge::Transfer — списание за перенос домена.


order_idintegerID заказа, по которому произведено списание


application_template_keystringКлюч шаблона услуги, на основе которого создано приложение для подписки (см. Просмотр и обновление информации о коннекторе)


additional_params

array of objects

Дополнительные параметры списания для услуг на основе следующих модулей:

  • MicrosoftCspProducts:
НазваниеТип данныхОписание
tenant_idstringID тенанта в Microsoft Partner Center
tenant_namestringИмя тенанта (домен) в Microsoft Partner Center
subscription_idstringID подписки на стороне Microsoft (внешний ID)
order_idstringID заказа на стороне Microsoft
alternate_idstringАльтернативный ID заказа на стороне Microsoft
product_idstringID продукта на стороне Microsoft, к которому относится ресурс, связанный со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
sku_idstringSKU ресурса на стороне Microsoft, связанного со списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
attribute_typestring

Информация о назначении списания для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan):

  • azure_plan — списание сформировано для основного потребления по подписке Microsoft Azure Plan.
  • azure_ri — списание сформировано для зарезервированных ресурсов (Azure RI).
  • 3rd_party — списание сформировано для сторонних ресурсов (third-party).
effective_costfloatСебестоимость списания для реселлера с учетом скидки PEC от Microsoft. Только для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)
  • Manual Provisioning Plugin (Ручной Провижининг):
НазваниеТип данныхОписание
tenant_namestringОсновное имя клиента, заказавшего подписку (см. Получение информации о клиенте реселлера по ID)
tenant_idstringID клиента, заказавшего подписку
order_idstringID заказа на покупку, связанного с подпиской
subscription_idstringID подписки
offer_idstringSKU тарифного плана, на основе которого создана подписка (см. Получение информации о тарифном плане реселлера)
  • Office365:
НазваниеТип данныхОписание
tenant_namestringИмя тенанта (домен) в Microsoft Partner Center
tenant_idstringИдентификатор тенанта в Microsoft Partner Center
order_idstringНомер заказа на стороне Microsoft
subscription_idstringID подписки на стороне Microsoft
offer_idstringУникальный идентификатор (SKU) плана или дополнения в Microsoft Partner Center
  • Vendor Service Plugin (VSP):
НазваниеТип данныхОписание
external_idstringApplication External ID (внешний ID)
plan_skustringPlan SKU
subscription_attributesobjectДополнительные атрибуты подписки, созданные в Vendor Portal, кроме атрибута, содержащего пароль
resource_keystringApplication Resource Key

В остальных случаях возвращается пустой массив



discountfloatРазмер скидки для данного списания в валюте выбранного реселлера


original_amountstringРазмер списания в валюте тарифного плана


original_amount_currencystringКод валюты тарифного плана


currency_ratestringКурс, по которому сформировано списание


currency_unitintegerНоминал валюты, который использовался при расчете величины списания


billing_datedateДата начала финансового периода, к которому относится списание

relationshipsobjectПеречень объектов, связанных со списанием


resellerobjectИнформация о реселлере



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


accountobjectИнформация о клиенте



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


subscriptionobjectИнформация о подписке



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


planobjectИнформация о тарифном плане



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


managerobjectИнформация о менеджере



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


plan_resourceobjectИнформация о ресурсе тарифного плана



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных


discountobjectИнформация о скидке



dataobject

Информация о связанном объекте:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных
includedarray

Дополнительная информация о связанных объектах, указанных в запросе:

НазваниеТип данныхОписание
idintegerID объекта
typestringТип данных
attributesobjectАтрибуты (см. ниже)
НазваниеТип данныхОписание
idintegerID подписки
typestringТип данных
attributesobjectИнформация о подписке

created_atdateДата и время создания подписки

updated_atdateДата и время последнего изменения подписки

auto_renewalbool

Признак автоматического продления подписки:

  • true — автоматическое продление включено.
  • false — автоматическое продление отключено.

billing_fromdateДата начала генерации списаний по подписке

expiration_datedateДата истечения срока действия подписки

namestringНазвание подписки

auto_renew_point_daysintegerТочка автоматического продления подписки (в днях)

start_datedateДата активации подписки

statusstring

Статус подписки (список статусов см. в Просмотр списка подписок)


payment_modelstring

Модель оплаты подписки. Возможные значения:

  • prepay — Предоплата.
  • postpay — Постоплата.

payment_model_parametersobjectПараметры модели оплаты подписки


credit_limitfloatВеличина кредитного лимита, заданная на уровне правила обслуживания или переопределенная на уровне клиента или подписки. Возвращается только для payment_model = postpay


current_debtfloatВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay
НазваниеТип данныхОписание
idstringID скидки
typestringТип данных
attributesobjectИнформация о скидке

created_atstringДата и время создания скидки

updated_atstringДата и время последнего изменения скидки

namestringНазвание скидки

statusstring

Статус скидки:

  • active — скидка доступна для применения при создании заказов.
  • inactive — скидка недоступна для применения при создании заказов.

typestringТип скидки (подробнее о типах скидки см. Управление скидками)

percentagestringРазмер скидки в процентах

duration_fromstringДата начала периода действия скидки (в формате ГГГГ-ММ-ДД)

duration_tostringДата окончания периода действия скидки (в формате ГГГГ-ММ-ДД)
  • Для ресурса тарифного плана:
НазваниеТип данныхОписание
idstringID ресурса тарифного плана
typestringТип данных
attributesobjectИнформация о ресурсе тарифного плана

created_atstringДата и время создания ресурса тарифного плана

updated_atstringДата и время последнего изменения ресурса тарифного плана

namestring

Название ресурса


measurablebool

Признак использования модели расчета стоимости за фактическое использование ресурса (недоступен, если функция не поддерживается внешними службами):

  • true — используется расчет за фактическое использование ресурса.
  • false — не используется расчет за фактическое использование ресурса.

unit_of_measurestring

Единица измерения ресурса:

  • unit — измеряемый ресурс, для которого указывается определенное количество.
  • boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения:
    • true — ресурс включен в тарифный план.
    • false — ресурс не включен в тарифный план.

application_template_namestringНазвание услуги, которая предоставляется в рамках данного тарифного плана

includedinteger

Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)


minimuminteger

Минимальное количество ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана)


limitinteger

Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак unlimited_units = true), то limit = 0


setup_feefloat

Величина платежа за установку ресурса


recurring_feefloat

Величина ежемесячной абонентской платы за ресурс


overuse_feefloat

Стоимость перерасхода ресурсов


renewal_feefloat

Стоимость продления использования ресурса


unlimited_unitsbool

Признак отключения лимитов использования ресурса:

  • true — лимиты отключены.
  • false — лимиты активны.

publicbool

Возможные значения:

  • true — ресурс доступен клиентам для заказа.
  • false — ресурс недоступен клиентам для заказа.

statusstring

Статус ресурса:

  • active — активный.
  • inactive — неактивный.
  • deleted — удален.

resource_idinteger

ID ресурса в шаблоне услуги


priorityintegerПриоритет ресурса. У основного ресурса priority максимальный

net_costsobject
  • Для делегированных тарифных планов — значения стоимостей указанных типов, заданные для ресурса тарифного плана на уровне вышестоящего реселлера (себестоимость ресурса тарифного плана).
  • Для остальных тарифных планов все значения стоимостей равны 0.


setup_feefloat

Величина платежа за установку ресурса



recurring_feefloat

Величина ежемесячной абонентской платы за ресурс



overuse_feefloat

Стоимость перерасхода ресурсов



renewal_feefloat

Стоимость продления использования ресурса


custom_attributesobject

Информация о дополнительных параметрах ресурса в виде пар "ключ-значение"

linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

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

GET /api/v3/resellers/230/reseller_charges?include=reseller,account,subscription,plan,discount&date_from=2018-07-01&date_to=2019-06-30&page[size]=2&page[number]=2
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "1277",
            "type": "reseller_charges",
            "attributes": {
                "created_at": "2018-07-06T11:32:53.280+03:00",
                "updated_at": "2018-07-06T11:32:53.280+03:00",
                "charge_id": 42154,
                "subscription_id": 3003909,
                "unit_price": "7.0",
                "amount": "84.0",
                "net_cost": 84,
                "subscription_resource_id": 24839,
                "subscription_resource_name": "r1",
                "plan_resource_id": 2949,
                "resource_id": 1424,
                "quantity": 1,
                "operate_from": "2018-07-06",
                "operate_to": "2019-07-05",
                "duration": 12,
                "description": "Switch resource (recurring fee) \"r1\" from Subscription #3003909 \"CSP Monthly v1 switch\" to \"CSP Monthly v1 switch\"",
                "type": "Charge::Recurring",
                "order_id": 4807,
				"application_template_key": "",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "84.0",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
				"billing_date": "2018-07-01"
            },
            "relationships": {
                "reseller": {
                    "data": {
                        "id": "230",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "278",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3003909",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "850",
                        "type": "plans"
                    }
                },
                "manager": {
                    "data": {
                        "id": "186",
                        "type": "managers"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "2949",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        },
        {
            "id": "1310",
            "type": "reseller_charges",
            "attributes": {
                "created_at": "2018-05-25T14:50:24.472+03:00",
                "updated_at": "2018-05-25T14:50:24.472+03:00",
                "charge_id": 43784,
                "subscription_id": 3003965,
                "unit_price": "5.0",
                "amount": "60.0",
                "net_cost": 60,
                "subscription_resource_id": 24996,
                "subscription_resource_name": "Resource 1",
                "plan_resource_id": 2940,
                "resource_id": 8,
                "quantity": 1,
                "operate_from": "2018-05-25",
                "operate_to": "2019-05-24",
                "duration": 12,
                "description": "Upgrade resource (recurring fee) \"Resource 1\" for Subscription #3003965 \"CSP plan with resources\"",
                "type": "Charge::Recurring",
                "order_id": 4919,
				"application_template_key": "",
                "additional_params": [],
                "discount": "0.00",
                "original_amount": "60.0",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
				"billing_date": "2018-05-01"
            },
            "relationships": {
                "reseller": {
                    "data": {
                        "id": "230",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "278",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "3003965",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "847",
                        "type": "plans"
                    }
                },
                "manager": {
                    "data": {
                        "id": "186",
                        "type": "managers"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "2940",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": null
                }
            }
        }
    ],
    "included": [
        {
            "id": "230",
            "type": "resellers",
            "attributes": {...
            }
        },
        {
            "id": "278",
            "type": "accounts",
            "attributes": {...
            },
            "relationships": {...
            }
        },
        {
            "id": "3003909",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2018-07-06T11:31:35.930767+0300",
                "updated_at": "2019-08-08T07:15:28.107062+0300",
                "auto_renewal": false,
                "billing_from": "2018-07-06",
                "expiration_date": "2019-07-06",
                "name": "CSP Monthly v1 switch",
                "auto_renew_point_days": 365,
                "start_date": "2018-07-06",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "850",
            "type": "plans",
            "attributes": {...
            }
        },
        {
            "id": "3003965",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2018-05-25T14:49:57.934152+0300",
                "updated_at": "2019-06-09T07:15:24.603637+0300",
                "auto_renewal": false,
                "billing_from": "2018-05-25",
                "expiration_date": "2019-05-25",
                "name": "CSP plan with resources",
                "auto_renew_point_days": 0,
                "start_date": "2018-05-25",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "847",
            "type": "plans",
            "attributes": {...
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/230/reseller_charges?date_from=2018-07-01&date_to=2019-06-30&include=reseller%2Caccount%2Csubscription%2Cplan%2Cdiscount&page%5Bnumber%5D=2&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/230/reseller_charges?date_from=2018-07-01&date_to=2019-06-30&include=reseller%2Caccount%2Csubscription%2Cplan%2Cdiscount&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/230/reseller_charges?date_from=2018-07-01&date_to=2019-06-30&include=reseller%2Caccount%2Csubscription%2Cplan%2Cdiscount&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/230/reseller_charges?date_from=2018-07-01&date_to=2019-06-30&include=reseller%2Caccount%2Csubscription%2Cplan%2Cdiscount&page%5Bnumber%5D=3&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/230/reseller_charges?date_from=2018-07-01&date_to=2019-06-30&include=reseller%2Caccount%2Csubscription%2Cplan%2Cdiscount&page%5Bnumber%5D=3&page%5Bsize%5D=2"
    }
}