> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yume.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Глоссарий: Уведомления, бонусы и воронка

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

Справочник к странице [«Триггеры и уведомления по аренде»](/ru/logic/rent/triggers).

## Понятия

| Понятие                                       | Значение                                                                                                                         |
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Реферальное вознаграждение по аренде          | Начисление вознаграждения реферальному агенту за конкретную аренду с отслеживанием факта выплаты.                                |
| Задача отправки уведомления по смене статуса  | задача: подбирает триггеры Wazzup для перехода статуса аренды и рассылает сообщения клиенту.                                     |
| Задача уведомления о просрочке аренды         | задача: формирует контекст по просроченной аренде и вызывает отправку уведомления о переходе в статус просрочки.                 |
| Формат реферального вознаграждения            | Валидация и создание вознаграждения; запрещает изменения по завершённой/отменённой аренде без спец-права.                        |
| Формат смены статуса выплаты                  | Отмечает вознаграждение выплаченным: ставит статус «Выплачено», время и автора.                                                  |
| Список и создание реферальных вознаграждений  | API: получение списка вознаграждений по аренде и добавление нового.                                                              |
| Просмотр, изменение и удаление вознаграждения | API: операции над одним реферальным вознаграждением.                                                                             |
| Отметка вознаграждения выплаченным            | API: перевод реферального вознаграждения в статус «Выплачено».                                                                   |
| Списание бонусов на аренду                    | API: применяет бонусы клиента к аренде, создавая приветственный бонус при первой аренде и списывая максимально допустимую сумму. |
| Отмена списания бонусов                       | API: удаляет бонусные списания по аренде и пересчитывает суммы.                                                                  |
| Статус реферальной выплаты                    | Состояние выплаты реферального вознаграждения агенту.                                                                            |

## Модели и поля

### Реферальное вознаграждение по аренде

*Начисление вознаграждения реферальному агенту за конкретную аренду с отслеживанием факта выплаты. Модель с привязкой к компании; связь с агентом опциональна.*

**Связи**

| Поле              | Тип   | Описание                                             |
| ----------------- | ----- | ---------------------------------------------------- |
| Аренда            | связь | Аренда, за которую начисляется вознаграждение        |
| Реферальный агент | связь | Агент-получатель вознаграждения; может отсутствовать |

**Деньги**

| Поле                 | Тип             | Описание                                |
| -------------------- | --------------- | --------------------------------------- |
| Сумма вознаграждения | число (2 знака) | Размер выплаты агенту, не отрицательный |

**Статус**

| Поле               | Тип          | Описание                                          |
| ------------------ | ------------ | ------------------------------------------------- |
| Статус выплаты     | перечисление | Выплачено или ожидает выплаты                     |
| Дата смены статуса | дата/время   | Момент, когда вознаграждение отметили выплаченным |
| Кто сменил статус  | связь        | Пользователь, отметивший выплату                  |

**Служебные**

| Поле            | Тип        | Описание         |
| --------------- | ---------- | ---------------- |
| Дата создания   | дата/время | Из AbstractModel |
| Дата обновления | дата/время | Из AbstractModel |

### Задача отправки уведомления по смене статуса

*задача: подбирает триггеры Wazzup для перехода статуса аренды и рассылает сообщения клиенту. Проверяет активность интеграции Wazzup; без указанного триггера берёт только мгновенные триггеры (таймаут не более 1 минуты); пропускает несуществующую компанию.*

| Поле             | Тип     | Описание                                                         |
| ---------------- | ------- | ---------------------------------------------------------------- |
| Телефон клиента  | текст   | Номер получателя уведомления                                     |
| Новый статус     | текст   | Статус аренды, в который перешли                                 |
| Прежний статус   | текст   | Статус аренды до перехода                                        |
| ID триггера      | число   | Конкретный триггер сообщения; если не задан — берутся мгновенные |
| Контекст шаблона | словарь | Подстановки для текста и ключей шаблона сообщения                |

### Задача уведомления о просрочке аренды

*задача: формирует контекст по просроченной аренде и вызывает отправку уведомления о переходе в статус просрочки. Статус-переход всегда в просрочку; собирает список групп инвентаря без обмена; менеджер берётся из создателя или последнего действия.*

| Поле        | Тип   | Описание                                          |
| ----------- | ----- | ------------------------------------------------- |
| ID аренды   | число | Аренда, по которой шлётся уведомление о просрочке |
| ID триггера | число | Триггер сообщения для перехода в просрочку        |

### Формат реферального вознаграждения

*Валидация и создание вознаграждения; запрещает изменения по завершённой/отменённой аренде без спец-права. Статус аренды — вычисляемое поле только для чтения; создание привязывает вознаграждение к аренде из URL.*

| Поле          | Тип   | Описание                                           |
| ------------- | ----- | -------------------------------------------------- |
| Статус аренды | число | Текущий статус связанной аренды, только для чтения |

### Формат смены статуса выплаты

*Отмечает вознаграждение выплаченным: ставит статус «Выплачено», время и автора.*

### Список и создание реферальных вознаграждений

*API: получение списка вознаграждений по аренде и добавление нового. Фильтр по аренде; скрывает удалённые аренды.*

### Просмотр, изменение и удаление вознаграждения

*API: операции над одним реферальным вознаграждением. Поиск по идентификатору; скрывает удалённые аренды.*

### Отметка вознаграждения выплаченным

*API: перевод реферального вознаграждения в статус «Выплачено».*

### Списание бонусов на аренду

*API: применяет бонусы клиента к аренде, создавая приветственный бонус при первой аренде и списывая максимально допустимую сумму. Лимит списания равен наименьшему из остатка к оплате, процента от суммы и баланса бонусов; после списания пересчитывает дочерние суммы.*

| Поле      | Тип   | Описание                             |
| --------- | ----- | ------------------------------------ |
| ID аренды | число | Аренда, к которой применяются бонусы |

### Отмена списания бонусов

*API: удаляет бонусные списания по аренде и пересчитывает суммы. Удаляет транзакции с отрицательной суммой (списания), затем пересчитывает дочерние суммы.*

| Поле      | Тип   | Описание                             |
| --------- | ----- | ------------------------------------ |
| ID аренды | число | Аренда, по которой отменяются бонусы |

## Статусы и справочники

### Статус реферальной выплаты

* Выплачено
* Ожидает выплаты