Плейсхолдеры для описания правила обработки события

Общее для всех событий

owner.status

Статус Владельца клиента

string

owner.status = "active"

owner.country

2-буквенный код страны (ISO) из адресной информации Владельца клиента (например, BY для Республики Беларусь)

string

owner.country = "BY"

owner.city

Название города из адресной информации Владельца клиента

string

owner.city = "Minsk"

current_date

Текущая дата

date

current_date

Приближается финансовая блокировка клиента (Account credit hold is coming)

Клиент изменен (Account changed)

Клиент создан (Account created)

Порог срабатывания финансовой блокировки изменен (Financial blocking threshold was changed)

Менеджер клиента изменен (Account manager changed)

Недостаточно средств на балансе (Low balance)

Закрывающие документы сформированы (Closing documents generated)

Создание сервера (Create instance)

Сброс пароля сервера (Reset instance password)

account.balance

Баланс клиента

number

account.balance = 1000

account.balance.was

Предыдущее значение баланса клиента

number

account.balance.was = 100

account.city

Название города из адресной информации клиента

string

account.city = "Minsk"

account.class_id

ID правила обслуживания клиента

integer

account.class_id = 1

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "manual"

account.country

2-буквенный код страны (ISO) из адресной информации клиента (например, BY для Республики Беларусь)

string

account.country = "BY"

account.financial_blocking_threshold

Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение разрешенного периода отрицательного баланса

number

account.financial_blocking_threshold = 100

account.has_endless_trial_subscriptions

Признак наличия у клиента хотя бы одной активной коммерческой подписки с бессрочным периодом

boolean

account.has_endless_trial_subscriptions = true

account.has_manager

Признак наличия прикрепленного менеджера

boolean

account.has_manager = true

account.regular_sending

Плейсхолдер используется для задания условий отправки уведомлений о низком балансе.

• Если account.regular_sending = true, отправка уведомлений осуществляется при выполнении биллинг процесса.

• Если account.regular_sending = false, отправка уведомлений осуществляется в момент изменения баланса.

• Если account.regular_sending не задан, отправка уведомлений осуществляется дважды: при выполнении биллинг процесса и в момент изменения баланса.

boolean

account.regular_sending = true

account.status

Статус клиента

string

account.status = "inactive"

account.status.was

Предыдущий статус клиента

string

account.status.was = "inactive"

account.subscription_credit_limit

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

number

account.subscription_credit_limit = 100

account.type_id

ID типа клиентов клиента

integer

account.type_id = 1

account.type_key

Ключ типа клиентов клиента

string

account.type_key = "business"

account.owner_reset_password_url

Одноразовая ссылка для установки пароля Владельца клиента

string

account.owner_reset_password_url = "http://example.com/password/edit?reset_password_token=1q2w3e"

Соглашение обновлено (Agreement updated)

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "postpay"

account.status

Статус клиента

string

account.status = "active"

request_type

Тип запроса обновления соглашения (см. Обновление соглашения):

• automatically — автоматически по расписанию

• manually — вручную

string

request_type = "automatically"

agreement_status

Статус соглашения:

• waiting_for_accept — запрошено обновление соглашения

string

agreement_status = "waiting_for_accept"

agreement_type

Тип соглашения (см. Соглашения):

• privacy_notice_and_policy_agreement — Уведомление о конфиденциальности и Политика конфиденциальности.

• microsoft_customer_agreement — Клиентское соглашение Microsoft.

• terms_and_conditions — Правила продаж.

string

agreement_type = "terms_and_conditions"

days_passed

Количество дней с момента запроса обновления соглашения

integer

days_passed = 0

Закрытие Акта (Invoice closed)

Счет был подтвержден (The Invoice was approved)

invoice.status

Cтатус акта

string

invoice.status = "open"

invoice.has_attached

Указывает, был ли прикреплен к платежу файл счета на оплату, сформированный сторонней ERP-системой, при подтверждении акта по модели Постоплата с внешним управлением (см.

)

boolean

invoice.has_attached = true

account.type.key

Ключ типа клиентов клиента

string

account.type_key = "business"

Ручная операция (Manual Operation)

operation.id

ID ручной операции

integer

operation.id = 1

operation.status

Статус ручной операции (см. Просмотр списка ручных операций)

string

operation.status = "approval_required"

operation.status = "declined"

operation.type

Тип ручной операции (см.

). Например, для ручной операции при остановке подписки:

• operation.type = "manual_provisioning_plugin_application_stop" — если подписка создана на основе модуля "Ручной Провижининг" (Manual Provisioning plugin).

• operation.type = "subscription_stop" — для всех остальных подписок.

string

operation.type = "postpay_subscription_verify"

operation.type = "manual_provisioning_plugin_application_install"

operation.type = "subscription_stop"

product.id

ID продукта тарифного плана

integer

product.id = 1

product.name

Имя продукта тарифного плана

string

product.name = "ESET"

product_category.id

ID продукта тарифного плана

integer

product_category.id = 1

plan.id

ID тарифного плана

integer

plan.id = 1

plan_category.key

Ключ категории тарифных планов

string

plan_category.key = "default"

subscription.id

ID подписки

integer

subscription.id = 1

subscription.status.was

Предыдущий статус тодписки

string

subscription.status.was="installing"

subscription.status

Статус подписки

string

subscription.status.was="active"

account.type_key

Ключ типа клиентов

string

account.type_key = "personal"

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "default"

Срок оплаты платежа наступил (Payment due date has come)

payment.due_date_passed

Количество дней после перехода платежа в статус Просрочен

integer

payment.due_date_passed = 1

Приглашение пользователя (User invitation)

-

-

-

-

Платеж изменен (Payment has been changed) (ранее — Платеж получен (Payment has been received))

account.type_key

Ключ типа клиентов

string

account.type_key = "business"

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "manual"

account.financial_blocking_threshold

Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение разрешенного периода отрицательного баланса

number

account.financial_blocking_threshold = 100

account.balance

Баланс клиента

integer

account.balance = 1000

account.status

Статус клиента

string

account.status = "inactive"

account.country

2-буквенный код страны (ISO) из адресной информации клиента (например, BY для Республики Беларусь)

string

account.country = "BY"

account.city

Название города из адресной информации клиента

string

account.city = "Minsk"

payment.total

Общая сумма платежа (Итого)

integer

payment.total = 100

payment.status

Статус платежа

string

payment.status = "completed"

Запрос сброса пароля (Password reset request)

Подтверждение email (Verify email)

user.id

ID пользователя

integer

user.id = 1

Запрос цены изменен (Request for quote changed)

account.class_id

ID правила обслуживания клиента

integer

account.class_id = 1

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "manual"

quote.status

Статус запроса цен (см. Просмотр списка запросов цен):

• pending

• waiting_for_approval

• declined

• approved

• expired

• cancelled

string

quote.status = "pending"

Запрос сброса пароля менеджера

Manager password reset request

manager.id

ID менеджера

integer

manager.id = 1

До окончания периода подписки
(Before subscription expiration)

После окончания периода подписки
(After subscription expiration)

Подписка переведена из пробного статуса в платный 
(After subscription switched from trial to no-trial)

Подписка изменена (Subscription changed)

Кредитный лимит для постоплатной подписки изменен (Credit limit for postpaid subscription was changed)

Приближение к кредитному лимиту постоплатной подписки (Credit limit for postpaid subscription is approaching)

account.balance

Баланс клиента

number

account.balance = 1000

account.status

Статус клиента

string

account.status = "inactive"

account.type_key

Ключ типа клиентов

string

account.type_key = "business"

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "manual"

account.financial_blocking_threshold

Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение разрешенного периода отрицательного баланса

number

account.financial_blocking_threshold = 100

account.subscription_credit_limit

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

number

account.subscription_credit_limit = 100

account.country

2-буквенный код страны (ISO) из адресной информации клиента (например, BY для Республики Беларусь)

string

account.country = "BY"

account.city

Название города из адресной информации клиента

string

account.city = "Minsk"

plan.auto_renewal_disabled

Включена ли опция Блокировать опцию Автопродление в тарифном плане

boolean

plan.auto_renewal_disabled = false

plan.id

ID тарифного плана

integer

plan.id = 1

plan.status

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

string

plan.status = "completed"

plan_period.duration_value

Длительность периода подписки на тарифный план

integer

plan_period.duration_value = 30

plan_period.duration_type

Единицы измерения длительности периода подписки на тарифный план (год, месяц, день)

string

plan_period.duration_type = "months"

plan_period.trial

Является ли период тарифного плана пробным

string ("boolean")

plan_period.trial = "false"

plan_period.setup_fee

Стоимость установки тодписки на период тарифного плана

number

 plan_period.setup_fee = 100

plan_period.recurring_fee

Абонентская плата за тодписку на период тарифного плана

number

plan_period.recurring_fee = 100

plan_period.renewal_fee

Стоимость продления тодписки на период тарифного плана

number

plan_period.renewal_fee = 100

plan_category.key

Ключ категории тарифных планов

string

plan_category.key = "streaming"

plan_category.id

ID категории тарифных планов

integer

plan_category.id = 1

subscription.id

ID подписки

integer

subscription.id = 1

subscription.csp

Является ли подписка предоставляемой по программе Microsoft CSP

boolean

subscription.csp = true

subscription.individual_price

Заказана ли подписка по индивидуальным ценам (см.

)

boolean

subscription.individual_price = true

subscription.status

Статус подписки

string

subscription.status = "active"

subscription.status.was

Предыдущий статус подписки

string

subscription.status.was="installing"

subscription.auto_renewal

Включена ли опция Автопродление в подписке

boolean

subscription.auto_renewal = true

subscription.auto_renewal_disabled

Включена ли опция Блокировать опцию Автопродление в подписке

boolean

subscription.auto_renewal_disabled = false

subscription.auto_renewal.was

Предыдущее состояние опции Автопродление в подписке

boolean

subscription.auto_renewal.was = true

subscription.days_left

Количество дней до даты истечения подписки

integer

subscription.days_left = 7

subscription.days_passed

Количество дней, прошедших со дня создания подписки

integer

subscription.days_passed = 15

subscription.plan_class

Название правила предоставления тарифного плана

string

subscription.plan_class = "default"

subscription.plan_class_key

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

string

subscription.plan_class_key = "default"

subscription.payment_model

Модель оплаты подписки. Возможные значения: prepay (Предоплата) или postpay (Постоплата)

string

subscription.payment_model = "postpay"

subscription_postpay.current_debt

Текущая задолженность по подписке, рассчитанная как сумма всех списаний по подписке за текущий финансовый период в статусе Заблокировано

number

subscription_postpay.current_debt = 100

subscription_postpay.credit_limit

Величина задолженности по подписке, при превышении которой подписка по модели Постоплата будет остановлена

number

subscription_postpay.credit_limit = 100

product.id

ID продукта тарифного плана, на который оформлена подписка (см.

)

integer

 product.id = 1

product.name

Имя продукта тарифного плана, на который оформлена подписка (см.

)

integer

product.name = "Default"

order.type

Тип заказа

string

order.type = "RenewalOrder"

Заказ изменен (Order changed)

Заказ создан (Order created)

Повторная отправка заказа (Resend the order)

Заказ завершен (немедленный) (Order completed (immediate))

order.id

ID заказа

integer

order.id = 1

order.plans_ids

ID заказанных тарифных планов

integer

order.type = "SalesOrder" and (order.plans_ids include? 2000030)

order.status

Статус заказа

string

order.status = "waiting_for_payment"

order.status.was

Предыдущий статус заказа

string

order.status.was = "provisioning"

order.total

Общая стоимость заказа

integer

 order.total = 100

order.type

Тип заказа

string

order.type = "RenewalOrder"

order.renewal_point

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

boolean

order.renewal_point = true

order.renewal_is_positive

Установлено ли автоматическое продление подписки до наступления дня ее истечения (см. Просмотр и обновление информации о подписке):

• true — заказ на продление формируется до наступления дня истечения подписки (значение параметра Точка автоматического продления (в днях) больше 0).

• false — заказ на продление формируется в день истечения подписки (значение Точка автоматического продления (в днях) = 0).

boolean

order.renewal_is_positive = true

subscription.status

Статус подписки

string

subscription.status.was="active"

product.id

ID продукта тарифного плана на который оформлена подписка, включенная в заказ (см.

)

integer

 product.id = 1

product.name

Название продукта тарифного плана на который оформлена подписка, включенная в заказ (см.

)

integer

product.name = "Default"

subscription.payment_model

Модель оплаты подписки. Возможные значения: prepay (Предоплата) или postpay (Постоплата)

string

subscription.payment_model = "postpay"

plan_category.key

Ключ категории тарифных планов

string

plan_category.key = "streaming"

subscription.plan_class

Название правила предоставления тарифного плана

string

subscription.plan_class = "default"

subscription.plan_class_key

Ключ правила предоставления

string

subscription.plan_class_key = "default"

Заказы завершены (за период) (Orders completed (by period))

calendar_period 

Период, за который выбираются заказы и отправляется уведомление:

• Месяц — отправка каждого 1 числа для заказов, у которых дата завершения в прошедшем календарном месяце.

• Неделя — отправка каждый понедельник для заказов, у которых дата завершения на прошедшей неделе.

• День — отправка ежедневно для заказов, у которых дата завершения вчера.

string

calendar_period = "previous_week"

calendar_period = "previous_month"

calendar_period = "previous_day"

order.type

Тип заказа

string

order.type = "RenewalOrder"

plan_category.key

Ключ категории тарифного плана, связанного с подпиской

string

plan_category.key = "plan_category_key"

subscription.payment_model

Модель оплаты подписки. Возможные значения: prepay (Предоплата) или postpay (Постоплата)

string

subscription.payment_model = "postpay"

subscription.plan_class

Название правила предоставления тарифного плана

string

subscription.plan_class = "default"

subscription.plan_class_key

Ключ правила предоставления

string

subscription.plan_class_key = "default"

Повторная отправка заказа (Resend the order)

order.days_passed

Количество дней, прошедших со дня создания заказа

integer

order.days_passed = 5

Обещанный платеж создан (Guaranteed payment created)

Обещанный платеж изменен (Guaranteed payment changed)

Обещанный платеж истекает (Guaranteed payment will expire)

account.type_id

ID типа клиентов

integer

account.type_id = 1

account.type_key

Ключ типа клиентов

string

account.type_key = "business"

account.class_id

ID правила обслуживания клиента

integer

account.class_id = 1

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "manual"

guaranteed_payment.status.was

Предыдущий статус обещанного платежа

string

guaranteed_payment.status.was = "provided"

guaranteed_payment.status

Статус обещанного платежа

string

guaranteed_payment.status = "revoked"

guaranteed_payment.days_left

Количество дней до истечения обещанного платежа

integer

guaranteed_payment.days_left = 1

Финансовый день наступает (Billing day is coming)

billing_day

Дата финансового дня, для которого было вызвано событие

integer

billing_day = 5

billing_day_left

Количество дней, которое осталось до финансового дня, для которого было вызвано событие

integer

billing_day_left = 7

billing_day_open_charges_amount

Сумма списаний в статусе Открыто, которые будут закрыты или заблокированы в финансовый день, для которого было вызвано событие. Учитываются только подписки, у которых Точка автоматического продления = 0. Если списания в статусе Открыто не существуют, то производится расчет суммы на основе предварительной генерации списаний на будущий финансовый период

number

billing_day_open_charges_amount = 120.1

plan_ids

Массив ID тарифных планов активных подписок клиента

array(int)

plan_ids include? 200023

product_ids

Массив ID продуктов тарифных планов, на которые оформлены активные подписки клиента

array(int)

product_ids include? 100022

product_names

Массив названий продуктов тарифных планов, на которые оформлены активные подписки клиента

array(str)

product_names include? "Default"

monthly_billing

Флаг, указывающий на то, что у клиента есть неудаленные подписки с месячными платежами (например, с типом биллинга Monthly Prolongation, Monthly Commitment), для которых актуален финансовый день, для которого было вызвано событие

boolean

monthly_billing = true

account.type_key

Ключ типа клиента

string

account.type_key = "personal"

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "default"

account.balance

Доступный баланс клиента

number

account.balance = 58.5

account.financial_blocking_threshold

Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение разрешенного периода отрицательного баланса

number

account.financial_blocking_threshold = 10000

subscription.expiration_date

Дата истечения подписки

date ДД.ММ.ГГГГ

01.01.2019

subscription.payment_model

Модель оплаты подписки. Возможные значения: prepay (Предоплата) или postpay (Постоплата)

string

subscription.payment_model = "postpay"

Срок оплаты платежа приближается (Payment due date is coming)

payment.days_left

Количество дней до крайней даты оплаты платежа (см. Срок оплаты в

), за которое будет отправлено уведомление

integer

payment.days_left = 5

Порог срабатывания финансовой блокировки изменен (Credit hold threshold was changed)

account.financial_blocking_threshold

Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение разрешенного периода отрицательного баланса

number

account.financial_blocking_threshold = 100

Финансовый день по подпискам менеджера наступил

(Billing day for manager's subscriptions has come)

(ранее — Финансовый день наступил (Billing day has come))

billing_day

Дата финансового дня, для которого вызывается событие

integer

billing_day = 5

subscriptions_plan_category_keys

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

array

subscriptions_plan_category_keys include? "azure"

subscriptions_statuses

Массив статусов подписок, для проверки статусов подписок клиентов, для которых может срабатывать данное событие уведомлений

array

subscriptions_statuses include? "active"

Создан объединенный платеж (Joined payment created)

Повторная отправка объединенного платежа (Resend the joined payment) 

account.class_id

ID правила обслуживания клиента

integer

account.class_id = 1

account.class_key

Ключ правила обслуживания клиента

string

account.class_key = "default"

payment.days_passed

Количество дней, прошедших со дня создания объединенного платежа

integer

payment.days_passed = 5

Финансовый день по подписке клиента наступил (Billing day for account's subscription has come)

billing_day_passed

Количество дней после наступления финансового дня, когда срабатывает событие уведомлений для прошедшего финансового периода

integer

billing_day_passed = 5

plan_category_key

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

string

plan_category_key = "azure"

subscription_status

Статус подписки, для которого может срабатывать событие уведомлений

string

subscription_status = "active'

account_class_key

Правило обслуживания клиента, для которого может срабатывать событие уведомлений

string

account_class_key = "default"

total_amount

Сумма списаний в статусе Закрыто за прошедший финансовый период для подписки

number

total_amount < 0

total_amount >= 0

Корректировка баланса подтверждена (Correction approved)

correction.approved_manager_id

Список ID менеджеров, подтвердивших корректировку, для которых может срабатывать событие уведомлений

integer

correction.approved_manager_id = 221

До истечения постоплатных подписок клиента (Before account's postpaid subscriptions expiration)

before_subscriptions_expirations

Массив дней до даты истечения подписок клиента

integer

before_subscriptions_expirations include? 1

subscription.status

Статус подписки. Поддерживаются следующие значения:

• active

• graced

• stopped

• waiting_for_manual_approve

string

subscription.status = "active" OR
subscription.status = "graced"

Оплата платежа получена из внешней системы (Paid amount has been received from external system)

payment_transaction.amount

Сумма оплаты, указанная в теле запроса 

number

payment_transaction.amount = 15

payment.total

Сумма платежа в платформе

number

payment.total = 10

payment.status.was

Предыдущий статус платежа

string

payment.status.was = "completed"

payment.status

Текущий статус платежа

string

payment.status = "completed"

VSP подписка создана (VSP subscription created)

VSP ресурсы изменились (VSP resources changed)

plan.id

ID тарифного плана, связанного с подпиской

integer

plan.id = 123

product.id

ID продукта, связанного с подпиской

integer

product.id = 123

product.name

Название продукта, связанного с подпиской

string

product.name = "Product Name"

plan_category.id

ID категории тарифного плана, связанного с подпиской

integer

plan_category.id = 123

plan_category.key

Ключ категории тарифного плана, связанного с подпиской

string

plan_category.key = "plan_category_key"

product_category.id

ID категории продукта, связанной с подпиской

integer

product_category.id = 123

product_category.key

Ключ категории продукта, связанной с подпиской

string

product_category.key = "product_category_key"

subscription.payment_model

Модель оплаты подписки. Возможные значения: prepay (Предоплата) или postpay (Постоплата)

string

subscription.payment_model = "postpay"

Отчет о потреблении по pay-as-you-go подпискам готов (The report with daily consumptions of pay-as-you-go subscriptions is ready)

consumption_report.status

Статус отчета:

• failed — ошибка генерации отчета.

• completed — отчет готов.

string

consumption_report.status = "completed"

consumption_report.scheduled

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

boolean

consumption_report.scheduled = true

Отсутствует PEC по подписке AzurePlan (No PEC for AzurePlan subscription)

pec_status

Статус PEC для подписки Microsoft Azure Plan — наличие PEC в данных о потреблении за предыдущие сутки. Возможные значения:

• yes

• partially

• no

Подробнее см. в руководстве .

string

pec_status = "yes"

pec_coverage

Покрытие PEC для подписки Microsoft Azure Plan — процентное отношение суммы, в которой есть PEC, к общей сумме потребления за финансовый период. Подробнее см.  в руководстве .

number

pec_coverage = 100