Получение информации о наилучшей Скидке типа Реселлер

Метод Get information about the best Reseller Discount используется для получения информации о наилучшей Скидке типа Реселлер среди предоставленных вышестоящим Реселлером для текущего Реселлера или любого из его нижестоящих Реселлеров. Наилучшей считается Скидка, имеющая наибольший процент среди всех Скидок, доступных с учетом заданных условий.

Информация о наилучшей действующей Скидке запрашивается на указанную дату и может учитывать ограничения действия Скидки по указанному ID Тарифного плана или Подписки (подробнее о Скидках типа Реселлер см. Управление скидками типа Реселлер):

Если в запросе не указаны опциональные параметры, то учитываются только Скидки без ограничений по Подписке, Тарифному плану, Клиенту.
Если в запросе указан ID Тарифного плана, то учитываются только Скидки без ограничений по Подписке, Клиенту.
Если в запросе указан ID Подписки, то учитываются Скидки с учетом ограничений по Подписке, Тарифному плану, Клиенту.

Расчет суммы Скидки выполняется только в момент формирования реселлер-Списаний Реселлера: при закрытии клиентского Списания или наступлении Финансового дня.

Полученная информация о наилучшей Скидке не гарантирует применение этой Скидки:

На момент закрытия Финансового периода может появиться и действовать другая Скидка, которая станет лучшей.
Действие текущей лучшей Скидки может завершиться до момента закрытия Финансового периода.

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

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API токен Сотрудника, выполняющего операцию
Content-Type	header	string	Обязательный	Предназначен для идентификации формата и способа представления сущности
Accept	header	string	Обязательный	Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_id	path	integer	Обязательный	ID Реселлера, для которого запрашивается информация о Скидке. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
current_date	query	date	Обязательный	Дата, для которой запрашивается информация о наилучшей действующей Скидке, в формате ГГГГ-ММ-ДД
plan_id	query	string	Опциональный	ID Тарифного плана, для которого запрашивается информация о наилучшей действующей Скидке
subscription_id	query	string	Опциональный	ID Подписки, для которой запрашивается информация о наилучшей действующей Скидке

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

Название			Тип данных	Описание
data			object	Данные ответа
	id		integer	ID Скидки
	type		string	Тип данных
	attributes		object	Информация о Скидке
		created_at	date	Дата и время создания Скидки
		updated_at	date	Дата и время последнего обновления Скидки
		start_at	date	Дата начала периода действия Скидки в формате ГГГГ-ММ-ДД
		finish_at	date	Дата конца периода действия Скидки в формате ГГГГ-ММ-ДД
		name	string	Название Скидки
		type	string	Тип Скидки
		rate	string	Размер Скидки в процентах от 0 до 100
		apply_to_subscription	bool	Применимость Скидки только для определенной Подписки: true — Скидка применяется только для выбранной Подписки выбранного Реселлера на один уровень ниже Реселлера, предоставившего Скидку (см. subscription). false — Скидка может применяться для всех (с учетом ограничений) Подписок выбранного Реселлера на один уровень ниже Реселлера, предоставившего Скидку. Если `all_resellers = true`, Скидка всегда может применяться для всех Подписок (с учетом ограничений)
		all_resellers	bool	Доступность Скидки для всех Реселлеров: true — Скидка доступна для всех Реселлеров на один уровень ниже Реселлера, предоставившего Скидку. false — Скидка доступна только для выбранных Реселлеров на один уровень ниже Реселлера, предоставившего Скидку (см. resellers).
		all_plans	bool	Доступность Скидки для всех Тарифных планов на уровне выбранных Реселлеров: true — Скидка доступна для всех Тарифных планов на уровне выбранных Реселлеров. false — Скидка доступна только для выбранных Тарифных планов на уровне выбранных Реселлеров (см. plans). Если `all_resellers = true`, Скидка всегда доступна для всех Тарифных планов
		all_accounts	bool	Доступность Скидки для всех Клиентов выбранных Реселлеров: true — Скидка доступна для всех Клиентов выбранных Реселлеров. false — Скидка доступна только для выбранных Клиентов выбранных Реселлеров (см. accounts). Если `all_resellers = true`, Скидка всегда доступна для всех Клиентов
		resellers	array	Список выбранных Реселлеров, если `all_resellers = false`
		plans	array	Список выбранных Тарифных планов, если `all_plans = false`
		accounts	array	Список выбранных Клиентов, если `all_accounts = false`
		subscription	integer	ID выбранной Подписки выбранного Реселлера, если `apply_to_subscription = true`

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

GET /api/v3/resellers/389/reseller_discounts?current_date=2021-03-04
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "128",
        "type": "discounts",
        "attributes": {
            "created_at": "2021-03-02T17:20:57.715+03:00",
            "updated_at": "2021-03-03T16:47:02.958+03:00",
            "start_at": "2021-03-02",
            "finish_at": "2021-03-30",
            "name": "10per",
            "type": "reseller",
            "rate": "10.0",
            "apply_to_subscription": false,
            "all_resellers": true,
            "all_plans": true,
            "all_accounts": true,
            "resellers": [],
            "plans": [],
            "accounts": [],
            "subscription": {}
        }
    }
}