Получение списка списаний конечных клиентов

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

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

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/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ОпциональныйПараметр постраничной навигации. Номер страницы ответа
filter[close_date]querystringОпциональный

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

  • filter[close_date][gt] — дата закрытия более, чем указанная дата.
  • filter[close_date][lt] — дата закрытия менее, чем указанная дата.

filter[subscription_id]

query

integer

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

Фильтрация списка по ID подписки

filter[status]

query

string

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

Фильтрация списка по статусу списания (список статусов см. в Атрибуты списаний)

filter[created_at]

query

string

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

Предназначен для фильтрации списаний по дате и времени создания в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[created_at][gt] — дата и время более, чем указанные.
  • filter[created_at][lt] — дата и время менее, чем указанные.
filter[updated_at]

query

string

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

Предназначен для фильтрации списаний по дате дате и времени последнего обновления в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС в часовом поясе платформы или в указанном часовом поясе (например, ГГГГ-ММ-ДДTЧЧ:ММ:ССZ в часовом поясе UTC, см. RFC 3339). Для указания диапазона используются следующие фильтры:
  • filter[updated_at][gt] — дата и время более, чем указанные.
  • filter[updated_at][lt] — дата и время менее, чем указанные.
filter[plan_class_ids]

query

string

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

Предназначен для фильтрации списаний по ID правила предоставления (см. Просмотр списка правил предоставления). Поддерживается указание списка из нескольких ID правил предоставления, разделенных запятыми
filter[billing_date]querystringОпциональныйПредназначен для фильтрации закрытых списаний по дате начала финансового периода в формате ГГГГ-ММ-ДД, к которому они относятся
includequerystringОпциональный

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

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

Реселлер

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

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

plan
Налогиtaxes
Заказ (кроме PAYG-подписок)order

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

Название

Тип данных

Описание

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


id

stringID списания

typestringТип данных

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


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


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


subscription_idintegerID подписки


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


operate_from

stringДата начала периода, оплаченного списанием, в формате ГГГГ-ММ-ДД


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


unit_pricestringЦена продажи единицы ресурса или услуги в валюте тарифного плана


amountstringСумма списания в валюте реселлера с налогами


statusstringСтатус списания (список статусов см. в Атрибуты списаний)


typestring

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

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


net_coststring

  • Для тарифных планов, созданных на уровне реселлера — себестоимость списания в валюте реселлера, рассчитанная по формуле:

    net_cost = cost × duration × quantity × net_cost_currency_rate / net_cost_currency_unit

    где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания.

  • Для делегированных тарифных планов — себестоимость списания в валюте вышестоящего реселлера, равная сумме связанного реселлер-списания (amount).

Если списание не закрыто, net_cost = null



tax_is_calculated_usingstring

Значение параметра Налоги рассчитываются в системных настройках на момент создания списания (см. Настройки расчета налогов):

  • net_prices — Сверх цены плана — цены в тарифном плане указаны без налогов.
  • gross_prices — Внутри цены плана — цены в тарифном плане включают в себя налоги.


net_amountstringСумма списания в валюте реселлера без налогов


taxes_amountstringСумма всех налогов в валюте реселлера для списания


net_cost_originalstring

Cебестоимость списания в валюте тарифного плана:

  • Для тарифных планов, созданных на уровне реселлера, рассчитывается по формуле:

    net_cost_original = cost × duration × quantity

    где cost — себестоимость периода или ресурса, заданная в тарифном плане для соответствующего типа списания.

  • Для делегированных тарифных планов рассчитывается по формуле:

    net_cost_original = amount × net_cost_currency_unit / net_cost_currency_rate

    где amount — сумма связанного реселлер-списания в валюте вышестоящего реселлера.

Если списание не закрыто, net_cost_original = null



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


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


unit_price_currencystringКод валюты тарифного плана, в котором хранится информация о стоимости


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


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


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


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


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


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


operate_tostringДата окончания периода, оплаченного списанием, в формате ГГГГ-ММ-ДД


close_datestring

Дата, когда списание должно быть закрыто, в формате ГГГГ-ММ-ДД



billing_datestringДата начала финансового периода, к которому относится закрытое списание, в формате ГГГГ-ММ-ДД


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


additional_params

array of objects

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

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

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

  • azure_plan — списание сформировано для основного потребления по подписке Microsoft Azure Plan.
  • azure_ri — списание сформировано для зарезервированных ресурсов (Azure RI).
  • 3rd_party — списание сформировано для сторонних ресурсов (third-party).
  • azure_savings — списание сформировано для услуги Azure Savings Plan.
effective_costnumberСебестоимость списания для реселлера с учетом скидки PEC от Microsoft. Только для подписок на услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)
azure_plan_idstringID "контейнера" Azure Plan на стороне Microsoft, в рамках которого создаются подписки клиента. Только для подписок на услугу Microsoft Azure Plan (см. Заказ подписки на услугу Microsoft Azure Plan через Панель управления Оператора)
  • Manual Provisioning Plugin (Ручной Провижининг):
НазваниеТип данныхОписание
tenant_namestringОсновное имя клиента, заказавшего подписку (см. Получение информации о клиенте)
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
attribute_typestring

Информация о назначении списания:

effective_costnumberСебестоимость финального списания для реселлера. Только для подписок Google Cloud Platform (см. Формирование записей о потребленных ресурсах для подписки на Услугу Google Cloud Platform). В остальных случаях параметр отсутствует

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



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


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


original_amount_currencystringКод валюты тарифного плана для расчета суммы списания


currency_ratestringКурс валюты реселлера к валюте тарифного плана на уровне реселлера, использованный при расчете суммы списания


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


net_cost_original_currencystringКод валюты тарифного плана для расчета себестоимости списания

relationshipsobject

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

  • Реселлер-списания одновременно связаны с родительским тарифным планом и ресурсом тарифного плана подписки.
  • При переключении тарифного плана старые списания по подписке и новые списания за возврат средств остаются связаны со старым тарифным планом и его ресурсами. Все остальные новые списания будут связаны с новым тарифным планом и его ресурсами.



taxesobjectИнформация о налогах



dataarray of objects

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

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


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



dataobject

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

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


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



dataobject

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

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


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



dataobject

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

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


planobject

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




dataobject

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

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


plan_resourceobject

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




dataobject

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

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


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



dataobject

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

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


orderobject

Информация о заказе




dataobject

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

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

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

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

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

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

auto_renewalbool

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

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

billing_fromstringДата начала генерации списаний по подписке в формате ГГГГ-ММ-ДД

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

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

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

start_datestringДата активации подписки в формате ГГГГ-ММ-ДД

statusstring

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


payment_modelstring

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

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

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


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


current_debtnumberВеличина текущей задолженности по подписке. Возвращается только для payment_model = postpay

  • Для налогов — о каждом налоге, использованном при создании списания:

    НазваниеТип данныхОписание
    idstringID налога
    typestringТип данных
    attributesobjectИнформация о налоге

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

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

    		charge_idintegerID списания, для которого рассчитан налог

    		origin_idintegerID налога в налоговом модуле

    		namestringНазвание налога

    		codestringКод налога

    		ratenumberРазмер налога в процентах

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

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

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

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

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

laststringСсылка на последнюю страницу
metaobjectДополнительная информация о списании

currencystringКод валюты реселлера

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

GET /api/v3/resellers/1/charges?page[size]=2&page[number]=1995
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": [
        {
            "id": "7302",
            "type": "charges",
            "attributes": {
                "created_at": "2023-02-25T04:12:17.520233+0000",
                "updated_at": "2023-02-25T04:12:18.343218+0000",
                "subscription_id": 1728,
                "subscription_resource_id": 2076,
                "operate_from": "2023-11-01",
                "description": "Upgrade resource (recurring fee) \"Licenses\" for Subscription #1728 \"Office\"",
                "unit_price": "30.0",
                "amount": "18.15",
                "status": "refunded",
                "type": "Charge::Recurring",
                "net_cost": null,
                "net_amount": "15.0",
                "taxes_amount": "3.15",
                "net_cost_original": null,
                "net_cost_currency_rate": "1.0",
                "net_cost_currency_unit": 1,
                "unit_price_currency": "USD",
                "quantity": 1.0,
                "duration": 1.0,
                "subscription_resource_name": "Licenses",
                "plan_resource_id": 1335,
                "resource_id": 4943,
                "order_id": 3595,
                "operate_to": "2023-11-30",
                "close_date": "2023-11-30",
                "billing_date": null,
                "application_template_key": "",
                "additional_params": [
                    {
                        "tenant_name": "XXXXX",
                        "tenant_id": 246,
                        "order_id": 3595,
                        "subscription_id": 1728,
                        "offer_id": ""
                    }
                ],
                "discount": "15.00",
                "original_amount": "18.15",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
                "net_cost_original_currency": "USD",
                "tax_is_calculated_using": "net_prices"
            },
            "relationships": {
                "taxes": {
                    "data": [
                        {
                            "id": "8889",
                            "type": "taxes"
                        },
                        {
                            "id": "8890",
                            "type": "taxes"
                        },
                        {
                            "id": "8891",
                            "type": "taxes"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "246",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "1728",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1253",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "1335",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": {
                        "id": "9",
                        "type": "discounts"
                    }
                },
                "order": {
                    "data": {
                        "id": "2",
                        "type": "sales_orders"
                    }
                }
            }
        },
        {
            "id": "7303",
            "type": "charges",
            "attributes": {
                "created_at": "2023-02-25T04:12:17.533114+0000",
                "updated_at": "2023-02-25T04:12:18.350008+0000",
                "subscription_id": 1728,
                "subscription_resource_id": 2076,
                "operate_from": "2023-12-01",
                "description": "Upgrade resource (recurring fee) \"Licenses\" for Subscription #1728 \"Office\"",
                "unit_price": "30.0",
                "amount": "18.15",
                "status": "refunded",
                "type": "Charge::Recurring",
                "net_cost": null,
                "net_amount": "15.0",
                "taxes_amount": "3.15",
                "net_cost_original": null,
                "net_cost_currency_rate": "1.0",
                "net_cost_currency_unit": 1,
                "unit_price_currency": "USD",
                "quantity": 1.0,
                "duration": 1.0,
                "subscription_resource_name": "Licenses",
                "plan_resource_id": 1335,
                "resource_id": 4943,
                "order_id": 3595,
                "operate_to": "2023-12-31",
                "close_date": "2023-12-31",
                "billing_date": null,
                "application_template_key": "",
                "additional_params": [
                    {
                        "tenant_name": "XXXXX",
                        "tenant_id": 246,
                        "order_id": 3595,
                        "subscription_id": 1728,
                        "offer_id": ""
                    }
                ],
                "discount": "15.00",
                "original_amount": "18.15",
                "original_amount_currency": "USD",
                "currency_rate": "1.0",
                "currency_unit": 1,
                "net_cost_original_currency": "USD",
                "tax_is_calculated_using": "net_prices"
            },
            "relationships": {
                "taxes": {
                    "data": [
                        {
                            "id": "8892",
                            "type": "taxes"
                        },
                        {
                            "id": "8893",
                            "type": "taxes"
                        },
                        {
                            "id": "8894",
                            "type": "taxes"
                        }
                    ]
                },
                "reseller": {
                    "data": {
                        "id": "1",
                        "type": "resellers"
                    }
                },
                "account": {
                    "data": {
                        "id": "246",
                        "type": "accounts"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "1728",
                        "type": "subscriptions"
                    }
                },
                "plan": {
                    "data": {
                        "id": "1253",
                        "type": "plans"
                    }
                },
                "plan_resource": {
                    "data": {
                        "id": "1335",
                        "type": "plan_resources"
                    }
                },
                "discount": {
                    "data": {
                        "id": "9",
                        "type": "discounts"
                    }
                },
                "order": {
                    "data": {
                        "id": "2",
                        "type": "sales_orders"
                    }
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/charges?page%5Bnumber%5D=1995&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/charges?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/charges?page%5Bnumber%5D=1994&page%5Bsize%5D=2",
        "next": "https://test.activeplatform.com/api/v3/resellers/1/charges?page%5Bnumber%5D=1996&page%5Bsize%5D=2",
        "last": "https://test.activeplatform.com/api/v3/resellers/1/charges?page%5Bnumber%5D=1996&page%5Bsize%5D=2"
    },
    "meta": {
        "currency": "USD"
    }
}