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

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

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

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

Аргументы

Название

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

Тип данных

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

Описание

X-Api-Token header string Обязательный API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)

Content-Type header string Обязательный Предназначен для идентификации формата и способа представления сущности

Accept header string Обязательный Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)

reseller_id path integer Обязательный ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

charge_id

path

integer

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

ID Списания

include

query

string

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

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

Объект	Значение параметра
Реселлер	`reseller`
Клиент	`account`
Подписка	`subscription`
Тарифный план	`plan`

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

Название

Тип данных

Описание

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

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

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

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

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

MicrosoftCspProducts Plugin:

Название	Тип данных	Описание
tenant_id	string	ID тенанта в Microsoft Partner Center
tenant_name	string	Имя тенанта (домен) в Microsoft Partner Center
subscription_id	string	ID подписки на стороне Microsoft (внешний ID)
order_id	string	ID заказа на стороне Microsoft
alternate_id	string	Альтернативный ID заказа на стороне Microsoft
product_id	string	ID продукта на стороне Microsoft, к которому относится ресурс, связанный со Списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
sku_id	string	SKU ресурса на стороне Microsoft, связанного со Списанием (пример см. в Получение списка ресурсов для коннектора Microsoft Software Subscriptions)
effective_cost	float	Себестоимость Списания для Реселлера с учетом скидки PEC от Microsoft. Только для Подписок на Услугу Microsoft Azure Plan (см. Формирование записей о потребленных ресурсах для подписки на услугу Microsoft Azure Plan)

Manual Provisioning Plugin (Ручной Провижининг):

Название	Тип данных	Описание
tenant_name	string	Основное имя Клиента, заказавшего Подписку (см. Получение информации о Клиенте Реселлера по ID)
tenant_id	string	ID Клиента, заказавшего Подписку
order_id	string	ID Заказа на покупку, связанного с Подпиской
subscription_id	string	ID Подписки
offer_id	string	SKU Тарифного плана, на основе которого создана Подписка (см. Получение информации о Тарифном плане Реселлера)

Office365:

Название	Тип данных	Описание
tenant_name	string	Имя тенанта (домен) в Microsoft Partner Center
tenant_id	string	ID тенанта в Microsoft Partner Center
order_id	string	Номер заказа на стороне Microsoft
subscription_id	string	ID подписки на стороне Microsoft
offer_id	string	Уникальный идентификатор (SKU) плана или дополнения в Microsoft Partner Center

Vendor Service Plugin (VSP):

Название	Тип данных	Описание
external_id	string	Application External ID (внешний ID)
plan_sku	string	Plan SKU
subscription_attributes	object	Дополнительные атрибуты Подписки, созданные в Vendor Portal, кроме атрибута, содержащего пароль
resource_key	string	Application Resource Key

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

discount

float

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

original_amount

string

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

original_amount_currency

string

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

currency_rate

string

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

currency_unit

integer

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

relationships

array

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

taxes

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

reseller

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

account

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

subscription

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

plan

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

discount

array

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

data

array

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

Название		Тип данных	Описание
id		integer	ID объекта
type		string	Тип данных

included

array

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

Название	Тип данных	Описание
id	integer	ID объекта
type	string	Тип данных
attributes	array	Атрибуты (см. ниже)

Атрибуты:

Для Реселлера: состав данных см. в Получение информации о Реселлере.
Для Клиента состав данных см. в Получение информации о клиенте Реселлера по ID.
Для Подписки:

Название			Тип данных	Описание
id			integer	ID Подписки
type			string	Тип данных
attributes			array	Информация о Подписке
	created_at		date	Дата и время создания Подписки
	updated_at		date	Дата и время последнего изменения Подписки
	auto_renewal		bool	Признак автоматического продления Подписки: false — автоматическое продление отключено. true — автоматическое продление включено.
	billing_from		date	Дата начала генерации Списаний по Подписке
	expiration_date		date	Дата истечения срока действия Подписки
	name		string	Название Подписки
	renew_point_days		integer	Количество дней до истечения Подписки, когда Клиент получает счет на продление
	start_date		date	Дата активации Подписки
	status		string	Статус Подписки (список статусов см. в Просмотр списка подписок)
	payment_model		string	Модель оплаты Подписки. Возможные значения: prepay – Предоплата. postpay – Постоплата.
	payment_model_parameters		object	Параметры модели оплаты Подписки
		credit_limit	float	Величина кредитного лимита, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay
		current_debt	float	Величина текущей задолженности по Подписке. Возвращается только для payment_model = postpay

Для Тарифного плана состав данных см. в Получение информации о Тарифном плане Реселлера

links

array

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

self

string

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

first

string

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

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

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

last

string

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

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

GET /api/v3/resellers/1/charges/6118?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": "6118",
        "type": "charges",
        "attributes": {
            "created_at": "2016-11-30T12:35:53.737502+0300",
            "updated_at": "2017-01-19T17:35:29.198370+0300",
            "subscription_id": 315,
            "subscription_resource_id": null,
            "quantity": 1,
            "operate_from": "2017-01-01",
            "duration": 1,
            "description": "Покупка услуги (абонентская плата) #315 \"Auto provisioning w/o resources \"",
            "unit_price": "0.0",
            "amount": "0.5",
            "status": "deleted",
            "type": "Charge::Recurring",
            "net_cost": null,
            "taxes_amount": 0,
            "subscription_resource_name": null,
            "plan_resource_id": null,
            "resource_id": null,
            "order_id": 404,
            "operate_to": "2017-01-31",
            "close_date": "2017-01-31",
			"billing_date": "2017-01-01",
            "additional_params": [],
            "application_template_key": "",
            "discount": "0.50",
            "original_amount": "0.5",
            "original_amount_currency": "BYN",
            "currency_rate": "1.0",
            "currency_unit": 1
        },
        "relationships": {
            "taxes": {
                "data": []
            },
            "reseller": {
                "data": {
                    "id": "1",
                    "type": "resellers"
                }
            },
            "account": {
                "data": {
                    "id": "10",
                    "type": "accounts"
                }
            },
            "subscription": {
                "data": {
                    "id": "315",
                    "type": "subscriptions"
                }
            },
            "plan": {
                "data": {
                    "id": "9",
                    "type": "plans"
                }
            },
            "discount": {
                "data": {
                    "id": "17",
                    "type": "discounts"
                }
            }
        }
    },
    "included": [
        {
            "id": "1",
            "type": "resellers",
            "attributes": {
                "created_at": "2016-08-25T09:26:12.491+03:00",
                "updated_at": "2020-01-16T13:10:53.572+03:00",
                "parent_id": 27,
                "general": {
                    "created_at": "2016-08-25T09:26:12.491+03:00",
                    "updated_at": "2020-01-16T13:10:53.572+03:00",
                    "name": "SL SP Root",
                    "domain": "test.activeplatform.com",
                    "manager": "Alena Rtaeva",
                    "currency": "BYN"
                },
                "company": {
                    "created_at": "2016-08-25T09:26:12.491+03:00",
                    "updated_at": "2020-01-16T13:10:53.572+03:00",
                    "city": "Минск",
                    "zip": "220053",
                    "country": "BY",
                    "fax": "",
                    "name": "SL SP Root",
                    "address_line_1": "Гаяяяя",
                    "address_line_2": "Гаяяяяя",
                    "state": "Минская",
                    "phone": "+375250000060",
                    "email": "example@gmail.com"
                },
                "contacts": {
                    "created_at": "2016-08-25T09:26:12.491+03:00",
                    "updated_at": "2020-01-16T13:10:53.572+03:00",
                    "first_name": "Ivan",
                    "last_name": "Ivanov",
                    "middle_name": "",
                    "position": "",
                    "phone": "+375250000060",
                    "email": "test@example.ru"
                },
                "custom_attributes": {
                    "inn": "",
                    "email": "",
                    "l": ""
                }
            }
        },
        {
            "id": "10",
            "type": "accounts",
            "attributes": {
                "created_at": "2016-10-25T08:23:19.005+03:00",
                "updated_at": "2019-03-13T07:15:25.452+03:00",
                "reseller_id": 1,
                "name": "POTTER",
                "account_class_id": 1,
                "primary_name": "POTTER",
                "first_name": "Nata",
                "middle_name": "",
                "last_name": "Potter",
                "country": "US",
                "region": "WA",
                "city": "Bellevue",
                "street": "Tremont str.",
                "building": "13",
                "office": "203",
                "zip": "98005",
                "phone": "+16055545555",
                "email": "test@email.com",
                "status": "active",
                "balance": "504.0",
                "usable_balance": "483.0",
                "current_debt": 0,
                "subscription_credit_limit": 0,
                "financial_blocking_threshold": 100,
                "account_type_id": 1602,
                "manager_id": null,
                "owner_id": 20,
                "tech_user_id": 20,
                "bill_user_id": 20,
                "custom_attributes": {
                    "registration_date": "14.02.2017",
                    "registration_number": "2342342",
                    "registration_authority": "234234",
                    "unp": "234234234",
                    "invoice": "0",
                    "dns": "0",
                    "post_address": "",
                    "fax": "",
                    "contact_position": "asdf",
                    "contact_charter": "asdf",
                    "bank_code": "234234",
                    "bank_name": "234234234",
                    "bank_account": "23423423423417",
                    "okpo": "",
                    "resolution_number": ""
                },
                "manager": null,
                "default_payment_model": "prepay",
                "account_type": {
                    "id": 1602,
                    "name": "Юридическое лицо",
                    "created_at": "2017-03-21T10:48:13.152+03:00",
                    "updated_at": "2017-03-21T10:48:13.152+03:00",
                    "reseller_id": 1,
                    "name_pattern": "%primary_name",
                    "primary_name": "Company name",
                    "key": "business",
                    "default_payment_method_id": null,
                    "ancestry": "1600",
                    "use_by_default": false
                },
                "account_class": {
                    "id": 1,
                    "reseller_id": 1,
                    "name": "Default",
                    "created_at": "2016-08-25T09:26:12.820+03:00",
                    "updated_at": "2019-11-29T12:27:15.315+03:00",
                    "financial_blocking_threshold": "100.0",
                    "due_order_period": 90,
                    "subzero_period": 1,
                    "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": false,
                    "receipt_day": null,
                    "payment_model": "prepay",
                    "default": true,
                    "due_payment_period": 30,
                    "subscription_credit_limit": "0.0"
                }
            },
            "relationships": {
                "subscriptions": {
                    "data": [
                        {
                            "id": "322",
                            "type": "subscriptions"
                        },
                        {
                            "id": "970",
                            "type": "subscriptions"
                        }
                    ]
                }
            }
        },
        {
            "id": "315",
            "type": "subscriptions",
            "attributes": {
                "created_at": "2016-11-30T12:35:53.369910+0300",
                "updated_at": "2017-05-14T01:02:45.402943+0300",
                "auto_renewal": false,
                "billing_from": "2016-11-30",
                "expiration_date": "2017-04-30",
                "name": "Auto provisioning w/o resources ",
                "renew_point_days": 0,
                "start_date": "2016-11-30",
                "status": "deleted",
                "payment_model": "prepay",
                "payment_model_parameters": {}
            }
        },
        {
            "id": "9",
            "type": "plans",
            "attributes": {
                "created_at": "2016-10-05T16:19:20.424+03:00",
                "updated_at": "2019-11-22T14:13:57.454+03:00",
                "status": "active",
                "name": "Auto provisioning w/o resources  234",
                "description": "",
                "public": true,
                "plan_class_id": 1,
                "product_id": 403,
                "billing_type": "reservation",
                "ancestry": null,
                "reseller_id": 1,
                "plan_class": "default",
                "product_category_id": 190,
                "product_category": "default",
                "product": "Default",
                "plan_resources": {
                    "data": [
                        {
                            "id": "562",
                            "type": "plan_resources",
                            "attributes": {
                                "created_at": "2016-10-07T15:14:24.975+03:00",
                                "updated_at": "2016-10-07T15:16:58.931+03:00",
                                "name": "Resource 4",
                                "measurable": false,
                                "unit_of_measure": "unit",
                                "application_template_name": "Auto provisioning",
                                "included": 0,
                                "minimum": 0,
                                "limit": 0,
                                "setup_fee": "1.0",
                                "recurring_fee": "1.0",
                                "overuse_fee": "2.0",
                                "renewal_fee": "1.0",
                                "unlimited_units": true,
                                "public": true,
                                "status": "active",
                                "resource_id": 272,
                                "custom_attributes": {}
                            }
                        }
                    ]
                },
                "plan_periods": {
                    "data": [
                        {
                            "id": "32",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2016-10-05T16:31:25.705+03:00",
                                "updated_at": "2016-12-29T12:22:54.002+03:00",
                                "duration_value": 2,
                                "duration_type": "month",
                                "setup_fee": "1.0",
                                "recurring_fee": "1.0",
                                "transfer_fee": "15.0",
                                "renewal_fee": "13.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": ""
                            }
                        },
                        {
                            "id": "33",
                            "type": "plan_periods",
                            "attributes": {
                                "created_at": "2016-10-05T16:31:25.731+03:00",
                                "updated_at": "2016-12-29T12:22:54.183+03:00",
                                "duration_value": 2,
                                "duration_type": "year",
                                "setup_fee": "1.0",
                                "recurring_fee": "1.0",
                                "transfer_fee": "33.0",
                                "renewal_fee": "30.0",
                                "trial": false,
                                "public": true,
                                "status": "active",
                                "description": ""
                            }
                        }
                    ]
                },
                "available_account_types": [
                    {
                        "id": 1,
                        "name": "Personal BLR",
                        "created_at": "2016-08-25T09:26:12.658+03:00",
                        "updated_at": "2019-05-08T07:21:42.843+03:00",
                        "reseller_id": 1,
                        "name_pattern": "%first_name %middle_name %last_name",
                        "primary_name": "",
                        "key": "personalblr",
                        "default_payment_method_id": 2,
                        "ancestry": null,
                        "use_by_default": false
                    },
                    {
                        "id": 2,
                        "name": "Business BLR",
                        "created_at": "2016-08-25T09:26:12.674+03:00",
                        "updated_at": "2019-05-08T03:11:31.082+03:00",
                        "reseller_id": 1,
                        "name_pattern": "%primary_name",
                        "primary_name": "Company name",
                        "key": "businessblr",
                        "default_payment_method_id": 197,
                        "ancestry": null,
                        "use_by_default": false
                    }
                ],
                "plan_currency": "RUB",
                "custom_attributes": {
                    "item_1c_for_resellers": "",
                    "vat25": "0"
                }
            }
        }
    ],
    "meta": {
        "currency": "BYN"
    }
}