Плейсхолдеры для описания правила обработки события
В таблице ниже приведен список событий и соответствующих им плейсхолдеров, которые могут быть использованы для описания правила обработки (см. Создание события уведомлений).
При описании правила обработки события возможны следующие операции с плейсхолдерами:
>
<
>=
<=
=
!=
include? (например,
order.type = "SalesOrder" and (order.plans_ids include? 2000030)) — обработчик события сработает, если в заказ на покупку включен тарифный план с id =2000030)- exclude? (исключить определенные сущности (по id, ключу, имени) из выбранного массива сущностей, например, чтобы исключить отправку уведомления о создании заказа на подписку по тарифному плану с id = 2000, используйте следующее правило:
order.plans_ids exclude? 2000) and (например, чтобы исключить несколько сущностей из массива, используйте
(product_ids exclude? 34650) and (product_ids exclude? 34702))- or. Для нескольких
orпослеandиспользуйте дополнительные скобки:order.type = "RenewalOrder" and order.renewal_is_positive = true and subscription.payment_model = "prepay" and ((order.plans_ids include? 293827) or (order.plans_ids include? 293824) or (order.plans_ids include? 294340)) - % (например, 30% от порога срабатывания финансовой блокировки:
account.financial_blocking_threshold % 30)
| Событие | Плейсхолдер | Описание | Тип | Пример |
|---|---|---|---|---|
Общее для всех событий | 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 | Плейсхолдер используется для задания условий отправки уведомлений о низком балансе.
| 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" | |
Закрытие Акта (Invoice closed)
Счет был подтвержден (The Invoice was approved) | invoice.status | Cтатус акта | string | invoice.status = "open" |
| invoice.has_attached | Указывает, был ли прикреплен к платежу файл счета на оплату, сформированный сторонней ERP-системой, при подтверждении акта по модели Постоплата с внешним управлением (см. Управление актами по модели Постоплата сторонней 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 | Тип ручной операции (см. Просмотр списка ручных операций). Например, для ручной операции при остановке подписки:
| 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 |
Запрос сброса пароля менеджера Manager password reset request | manager.id | ID менеджера | integer | manager.id = 1 |
До окончания периода подписки После окончания периода подписки Подписка переведена из пробного статуса в платный Подписка изменена (Subscription changed)
Кредитный лимит для постоплатной подписки изменен (Credit limit for postpaid subscription was changed)
| 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 | Является ли период тарифного плана пробным Значения true и false должны быть указаны в кавычках. | 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.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.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 | Установлено ли автоматическое продление подписки до наступления дня ее истечения (см. Просмотр и обновление информации о подписке):
| 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" | |
Повторная отправка заказа (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 | Количество дней, которое осталось до финансового дня, для которого было вызвано событие В финансовый день, для которого было вызвано событие, возвращает количество дней до следующего финансового дня, а не 0. | 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" | |
| Корректировка баланса подтверждена (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 |
| Оплата платежа получена из внешней системы (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)
| 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 | Статус отчета:
| string | consumption_report.status = "completed" |
| consumption_report.scheduled | Признак запланированного ежемесячного отчета | boolean | consumption_report.scheduled = true |