Получение информации о реселлер-Списании Реселлера по ID

Метод Get the Reseller's Charge by ID позволяет получить информацию о реселлер-Списании для текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

charge_id

pathintegerОбязательный

ID Списания

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

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

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

Реселлер

reseller
Клиент
account
Подписка
subscription

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

plan
Скидка
discount
Ресурс Тарифного планаplan_resource

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

Название

Тип данных

Описание

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


id

integerID Списания

typestringТип данных

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


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


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


charge_idinteger
  • 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 Plugin:
НазваниеТип данныхОписание
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)
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_idstringID тенанта в 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Номинал валюты, который использовался при расчете величины Cписания


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

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


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



dataarray

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

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


accountarrayИнформация о Клиенте



dataarray

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

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


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



dataarray

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

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


planarrayИнформация о Тарифном плане



dataarray

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

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


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



dataarray

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

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


plan_resourcearrayИнформация о Ресурсе



dataarray

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

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


discountarrayИнформация о Скидке



dataarray

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

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

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

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

Атрибуты:

НазваниеТип данныхОписание
idintegerID Подписки
typestringТип данных
attributesarrayИнформация о Подписке

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

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

auto_renewalbool

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

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

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

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

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

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. Limit может быть также равен 0 когда Ресурс не является безлимитным, если minimum и 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

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

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

GET /api/v3/resellers/230/reseller_charges/1310?include=reseller,account,subscription,plan,discount
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "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-05"
        },
        "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": {
                "created_at": "2017-10-12T14:21:59.236+03:00",
                "updated_at": "2018-07-26T07:30:35.463+03:00",
                "parent_id": 229,
                "general": {
                    "created_at": "2017-10-12T14:21:59.236+03:00",
                    "updated_at": "2018-07-26T07:30:35.463+03:00",
                    "name": "SL 365",
                    "domain": "test.activeplatform.com",
                    "manager": "slt1manager",
                    "currency": "USD"
                },
                "company": {
                    "created_at": "2017-10-12T14:21:59.236+03:00",
                    "updated_at": "2018-07-26T07:30:35.463+03:00",
                    "city": "Minsk",
                    "zip": "",
                    "country": "BY",
                    "fax": "",
                    "name": "Acme",
                    "address_line_1": "Mira",
                    "address_line_2": "1",
                    "state": "",
                    "phone": "+375290000000",
                    "email": ""
                },
                "contacts": {
                    "created_at": "2017-10-12T14:21:59.236+03:00",
                    "updated_at": "2018-07-26T07:30:35.463+03:00",
                    "first_name": "Adam",
                    "last_name": "Smith",
                    "middle_name": "",
                    "position": "",
                    "phone": "+375290000000",
                    "email": "example@gmail.com"
                },
                "custom_attributes": {}
            }
        },
        {
            "id": "278",
            "type": "accounts",
            "attributes": {
                "created_at": "2018-07-06T10:41:59.558+03:00",
                "updated_at": "2019-02-01T16:51:37.908+03:00",
                "reseller_id": 230,
                "name": "Виталий  Комич",
                "account_class_id": 954,
                "primary_name": "",
                "first_name": "Виталий",
                "middle_name": "",
                "last_name": "Комич",
                "country": "BY",
                "region": "Минская",
                "city": "Минск",
                "street": "Кальварийская",
                "building": "",
                "office": "",
                "zip": "112305",
                "phone": "+375440000000",
                "email": "example@activeplatform.com",
                "status": "active",
                "balance": "99543.98",
                "usable_balance": "99514.96",
                "current_debt": 0,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 100,
                "account_type_id": 3938,
                "manager_id": null,
                "owner_id": 659,
                "tech_user_id": 659,
                "bill_user_id": 659,
                "custom_attributes": {},
                "manager": null,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 3938,
                    "name": "Физическое лицо",
                    "created_at": "2017-10-12T14:21:59.392+03:00",
                    "updated_at": "2017-10-12T14:21:59.392+03:00",
                    "reseller_id": 230,
                    "name_pattern": "%first_name %middle_name %last_name",
                    "primary_name": "",
                    "key": "personal",
                    "default_payment_method_id": null,
                    "ancestry": "1562/1564/3933",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 954,
                    "reseller_id": 230,
                    "name": "Default",
                    "created_at": "2017-10-12T14:22:00.507+03:00",
                    "updated_at": "2019-02-07T15:42:39.112+03:00",
                    "financial_blocking_threshold": "100.0",
                    "due_order_period": 14,
                    "subzero_period": 5,
                    "stop_subscription_type": "automatically",
                    "key": "default",
                    "color": "grey",
                    "guaranteed_payment_limit": 1000,
                    "guaranteed_payment_period": 7,
                    "delete_subscription_type": "automatically",
                    "denominated": false,
                    "buy_with_negative_balance": true,
                    "receipt_day": null,
                    "payment_model": "prepay",
                    "default": false,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "3003911",
                            "type": "subscriptions"
                        },
                        {
                            "id": "3003965",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        },
        {
            "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",
                "renew_point_days": 0,
                "start_date": "2018-05-25",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "847",
            "type": "plans",
            "attributes": {
                "created_at": "2018-07-06T11:27:20.029+03:00",
                "updated_at": "2020-01-04T11:13:18.206+03:00",
                "status": "active",
                "name": "CSP plan with resources",
                "description": "",
                "public": true,
                "plan_class_id": 3866,
                "product_id": 555,
                "billing_type": "csp_monthly",
                "ancestry": "12",
                "reseller_id": 229,
                "plan_class": "CSP monthly",
                "product_category_id": 536,
                "product_category": "default",
                "product": "Default",
                "plan_resources": {
                    "data": [
                        {
                            "id": "2938",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2018-07-06T11:27:20.114+03:00",
                                "updated_at": "2018-07-06T11:27:20.114+03:00",
                                "name": "Resource 1",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Auto provisioning",
                                "included": 0,
                                "minimum": 1,
                                "limit": 0,
                                "setup_fee": "0.0",
                                "recurring_fee": "5.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0",
                                "unlimited_units": true,
                                "public": true,
                                "status": "active",
                                "resource_id": 8,
                                "custom_attributes": {}
                            }
                        },
                        {
                            "id": "2939",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2018-07-06T11:27:20.122+03:00",
                                "updated_at": "2018-07-06T11:27:20.122+03:00",
                                "name": "Resource 2",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Auto provisioning",
                                "included": 0,
                                "minimum": 0,
                                "limit": 0,
                                "setup_fee": "0.0",
                                "recurring_fee": "5.0",
                                "overuse_fee": "0.0",
                                "renewal_fee": "0.0",
                                "unlimited_units": true,
                                "public": true,
                                "status": "active",
                                "resource_id": 9,
                                "custom_attributes": {}
                            }
                        }
                    ]
                },
                "plan_periods": {
                    "data": [
                        {
                            "id": "1687",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2018-07-06T11:27:20.082+03:00",
                                "updated_at": "2018-07-06T11:27:20.082+03:00",
                                "duration_value": 1,
                                "duration_type": "month",
                                "setup_fee": "1.0",
                                "recurring_fee": "1.0",
                                "transfer_fee": "17.0",
                                "renewal_fee": "15.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": ""
                            }
                        },
                        {
                            "id": "1675",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2018-07-06T11:27:20.037+03:00",
                                "updated_at": "2018-07-06T11:27:20.037+03:00",
                                "duration_value": 1,
                                "duration_type": "year",
                                "setup_fee": "0.0",
                                "recurring_fee": "0.0",
                                "transfer_fee": "0.0",
                                "renewal_fee": "0.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": ""
                            }
                        }
                    ]
                },
                "available_account_types": [
                    {
                        "id": 3927,
                        "name": "Personal BLR",
                        "created_at": "2017-10-12T13:44:58.444+03:00",
                        "updated_at": "2017-10-12T13:44:58.444+03:00",
                        "reseller_id": 229,
                        "name_pattern": "%first_name %middle_name %last_name",
                        "primary_name": "",
                        "key": "personalblr",
                        "default_payment_method_id": 2,
                        "ancestry": "1",
                        "use_by_default": false
                    },
                    {
                        "id": 3931,
                        "name": "Business BLR",
                        "created_at": "2017-10-12T13:44:58.474+03:00",
                        "updated_at": "2017-10-12T13:44:58.474+03:00",
                        "reseller_id": 229,
                        "name_pattern": "%primary_name",
                        "primary_name": "Company name",
                        "key": "businessblr",
                        "default_payment_method_id": 197,
                        "ancestry": "2",
                        "use_by_default": false
                    }
                ],
                "plan_currency": "EUR",
                "custom_attributes": {
                    "item_1c_for_resellers": "",
                    "vat25": "0"
                }
            }
        }
    ]
}