================================================================================
КАК ПОЛЬЗОВАТЬСЯ: СКОПИРУЙТЕ ССЫЛКУ НА ЭТОТ ФАЙЛ ИЗ АДРЕСНОЙ СТРОКИ БРАУЗЕРА
(https://docs.agenum.ru/llms-full.txt), ОТПРАВЬТЕ ЕЁ СВОЕЙ НЕЙРОСЕТИ И ЗАДАЙТЕ ВОПРОС.
НЕЙРОСЕТЬ САМА ОТКРОЕТ ССЫЛКУ И ПРОЧИТАЕТ ВСЁ О ПЛАТФОРМЕ.
================================================================================

# Документация Agenum

> Agenum — партнёрская программа, которая разворачивается для каждого клиента
> отдельным контуром на <контур>.agenum.ru. Ниже — вся документация одним
> файлом, страница за страницей. Опись страниц: https://docs.agenum.ru/llms.txt

Адрес https://ваш-контур.agenum.ru в тексте — заглушка: подставьте адрес своего
контура. Консоль (console.agenum.ru) у всех клиентов одна.

---

# Подойдёт ли вам Agenum

Раздел: О продукте. Адрес: https://docs.agenum.ru/about/is-it-for-you/

> Нужен ли вам сервис, кому он подходит, кому нет и что требуется, чтобы начать.

Короткий ответ: Agenum нужен, если клиентов вам приводят люди — партнёры,
агенты или ваши же сотрудники — и вы хотите видеть, кто сколько привёл, а при
необходимости и считать вознаграждение. Если клиенты приходят только из рекламы
и поиска, считать в нём нечего.

## Кому нужен этот сервис

Продукт рассчитан на компании, у которых уже есть или планируется круг людей,
приводящих клиентов. Обычно это выглядит так:

- **партнёрская или реферальная программа**: агенты, блогеры, мастера, подрядчики
  рекомендуют вас и получают процент или фиксированную сумму;
- **сеть представителей**: несколько десятков человек продвигают ваш продукт в
  своих городах или нишах, и каждому нужно считать вознаграждение отдельно;
- **программа «приведи друга»** для действующих клиентов, если участников больше,
  чем удобно вести в таблице;
- **подписка или повторные покупки**: партнёр получает процент с каждого
  платежа приведённого клиента, а ваша система передаёт платежи
  [через API](https://docs.agenum.ru/api/lead/#как-начислять-процент-с-каждого-платежа-клиента-revshare);
- **несколько направлений сразу**: разные условия для разных продуктов и групп
  партнёров, которые вручную путаются между собой;
- **свои продавцы и маркетологи**: сотрудники приводят клиентов по личным
  ссылкам и промокодам, а вам нужно видеть, чья работа приносит заявки.

Общий признак один: **клиентов приводят конкретные люди, и учёт того, кто
сколько привёл, стало тяжело вести руками.**

Выплаты через сервис при этом не обязательны. Вознаграждение в предложении
задаётся всегда, но если вы рассчитываетесь по-своему или не платите вовсе,
достаточно простого условия — а сервисом пользоваться только ради статистики.

## Кому сервис не нужен

- **Клиенты приходят только из рекламы и поиска.** Считать некого: партнёров нет,
  а рекламные площадки в продукт не интегрируются.
- **Нужна CRM или сквозная аналитика.** Agenum ведёт заявки от партнёров и
  вознаграждение по ним, а не всю воронку продаж.
- **Нужна готовая база партнёров.** Продукт даёт инструмент, но не аудиторию:
  искать и приглашать людей придётся самим.

## Стоит ли подключаться, если партнёров мало

Если партнёров два-три и в ближайшее время больше не станет — таблицы хватит.
Сервис окупается на объёме учёта, а не на самом факте выплат: пока начисления
помещаются в голове, считать их в интерфейсе смысла нет.

Другое дело, если партнёров мало, но вы собираетесь набирать: тогда удобнее
завести правила и статусы заранее, чем переносить накопленную историю из таблицы
потом.

## Чем Agenum отличается от конкурентов

Честного ответа «мы лучше конкурентов» здесь не будет: условия у всех меняются,
и такое сравнение устареет раньше, чем вы его прочитаете. Сравнивать с
конкретными сервисами мы не берёмся, но про сам подход сказать можно:

- продукт разворачивается **отдельным контуром лично для вас**: свой адрес, своя
  база, свои пользователи, чужих партнёров и чужого трафика в нём нет;
- партнёрам вы даёте **свой домен**, а не ссылку на чужую площадку;
- заявки и вознаграждения можно вести как руками в админке, так и
  [через API](https://docs.agenum.ru/api/) из своей системы;
- правила вознаграждения и статусы заявок настраиваете вы, а не выбираете из
  готового набора.

## Как понять, что пора

Несколько признаков, по которым обычно и приходят:

- вы не можете быстро ответить, сколько должны конкретному партнёру за месяц;
- партнёры спорят о том, кто привёл клиента, и доказательств нет;
- сотрудник тратит день в месяц на сведение таблицы с начислениями;
- партнёры пишут в личные сообщения, чтобы узнать статус заявки или выплаты.

## Что нужно, чтобы начать

1. Решить, **за что вы платите**: за заявку, за оплаченный заказ, за что-то ещё.
   От этого зависят [статусы лида](https://docs.agenum.ru/admin/settings/lead-statuses/) и
   [шаблоны вознаграждения](https://docs.agenum.ru/admin/settings/award-templates/).
2. Понять, **как вы узнаёте о результате**. Если заявки ведутся в вашей системе,
   потребуется интеграция через [внешний API](https://docs.agenum.ru/api/); если нет — статусы можно
   двигать руками в админке.
3. [Создать контур](https://docs.agenum.ru/console/create-tenant/) и пройти первичную настройку.
   Первый контур разворачивается с пробным периодом, без оплаты — его срок и
   тарифы на странице [«Реквизиты и тарифы»](https://console.agenum.ru/legal).

Контуры создаются из аккаунта в Консоли, а самостоятельная регистрация там
сейчас закрыта — продукт ещё не запущен публично. Как получить доступ, написано
на странице [«Аккаунт в Консоли»](https://docs.agenum.ru/console/account/).

:::tip
Состав доступных разделов зависит от тарифа. Что входит в ваш — видно в
[Консоли](https://docs.agenum.ru/console/billing/).
:::

## Читать также

- [Какие проблемы решает Agenum](https://docs.agenum.ru/about/what-it-solves/) — что продукт умеет и чего
  не делает.
- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — как развернуть свой экземпляр.
- [Внешний API](https://docs.agenum.ru/api/) — если заявки приходят из вашей системы.

---

# Какие проблемы решает Agenum

Раздел: О продукте. Адрес: https://docs.agenum.ru/about/what-it-solves/

> Зачем нужен сервис, какие проблемы решает, что умеет и чего не делает.

Agenum — сервис для партнёрских программ. Вы описываете, за что готовы платить
вознаграждение, приглашаете людей и компании продвигать ваш продукт, а сервис
считает, кто кого привёл и сколько ему причитается.

Если коротко: сервис нужен, когда клиентов вам приводят люди — партнёры или ваши
же сотрудники, — а считать вручную, кто сколько привёл и сколько ему причитается,
стало тяжело.

## Какие проблемы решает сервис

Партнёрскую программу можно вести и без сервиса: раздать партнёрам промокоды,
собирать заявки в почте, а начисления считать в таблице. Работает это до первого
десятка партнёров, дальше начинается знакомое:

- непонятно, кто именно привёл клиента, когда промокод разошёлся по чатам;
- партнёр не видит, что с его заявкой, и пишет вам напрямую;
- вознаграждение считается вручную, и любая ошибка обнаруживается при выплате;
- на каждый вопрос «сколько я заработал» уходит время сотрудника.

Agenum закрывает именно эту часть: учёт того, кто привёл клиента, и расчёт
вознаграждения по описанным вами правилам.

## Что умеет сервис

| Задача | Где решается |
|---|---|
| Описать, что продвигают партнёры и на каких условиях | [Предложения](https://docs.agenum.ru/admin/offer/) |
| Задать правила вознаграждения | [Шаблоны вознаграждения](https://docs.agenum.ru/admin/settings/award-templates/) |
| Принять партнёров, распределить по группам, при необходимости заблокировать | [Партнёры](https://docs.agenum.ru/admin/partner/) |
| Выдать партнёрам персональные ссылки и промокоды | [Ссылки и промокоды](https://docs.agenum.ru/admin/offer/links-and-promocodes/) |
| Собирать заявки, которые приводят партнёры, и вести их по статусам | [Лиды](https://docs.agenum.ru/admin/lead/) |
| Платить процент с каждого платежа клиента — подписки, повторных заказов (RevShare) | [Сделки по лиду](https://docs.agenum.ru/api/lead/#как-начислять-процент-с-каждого-платежа-клиента-revshare) |
| Подтверждать и выплачивать вознаграждение | [Выплаты](https://docs.agenum.ru/admin/payout/) |
| Передавать заявки из своей системы и забирать данные обратно | [Внешний API](https://docs.agenum.ru/api/) |

У партнёра при этом есть собственный кабинет: он сам берёт предложения в работу,
получает ссылки, видит [баланс](https://docs.agenum.ru/partner/balance/) и запрашивает
[выплату](https://docs.agenum.ru/partner/payout/) — без переписки с вашими сотрудниками.

## Как сервис защищает от накрутки и фиктивных заявок

Главная защита — в самой модели: **платите вы только за результат, который
подтвердили сами.** Начисление появляется, когда лид переходит в статус, за
который настроено вознаграждение, или по нему добавляется сделка. Это делает
ваш сотрудник в админке или ваша система через API — партнёр сам статус не
двигает. Клики и переходы не оплачиваются вовсе: накрученные, они испортят
только статистику переходов, но не выплаты.

Поверх этого:

- **уникальные переходы** по ссылке считаются отдельно от кликов: повторные
  клики одного посетителя за день засчитываются одним переходом — подробнее
  на странице [ссылок и промокодов](https://docs.agenum.ru/admin/offer/links-and-promocodes/#что-видно-на-вкладке-ссылки);
- **дубли заявок отклоняются**: повторная заявка с теми же данными по тому же
  промокоду в течение дня не создаётся, а при передаче из вашей системы дубли
  отсекает [идентификатор заявки](https://docs.agenum.ru/api/lead/#как-не-создать-дубль-лида-при-повторном-запросе);
- **период удержания** даёт время на проверку: начисленное партнёр выведет
  только через заданное число дней, а до этого его можно
  [отменить](https://docs.agenum.ru/api/lead/#как-отменить-начисление-по-лиду) — например, если
  клиент вернул товар;
- **недобросовестного партнёра** можно [заблокировать](https://docs.agenum.ru/admin/partner/#как-заблокировать-партнёра).

Чего нет: поведенческого анализа, выявления ботов и чёрных списков IP-адресов.
Если ваш процесс подтверждения заявок доверяет всему, что пришло, проверку
придётся строить на своей стороне — до того, как лид переведён в оплачиваемый
статус.

## Чего сервис не делает

Это не менее важно, чем список возможностей:

- **не приводит партнёров** — искать и приглашать их вы будете сами;
- **не рекламная сеть и не биржа**: продукт разворачивается лично для вас, чужих
  партнёров и чужого трафика в нём нет;
- **не CRM**: сделки и клиентскую базу ведёт ваша система, сюда попадают заявки
  от партнёров;
- **не считает продажи сам** — о том, что заявка стала оплаченной, сервису
  сообщаете вы: вручную статусом лида или через [API](https://docs.agenum.ru/api/lead/);
- **не платит деньги за вас**: выплату делает ваша бухгалтерия, сервис ведёт
  учёт начисленного и заявок на вывод.

## Из чего состоит сервис

Agenum разворачивается отдельным экземпляром — [контуром](https://docs.agenum.ru/console/#что-такое-контур)
— по адресу вида `ваш-контур.agenum.ru`. Внутри него два рабочих места:

- [админка](https://docs.agenum.ru/admin/) для ваших сотрудников: предложения, партнёры, лиды, выплаты;
- [личный кабинет партнёра](https://docs.agenum.ru/partner/) для тех, кто вас продвигает.

Сам контур, тариф и оплата живут в [Консоли](https://docs.agenum.ru/console/) — общем для всех клиентов
кабинете на [console.agenum.ru](https://console.agenum.ru). Регистрация в
Консоли пока закрыта: продукт не запущен публично, доступ выдаётся по
обращению — подробности на странице [«Аккаунт в Консоли»](https://docs.agenum.ru/console/account/).

## Читать также

- [Подойдёт ли вам Agenum](https://docs.agenum.ru/about/is-it-for-you/) — на каких условиях продукт
  окупается, а когда лучше обойтись без него.
- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — что нужно, чтобы развернуть свой
  экземпляр.
- [С чего начать в админке](https://docs.agenum.ru/admin/#с-чего-начать) — порядок первичной настройки.

---

# Консоль

Раздел: Консоль. Адрес: https://docs.agenum.ru/console/

> Личный кабинет клиента Agenum — контуры, тариф, оплата и данные аккаунта.

Консоль — ваш кабинет как клиента Agenum. Отсюда вы создаёте контуры, следите
за тарифом и оплатой и управляете своим аккаунтом.

Консоль живёт на одном адресе для всех клиентов — [console.agenum.ru](https://console.agenum.ru).
Не путайте её с кабинетом, который вы получаете внутри своего контура: там своя
учётная запись и свой адрес.

## Что такое контур

Контур — отдельный экземпляр продукта, развёрнутый лично для вас. У него свой
адрес вида `ваш-контур.agenum.ru`, своя база и свои пользователи. Данные одного
контура не пересекаются с данными других клиентов.

В контуре два кабинета: **личный кабинет партнёра** для ваших партнёров и
**админка** для ваших сотрудников.

## С чего начать

1. [Создайте контур](https://docs.agenum.ru/console/create-tenant/) и дождитесь, пока он будет готов.
2. Зайдите в админку контура и заведите там первого администратора.
3. Пригласите партнёров.

Всё это делается из аккаунта в Консоли, а самостоятельная регистрация сейчас
закрыта: продукт ещё не запущен публично. Как получить доступ — на странице
[«Аккаунт в Консоли»](https://docs.agenum.ru/console/account/).

## Что ещё есть в Консоли

- [Аккаунт в Консоли](https://docs.agenum.ru/console/account/) — регистрация, вход и правовые
  документы Agenum.
- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — как выбрать адрес и тариф и
  развернуть контур.
- [Управление контуром](https://docs.agenum.ru/console/tenant/) — статусы контура, запуск после
  остановки и вход в админку.
- [Тариф и оплата](https://docs.agenum.ru/console/billing/) — что входит в тариф, смена тарифа,
  оплата и продление.

## Читать также

- [ЛК администратора](https://docs.agenum.ru/admin/) — кабинет ваших сотрудников внутри контура
- [ЛК партнёра](https://docs.agenum.ru/partner/) — кабинет ваших партнёров
- [Внешний API](https://docs.agenum.ru/api/) — если планируете интеграцию со своей системой

---

# Аккаунт в Консоли

Раздел: Консоль. Адрес: https://docs.agenum.ru/console/account/

> Регистрация и вход в Консоль, подтверждение email, данные аккаунта и правовые документы Agenum.

Аккаунт в Консоли — ваша учётная запись как клиента Agenum. Она отдельная от
учётных записей внутри контуров: под этим email и паролем вы входите только на
[console.agenum.ru](https://console.agenum.ru).

## Как зарегистрироваться

**Регистрация в Консоли временно закрыта** — продукт ещё не запущен публично.
Ссылки **Зарегистрироваться** на странице входа нет, а прямой адрес страницы
регистрации возвращает на форму входа. Если вам нужен доступ, напишите по
контактам со страницы [«Реквизиты и тарифы»](https://console.agenum.ru/legal).

Когда регистрацию откроют, порядок будет такой:

1. На [console.agenum.ru](https://console.agenum.ru) откройте **Зарегистрироваться**.
2. Введите **Email** и **Пароль** — не короче 8 символов.
3. Отметьте чекбокс о принятии Пользовательского соглашения, Поручения на
   обработку персональных данных и Политики обработки персональных данных.
   Названия документов — ссылки, ведущие на PDF.
4. Нажмите **Зарегистрироваться**.

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

:::tip
Момент принятия условий и их редакция фиксируются на сервере в момент
регистрации — не переносите их с других страниц.
:::

## Как подтвердить email

Шаг относится к регистрации, а она сейчас закрыта — подтверждение email
понадобится, когда её откроют.

После регистрации на почту приходит письмо с шестизначным кодом.

1. Введите код в поле на экране подтверждения.
2. Нажмите **Подтвердить**.

Код действует ограниченное время. Если не пришёл или истёк — нажмите
**Отправить код повторно**; запросить новый код можно не чаще раза в минуту.
После нескольких неверных попыток ввода система попросит запросить код заново.

## Как войти

1. На [console.agenum.ru](https://console.agenum.ru) введите **Email** и
   **Пароль**.
2. Нажмите **Войти**.

Кроме формы входа на странице сейчас только ссылка
[«Реквизиты и тарифы»](https://console.agenum.ru/legal): ссылка на регистрацию
с неё убрана, пока регистрация закрыта.

Если email ещё не подтверждён, вход откажет — вернитесь к письму с кодом.
Сообщение «Неверный email или пароль» одинаково и для несуществующего
аккаунта, и для неверного пароля — так система не подсказывает, зарегистрирован
ли адрес.

## Что делать, если забыли пароль

Самостоятельного восстановления пароля в Консоли пока нет. Если доступ к
аккаунту потерян, напишите в поддержку — реквизиты для связи указаны на
странице [«Реквизиты и тарифы»](https://console.agenum.ru/legal).

## Что видно в аккаунте

В шапке Консоли справа виден email, под которым вы вошли, и кнопка **Выйти**.
Отдельной страницы профиля с личными данными в Консоли нет: она хранит только
email и пароль для входа.

## Как удалить аккаунт

Самостоятельной кнопки удаления в Консоли нет намеренно — удаление аккаунта
уничтожает и все ваши контуры, поэтому запрос сверяется с личностью заявителя.
Чтобы удалить аккаунт, напишите обращение в поддержку с адреса, на который он
зарегистрирован.

## Правовые документы Agenum

Оферта (Пользовательское соглашение), Политика обработки персональных данных и
Поручение на обработку персональных данных доступны в двух местах:

- на экране регистрации — ссылками рядом с чекбоксом;
- на странице [«Реквизиты и тарифы»](https://console.agenum.ru/legal) —
  вместе с реквизитами продавца и действующими тарифами. Эта страница
  открывается без входа в аккаунт.

Рядом с каждым документом указана редакция — дата последнего изменения. Именно
эта редакция и записывается за вами в момент, когда вы отмечаете чекбокс при
регистрации.

## Читать также

- [Консоль](https://docs.agenum.ru/console/) — что ещё можно делать в кабинете клиента
- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — первый шаг после регистрации
- [Тариф и оплата](https://docs.agenum.ru/console/billing/) — тарифы и правила оплаты, которые
  описывает та же страница «Реквизиты и тарифы»

---

# Тариф и оплата

Раздел: Консоль. Адрес: https://docs.agenum.ru/console/billing/

> Что входит в тариф контура, как его сменить, как оплатить и продлить и что будет, если не оплатить вовремя.

Контур работает по тарифу: тариф задаёт цену и ограничения, а блок **Оплата**
на странице контура — то, чем этот тариф оплачивается и продлевается.

## Что входит в тариф

На карточке тарифа — на странице контура при смене тарифа и на публичной
странице [«Реквизиты и тарифы»](https://console.agenum.ru/legal) — указаны
название, цена в месяц и список ограничений. Цена везде указана в рублях и
копейках — `4 900,00 ₽ / мес`. Если под списком написано **Без ограничений**,
значит на этом тарифе их нет.

## Как сменить тариф

1. На странице контура нажмите **Сменить тариф**.
2. Выберите тариф в списке — текущий отмечен как **Текущий** и недоступен для
   повторного выбора.
3. Проверьте, как изменится дата, до которой оплачен контур: при переходе на
   более дешёвый тариф оплаченное время растянется на больший срок, при
   переходе на более дорогой — сократится.
4. Нажмите **Сменить тариф**.

Новые ограничения применяются в течение нескольких минут — контуру нужно
перезапустить свой бэкенд. Если новый тариф ограничивает то, чего уже создано
больше лимита, существующие записи остаются, но добавить новые сверх лимита не
получится.

:::tip
Пока контур ещё разворачивается впервые, смена тарифа недоступна.
:::

## Как оплатить контур

В блоке **Оплата** на странице контура:

1. Выберите период — 1, 6 или 12 месяцев. У полугода и года рядом с ценой
   показана скидка.
2. Нажмите **Оплатить**.
3. Введите данные банковской карты на странице ЮKassa и подтвердите платёж.

После оплаты вы вернётесь на страницу контура — она сама дождётся
подтверждения от банка и обновит статус. Автосписаний нет: каждый следующий
период оплачивается отдельным платежом.

Если период недоступен для выбора, рядом с ним написана причина — например,
что вперёд можно оплатить не больше определённого числа месяцев.

## Что происходит после оплаты

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

Дата, до которой контур оплачен, всегда видна на странице контура. Если контур
работает дольше, чем оплачено — например, за счёт остатка пробного периода —
страница покажет обе даты: до какой оплачено и до какой контур ещё работает.

## Можно ли попробовать Agenum бесплатно

Да: первый контур на аккаунте разворачивается с пробным периодом, без оплаты.
Пробный период даётся один раз на аккаунт и действует на любом тарифе — как
это выглядит при создании контура, описано на странице
[«Создание контура»](https://docs.agenum.ru/console/create-tenant/).

Длительность пробного периода и актуальные тарифы — на странице
[«Реквизиты и тарифы»](https://console.agenum.ru/legal), над карточками
тарифов.

## Что будет, если не оплатить вовремя

Когда оплаченный или пробный период заканчивается, контур останавливается —
данные при этом никуда не пропадают. Оплатите его в любой момент, и он снова
заработает. Что происходит с контуром, если он остаётся неоплаченным надолго,
описано на странице [«Управление контуром»](https://docs.agenum.ru/console/tenant/).

## Куда обратиться по вопросам оплаты

Реквизиты продавца и контакты для вопросов об оплате и возврате — на странице
[«Реквизиты и тарифы»](https://console.agenum.ru/legal).

## Читать также

- [Управление контуром](https://docs.agenum.ru/console/tenant/) — статусы контура и что с ним
  происходит без оплаты
- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — выбор тарифа при создании и
  правила пробного периода
- [Аккаунт в Консоли](https://docs.agenum.ru/console/account/) — правовые документы и данные
  аккаунта

---

# Создание контура

Раздел: Консоль. Адрес: https://docs.agenum.ru/console/create-tenant/

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

Контур — ваша собственная копия Agenum на отдельном поддомене. Пока контура нет,
в консоли нечего настраивать: с его создания начинается вся работа.

## Как создать контур

1. Откройте [console.agenum.ru](https://console.agenum.ru) и нажмите
   **Создать контур** на странице «Мои контуры».
2. Введите адрес — то, что будет стоять перед `.agenum.ru`.
3. Выберите тариф в блоке **Тариф**.
4. Нажмите **Развернуть контур**.

Кнопка неактивна, пока не заполнен адрес и не выбран тариф. После нажатия
консоль откроет страницу контура — дальше всё происходит на ней.

Первый контур на аккаунте разворачивается бесплатно, по пробному периоду. Его
длительность и тарифы — на странице
[«Реквизиты и тарифы»](https://console.agenum.ru/legal).

:::tip
Если пробный период на аккаунте уже был использован, кнопка называется
**Создать и перейти к оплате**: поддомен и тариф закрепятся за вами, а
разворачиваться контур начнёт после оплаты.
:::

## Какой адрес выбрать

Адрес состоит из 3–30 символов: латиница, цифры и дефис, причём дефис не может
стоять по краям. Заглавные буквы и пробелы не принимаются.

Адрес виден всем, кто пользуется контуром: по нему заходят и ваши сотрудники, и
ваши партнёры. Сменить его после создания нельзя — можно только создать другой
контур.

| Сообщение при создании | Что оно означает |
|---|---|
| Поддомен уже занят | адрес занят другим контуром, выберите другой |
| Этот поддомен зарезервирован | служебное имя вроде `www`, `api` или `admin` |
| Достигнут лимит бесплатных контуров на аккаунт | на аккаунте уже есть контур, созданный по пробному периоду |
| Уже есть неоплаченный контур | оплатите его или дождитесь, пока освободится резерв |
| Свободные мощности закончились | попробуйте позже: мест под новые контуры сейчас нет |

## Как выбрать тариф при создании

Тарифы показаны карточками: название, цена в месяц (в рублях и копейках,
например `4 900,00 ₽ / мес`) и список того, что в тариф входит. Карточка без
списка означает, что ограничений у тарифа нет.

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

Пробный период даётся **один раз на аккаунт** и действует на любом тарифе — его
длительность написана прямо над карточками. Второй контур на том же аккаунте
уже разворачивается после оплаты.

## Что происходит после создания

Контур разворачивается несколько минут. На его странице видно, какой шаг идёт
сейчас:

| Шаг | Что происходит |
|---|---|
| В очереди на развертывание | контур ждёт своей очереди |
| Подготовка конфигурации | собираются настройки контура |
| Запуск сервисов | поднимаются приложения контура |
| Ожидание готовности сервисов | проверяется, что всё запустилось |
| Настройка домена и SSL | адрес начинает открываться по HTTPS |

Страницу можно закрыть и вернуться позже: развёртывание не прервётся.

Когда всё готово, статус меняется на «Работает», а на странице появляются две
ссылки — на **ЛК партнёра** и на **Админку**. Там же указано, до какой даты
контур оплачен.

## Где взять данные для входа в админку

На готовом контуре нажмите **Показать данные для входа в админку** — консоль
покажет почту и пароль первого администратора.

:::tip
Данные показываются **один раз**. Сохраните их сразу: повторно посмотреть пароль
нельзя, и если он потерян, восстановить доступ поможет только поддержка.
:::

С этими данными зайдите в [админку контура](https://ваш-контур.agenum.ru/admin) и
начинайте настройку: предложения, поля лида, партнёры.

## Что делать, если контур не развернулся

Статус «Ошибка» означает, что развернуть контур не удалось.

- **Контур оплачен.** Его данные сохранены, на странице есть кнопка
  **Повторить развертывание** — она доводит контур до рабочего состояния.
- **Контур не оплачен.** Попробуйте создать контур ещё раз или напишите в
  поддержку. Адрес освободится и его можно будет занять снова.

Технические подробности ошибки показаны тут же, под сообщением — их стоит
приложить к обращению в поддержку.

## Читать также

- [Консоль](https://docs.agenum.ru/console/) — что ещё можно делать в кабинете клиента
- [ЛК администратора](https://docs.agenum.ru/admin/) — первые шаги в админке нового контура
- [Поля лида](https://docs.agenum.ru/admin/settings/lead-field-types/) — с чего начинается настройка приёма заявок

---

# Управление контуром

Раздел: Консоль. Адрес: https://docs.agenum.ru/console/tenant/

> Карточка контура, статусы, запуск после остановки, вход в админку и что происходит с данными.

Страница контура — место, где видно его текущее состояние и откуда им
управляют. Открывается кликом по карточке контура на странице **Мои контуры**
в [Консоли](https://console.agenum.ru).

## Что видно на карточке контура

Список **Мои контуры** показывает по каждому контуру адрес, статус и — если
контур работает — тариф с его ценой в месяц (`4 900,00 ₽/мес`) и дату, до
которой контур оплачен. Клик по карточке
открывает страницу контура целиком.

## Что означают статусы контура

| Статус | Что значит |
|---|---|
| Ждёт оплаты | адрес и тариф закреплены за вами, но контейнеры ещё не подняты — они появятся после оплаты |
| Разворачивается | контур поднимается, обычно несколько минут; шаги перечислены на странице [«Создание контура»](https://docs.agenum.ru/console/create-tenant/) |
| Работает | контур доступен по своему адресу |
| Остановлен | контур выключен, но данные сохранены |
| Ошибка | развернуть или поднять контур не удалось |
| Удалён | контур и его данные уничтожены безвозвратно |

## Где взять адрес админки и как туда попасть

На странице работающего контура показаны две ссылки: на **ЛК партнёра** и на
**Админку**. Админка открывается по адресу вида
`https://ваш-контур.agenum.ru/admin/`.

Данные для входа первого администратора выдаются один раз, сразу после того
как контур становится готов — подробно об этом на странице
[«Создание контура»](https://docs.agenum.ru/console/create-tenant/). Если пароль потерян, попросите
нового администратора завести вас через
[ЛК администратора](https://docs.agenum.ru/admin/) — либо, если администраторов не осталось,
обратитесь в поддержку.

## Как запустить остановленный контур

Контур останавливается сам — из-за окончания пробного периода или неоплаты, а
не по вашей команде. Подробнее о деньгах и продлении — на странице
[«Тариф и оплата»](https://docs.agenum.ru/console/billing/).

Пока данные контура ещё не удалены, его можно вернуть к работе:

- Если срок ещё не истёк — на странице контура нажмите **Возобновить**: контур
  снова начнёт разворачиваться.
- Если срок истёк — сначала оплатите контур в блоке **Оплата** на той же
  странице. После подтверждения оплаты контур поднимется автоматически.

## Что происходит при удалении контура

Отдельной кнопки «Удалить контур» у владельца нет. Контур, который остаётся
остановленным достаточно долго, система удаляет автоматически вместе со всеми
его данными — но не раньше, чем на почту, привязанную к аккаунту, придёт
письмо с датой, после которой это произойдёт. Оплатите или возобновите контур
до этой даты, чтобы сохранить данные.

Само удаление необратимо: контейнеры, база и файлы контура уничтожаются
безвозвратно, а статус меняется на «Удалён».

## Что делать, если контур в статусе «Ошибка»

- **Контур оплачен.** На странице контура есть кнопка **Повторить
  развертывание** — она доводит контур до рабочего состояния, данные при этом
  сохранены.
- **Контур не оплачен.** Создайте контур ещё раз или напишите в поддержку.

Текст технической ошибки показан прямо на странице контура — приложите его к
обращению в поддержку.

## Читать также

- [Создание контура](https://docs.agenum.ru/console/create-tenant/) — как контур появляется впервые
- [Тариф и оплата](https://docs.agenum.ru/console/billing/) — смена тарифа, оплата и продление
- [ЛК администратора](https://docs.agenum.ru/admin/) — что делать в контуре после входа в админку

---

# ЛК партнёра

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/

> Личный кабинет партнёра — предложения, ссылки, промокоды, баланс и выплаты.

Личный кабинет партнёра — место, где вы берёте предложения в работу, получаете
ссылки и промокоды и следите за вознаграждением.

Кабинет живёт на адресе вашего контура — том самом, по которому вас пригласили.

## Что здесь можно делать

| Раздел | Зачем |
|---|---|
| [Регистрация и вход](https://docs.agenum.ru/partner/registration/) | завести аккаунт, войти, задать пароль по ссылке из письма компании, восстановить пароль |
| Предложения | взять предложение в работу, получить ссылку или промокод, увидеть свои заявки по статусам — см. [страницу предложения](https://docs.agenum.ru/partner/offer/) |
| [Баланс](https://docs.agenum.ru/partner/balance/) | посмотреть начисленное вознаграждение, что из него доступно к выводу и выписку движений по балансу |
| [Выплаты](https://docs.agenum.ru/partner/payout/) | запросить вывод, следить за статусом заявки и выгрузить её состав |
| [Мои акты](https://docs.agenum.ru/partner/acts/) | скачать и подписать акты по выплатам, если компания их выпускает |
| [Оферта](https://docs.agenum.ru/partner/program-offer/) | прочитать и принять договор с компанией, если она его выложила |
| [Профиль](https://docs.agenum.ru/partner/profile/) | личные данные, пароль, подтверждение email, юридический статус и реквизиты |
| [Уведомления](https://docs.agenum.ru/partner/notifications/) | что кабинет сообщает о ваших заявках на выплату |

Главная страница кабинета (**Главная** в боковом меню) на сегодня не показывает
собственной сводки — с неё удобно перейти в остальные разделы через меню.

:::tip
Часть разделов может быть скрыта — набор возможностей зависит от настроек
вашего контура.
:::

## С чего начать

1. Откройте [список предложений](https://ваш-контур.agenum.ru/offer) и выберите
   подходящее.
2. Откройте [страницу предложения](https://docs.agenum.ru/partner/offer/) и получите ссылку или промокод.
3. Приводите клиентов и следите за начислениями в разделе [«Баланс»](https://docs.agenum.ru/partner/balance/).

## Читать также

- [ЛК администратора](https://docs.agenum.ru/admin/) — кабинет сотрудников вашей компании-партнёра
- [Консоль](https://docs.agenum.ru/console/) — кабинет клиента Agenum

---

# Мои акты

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/acts/

> Где найти акты по выплатам вознаграждения, как их скачать и подписать электронной подписью кодом из письма.

Раздел [Мои акты](https://ваш-контур.agenum.ru/acts) — акты по выплатам, которые
компания перечислила вам. Акт подтверждает, что вы оказали услугу, а компания
её приняла и оплатила.

:::tip
Раздел есть не у всех: он появляется в меню, только если компания выпускает
акты по выплатам.
:::

## Когда появляется акт

Акт выпускается автоматически, когда компания отмечает заявку на выплату как
выплаченную. Отдельно запрашивать его не нужно. Номер акта выглядит как
`2026-17`: год и порядковый номер в этом году.

Акт выпускается, если в профиле у вас указан статус самозанятого, ИП или
юридического лица. Физическому лицу без статуса акт не выпускается — выплата
при этом приходит как обычно.

В акте — реквизиты компании и ваши, строки по предложениям с числом лидов и
суммой, итог прописью. В приложении к акту — каждый лид, за который начислено
вознаграждение, с датой и суммой.

:::tip
Самозанятому акт не заменяет чек: чек в «Мой налог» на полученную выплату
по-прежнему формируете вы сами.
:::

## Что видно в списке актов

Каждый акт — карточка **Акт № …: сумма**:

| Поле | Что означает |
|---|---|
| Дата акта | когда акт выпущен |
| Заявка | номер заявки на выплату, по которой выпущен акт, — ссылка ведёт на неё |
| Подписан электронной подписью | когда и кем вы подписали акт в кабинете |
| Подписан | когда компания отметила, что акт подписан вне кабинета |

Пока акт не подписан, под карточкой может стоять подсказка, почему подписать
его сейчас нельзя, — см. [что делать, если акт не подписывается](https://docs.agenum.ru/partner/acts/#что-делать-если-акт-не-подписывается-в-кабинете).

Фильтр по году над списком сужает его до одного года — **Все годы** показывает
всё. Пока выплат с актами не было, в разделе написано «Актов пока нет».

## Как скачать акт

Нажмите **Скачать PDF** на карточке акта. Тот же акт можно скачать со
[страницы заявки](https://docs.agenum.ru/partner/payout/) — блок **Акт** появляется у выплаченной
заявки.

## Как подписать акт в кабинете

Акт можно подписать простой электронной подписью — кодом, который приходит на
вашу почту. Такая подпись равнозначна подписи на бумаге, если это записано в
оферте компании. Кнопка **Подписать** появляется на карточке акта, только когда
подписать его можно.

1. Нажмите **Подписать** на карточке акта.
2. Нажмите **Скачать акт** и прочитайте его.
3. Если вы подписываете за организацию, заполните **ФИО подписанта**,
   **Должность** и **Основание полномочий** — например «Устав» или номер и дата
   доверенности.
4. Отметьте **Ознакомился с актом и подписываю его** и нажмите **Получить код**.
5. Введите шестизначный **Код из письма** и нажмите **Подписать**.

В письме с кодом указаны номер и сумма акта — проверьте, что подписываете тот
акт. Если письмо не пришло, через минуту можно нажать **Отправить код
повторно**.

После подписи в карточке появится поле **Подписан электронной подписью** с
датой и именем подписанта, а на почту придёт письмо, что акт подписан. Если
такое письмо пришло, а вы ничего не подписывали, сразу напишите компании.

:::tip
Подписывает акт тот, кто указан в нём исполнителем. Самозанятый и ИП
подписывают сами — поля подписанта для них нет. За организацию подписывает
руководитель или представитель по доверенности, и его данные вы указываете при
подписании.
:::

Подписанный акт не меняется и подпись с него не снимается. PDF остаётся тем же
файлом, что вы скачивали до подписи.

## Как ещё может быть подписан акт

Если компания подписывает акты на бумаге или в системе электронного
документооборота, договаривайтесь с ней. Когда акт подписан так, компания
ставит у себя отметку, и в карточке появляется поле **Подписан** с датой.
Подписать такой акт в кабинете уже нельзя.

## Что делать, если акт не подписывается в кабинете

Под карточкой акта подсказка объясняет, что мешает:

| Подсказка | Что сделать |
|---|---|
| Чтобы подписать акт в кабинете, примите действующую редакцию оферты — в ней есть соглашение об электронной подписи | Откройте раздел [Оферта](https://docs.agenum.ru/partner/program-offer/) и примите действующую редакцию |
| Компания пока не подписывает акты в кабинете — как подписать акт, уточните у неё | В действующей оферте компании нет соглашения об электронной подписи, и с вашей стороны это не исправить. Подписать акт можно так, как договоритесь с компанией: на бумаге или в системе электронного документооборота |
| Подтвердите адрес электронной почты: на него придёт код подписания | Подтвердите почту в [профиле](https://docs.agenum.ru/partner/profile/) |
| Файл акта ещё не готов — обновите страницу позже, чтобы подписать акт | Обновите страницу через несколько минут |
| Акт подписан вне кабинета | Компания уже отметила акт подписанным — подписывать его не нужно |

**«Неверный код».** Проверьте код в последнем письме. Ввести неверный код можно
5 раз за сутки — дальше подписать этот акт получится только на следующий день.

**«Код истёк или не запрашивался».** Код действует ограниченное время. Нажмите
**Отправить код повторно**.

**«Данные для подписи изменились — запросите новый код».** Пока вы вводили код,
изменилось что-то, к чему он привязан: адрес почты, редакция оферты или акт.
Окно закроется, а список актов обновится — запросите код заново.

## Что делать, если акта нет или в нём ошибка

**Выплата пришла, а акта нет.** Проверьте юридический статус в
[профиле](https://docs.agenum.ru/partner/profile/): физическому лицу без статуса акт не выпускается.
Если статус указан верно, напишите компании — акт мог не выпуститься из-за
неполных данных, и компания может выпустить его позже.

**В акте неверные данные.** Выпущенный акт не меняется: он фиксирует ваши
данные и данные компании на момент выпуска. Исправьте данные в профиле — они
попадут в следующие акты, а по текущему обратитесь к компании.

## Читать также

- [Выплаты](https://docs.agenum.ru/partner/payout/) — заявки, по которым выпускаются акты, и выгрузка состава выплаты
- [Оферта](https://docs.agenum.ru/partner/program-offer/) — договор, на который ссылается акт, и соглашение об электронной подписи
- [Профиль](https://docs.agenum.ru/partner/profile/) — юридический статус и ИНН, которые печатаются в акте

---

# Баланс

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/balance/

> Из чего складывается баланс партнёра, что значит удержание и когда деньги становятся доступны для вывода.

Экран **Баланс** показывает, сколько вам начислено за приведённых клиентов и
сколько из этого уже можно вывести. Открывается по ссылке **Баланс** в верхней
части бокового меню — там же виден текущий доступный остаток.

## Из чего складывается баланс

| Строка | Что означает |
|---|---|
| **Доступно для вывода** | сумма, которую можно запросить к выплате прямо сейчас |
| **На удержании** | начислено, но ещё не прошёл срок удержания — вывести пока нельзя |
| **Ожидает выплаты** | уже включено в заявку на выплату, которая в работе |

**Доступно для вывода** учитывает и то, что вы уже запросили: как только заявка
создана, её сумма переходит из «Доступно» в «Ожидает выплаты».

## Как посмотреть, из чего сложился баланс

Ниже трёх сумм на том же экране — раздел **Движения**: список всех операций по
вашему балансу, свежие сверху. Он и отвечает на вопрос «почему у меня именно
столько». Список догружается по мере прокрутки.

В каждой строке — что за операция, на какую сумму и когда. Сумма со знаком:
плюс — вам начислили, минус — списали.

| Операция | Когда появляется |
|---|---|
| **Начисление за лид** | лид дошёл до статуса, за который платят вознаграждение |
| **Отмена начисления** | лид позже перешёл в статус, отменяющий сделку |
| **Резерв под выплату** | вы создали заявку на выплату — сумма отложена под неё |
| **Возврат резерва** | заявку отклонили или вы её отменили, деньги вернулись |

У **Резерва под выплату** и **Возврата
резерва** есть ссылка **Заявка на выплату** — она ведёт на саму заявку.

:::tip
**Резерв под выплату** — не потеря денег, а перекладывание. Ровно на эту сумму
уменьшилось **Доступно для вывода** и увеличилось **Ожидает выплаты**.
:::

### Что значит подпись «в удержании до»

У начисления, срок удержания которого ещё не прошёл, рядом с датой стоит
**в удержании до** и дата. В этот день сумма сама перейдёт в **Доступно для
вывода**.

У отмены начисления такой даты нет — вместо неё написано **отменено начисление
в удержании**. Это значит, что отменили ту сумму, которая ещё лежала на
удержании и до вывода не дошла: **Доступно для вывода** от такой отмены не
уменьшается.

## Когда появляется начисление

Начисление приходит, когда статус лида, приведённого по вашей ссылке или
промокоду, меняется на статус, за который компания платит вознаграждение —
например, «Сделка» или «Оплачено». Правила начисления настраивает компания
для каждого предложения, поэтому суммы и статусы, за которые платят, у разных
предложений и разных компаний свои — их можно посмотреть на
[странице предложения](https://docs.agenum.ru/partner/offer/).

Начисление появляется не в ту же секунду, что и смена статуса, а обычно в
течение минуты: сумму сначала нужно посчитать. Если за это время компания
отменила заявку, начисления не будет вовсе.

## Почему деньги не сразу доступны для вывода

После начисления сумма обычно ещё какое-то время числится **На удержании**:
это время нужно компании, чтобы клиент не передумал и сделка не отменилась.
Пока идёт удержание, начисление уже видно в кабинете, но вывести его нельзя.
Как только срок удержания прошёл, сумма сама переходит в **Доступно для
вывода** — никаких действий от вас не требуется.

## Что делать, если баланс выглядит не так, как ожидалось

Начните с раздела **Движения** на этом же экране: в нём видно каждую операцию с
причиной и датой, и чаще всего ответ находится там.

**Начисления не видно вовсе.** В движениях нет строки **Начисление за лид** —
значит его и не было. Проверьте статус лида на
[странице предложения](https://docs.agenum.ru/partner/offer/): начисление появляется только после
того, как статус сменится на тот, за который положено вознаграждение. Если
статус сменился только что, подождите минуту и обновите страницу.

**Сумма в «Доступно» меньше, чем начислено.** Часть могла уйти в **На
удержании** (ещё не прошёл срок) или в **Ожидает выплаты** (уже в заявке на
вывод) — посмотрите оба этих значения. В движениях этому соответствуют строки с
подписью **в удержании до** и строка **Резерв под выплату**.

**Начисление пропало.** Найдите в движениях строку **Отмена начисления** — она
появляется, когда статус лида изменился на отменяющий сделку.

## Читать также

- [Выплаты](https://docs.agenum.ru/partner/payout/) — как вывести доступную сумму
- [Страница предложения](https://docs.agenum.ru/partner/offer/) — за какие статусы и сколько платит конкретное предложение
- [Профиль](https://docs.agenum.ru/partner/profile/) — реквизиты, на которые приходит выплата

---

# Уведомления

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/notifications/

> Список уведомлений партнёра и настройка, какие из них приходят в кабинет и на почту.

Раздел **Уведомления** открывается по одноимённой ссылке в верхней части
бокового меню. В нём две вкладки: **Список** и **Настройки**.

## Что попадает в список уведомлений

Партнёру приходят уведомления о заявках на выплату: их **одобрении**,
**выполнении** и **отклонении** — с суммой заявки в тексте. Отдельно приходит
уведомление об **изменении реквизитов выплаты**: оно появляется каждый раз,
когда реквизиты меняются или удаляются, — в том числе если это сделала
компания. Если компания отменила вам начисление, придёт уведомление об
**отмене начисления** — с суммой и причиной. Непрочитанные
уведомления выделены и отмечены точкой; клик по уведомлению отмечает его
прочитанным. Кнопка **Прочитать все** отмечает прочитанными сразу все.

Уведомление об **изменении условий вознаграждения** приходит, когда компания
поменяла вознаграждение в предложении, по которому вы работаете, — то есть у вас
есть по нему действующая ссылка или активный промокод. Что именно поменялось, в
тексте не пишется: ссылка **Подробнее** открывает предложение с актуальными
условиями. Если правка вашего вознаграждения не коснулась — например, поменяли
ставку другой группы партнёров, — уведомления не будет.

Новое уведомление также всплывает всплывающим сообщением в кабинете в момент
события — заходить в раздел для этого не обязательно.

## Как настроить, какие уведомления приходят

Вкладка **Настройки** — таблица: строки — типы уведомлений, столбцы — каналы
доставки, **В приложении** и **Email**. Переключатель в ячейке включает или
выключает конкретное сочетание.

По умолчанию все уведомления приходят и в кабинет, и на почту — кроме
**изменения условий вознаграждения**: оно приходит только в кабинет. Если
хотите получать его и письмом, включите для него **Email**.

Два уведомления отключить нельзя — их переключатели всегда включены и
неактивны. **Отклонение выплаты** требует вашего внимания в любом случае, а
**изменение реквизитов выплаты** защищает деньги: если реквизиты поменял не вы,
это первое, о чём нужно узнать. Возможность отключить такое письмо была бы
подарком тому, кто получил доступ к вашему аккаунту.

## Что делать, если уведомления не приходят

**Не приходят на почту.** Проверьте на вкладке **Настройки**, включён ли
канал **Email** для нужного типа, и папку «Спам». Об изменении условий
вознаграждения письмо по умолчанию не приходит — его нужно включить самому.

**Не появляются в кабинете.** Проверьте канал **В приложении** на вкладке
**Настройки** — уведомление могло быть отключено именно для него.

**Пришло письмо об изменении реквизитов, а вы их не меняли.** Реквизиты мог
заполнить администратор компании — это штатная ситуация. Если же вы уверены,
что никто не должен был этого делать, смените пароль в
[профиле](https://docs.agenum.ru/partner/profile/) и проверьте там же, куда сейчас уходят деньги.

## Читать также

- [Выплаты](https://docs.agenum.ru/partner/payout/) — заявки, о которых приходят уведомления
- [Профиль](https://docs.agenum.ru/partner/profile/) — email, на который приходят уведомления
- [Страница предложения](https://docs.agenum.ru/partner/offer/) — где посмотреть условия вознаграждения

---

# Страница предложения

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/offer/

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

Страница предложения — рабочее место партнёра по одному предложению. Здесь
видно условия, отсюда берутся ссылки и промокоды, и здесь же считается
статистика по приведённым клиентам.

Открывается из [списка предложений](https://ваш-контур.agenum.ru/offer) кликом по
названию. Наверху две вкладки: **Данные предложения** и **Статистика**.

Отдельно принимать предложение не нужно: любое предложение из вашего списка
уже рабочее — открывайте его и создавайте ссылки и промокоды.

## Что написано в предложении

| Строка | Что означает |
|---|---|
| **Описание** | условия и пояснения от рекламодателя |
| **Ссылка предложения** | страница, на которую приводятся клиенты |
| **Период действия** | дата окончания или «Бессрочно» |
| **Вознаграждение** | сколько вы получите и за какой статус заявки |

Вознаграждение показывается **ваше**: у разных партнёров по одному и тому же
предложению условия могут отличаться — по уровню, группе или персональной
ставке. Цифра на странице считается так же, как реальное начисление.

Вознаграждение разложено по статусам заявки, по строке на статус: например,
`Сделка: 1 500,00 ₽` или `Сделка: 1 500,00 ₽ + 3%`, если за статус положены
и фиксированная сумма, и процент от суммы сделки. Процент выводится как `3%`,
сумма — в рублях и копейках. В карточке в списке предложений те же строки идут
через точку с запятой. Прочерк означает, что вознаграждение по этому
предложению вам не назначено.

Если компания поменяет ваше вознаграждение по предложению, в котором у вас есть
ссылка или активный промокод, придёт [уведомление](https://docs.agenum.ru/partner/notifications/) со
ссылкой на эту страницу.

Ниже — раздел **Материалы**: баннеры и креативы, которые можно использовать в
рекламе. Клик по картинке открывает её целиком.

## Как получить партнёрскую ссылку

Раздел **Ссылки** есть у тех предложений, где рекламодатель разрешил работать
ссылками.

1. Нажмите **Создать ссылку**.
2. Введите название — оно нужно только вам, чтобы различать площадки.
3. Нажмите **Создать**.

Готовая короткая ссылка появится в списке под названием. Её и нужно размещать:
переход по ней ведёт клиента на страницу предложения, а переход при этом
записывается на вас.

Рядом со ссылкой видно два счётчика: **Клики** — все переходы, **Уникальные** —
переходы разных людей. Повторные заходы одного человека за день считаются одним
уникальным.

Переход — ещё не заявка. Заявка появляется, только когда клиент оставит свои
данные — например, заполнит форму на сайте рекламодателя — и рекламодатель
передаст их в Agenum. Поэтому переходов всегда больше, чем заявок.

Название можно поменять — кликом по нему или кнопкой **Изменить**. Кнопка
**Удалить** скрывает ссылку: она перестаёт работать, но уже приведённые по ней
клиенты и начисления остаются.

Длинный список догружается кнопкой **Загрузить ещё**.

## Как получить промокод

Раздел **Промокоды** есть у тех предложений, где рекламодатель разрешил работать
промокодами.

1. Нажмите **Создать промокод**.
2. Введите сам код — его будут вводить ваши клиенты.
3. Нажмите **Создать**.

Код должен быть уникальным для всего контура: если такой уже занят, появится
сообщение «Такой промокод уже есть» — придумайте другой.

Под кодом показан **Бонус** — что получает клиент, который им воспользуется.
Если у промокода своего бонуса нет, показывается общий бонус предложения.

## Что означают статусы промокода

| Статус | Что значит |
|---|---|
| На проверке | код создан и ждёт решения рекламодателя, клиентам его давать рано |
| Активно | код работает, заявки по нему записываются на вас |
| Неактивно | код отклонён или отключён и больше не работает |

:::tip
Изменение кода возвращает промокод на проверку — даже если он уже был активен.
Поэтому работающий код лучше не переименовывать, а создать рядом новый.
:::

## Сколько заявок по предложению видно в списке предложений

В [списке предложений](https://ваш-контур.agenum.ru/offer) на карточке каждого
предложения есть строка **Лиды** — ваши заявки по нему, разложенные по
статусам. Каждый цветной значок — один статус и число заявок в нём; цвета
статусов задаёт компания. Наведите на значок, чтобы увидеть название статуса и
точное число: большие числа на значке сокращаются, например `1.2K` или `1M`.

Если заявок по предложению у вас ещё нет, на карточке написано **Лидов нет**.

Здесь считаются **все** ваши заявки по предложению: и пришедшие по ссылке или
промокоду, и добавленные компанией вручную, и отменённые. Поэтому число на
карточке может быть больше, чем во вкладке **Статистика** на странице
предложения: там учитываются только заявки по ссылкам и промокодам, без
отменённых.

## Где посмотреть статистику по предложению

Вкладка **Статистика** показывает воронку «Эффективность предложения»:
сколько было переходов и сколько заявок дошло до каждого статуса. Отдельными
вкладками разделены результаты по ссылкам и по промокодам, ниже — тот же
результат по дням.

Отменённые заявки в воронку не попадают.

## Что делать, если что-то не работает на странице предложения

**Нет раздела «Ссылки» или «Промокоды».** Рекламодатель разрешил по этому
предложению только один инструмент из двух.

**Переходы по ссылке есть, а заявок нет.** Заявка появляется не от перехода, а
когда клиент оставит данные и рекламодатель передаст их в Agenum. Если клиенты
только смотрят страницу и уходят, заявок не будет.

**Промокод давно «На проверке».** Решение принимает рекламодатель на своей
стороне; ускорить это из кабинета нельзя.

**Предложение перестало открываться.** Скорее всего, у него закончился период
действия или его закрыли для вашей группы партнёров. Начисления по уже
приведённым клиентам при этом сохраняются.

Если предложение закрыли для вас, ваши ссылки и промокоды по нему перестают
приносить вам заявки. Клиент, перешедший по вашей ссылке, всё так же попадает на
страницу предложения, но переход за вами не записывается, а его заявка приходит
к компании без партнёра. Когда доступ вернут, новые заявки снова будут ваши;
заявки, пришедшие, пока доступа не было, за вами не закрепятся.

## Читать также

- [ЛК партнёра](https://docs.agenum.ru/partner/) — остальные разделы кабинета
- [ЛК администратора](https://docs.agenum.ru/admin/) — как то же предложение выглядит со стороны рекламодателя

---

# Выплаты

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/payout/

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

Раздел **Выплаты** — список ваших заявок на вывод вознаграждения и место, где
их можно создавать и отслеживать.

## Как посмотреть список выплат

Список открывается по ссылке **Выплаты** в боковом меню. Каждая карточка
показывает сумму в рублях и копейках (`1 500,00 ₽`), статус, дату создания и,
если заявка уже обработана, дату обработки. Клик по карточке открывает её целиком.

Фильтр **Статус** сужает список до одного или нескольких статусов сразу.
Список догружается по мере прокрутки.

## Как запросить выплату

1. Нажмите **Создать** на странице **Выплаты**.
2. Введите **Сумма, ₽** — не больше того, что показано как **Доступно для
   вывода** на [странице «Баланс»](https://docs.agenum.ru/partner/balance/). Сумма вводится в рублях,
   копейки отделяйте точкой: `1500.50`.
3. При желании добавьте **Комментарий к заявке**.
4. Нажмите **Создать**.

Реквизиты в форме не вводятся: заявка берёт те, что указаны на вкладке
**Реквизиты выплат** в [профиле](https://docs.agenum.ru/partner/profile/). Форма показывает, куда
уйдут деньги, и даёт ссылку, если их нужно поправить.

Заявка запоминает реквизиты в момент создания. Если потом изменить их в
профиле, уже поданная заявка будет оплачена по старым — по тем, которые вы
видели, когда её создавали. Поэтому, пока заявка не закрыта, менять реквизиты
кабинет не даёт.

Пока по вашему аккаунту есть необработанная заявка, создать вторую нельзя —
дождитесь решения по текущей или отмените её.

Если компания выложила оферту партнёрской программы, а вы ещё не приняли её
действующую редакцию, над формой появится «Перед выводом средств примите
действующую редакцию оферты партнёрской программы». Откройте оферту по ссылке,
отметьте **Принимаю оферту партнёрской программы (редакция от …)** и создайте
заявку.

:::tip
У компании обычно есть минимальная сумма выплаты. Если ввести меньше, кабинет
покажет, какая сумма минимальна для этого контура.
:::

## Что делать, если кнопка «Создать» недоступна

Для выплаты нужны две отдельные проверки, и под кнопкой видно, какой не
хватает:

| Сообщение | Что сделать |
|---|---|
| **Чтобы создавать выплаты, подтвердите email в профиле** | подтвердите почту кодом в [профиле](https://docs.agenum.ru/partner/profile/) |
| **Вы не можете создавать выплаты, так как ваш аккаунт ещё не верифицировал администратор** | дождитесь, пока аккаунт проверит компания, или свяжитесь с ней |

Если вы недавно сменили email, подтвердите заново уже новый адрес.

## Что делать, если выплата не создаётся из-за ИНН

Большинству компаний ИНН нужен, чтобы перевести вам деньги и провести выплату
по своей бухгалтерии. Поэтому заявка не создастся, пока он не указан верно.

**«Для вывода средств заполните ИНН в профиле».** Откройте
[профиль](https://docs.agenum.ru/partner/profile/), вкладку **Юридический статус**, и заполните ИНН.
Это не та же вкладка, что **Реквизиты выплат**: там указывается, куда переводить
деньги, а ИНН нужен компании для бухгалтерии.

**«ИНН в профиле указан некорректно».** В значении опечатка. ИНН проверяется по
контрольным цифрам, как это делает налоговая: у физлица, самозанятого и ИП он
состоит из 12 цифр, у юридического лица — из 10. Проверьте, что скопировали его
целиком и без лишних символов.

**«Для вывода средств заполните в профиле корректный ИНН».** Компания выдаёт
по выплатам акты, а в акте печатается ваш ИНН — поэтому самозанятому, ИП и
юрлицу он нужен обязательно и именно тот, что подходит выбранному статусу.
Проверьте его на вкладке **Юридический статус** в [профиле](https://docs.agenum.ru/partner/profile/).

**«Обратитесь к администратору — это поле заполняет он».** В вашей программе ИНН
заполняет сама компания, и в анкете его нет. Напишите ей.

## Что делать, если выплата не создаётся из-за реквизитов

**«Для вывода средств заполните реквизиты выплаты в профиле».** Компании некуда
перевести деньги. Откройте [профиль](https://docs.agenum.ru/partner/profile/), вкладку **Реквизиты
выплат**, и укажите банковский счёт либо номер телефона для перевода.

Ошибки в самих реквизитах — неверная контрольная цифра счёта, чужой БИК,
городской номер телефона — кабинет показывает сразу при сохранении, а не при
подаче заявки. Их разбор на [странице профиля](https://docs.agenum.ru/partner/profile/).

Некоторые компании реквизиты не собирают вовсе — например, если вознаграждение
не денежное. Тогда этого шага у вас не будет.

## Что делать, если выплата не создаётся из-за оферты

**«Примите оферту партнёрской программы».** У компании есть оферта, и её
действующую редакцию вы ещё не приняли. Обычно форма принятия уже видна над
полями заявки — отметьте согласие и создайте заявку снова. Принять оферту можно
и заранее, в разделе [Оферта](https://docs.agenum.ru/partner/program-offer/).

**«Оферта обновилась…».** Пока вы заполняли форму, компания выпустила новую
редакцию. Форма покажет её — откройте, ознакомьтесь и примите уже её.

## Что означают статусы выплаты

| Статус | Что значит |
|---|---|
| **Запрошена** | заявка создана и ждёт решения компании |
| **Одобрена** | компания подтвердила заявку, деньги готовятся к переводу |
| **Выплачена** | деньги отправлены по реквизитам из заявки |
| **Отклонена** | компания отклонила заявку — деньги остаются на балансе |
| **Отменена** | заявку отменили вы сами |

## Что можно сделать с заявкой, пока она в работе

Пока заявка в статусе **Запрошена** или **Одобрена**, на её странице доступна
кнопка **Отменить** — отменённая сумма возвращается в **Доступно для вывода**
на балансе. Для остальных статусов кабинет прямо пишет: «Изменить статус этой
заявки нельзя» — решение по ней уже принято.

На карточке выплаты также видно комментарий, который оставила компания при
обработке заявки, и реквизиты, по которым она будет оплачена. Номер счёта и
телефон показаны не целиком — видны только последние цифры.

## Из чего состоит выплата и как выгрузить её состав

Блок **Состав выплаты** на странице заявки показывает, из каких начислений
собрана сумма: по строке на каждое, с суммой. Если начисление вошло в заявку
не целиком, рядом видно «из …» — его полная сумма. Остаток останется на
балансе и уйдёт в следующую заявку.

Кнопка **Скачать состав (CSV)** выгружает то же самое таблицей: предложение,
номер лида, дата и сумма по каждой строке и итог внизу. Файл открывается в
Excel и подходит, чтобы сверить выплату со своими записями или подготовить по
ней документы, например счёт-фактуру.

У отклонённой и отменённой заявки кнопки нет: деньги вернулись на баланс, и
блок лишь напоминает, из чего заявка состояла.

## Где взять акт по выплате

Если компания выпускает акты, у выплаченной заявки появляется блок **Акт**:
**Акт № … от …**, отметка **Подписан электронной подписью …**, если вы
подписали его в кабинете, или **Подписан …**, если компания отметила его
подписанным, и кнопка **Скачать PDF**. Подписывают акт и смотрят все акты разом
в разделе
[Мои акты](https://docs.agenum.ru/partner/acts/).

## Что делать, если выплата задерживается

Пока заявка в статусе **Запрошена** или **Одобрена**, ускорить её из кабинета
нельзя — решение и сроки перевода на стороне компании. Если срок кажется
слишком долгим, свяжитесь с компанией напрямую: контакты кабинет не показывает.

## Читать также

- [Баланс](https://docs.agenum.ru/partner/balance/) — сколько доступно для вывода прямо сейчас
- [Профиль](https://docs.agenum.ru/partner/profile/) — подтверждение email, юридические данные и реквизиты для выплат
- [Мои акты](https://docs.agenum.ru/partner/acts/) — акты по всем выплатам
- [Уведомления](https://docs.agenum.ru/partner/notifications/) — как узнать об изменении статуса заявки не заходя в кабинет

---

# Профиль

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/profile/

> Личные данные, смена пароля, подтверждение email, юридический статус и реквизиты для выплат.

Раздел **Профиль** открывается по одноимённой ссылке в верхней части бокового
меню. В нём четыре вкладки: **Основное**, **Безопасность**, **Юридический
статус** и **Реквизиты выплат**.

## Как изменить личные данные

На вкладке **Основное** можно поменять **Имя**, **Фамилию**, **Отчество**,
**Email** и аватар. Кнопка **Заменить** под аватаром открывает выбор файла,
**Удалить** возвращает аватар по умолчанию. Изменения сохраняются кнопкой
**Сохранить**.

## Как сменить email

1. На вкладке **Основное** введите новый адрес в поле **Email**.
2. Появится поле **Текущий пароль — для смены email** — введите пароль, которым
   входите сейчас.
3. Нажмите **Сохранить**.

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

После смены:

- новый адрес нужно [подтвердить](https://docs.agenum.ru/partner/profile/#как-подтвердить-email) — до этого выплаты
  запросить нельзя;
- на старый адрес придёт письмо, что почта аккаунта изменена — если это были
  не вы, сразу свяжитесь с компанией;
- все прошлые входы на других устройствах станут недействительны, на текущем
  вы останетесь в кабинете.

## Как подтвердить email

Пока email не подтверждён, под ним показан блок **Верификация email**.

1. Нажмите **Отправить код**.
2. Введите код из письма в поле, которое появится ниже.
3. Нажмите **Подтвердить**.

Подтверждённый email нужен, чтобы [запрашивать выплаты](https://docs.agenum.ru/partner/payout/) —
без этого кнопка создания заявки остаётся недоступной. Кроме почты, аккаунт
должна подтвердить компания: это отдельная проверка, на неё вы не влияете.

Если вы задавали пароль по ссылке из письма компании, почта уже подтверждена —
блока **Верификация email** не будет.

:::tip
Повторно запросить код можно через минуту — кнопка покажет обратный отсчёт.
:::

## Как сменить пароль

На вкладке **Безопасность** введите **Текущий пароль** и **Новый пароль**,
затем нажмите **Сохранить**. Если текущий пароль указан неверно, кабинет
сообщит об этом отдельно.

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

## Как изменить юридический статус и данные

На вкладке **Юридический статус** выберите статус на вкладках — например,
физическое лицо, самозанятый, ИП или юридическое лицо — и заполните поля под
ним. Набор полей зависит от статуса и от того, что настроила компания в этом
контуре.

Эти данные компания использует для выплат — например, для документов, которые
нужны при переводе вознаграждения. Заполните их точно: ошибка может задержать
выплату. После изменения нажмите **Сохранить**.

Куда переводить деньги, указывается отдельно — на вкладке **Реквизиты выплат**.

## Как указать реквизиты для выплат

На вкладке **Реквизиты выплат** выберите способ и заполните поля.

**Банковский счёт** — **Номер счёта** (20 цифр), **БИК банка** (9 цифр) и
**Имя получателя** так, как оно указано в банке.

**Перевод по номеру телефона** — **Номер телефона**, к которому привязан счёт,
**Имя получателя** и, по желанию, **Банк получателя**.

Нажмите **Сохранить**. После сохранения кабинет показывает реквизиты не
целиком: у номера счёта и телефона видны только последние цифры. Так они
выглядят и у сотрудников компании.

:::tip
Компания может заполнить реквизиты за вас — тогда на вкладке они уже будут.
Проверьте их перед первой заявкой: платят именно по ним.
:::

## Как изменить реквизиты выплат

Нажмите **Изменить** и введите реквизиты заново — целиком, включая номер счёта.
Поправить одну цифру нельзя: сохранённое значение скрыто, и подставить его в
поле кабинет не может.

Кнопка **Удалить** убирает реквизиты; после этого выплату не запросить, пока не
заполните новые.

**Пока у вас есть необработанная заявка на выплату, реквизиты менять нельзя** —
кабинет предложит сначала отменить заявку. Ограничение денежное, а не
формальное: заявка платится по тем реквизитам, которые были при её создании, и
если бы правка проходила, деньги ушли бы на старый счёт, а в профиле вы видели
бы новый.

## Что делать, если что-то не сохраняется

**Не приходит код подтверждения email.** Проверьте папку «Спам» и что email
указан без опечаток на вкладке **Основное**.

**«Неверный текущий пароль» при смене пароля или email.** Введите пароль,
которым входите в кабинет сейчас, а не новый.

**«Слишком много неверных попыток».** После пяти неверных вводов текущего
пароля смена пароля и email блокируется на 15 минут. Если пароль забыт,
выйдите и [восстановите его](https://docs.agenum.ru/partner/registration/) через страницу входа.

**Не получается сохранить юридический статус.** Проверьте, что заполнены все
обязательные поля под выбранным статусом.

**«Поле "ИНН" заполнено некорректно».** ИНН проверяется по контрольным цифрам,
как это делает налоговая, — значение с опечаткой не сохранится. У физлица,
самозанятого и ИП он состоит из 12 цифр, у юридического лица — из 10.

**«Сохранённый ИНН не подходит выбранному юридическому статусу».** Вы меняете
статус, а указанный ранее ИНН другой длины: у организации и у человека форматы
разные. Укажите ИНН, соответствующий новому статусу.

**«Номер счёта не соответствует БИК».** В одном из двух полей опечатка. Номер
счёта содержит контрольную цифру, которая считается вместе с БИК, — поэтому
кабинет видит ошибку сразу, не дожидаясь неудачного перевода. Сверьте оба
значения с реквизитами из банка и проверьте, что счёт рублёвый.

**«Это корреспондентский счёт банка, а не счёт получателя».** Из реквизитов
банка скопирован не тот счёт: корреспондентский принадлежит самому банку.
Ваш — тот, что подписан «расчётный счёт» или «счёт получателя».

**«Укажите мобильный номер телефона РФ».** Перевод по номеру работает только
по мобильным номерам российских операторов, городской не подойдёт.

**«Пока есть активная заявка на выплату, реквизиты менять нельзя».** Отмените
заявку на [странице выплат](https://docs.agenum.ru/partner/payout/) или дождитесь решения по ней.

## Читать также

- [Регистрация и вход](https://docs.agenum.ru/partner/registration/) — требования к паролю и восстановление доступа
- [Выплаты](https://docs.agenum.ru/partner/payout/) — зачем нужно подтверждение email и как подать заявку
- [Уведомления](https://docs.agenum.ru/partner/notifications/) — какие письма кабинет присылает на этот email

---

# Оферта партнёрской программы

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/program-offer/

> Где прочитать оферту компании, как её принять и что делать, когда выходит новая редакция.

Оферта — договор компании с партнёрами: на каких условиях вы участвуете в
программе и получаете вознаграждение. Её текст компания выкладывает в кабинет
PDF-файлом, а вы принимаете её отметкой.

Раздел [Оферта](https://ваш-контур.agenum.ru/program-offer) показывает действующую
редакцию и те, что вы уже приняли.

:::tip
Раздела нет, если компания не выложила оферту. Тогда принимать ничего не нужно.
:::

## Когда нужно принимать оферту

- **При регистрации.** На втором шаге есть отметка **Я принимаю оферту
  партнёрской программы (редакция от …)** — без неё зарегистрироваться не
  получится. Прочитать текст можно по ссылке **Открыть оферту партнёрской
  программы (PDF)** рядом.
- **Перед выводом средств.** Если компания выпустила новую редакцию, принять её
  нужно до следующей заявки на выплату. Экран создания заявки сам покажет
  форму принятия.

Принятие хранится отдельно для каждой редакции: компания видит, какую именно
редакцию и когда вы приняли. Уведомления о новой редакции не приходят —
узнать о ней можно в этом разделе или на экране вывода средств.

## Как прочитать и принять оферту

Карточка **Действующая редакция от …**:

- **Скачать** — сохранить PDF;
- **Открыть в новой вкладке** — прочитать в браузере.

Если эту редакцию вы ещё не принимали, ниже отметьте **Ознакомился и принимаю**
и нажмите **Принять**. После этого в карточке появится **Принята** с датой.

Если в карточке написано **Редакция содержит соглашение об электронной
подписи**, приняв её, вы сможете [подписывать акты в кабинете](https://docs.agenum.ru/partner/acts/)
кодом из письма.

## Где посмотреть редакции, которые вы принимали

Блок **Принятые редакции** — все редакции, которые вы принимали, с датой
принятия. Каждую можно **Скачать**: так видно, на каких условиях вы работали в
тот или иной период.

## Как оферта связана с актами

Если компания выпускает акты по выплатам, в строке «Основание» акта указана
редакция оферты, которую вы приняли до выплаты. Подробнее об актах —
[Мои акты](https://docs.agenum.ru/partner/acts/).

Подписать акт в кабинете можно, только пока действующая редакция содержит
соглашение об электронной подписи и вы её приняли. Если компания выпустила
новую редакцию, примите её — иначе кнопка **Подписать** у актов пропадёт, даже
если прежнюю редакцию вы принимали.

## Что делать, если оферта не принимается

**«Оферта обновилась. Ознакомьтесь с новой редакцией и примите её».** Пока
страница была открыта, компания выпустила новую редакцию. Кабинет покажет её —
прочитайте и примите уже её.

**«Оферта партнёрской программы не загружена».** Компания убрала оферту или ещё
не выложила её. Принимать пока нечего.

## Читать также

- [Регистрация и вход](https://docs.agenum.ru/partner/registration/) — принятие оферты при регистрации
- [Выплаты](https://docs.agenum.ru/partner/payout/) — принятие новой редакции перед выводом средств
- [Мои акты](https://docs.agenum.ru/partner/acts/) — где оферта указана основанием

---

# Регистрация и вход

Раздел: ЛК партнёра. Адрес: https://docs.agenum.ru/partner/registration/

> Как зарегистрироваться в ЛК партнёра, войти — в том числе по ссылке из письма компании — и восстановить пароль.

ЛК партнёра живёт на адресе контура компании, чьи предложения вы продвигаете —
например, `https://ваш-контур.agenum.ru`. Этот адрес вам должна сообщить сама
компания: подобрать его самостоятельно нельзя, регистрация нового контура —
не часть работы партнёра.

## Как зарегистрироваться

Регистрация состоит из двух шагов.

1. Откройте страницу регистрации по ссылке от компании.
2. **Выберите ваш юридический статус** на вкладках — например, физическое лицо,
   самозанятый, ИП или юридическое лицо. Набор статусов зависит от контура: часть
   может быть недоступна.
3. Заполните поля, которые появились под выбранным статусом, и нажмите
   **Продолжить**.
4. На втором шаге укажите **Фамилию**, **Имя**, **Отчество**, **Email** и
   **Пароль**.
5. Если компания выложила оферту партнёрской программы, отметьте **Я принимаю
   оферту партнёрской программы (редакция от …)**. Текст открывается по ссылке
   **Открыть оферту партнёрской программы (PDF)**.
6. Нажмите **Зарегистрироваться**.

Сразу после этого вы попадаете в кабинет — письмо с подтверждением на этом шаге
не приходит.

:::tip
Пароль должен быть не короче 8 символов и содержать хотя бы одну цифру, одну
строчную и одну заглавную букву латиницы.
:::

## Что нужно для юридического статуса

Набор полей под каждым статусом свой — его определяет компания. Например, для
ИП может понадобиться ИНН, а для юридического лица — реквизиты организации.
Поля, отмеченные как обязательные, нужно заполнить, иначе **Продолжить** не
сработает.

ИНН — единственное поле, которое проверяется по содержимому: оно сверяется по
контрольным цифрам, как это делает налоговая. У физлица, самозанятого и ИП ИНН
состоит из 12 цифр, у юридического лица — из 10. Значение с опечаткой
зарегистрировать не получится.

Эти данные можно посмотреть и изменить позже в [профиле](https://docs.agenum.ru/partner/profile/) —
там же, где меняются реквизиты для выплат.

## Как войти в кабинет

1. Откройте адрес кабинета и введите **Email** и пароль.
2. Нажмите **Войти**.

Если данные не подошли, кабинет сообщит, что пользователь не найден — проверьте
email и пароль. Заблокированный компанией аккаунт войти не пустит: об этом
кабинет скажет отдельным сообщением.

## Как войти по ссылке из письма компании

Если компания завела ваш аккаунт сама, регистрироваться не нужно: на почту
придёт письмо со ссылкой. Такое же письмо приходит, если компания отправила
приглашение повторно или привязала аккаунт к новому адресу почты.

1. Откройте ссылку из письма.
2. Придумайте пароль, повторите его и нажмите **Сохранить и войти**.

Вы сразу окажетесь в кабинете, а почта будет считаться подтверждённой. Все
прошлые входы в кабинет на других устройствах станут недействительны.

Ссылка действует 72 часа и срабатывает один раз. Если компания присылала её
несколько раз, работает только последнее письмо. Пароль, который вы
задаёте, знаете только вы — компания его не видит и задать за вас не может.

## Как восстановить пароль

1. На странице входа нажмите **Восстановить**.
2. Введите **Email** и нажмите **Отправить код**.
3. Введите **Код из письма** и **Новый пароль**, нажмите **Сменить пароль**.

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

:::tip
Если письмо не пришло, повторно запросить код можно через минуту — кнопка
**Отправить код повторно** покажет обратный отсчёт. Код из письма годен
ограниченное время и разрешает не больше пяти попыток ввода; если не успели —
запросите новый.
:::

## Что делать, если что-то не получается

**Пишет, что email уже занят.** Партнёр с таким email в этом контуре уже
зарегистрирован — воспользуйтесь входом или восстановлением пароля.

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

**Пишет, что оферта обновилась.** Пока вы заполняли форму, компания выпустила
новую редакцию оферты. Форма покажет её — отметьте согласие с ней и
зарегистрируйтесь снова. Подробнее — [Оферта](https://docs.agenum.ru/partner/program-offer/).

**Код из письма не подходит.** Убедитесь, что вводите последний присланный
код: после повторной отправки старый код перестаёт действовать. После пяти
неверных попыток запросите код заново.

**Пишет «Ссылка недействительна».** Ссылка из письма истекла, уже
использована или компания отправила вам новую. Откройте последнее письмо,
попросите компанию прислать ссылку заново или задайте пароль сами через
[восстановление](https://docs.agenum.ru/partner/registration/#как-восстановить-пароль) — оно работает, даже если вы ещё
ни разу не входили.

**Компания завела аккаунт, а войти не получается.** Пока вы не задали пароль
по ссылке, кабинет отвечает так же, как на неверный пароль. Найдите письмо со
ссылкой или воспользуйтесь восстановлением пароля.

## Читать также

- [ЛК партнёра](https://docs.agenum.ru/partner/) — обзор раздела и что доступно после входа
- [Профиль](https://docs.agenum.ru/partner/profile/) — смена пароля и юридических данных из кабинета
- [Оферта](https://docs.agenum.ru/partner/program-offer/) — договор, который вы принимаете при регистрации
- [Баланс](https://docs.agenum.ru/partner/balance/) — что происходит после первого приведённого клиента

---

# ЛК администратора

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/

> Админка контура — предложения, партнёры, лиды, выплаты и настройки.

Админка — рабочее место сотрудника, который ведёт партнёрскую программу:
заводит предложения, принимает партнёров, разбирает лиды и подтверждает выплаты.

Она живёт по адресу вашего контура с добавлением `/admin`, например
`ваш-контур.agenum.ru/admin`.

## Что здесь можно делать

| Раздел | Зачем |
|---|---|
| [Предложения](https://docs.agenum.ru/admin/offer/) | что именно продвигают партнёры и на каких условиях |
| [Партнёры](https://docs.agenum.ru/admin/partner/) | приём, группы, блокировка |
| [Лиды](https://docs.agenum.ru/admin/lead/) | заявки, которые привели партнёры |
| [Выплаты](https://docs.agenum.ru/admin/payout/) | подтверждение и выплата вознаграждения |
| [Акты](https://docs.agenum.ru/admin/payout/acts/) | акты по выплатам, если их выпуск включён |
| [Материалы](https://docs.agenum.ru/admin/materials/) | баннеры и креативы, которыми пользуются партнёры |
| [Настройки](https://docs.agenum.ru/admin/settings/) | справочники, роли, поля, ключи API |

:::tip
Некоторые разделы могут быть недоступны на вашем тарифе. Что входит в тариф,
видно в [Консоли](https://docs.agenum.ru/console/).
:::

## С чего начать

1. Настройте [поля лида](https://docs.agenum.ru/admin/settings/lead-field-types/) и
   [статусы лида](https://docs.agenum.ru/admin/settings/lead-statuses/) — из чего состоит заявка и как
   она движется.
2. Опишите условия вознаграждения в
   [шаблонах](https://docs.agenum.ru/admin/settings/award-templates/).
3. [Создайте первое предложение](https://docs.agenum.ru/admin/offer/create/).
4. [Заведите партнёров](https://docs.agenum.ru/admin/partner/create/) или дождитесь их регистрации и
   раздайте доступ к предложению.
5. Разбирайте [лиды](https://docs.agenum.ru/admin/lead/) и подтверждайте [выплаты](https://docs.agenum.ru/admin/payout/).

Открыть [список предложений](https://ваш-контур.agenum.ru/admin/offer).

## Где что настраивается

| Что нужно | Где |
|---|---|
| Состав заявки | [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/) |
| Путь заявки от новой до закрытой | [Статусы лидов](https://docs.agenum.ru/admin/settings/lead-statuses/) |
| Сколько и за что получает партнёр | [Шаблоны вознаграждений](https://docs.agenum.ru/admin/settings/award-templates/) |
| Анкета партнёра и реквизиты | [Поля партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/) |
| Разбиение партнёров по условиям | [Группы](https://docs.agenum.ru/admin/settings/partner-groups/) |
| Документы для партнёров | [Реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) и [оферта](https://docs.agenum.ru/admin/settings/program-offer/) |
| Доступ сотрудников | [Сотрудники](https://docs.agenum.ru/admin/settings/admins/) и [роли](https://docs.agenum.ru/admin/settings/roles/) |
| Интеграция со своей системой | [Ключи API](https://docs.agenum.ru/admin/settings/api-keys/) |

## Личные экраны

Свои данные и пароль — в [профиле](https://docs.agenum.ru/admin/profile/), письма и оповещения о
событиях контура — в [уведомлениях](https://docs.agenum.ru/admin/notifications/).

## Читать также

- [ЛК партнёра](https://docs.agenum.ru/partner/) — что видит партнёр с той стороны
- [Консоль](https://docs.agenum.ru/console/) — тариф, оплата и управление контуром
- [Внешний API](https://docs.agenum.ru/api/) — интеграция со своей системой

---

# Лиды

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/lead/

> Список заявок от партнёров — что означают колонки карточки, фильтры по статусу, партнёру, предложению и полям, массовое удаление.

Лид — заявка от клиента, которого привёл партнёр. Экран **Лиды** — общий
список всех заявок в контуре: видно, кто обратился, на каком этапе находится
заявка и кому она принадлежит. Откройте его в разделе
[Лиды](https://ваш-контур.agenum.ru/admin/lead).

## Что видно в карточке лида в списке

- **ID** — ссылка на [карточку лида](https://docs.agenum.ru/admin/lead/view/).
- Статус — цветной бейдж, цвет и название задаются в
  [конструкторе статусов](https://docs.agenum.ru/admin/settings/lead-statuses/).
- **Партнёр**, который привёл лида (ФИО, если оно заполнено, иначе email).
- **Оффер** — предложение, к которому относится заявка.
- Обязательные поля заявки со значениями. Необязательные поля в списке не
  показываются — их видно только на карточке лида.
- Дата создания.

## Как найти нужных лидов

Над списком — панель фильтров:

- **Статус** — один статус из настроенных в контуре;
- **Партнёр** и **Предложение** — поиск с множественным выбором;
- ниже, если в контуре настроены поля лида, появляются фильтры по каждому
  полю — своё поле ввода или список под тип поля, как в форме создания.

Фильтры комбинируются: список показывает лидов, подходящих под все выбранные
условия сразу. Кнопка **Сбросить** снимает все фильтры разом.

:::tip
Свободного текстового поиска и фильтра по датам на этом экране нет —
искать можно только по статусу, партнёру, предложению и значениям полей.
:::

## Как отредактировать или удалить лида

В карточке лида — кнопка с тремя точками, в ней:

- **Просмотреть** — открывает [карточку лида](https://docs.agenum.ru/admin/lead/view/);
- **Редактировать** — открывает [форму редактирования](https://docs.agenum.ru/admin/lead/create/);
- **Удалить** — безвозвратно удаляет лида после подтверждения.

Удалить можно не каждого лида. Если по нему партнёру уже начислено
вознаграждение, лид остаётся навсегда: от него зависит баланс партнёра.
Если статус лида только что сменился и начисление ещё считается, удаление
тоже не пройдёт. Подождите минуту и повторите.

## Как удалить несколько лидов сразу

Отметьте нужные карточки чекбоксами (или **Выбрать все** над списком) и
нажмите появившуюся кнопку **Удалить**. Как и при удалении одного лида,
действие безвозвратно и требует подтверждения.

Если хотя бы по одному из выбранных лидов есть начисление партнёру или оно
ещё считается, не удалится ни один. Снимите отметку с таких лидов и
повторите.

## Что делать, если нужного лида не видно в списке

Проверьте, не сузили ли фильтры список до пустого — нажмите **Сбросить** и
задайте условия заново. Если ищете по значению поля, а фильтра для него нет —
поле, скорее всего, скрыто в [настройках полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/):
скрытые поля пропадают из фильтров вместе с формой.

## Читать также

- [Создание и редактирование лида](https://docs.agenum.ru/admin/lead/create/)
- [Карточка лида](https://docs.agenum.ru/admin/lead/view/)
- [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/)

---

# Создание и редактирование лида

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/lead/create/

> Как завести заявку вручную, привязать её к партнёру и предложению и что можно изменить после создания.

Иногда клиента заводят в систему вручную — например, он позвонил напрямую, а
не пришёл по ссылке партнёра. Экран **Создание лида** открывается со
[списка лидов](https://ваш-контур.agenum.ru/admin/lead) по кнопке
**Создать лида**.

## Как создать лида вручную

1. Откройте список лидов и нажмите **Создать лида**.
2. При желании укажите **Предложение** — необязательно.
3. При желании укажите **Партнёра** — необязательно. Если предложение уже
   выбрано, поиск покажет только партнёров, которым оно доступно.
4. Если заполнены и партнёр, и предложение, можно указать, через что именно
   партнёр привёл клиента — вкладками **Ссылка** и **Промокод**: поиск ищет
   ссылки и промокоды этого партнёра по этому предложению.
5. Заполните поля лида. Их состав и то, какие из них обязательны, задаёт
   [конструктор полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/); обязательные
   помечены звёздочкой.
6. Нажмите **Сохранить**.

:::tip
Партнёра можно указать напрямую, без ссылки и промокода — просто выбрав его
в поле **Партнёр**. Если же не указать ни партнёра, ни ссылку, ни промокод,
лид создастся ничьим: вознаграждение по нему никому не начислится.
:::

## Как привязать лида к партнёру и предложению

Есть три варианта:

- **Напрямую** — выбрать партнёра в поле **Партнёр**, не трогая вкладки
  **Ссылка** и **Промокод**.
- **По ссылке** — выбрать конкретную ссылку партнёра на вкладке **Ссылка**.
  Так же, как если бы клиент сам перешёл по ней.
- **По промокоду** — выбрать промокод партнёра на вкладке **Промокод**. Как
  и при создании заявки через API, промокод должен быть активным, а повторная
  заявка с теми же значениями полей по тому же промокоду в течение суток
  будет отклонена как дубль.

## Что можно изменить при редактировании лида

После создания форма редактирования показывает только **Кастомные поля
лида** — значения можно менять, привязка к партнёру, предложению, ссылке или
промокоду фиксируется при создании и позже не меняется.

На той же форме редактирования, ниже полей, доступны те же блоки, что и на
[карточке лида](https://docs.agenum.ru/admin/lead/view/): смена статуса, добавление сделки и
список полученных вознаграждений — про них подробно на странице карточки.

Суммы в этих блоках вводятся в рублях — поле так и подписано **Сумма сделки,
₽**, — а показываются с копейками: `1 500,00 ₽`.

## Что делать, если лид не сохраняется

**Не удаётся сохранить лида.** Проверьте обязательные поля — без них
сохранить нельзя, сообщение назовёт конкретное поле.

**Лид создался ничьим.** Партнёр не был указан ни напрямую, ни через ссылку
или промокод — отредактировать привязку задним числом нельзя, нужно создать
лида заново с правильным партнёром.

**Появляется сообщение о дубле.** Заявка с таким же набором полей по этому
промокоду уже создана — проверьте список лидов, она уже там.

## Читать также

- [Список лидов](https://docs.agenum.ru/admin/lead/)
- [Карточка лида](https://docs.agenum.ru/admin/lead/view/)
- [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/)

---

# Карточка лида

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/lead/view/

> Что видно на карточке лида, как сменить статус, добавить сделку и посмотреть историю переходов по статусам.

Карточка лида — экран одной заявки: заполненные поля, привязка к партнёру и
предложению, работа со статусом и сделками. Откройте её из
[списка лидов](https://ваш-контур.agenum.ru/admin/lead), нажав на ID нужной
заявки.

## Что видно на вкладке «Общее»

- **Общие данные** — все заполненные поля лида.
- **Предложение и партнёр** — ссылки на карточку предложения и карточку
  партнёра, если они привязаны.
- **Инструмент** — как именно партнёр привёл лида: название и короткая
  ссылка, если это переход по ссылке; код, если это промокод. Если лида
  создали вручную без ссылки и промокода, здесь будет **Инструментов нет**.

## Как сменить статус лида

В блоке **Изменение статуса** — кнопка на каждый настроенный статус, кроме
текущего (она неактивна). Нажатие переводит лида в выбранный статус сразу,
без дополнительного подтверждения.

Если статус, в который переводите лида, — целевой (означает состоявшуюся
сделку), рядом с его кнопкой появляется поле **Сумма сделки, ₽**: без него
перевести лида в такой статус нельзя, если только в предложении не включено
**Разрешить сделки по предложению без суммы**.

Полный список статусов и то, какой из них целевой, настраивается в
[конструкторе статусов лидов](https://docs.agenum.ru/admin/settings/lead-statuses/).

## Как добавить сделку или сумму

Если по одному лиду проходит несколько сделок, следующие добавляют отдельно —
в блоке **Добавить сделку**: введите сумму в рублях в поле
**Сумма сделки, ₽** и нажмите **Добавить**. Поле и кнопка активны только тогда, когда лид уже находится в
целевом статусе. Каждая добавленная сделка появляется в списке ниже строками
**Сумма сделки** и **Дата сделки**; сумма показана в рублях и копейках,
например `1 500,00 ₽`. Пока сделок нет, блок показывает «Сделок по лиду пока
что нет».

С каждой добавленной сделки партнёру начисляется процент, если он задан в
[условиях вознаграждения](https://docs.agenum.ru/admin/settings/award-templates/). Фиксированная
сумма повторно не начисляется — она платится один раз, за перевод лида в
статус. Так можно платить партнёру процент с повторных платежей клиента —
например, с каждого месяца подписки. Вносить их руками не обязательно: ваша
CRM может передавать каждый платёж сама, через
[внешний API](https://docs.agenum.ru/api/lead/#как-начислять-процент-с-каждого-платежа-клиента-revshare).

## Как посмотреть вознаграждения по лиду

Блок **Вознаграждения** показывает все денежные операции по этому лиду — не
только начисления. Каждая строка содержит вид операции с суммой, дату и, если
операция связана с переходом по статусам, строку **Статус лида** с тем статусом,
на котором она сработала.

| Строка | Что произошло |
|---|---|
| **Начислено** | партнёру начислено вознаграждение за этот лид |
| **Отменено** | начисление отменено: лид перешёл в статус, отменяющий сделку |
| **Зарезервировано под выплату** | сумма отложена под заявку партнёра на выплату |
| **Резерв возвращён** | заявку отклонили или отменили, деньги вернулись партнёру |

Отменённые строки показаны приглушённо. У начисления, срок удержания которого
ещё не прошёл, добавляется строка **В удержании до** с датой: до неё партнёр
эту сумму вывести не может. У отмены такой строки нет — отменять начисление
можно только пока оно в удержании.

Если у операции есть комментарий, он выводится строкой **Комментарий**.

Пока операций не было, блок показывает «Вознаграждения партнерами ещё не
получены».

## История смены статусов

Вкладка **Статусы** наверху карточки открывает отдельный экран —
хронологический список всех переходов лида по статусам с датой и временем
каждого. Она полезна, когда нужно понять, сколько лид провёл в каждом
статусе, или разобрать спорную ситуацию с начислением.

У каждого перехода подписано, кто его сделал: **Изменил:** с именем сотрудника
или с названием API-ключа, если статус сменила ваша внешняя система через
[внешний API](https://docs.agenum.ru/api/lead/). У первого статуса, с которым лид создан, автора нет.

## Что делать, если статус лида или сделка не меняются

**Не получается перевести лида в целевой статус.** Укажите сумму сделки —
без неё перевод недоступен, если в предложении не разрешены сделки без
суммы.

**Кнопка «Добавить» в блоке сделок неактивна.** Лид ещё не в целевом
статусе — сначала переведите его туда.

**Не видно партнёра или предложения.** Лида могли создать без привязки —
см. [Создание и редактирование лида](https://docs.agenum.ru/admin/lead/create/).

## Читать также

- [Список лидов](https://docs.agenum.ru/admin/lead/)
- [Статусы лидов](https://docs.agenum.ru/admin/settings/lead-statuses/)
- [Создание и редактирование лида](https://docs.agenum.ru/admin/lead/create/)
- [Баланс партнёра](https://docs.agenum.ru/partner/balance/) — как те же операции выглядят в кабинете партнёра

---

# Рекламные материалы

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/materials/

> Общая библиотека баннеров и файлов для партнёров — группы, загрузка и что из неё видит партнёр.

Экран **Материалы** — общая библиотека баннеров, макетов и презентаций для
партнёров. Сама по себе она партнёрам не видна: материалы из неё прикрепляют к
конкретному предложению при [его создании или редактировании](https://docs.agenum.ru/admin/offer/create/),
и уже там их видит партнёр.

## Как загрузить материал

1. Откройте нужную группу (или раздел **Без группы**, если своей группы у
   материала не будет).
2. Нажмите **➕Загрузить**.
3. Выберите файл.
4. Материал сразу появится в группе.

Допустимые форматы: JPEG, PNG, GIF, WEBP, SVG, PDF и PPTX. Размер файла — до
10 МБ.

## Как разложить материалы по группам

Группы — это просто способ навигации по большой библиотеке, партнёру их
названия не видны.

**Создать группу.** Нажмите **Добавить группу**, введите название и нажмите
Enter. Название должно быть уникальным в контуре.

**Переименовать группу.** Нажмите **Переименовать** рядом с названием, введите
новое и уведите фокус с поля.

**Удалить группу.** Нажмите **Удалить** рядом с названием и выберите вариант:

| Вариант | Что происходит |
|---|---|
| Удалить только группу | материалы остаются, переносятся в выбранную группу или в «Без группы» |
| Удалить группу со всеми материалами | материалы удаляются вместе с группой |

Группу **Без группы** переименовать или удалить нельзя — это раздел по
умолчанию, а не настоящая группа.

## Как удалить материал

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

## Что видит партнёр

Партнёр не видит библиотеку целиком — только те материалы, которые прикреплены
к предложению, которое он открыл. Подробнее — на странице
[предложения у партнёра](https://docs.agenum.ru/partner/offer/).

## Читать также

- [Создание и редактирование предложения](https://docs.agenum.ru/admin/offer/create/)
- [Страница предложения у партнёра](https://docs.agenum.ru/partner/offer/)
- [ЛК администратора](https://docs.agenum.ru/admin/) — остальные разделы админки

---

# Уведомления

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/notifications/

> Какие уведомления получает администратор, где посмотреть список и как настроить каналы доставки.

Раздел **Уведомления** — события контура, которые касаются администратора.
Придёт уведомление в кабинет, на почту или никуда — зависит от настроек
каналов доставки, каждый можно включить или отключить отдельно.

## Какие бывают уведомления

| Уведомление | Когда приходит |
|---|---|
| Регистрация партнёра | в контуре зарегистрировался новый партнёр |
| Запрос выплаты | партнёр запросил выплату из своего кабинета |

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

Список на вкладке **Список** показывает уведомления от новых к старым.
Непрочитанные выделены и помечены точкой; клик по уведомлению отмечает его
прочитанным. Кнопка **Прочитать все** отмечает прочитанными сразу все.

## Как настроить канал доставки

На вкладке **Настройки** — таблица: строки — типы уведомлений, столбцы — каналы
**В приложении** и **Email**. Переключателем в ячейке включайте или отключайте
доставку конкретного уведомления по конкретному каналу.

## Читать также

- [Список партнёров](https://docs.agenum.ru/admin/partner/) — где видно, кто зарегистрировался
- [Выплаты](https://docs.agenum.ru/admin/payout/) — заявки, о которых приходят уведомления
- [Профиль и безопасность](https://docs.agenum.ru/admin/profile/) — остальные личные настройки

---

# Список предложений

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/offer/

> Таблица предложений админки — статусы, поиск, фильтры и действия из списка.

Предложение — это то, что вы предлагаете партнёрам продвигать: условия, ссылка,
вознаграждение. Экран **Предложения** — список всех предложений контура, с
которого начинается работа с партнёрской программой.

Откройте [список предложений](https://ваш-контур.agenum.ru/admin/offer) в боковом
меню.

## Что означают вкладки со статусами

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

| Вкладка | Что в неё попадает |
|---|---|
| **Активные** | предложение опубликовано, партнёры видят его прямо сейчас |
| **Отложенные** | предложение опубликовано, но период действия ещё не начался |
| **Черновики** | предложение не опубликовано и партнёрам не видно |
| **Архив** | у предложения закончился период действия |

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

По умолчанию список открывается на вкладке **Активные**.

## Как найти нужное предложение

Строка поиска ищет по названию. Дополнительно доступны фильтры:

- **Инструменты** — по тому, что партнёр может создавать: ссылку, промокод или
  оба сразу;
- **Категории** — по [категориям предложений](https://docs.agenum.ru/admin/settings/categories/);
- **Период действия** — по датам начала и конца периода.

Кнопка **Сбросить** очищает все фильтры разом.

## Что видно в карточке предложения

| Поле | Что означает |
|---|---|
| Название | ссылка на [карточку предложения](https://docs.agenum.ru/admin/offer/view/) |
| Значки ссылки и промокода | какие инструменты партнёр может использовать по этому предложению |
| Лиды | число заявок по предложению в разбивке по статусам, если они уже есть: цветной значок на статус, название — при наведении, порядок — как в [статусах лидов](https://docs.agenum.ru/admin/settings/lead-statuses/) |
| Категории | категории, к которым отнесено предложение |
| Период действия | даты начала и окончания или «Бессрочное» |
| Дата создания | когда предложение было создано |

## Как создать или изменить предложение

Кнопка **Создать предложение** в шапке страницы открывает
[форму создания](https://docs.agenum.ru/admin/offer/create/).

Для уже существующего предложения в меню действий карточки (три точки) есть
пункт **Редактировать** — он открывает ту же форму, заполненную текущими
данными.

## Как удалить предложение

В том же меню действий есть пункт **Удалить**. Удаление проходит только пока
по предложению не создано ни одной партнёрской ссылки и ни одного промокода —
если хотя бы один уже есть, предложение нужно оставить в архиве, а не удалять.

## Читать также

- [Создание и редактирование предложения](https://docs.agenum.ru/admin/offer/create/)
- [Карточка предложения](https://docs.agenum.ru/admin/offer/view/)
- [Категории предложений](https://docs.agenum.ru/admin/settings/categories/)

---

# Создание и редактирование предложения

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/offer/create/

> Как завести предложение, настроить инструменты, доступ и вознаграждение партнёров.

Форма создания и редактирования — один и тот же экран. Открывается кнопкой
**Создать предложение** из [списка предложений](https://ваш-контур.agenum.ru/admin/offer)
или пунктом **Редактировать** в меню карточки уже существующего предложения.

## Как создать предложение

1. Заполните **Название** и **Ссылку** — адрес, на который приводятся клиенты.
2. При необходимости добавьте **Описание** — его увидят партнёры на карточке
   предложения.
3. Включите нужные инструменты и настройте доступ для партнёров.
4. Настройте вознаграждение.
5. Нажмите **Сохранить**.

:::tip
**Сохранить** публикует предложение — партнёры смогут его увидеть сразу же
(или с даты начала периода, если он задан). **Сохранить черновик** сохраняет
всё как есть, но партнёрам предложение не показывает.
:::

## Что обязательно для публикации

При нажатии **Сохранить** название и ссылка должны быть заполнены — без них
появится сообщение об ошибке и предложение не сохранится. У **Сохранить
черновик** этого ограничения нет: черновик можно оставить пустым и
доработать позже.

Материалы — исключение из этого правила: если к предложению добавлены
материалы, при сохранении (в любом варианте) они должны существовать —
удалённый материал сохранить не получится.

## Какие инструменты можно включить

Переключатели **Партнерские ссылки** и **Промокоды** решают, что партнёр сможет создавать
по этому предложению в своём кабинете: партнёрскую ссылку, личный промокод
или оба инструмента сразу. Хотя бы один из них имеет смысл включить — иначе
партнёру нечем будет работать с предложением.

При включённых **Промокодах** появляется поле **Бонус по промокоду по
умолчанию** — то, что получит клиент по коду, если для конкретного промокода
партнёра бонус не задан отдельно.

:::tip
Если выключить инструмент у уже опубликованного предложения, все созданные по
нему партнёрские ссылки или промокоды не удаляются, а скрываются — партнёры
перестают их видеть, но статистика сохраняется.
:::

## Категории

Блок **Категории** — необязательная привязка предложения к одной или
нескольким [категориям](https://docs.agenum.ru/admin/settings/categories/). Категории помогают
партнёрам ориентироваться в списке предложений и участвуют в фильтрах списка.

## Материалы

Блок **Материалы** — рекламные баннеры и креативы, которые партнёр увидит на
карточке предложения и сможет использовать в продвижении. Кнопка
**Добавить материалы** открывает окно выбора из уже загруженных
[материалов](https://docs.agenum.ru/admin/materials/): отмеченные добавляются в предложение, а
крестик у выбранного материала убирает его оттуда.

## Период действия

Переключатель **Бессрочное предложение** включён по умолчанию — в этом
случае предложение действует, пока его не отправят в черновик или не удалят
руками. Если его выключить, откроются два поля дат — начало и конец периода:

- предложение с датой начала в будущем попадает на вкладку **Отложенные** и
  становится видимым партнёрам только с этой даты;
- предложение с датой конца в прошлом автоматически уходит в **Архив**.

Окончание периода не отменяет вознаграждение по уже пришедшим лидам. Лид,
который появился, пока предложение действовало, будет оплачен и после
окончания периода — когда дойдёт до нужного статуса.

## Кому будет видно предложение

Блок **Настройки доступа** решает, какие партнёры увидят предложение в своём
кабинете:

| Вариант | Кто увидит |
|---|---|
| Доступно всем | все партнёры |
| Доступно всем, кроме... | все, кроме выбранных |
| Скрыто для всех, кроме... | только выбранные |
| Скрыто для всех | никто |

Для двух средних вариантов кнопка **Выбрать** открывает окно, где условие
задаётся партнёрами или группами партнёров — можно комбинировать несколько
сразу.

Доступ — единственное условие работы партнёра с предложением: отдельно
принимать его партнёру не нужно. Кому предложение видно, тот сразу может завести
по нему ссылку или промокод.

Если закрыть доступ партнёру, который уже раздал ссылки и промокоды, они
перестают работать на него:

- переход по его ссылке ведёт клиента на страницу предложения, но не
  засчитывается партнёру;
- заявки клиентов, пришедших по его ссылкам и промокодам, приходят без
  партнёра, и вознаграждение за них не начисляется. Если интеграция сама
  указывает партнёра или его ссылку, заявка [отклоняется](https://docs.agenum.ru/api/lead/#если-у-партнёра-нет-доступа-к-предложению);
- по заявкам, пришедшим раньше, начисления ставятся как обычно.

Вернёте доступ — новые заявки снова записываются на партнёра. Заявки,
пришедшие без доступа, остаются без партнёра. Так же действует
[блокировка партнёра](https://docs.agenum.ru/admin/partner/#как-заблокировать-партнёра).

Заблокированных партнёров в окне выбора нет, и среди уже выбранных они не
показываются. При этом настройка не теряется: если заблокированный партнёр был в
списке, после разблокировки условие доступа снова действует на него как прежде.

## Как настроить вознаграждение

Блок **Вознаграждение** держит список условий: по какому статусу лида, кому и
сколько платить. Кнопка **Редактор условий** открывает окно, где для каждого
условия задаются:

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

Кнопка **Добавить условие** заводит ещё одно условие — их можно завести
сколько угодно, например разные проценты для разных статусов лида. Статус
лида обязателен в каждом условии: условия «за любой статус» нет. Если
партнёру подходят несколько условий, какое из них сработает — описано в
[шаблонах вознаграждений](https://docs.agenum.ru/admin/settings/award-templates/#какое-условие-сработает-если-партнёру-подходят-несколько).

Если после сохранения у партнёра изменилось вознаграждение, ему придёт
уведомление «Изменились условия вознаграждения» со ссылкой на предложение.
Получат его только те, кто по предложению уже работает — у кого есть ссылка
или активный промокод, — и только если предложение активно, а не черновик.
Партнёрам, чьё вознаграждение правка не затронула, уведомление не придёт.
На почту оно уходит, только если партнёр сам включил это в настройках.

Готовый набор условий сохраняется кнопкой **Сохранить как новый шаблон** — он
станет доступен другим предложениям. Кнопка **Загрузить условия из шаблона**
в самой форме предложения, наоборот, подставляет условия из уже сохранённого
шаблона вместо ручной настройки.

:::tip
Управление самими шаблонами — на отдельной странице
[«Шаблоны вознаграждений»](https://docs.agenum.ru/admin/settings/award-templates/).
:::

## Удержание вывода вознаграждения

Поле **Удержание (дней)** — сколько дней после сделки партнёр должен ждать,
прежде чем сможет вывести начисленное по этой сделке вознаграждение. При
создании предложения в поле уже стоит значение по умолчанию из
[общих настроек контура](https://docs.agenum.ru/admin/settings/application/) — его можно изменить,
на само предложение оно влияет только в момент сохранения.

**0** — рабочее значение: вознаграждение по такому предложению становится
доступно партнёру сразу после начисления, без удержания. Пустое поле
сохранится так же, как ноль. Максимум — 365 дней.

Отдельный переключатель **Разрешить сделки по предложению без суммы**
позволяет засчитывать целевые действия без указания суммы сделки.

## Читать также

- [Список предложений](https://docs.agenum.ru/admin/offer/)
- [Карточка предложения](https://docs.agenum.ru/admin/offer/view/)
- [Категории предложений](https://docs.agenum.ru/admin/settings/categories/)

---

# Ссылки и промокоды партнёров

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/offer/links-and-promocodes/

> Вкладки «Ссылки» и «Промокоды» карточки предложения — что видно и как завести их из админки.

Обычно партнёрскую ссылку или промокод заводит сам партнёр в своём кабинете.
Но то же самое можно сделать и из [карточки предложения](https://docs.agenum.ru/admin/offer/view/) —
на вкладках **Ссылки** и **Промокоды**.

## Что видно на вкладке «Ссылки»

Таблица со всеми партнёрскими ссылками по этому предложению: название,
идентификатор ссылки, партнёр-владелец, число кликов и уникальных переходов.
Клик по имени партнёра открывает его карточку.

**Клики** — все переходы по ссылке подряд. **Уникальные переходы** — сколько
разных посетителей перешло за день: посетитель узнаётся по IP-адресу и
браузеру, и его повторные клики по этой ссылке в тот же день увеличивают только
число кликов. День меняется в 03:00 по московскому времени. Большой разрыв между
кликами и уникальными переходами — повод присмотреться к трафику партнёра.

Клик — ещё не лид. Лид появляется, только когда клиент оставит данные —
например, заполнит форму на вашем сайте — и ваша система передаст их в Agenum
вместе с меткой перехода через [внешний API](https://docs.agenum.ru/api/lead/#как-привязать-лид-к-партнёру).
Пока этого не происходит, по ссылке будут клики, но не будет лидов.

## Как создать или изменить ссылку из админки

1. На вкладке **Ссылки** нажмите **Создать ссылку**.
2. Выберите **Партнёра** — в списке только те, кому это предложение доступно
   по [настройкам доступа](https://docs.agenum.ru/admin/offer/create/#кому-будет-видно-предложение).
   Заблокированных партнёров в нём нет.
3. Введите **Название ссылки** и нажмите кнопку сохранения.

Кнопка **Изменить** у готовой ссылки открывает то же окно, но партнёра сменить
уже нельзя — правится только название.

**Скрыть** прячет ссылку от партнёра, не удаляя её: статистика остаётся,
действие обратимо кнопкой **Показать**. **Удалить** стирает ссылку
безвозвратно вместе со всей статистикой по ней.

## Что видно на вкладке «Промокоды»

Таблица промокодов по предложению: сам код, статус, отметка, скрыт ли он от
партнёра, вознаграждение по коду и партнёр-владелец.

| Статус | Что значит |
|---|---|
| На проверке | код создан и ждёт решения — партнёру его ещё не показывают |
| Активен | код работает, заявки по нему засчитываются партнёру |
| Неактивен | код отключён и не работает |

Если у промокода нет собственного вознаграждения, в таблице показывается
вознаграждение предложения по умолчанию.

## Как создать или изменить промокод из админки

1. На вкладке **Промокоды** нажмите **Создать промокод**.
2. Выберите **Партнёра** — как и со ссылками, в списке только партнёры, которым
   доступно предложение.
3. Введите сам **Промокод** и при необходимости **Бонус** — если оставить
   поле пустым, применится бонус предложения по умолчанию.

При создании из админки промокод сразу становится активным, минуя проверку.

Кнопка **Изменить** у готового промокода меняет вознаграждение — партнёр и
код при редактировании не меняются. Активный промокод можно
**Деактивировать**, а неактивный — **Активировать** обратно. **Скрыть** и
**Удалить** работают так же, как у ссылок: скрытие обратимо и сохраняет
статистику, удаление — нет. Скрытый промокод становится неактивным, и
**Показать** возвращает его в список таким же — чтобы он снова работал, нажмите
**Активировать**.

## Что делать, если создать ссылку или промокод не получается

**Не видно кнопки «Создать ссылку» или «Создать промокод».** Соответствующий
инструмент выключен в [настройках предложения](https://docs.agenum.ru/admin/offer/create/).

**В списке партнёров никого нет или нет нужного.** Предложение закрыто для всех
или для этого партнёра — проверьте
[настройки доступа](https://docs.agenum.ru/admin/offer/create/#кому-будет-видно-предложение).
Заблокированный партнёр в список тоже не попадает.

**Ошибка «Предложение неактивно или недоступно партнёру».** Выдать партнёру
ссылку или промокод можно только по действующему предложению, доступному этому
партнёру. Предложение в черновике, ещё не началось или уже закончилось — либо
партнёр потерял к нему доступ. Та же ошибка приходит на **Активировать** у
промокода и **Показать** у скрытой ссылки, в том числе если партнёр заблокирован;
при создании заблокированному партнёру ответ — «Партнер заблокирован». Показать скрытый
промокод можно и в этом случае: он вернётся в список неактивным.

**Промокод не сохраняется.** Такой код уже занят — коды промокодов уникальны
в пределах контура.

## Читать также

- [Карточка предложения](https://docs.agenum.ru/admin/offer/view/)
- [Список предложений](https://docs.agenum.ru/admin/offer/)
- [Список партнёров](https://docs.agenum.ru/admin/partner/)

---

# Статистика предложения

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/offer/stats/

> Вкладка «Статистика» карточки предложения — воронка по статусам лидов и динамика по датам.

Вкладка **Статистика** на [карточке предложения](https://docs.agenum.ru/admin/offer/view/) —
сводный результат по всем партнёрам, которые работают с этим предложением
через ссылки и промокоды.

## Как читать воронку «Эффективность предложения»

Переключатель наверху блока разделяет результат по инструменту — **Ссылка**
или **Промокод**, у каждого своя воронка.

Для инструмента «Ссылка» первой строкой идут **Переходы** — все клики по
партнёрским ссылкам предложения. Дальше — по одной строке на каждый статус
лида, кроме отменяющих: сколько заявок дошло хотя бы до этого статуса.

Строка статуса показывает не «застряло именно на этом статусе», а «дошло как
минимум досюда»: заявка, продвинувшаяся дальше, продолжает считаться и в
более ранних статусах воронки. Статусы, до которых по предложению ещё не
дошла ни одна заявка, в воронке не показываются.

Отменённые заявки в воронку не попадают ни на одном статусе.

## Как читать график «По времени»

Тот же переключатель инструмента действует и здесь. Ниже — выбор одного или
нескольких статусов (и переходов для ссылок) для отображения на графике:
каждый выбранный статус или переходы рисуются отдельной линией с датой по
горизонтали.

Точка на графике — число уникальных заявок, дошедших до статуса в этот день,
а не число переходов заявок между статусами: если заявка несколько раз
возвращалась в один и тот же статус, она всё равно посчитана один раз.

## Читать также

- [Карточка предложения](https://docs.agenum.ru/admin/offer/view/)
- [Ссылки и промокоды партнёров](https://docs.agenum.ru/admin/offer/links-and-promocodes/)
- [Список лидов](https://docs.agenum.ru/admin/lead/)

---

# Карточка предложения

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/offer/view/

> Вкладки карточки предложения, что на них видно и какие действия доступны.

Карточка предложения открывается кликом по названию из
[списка предложений](https://ваш-контур.agenum.ru/admin/offer). Наверху — четыре
вкладки: **Данные предложения**, **Промокоды**, **Ссылки** и **Статистика**.

## Что видно на вкладке «Данные предложения»

Здесь собраны все условия предложения в том виде, в каком их задали при
создании: название, ссылка, описание, **Удержание вывода вознаграждения
(дней)**, включённые инструменты, категории, материалы, период действия,
настройки доступа и условия вознаграждения.

Ноль в строке удержания — не «не заполнено», а рабочее значение: вознаграждение
по такому предложению доступно партнёру сразу после начисления. Изменить
удержание можно только [в форме редактирования](https://docs.agenum.ru/admin/offer/create/).

Это витрина без редактирования прямо на месте — чтобы что-то изменить,
нажмите **Редактировать** в шапке карточки. Она откроет
[форму редактирования](https://docs.agenum.ru/admin/offer/create/), заполненную текущими данными.

## Как посмотреть партнёров, работающих с предложением

Отдельного списка «все подключённые партнёры» на карточке нет. Партнёров,
которые уже используют предложение, видно на вкладках
[«Ссылки» и «Промокоды»](https://docs.agenum.ru/admin/offer/links-and-promocodes/) — там указано,
кому из партнёров принадлежит каждая ссылка или промокод, а клик по имени
партнёра открывает его карточку.

## Как посмотреть статистику

Вкладка **Статистика** показывает воронку и динамику по датам для всех
партнёров, работающих с предложением сразу. Подробнее — на странице
[«Статистика предложения»](https://docs.agenum.ru/admin/offer/stats/).

## Что делать, если нужно снять предложение с публикации

Отдельной кнопки «Снять с публикации» на карточке нет. Чтобы партнёры
перестали видеть предложение, отредактируйте его и сохраните кнопкой
**Сохранить черновик** — оно вернётся в статус «Черновик». Если вместо этого
у предложения просто прошёл срок действия, оно само уйдёт в статус «Архив».

Удалить предложение можно только из [списка предложений](https://docs.agenum.ru/admin/offer/) — и
только пока по нему не создано ни одной партнёрской ссылки или промокода.

## Читать также

- [Список предложений](https://docs.agenum.ru/admin/offer/)
- [Создание и редактирование предложения](https://docs.agenum.ru/admin/offer/create/)
- [Ссылки и промокоды партнёров](https://docs.agenum.ru/admin/offer/links-and-promocodes/)

---

# Партнёры

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/partner/

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

Партнёр — тот, кто приводит вам клиентов по вашим предложениям и получает за
это вознаграждение. Экран **Партнёры** — общий список всех партнёров контура,
с него начинается работа с каждым из них: посмотреть карточку, изменить
данные, подтвердить, заблокировать или удалить.

## Как найти нужного партнёра

Вверху страницы — строка **Поиск по имени или email**: она ищет по email, имени
и фамилии, запрос отправляется по нажатию **Enter**. Крестик в конце строки
очищает поиск.

Рядом — кнопка **Фильтры**. Она открывает панель с полями, их можно сочетать:

| Фильтр | Что отбирает |
|---|---|
| **Группы** | партнёры, состоящие хотя бы в одной из выбранных групп |
| **Уровни** | партнёры выбранных уровней |
| **Активность** | значение **Активен**, **Неактивен** или **Без лидов** — см. [ниже](https://docs.agenum.ru/admin/partner/#как-понять-активен-ли-партнёр) |
| **Подтверждение** | значение **Подтверждённый** / **Не подтверждённый** |
| **Блокировка** | значение **Заблокированный** / **Не заблокированный** |

В **Активности**, **Подтверждении** и **Блокировке** пункт **Все** снимает
фильтр. Выбранное в панели начинает действовать только после **Применить**;
если закрыть панель без него, изменения пропадут. На кнопке **Фильтры** цифра
показывает, сколько фильтров сейчас действует: три выбранные группы считаются
одним фильтром.

:::tip
Поле **Уровни** появляется, только если в вашем кабинете включены уровни
партнёров.
:::

Под строкой поиска действующие фильтры видны плашками, например
**Группы: Блогеры, VIP**. Крестик на плашке снимает этот фильтр сразу, без
**Применить**. Плашки, которые не уместились в строку, собраны в кнопку **+N** —
по ней открывается список остальных. **Сбросить всё** рядом с плашками (и такая
же кнопка в панели фильтров) снимает все фильтры разом; поиск и сортировка
остаются.

Справа от фильтров — порядок списка: **Сначала новые**, **Сначала старые**,
**По имени, А–Я**, **По имени, Я–А**, **Больше лидов**, **Меньше лидов**,
**Недавний последний лид**, **Давний последний лид**. В двух последних партнёры
без лидов всегда в конце.

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

Это единственный экран, где видны заблокированные партнёры. Чтобы оставить только
их, выберите в фильтре **Блокировка** значение **Заблокированный**.

## Что видно в карточке партнёра

Каждая карточка списка показывает:

- имя партнёра (или email, если имя не заполнено) — ссылка на карточку;
- строку **Лиды**, если партнёр уже привёл хотя бы одного лида: по цветному
  значку на каждый статус, в котором есть лиды. Цвет — цвет статуса, число —
  сколько лидов в нём; название статуса видно при наведении. Значки идут в том
  же порядке, что и [статусы лидов](https://docs.agenum.ru/admin/settings/lead-statuses/), большие
  числа сокращаются: 1.2K, 1M;
- строку **Активность** — состояние и дату последнего лида;
- группы, в которых состоит партнёр;
- дату последней активности и дату регистрации.

Зелёная точка перед именем значит, что партнёр прямо сейчас в своём кабинете.

В виде таблицы те же данные разложены по колонкам. Колонка **Создан** по
умолчанию скрыта — включите её кнопкой настройки колонок в правом конце шапки
таблицы. Там же можно скрыть любую другую колонку, кроме имени.

## Как понять, активен ли партнёр

Активность — это лидогенерация: приводит ли партнёр новых клиентов.

| Активность | Что значит |
|---|---|
| **Активен** | за последние 30 дней на партнёра пришёл хотя бы один новый лид |
| **Неактивен** | лиды были, но последний — больше 30 дней назад |
| **Без лидов** | лидов не было ни разу — например, партнёр только зарегистрировался |

Считаются только **новые** лиды: смена статуса уже созданного лида активность не
продлевает. Удалённый лид её не отменяет. Если партнёр потерял доступ к
предложению, лид по его ссылке или промокоду приходит без партнёра и его
активность тоже не продлевает. Подсказка с этим описанием появляется при
наведении на заголовок колонки **Активность**.

**Последняя активность** — другое: когда партнёр последний раз был в своём
кабинете. Она показывает, заходит ли партнёр, а не приводит ли клиентов.

:::tip
Активность не влияет на лимит партнёров по тарифу: неактивный партнёр и партнёр
без лидов занимают место так же, как активный. Место освобождает только
[блокировка](https://docs.agenum.ru/admin/partner/#как-заблокировать-партнёра).
:::

## Как принять заявку от партнёра

Столбец **Подтверждение** отмечает, подтвердили ли вы партнёра — допустили к
выплатам. Подтверждение почты самим партнёром здесь не учитывается, оно видно
в карточке. Сама
кнопка **Подтвердить** / **Отменить** находится не в списке, а на
[карточке партнёра](https://docs.agenum.ru/admin/partner/view/) — откройте партнёра и переключите
там.

## Как заблокировать партнёра

1. У нужной карточки откройте меню действий (кнопка ⋮).
2. Нажмите **Заблокировать**.
3. Подтвердите действие.

Заблокированный партнёр не сможет войти в свой кабинет. Ссылка для входа,
отправленная ему до блокировки, тоже перестанет работать. Чтобы вернуть доступ,
откройте то же меню и нажмите **Разблокировать**.

Блокировка закрывает партнёру все предложения. Переходы по его ссылкам не
засчитываются, а новые заявки клиентов по его ссылкам и промокодам приходят без
партнёра.
По заявкам, пришедшим до блокировки, начисления ставятся как обычно. После
разблокировки новые заявки снова записываются на партнёра.

Заблокированный партнёр пропадает из выбора партнёров во всех остальных разделах:
в фильтрах лидов и актов, при создании выплаты, ссылки или промокода, в доступе к
предложению и условиях вознаграждения. Его лиды, выплаты и акты никуда не
деваются, а [карточка](https://docs.agenum.ru/admin/partner/view/) открывается по ссылке из них.
Если партнёр был указан в доступе к предложению или в условии вознаграждения, эта
настройка сохраняется и снова действует после разблокировки.

:::tip
Если на вашем тарифе ограничено число партнёров, заблокированные в лимит не
входят. Поэтому разблокировать партнёра не получится, если лимит уже занят
остальными.
:::

Там же, в меню действий, — **Редактировать** (открывает
[форму редактирования](https://docs.agenum.ru/admin/partner/create/)). Карточка партнёра открывается
кликом по его имени.

## Как удалить партнёра

1. Отметьте партнёров в списке.
2. В появившейся панели нажмите **Удалить**.
3. Подтвердите действие.

Удалить можно только партнёров, у которых ещё ничего нет: лидов, ссылок,
промокодов, выплат и актов. Если среди отмеченных есть хотя бы один такой, не
удалится никто — появится сообщение, у скольких из выбранных есть связанные
данные. Таких партнёров [блокируйте](https://docs.agenum.ru/admin/partner/#как-заблокировать-партнёра): история по ним
сохранится, а в остальных разделах они перестанут попадаться на глаза.

## Как выгрузить партнёров в файл

Список можно скачать таблицей CSV — она открывается двойным кликом в Excel.
Выгружать можно двумя способами:

| Что выгрузить | Где нажать |
|---|---|
| Всех партнёров, которых сейчас видно в списке | кнопка со стрелкой вниз справа в строке поиска, рядом с переключателем вида |
| Только отмеченных | отметьте партнёров, в появившейся панели нажмите **Экспорт** → **Выбранные** |

Выгрузка всех учитывает поиск, фильтры и сортировку: в файл попадут ровно те
партнёры, что в списке, в том же порядке, включая заблокированных, если они
видны. Панель массовых действий предлагает то же самое пунктом **Все** — рядом
с ним указано, сколько партнёров попадёт в файл. Пункт **Выбранные** берёт
только отмеченных партнёров, даже если с тех пор вы сменили фильтры.

Пока файл готовится, на кнопке крутится индикатор. Файл называется по дате
выгрузки, например `partners-2026-10-22.csv`.

В файле по строке на партнёра и такие столбцы:

- **ID**, **Фамилия**, **Имя**, **Отчество**, **Email**, **Юр. статус**;
- **Уровень** — если в вашем кабинете включены уровни партнёров;
- **Группы** — через запятую;
- **Лиды всего** и по столбцу на каждый [статус лидов](https://docs.agenum.ru/admin/settings/lead-statuses/) —
  сколько лидов партнёра в этом статусе;
- **Активность** — «Активен», если за последние 30 дней на партнёра пришёл
  новый лид, «Неактивен», если лиды были раньше, и «Без лидов», если их не было;
- **Последний лид** — когда пришёл последний новый лид;
- **Подтверждён**, **Заблокирован** — «Да» или «Нет»;
- **Последняя активность** — когда партнёр последний раз был в личном кабинете;
- **Создан** — дата регистрации.

Даты — со временем, по Москве.

Значения [дополнительных полей партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/) и
реквизиты для выплат в файл не попадают.

:::tip
За один раз можно выгрузить до 10 000 партнёров по фильтрам и до 2000
отмеченных. Если партнёров больше, появится сообщение — сузьте список
фильтрами или выгрузите его частями.
:::

## Как завести нового партнёра

Кнопка **Создать партнёра** в правом верхнем углу страницы открывает
[форму заведения партнёра](https://docs.agenum.ru/admin/partner/create/) — так добавляют партнёра
вручную, без его самостоятельной регистрации.

## Что делать, если партнёр не находится

Проверьте плашки под строкой поиска — фильтры сочетаются друг с другом, и
партнёр может не подходить под одно из условий. Нажмите **Сбросить всё**, затем
очистите поиск крестиком и начните заново.

## Читать также

- [Заведение и редактирование партнёра](https://docs.agenum.ru/admin/partner/create/)
- [Карточка партнёра](https://docs.agenum.ru/admin/partner/view/)
- [Группы партнёров](https://docs.agenum.ru/admin/settings/partner-groups/)

---

# Баланс партнёра

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/partner/balance/

> Вкладка «Баланс» в карточке партнёра — те же три суммы, что партнёр видит у себя, и все движения по его балансу с фильтром по виду.

Вкладка **Баланс** в [карточке партнёра](https://docs.agenum.ru/admin/partner/view/) показывает его
деньги целиком: сколько он может вывести, сколько ждёт и из каких операций это
сложилось. Она нужна, когда партнёр спрашивает «почему у меня столько» — вы
видите ровно то же, что он на своём [экране баланса](https://docs.agenum.ru/partner/balance/), и
говорите с ним одними словами.

Вкладка только для просмотра: изменить баланс или отменить операцию отсюда
нельзя.

## Как открыть баланс партнёра

Откройте партнёра из [списка партнёров](https://ваш-контур.agenum.ru/admin/partner)
и переключитесь на вкладку **Баланс** под его именем. Вкладка **Общее** —
данные, статус и статистика лидов.

## Из чего складывается баланс партнёра

Наверху вкладки — три суммы, подписанные так же, как у партнёра:

| Строка | Что означает |
|---|---|
| **Доступно для вывода** | сумма, которую партнёр может запросить к выплате прямо сейчас |
| **На удержании** | начислено, но срок удержания ещё не прошёл — вывести пока нельзя |
| **Ожидает выплаты** | уже включено в заявки на выплату, которые в работе |

Как только партнёр создаёт заявку, её сумма переходит из **Доступно для
вывода** в **Ожидает выплаты**. Если заявку отклонили или партнёр её отменил,
деньги возвращаются обратно.

## Как посмотреть движения по балансу партнёра

Под суммами — раздел **Движения**: все операции по балансу партнёра, свежие
сверху. Список догружается по мере прокрутки. Сумма в строке со знаком: плюс —
партнёру начислили, минус — списали.

| Операция | Когда появляется |
|---|---|
| **Начисление за лид** | лид дошёл до статуса, за который платят вознаграждение |
| **Отмена начисления** | лид перешёл в статус, отменяющий сделку, или начисление отменили вручную |
| **Резерв под выплату** | партнёр создал заявку на выплату — сумма отложена под неё |
| **Возврат резерва** | заявку отклонили или партнёр её отменил, деньги вернулись |

Сверх того, что видит партнёр, в строке есть подробности для разбора:

- дата и время операции — за день их бывает несколько;
- **В удержании до** с датой — у начисления, которое партнёр ещё не может
  вывести; у отмены такого начисления вместо этого подпись **Отменено
  начисление в удержании**;
- **Заявка №…** — у резерва и возврата, ссылка на
  [заявку на выплату](https://docs.agenum.ru/admin/payout/view/);
- **Карточка лида →** — у начисления и отмены, ссылка на
  [карточку лида](https://docs.agenum.ru/admin/lead/view/), откуда пришли деньги;
- **Автор** — у операций, сделанных вручную: имя сотрудника или название
  API-ключа, если операцию провела ваша система через [внешний API](https://docs.agenum.ru/api/lead/);
- **Комментарий** или, у отмены, **Причина** — если их оставили.

Отмены показаны приглушённо: они объясняют, куда делись деньги, но читать
выписку удобнее с начислений.

## Как найти операции одного вида

Фильтр **Вид движения** над списком оставляет операции только выбранного вида —
например, все **Отмены начисления** или все **Резервы под выплату**. Повторный выбор того
же вида снимает фильтр.

Фильтр сохраняется в адресе страницы: ссылкой с ним можно поделиться с
коллегой.

## Что значит «Отменено X из Y — остальное уже выплачено»

Начисление отменили, когда часть его уже ушла партнёру в выплате. Вернуть
выплаченное отменой нельзя, поэтому отменяется только невыплаченный остаток:
X — сколько отменено, Y — исходная сумма начисления.

## Что делать, если баланс партнёра выглядит не так, как ожидалось

**Суммы не совпадают с тем, что партнёр видит у себя.** Обновите страницу:
обе вкладки считают баланс одинаково, но ваша могла быть открыта до последней
операции.

**Начисление есть, а «Доступно для вывода» не выросло.** Посмотрите на строку
**В удержании до** — пока срок удержания не прошёл, сумма учитывается в **На
удержании**.

**У операции нет ссылки «Карточка лида».** Резервы и их возвраты с лидом не
связаны — ссылка есть только у начислений и их отмен.

## Читать также

- [Карточка партнёра](https://docs.agenum.ru/admin/partner/view/)
- [Баланс в кабинете партнёра](https://docs.agenum.ru/partner/balance/) — что видит сам партнёр
- [Карточка лида](https://docs.agenum.ru/admin/lead/view/) — вознаграждения по одному лиду

---

# Заведение и редактирование партнёра

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/partner/create/

> Как завести партнёра вручную, как он получает доступ в кабинет, что происходит при смене его email, группы и реквизиты выплат.

Обычно партнёры регистрируются сами. Но иногда партнёра нужно завести
вручную — например, если он не может пройти регистрацию сам. Одна и та же
форма используется и для заведения нового партнёра, и для редактирования уже
существующего.

## Как завести партнёра вручную

1. В списке [Партнёры](https://ваш-контур.agenum.ru/admin/partner) нажмите
   **Создать партнёра**.
2. Заполните **Email** — на него партнёру придёт письмо со ссылкой для входа.
3. При необходимости заполните **Имя**, **Отчество** и **Фамилию**.
4. Выберите хотя бы одну **Группу** — без группы партнёра не сохранить.
5. Выберите **Юридический статус** и заполните поля, которые появятся под
   ним — их набор зависит от выбранного статуса.
6. Нажмите **Сохранить**.

:::tip
Юридический статус и его дополнительные поля настраиваются заранее на
странице [Поля и юридические типы партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/).
:::

## Как партнёр, заведённый вручную, попадает в кабинет

Пароль партнёру вы не задаёте и не знаете — его задаёт только сам партнёр.
После сохранения ему на почту приходит письмо со ссылкой: по ней он
придумывает пароль и сразу попадает в кабинет. Ссылка действует 72 часа и
срабатывает один раз.

Пока партнёр не перешёл по ссылке, войти в кабинет он не может. В
[карточке партнёра](https://docs.agenum.ru/admin/partner/view/) в строке **Пароль** при этом видно
**Не задан — партнёр ещё не входил**.

Если ссылка истекла или письмо потерялось, отправьте новую кнопкой
**Отправить приглашение повторно** в карточке партнёра. Партнёр может и сам задать
пароль через [восстановление](https://docs.agenum.ru/partner/registration/) на странице входа.

Когда партнёр уже задал пароль, кнопки больше нет: сбросить пароль за партнёра
нельзя. Забытый пароль он восстановит сам — код придёт на его подтверждённую
почту.

:::tip[Почему пароль не задаёт компания]
Пароль знает только партнёр — значит, всё, что сделано в его кабинете, сделал
он сам. Если бы пароль знала компания, это было бы не доказать.
:::

## Как отредактировать данные партнёра

Откройте [карточку партнёра](https://docs.agenum.ru/admin/partner/view/) и нажмите
**Редактировать** — откроется та же форма, уже заполненная текущими данными.
Измените нужные поля и нажмите **Сохранить**.

Пароля в форме нет: если партнёр его забыл, отправьте ему новую ссылку для
входа из [карточки](https://docs.agenum.ru/admin/partner/view/) или подскажите
[восстановить пароль](https://docs.agenum.ru/partner/registration/) самому.

## Что происходит при смене email партнёра

Обычно email меняет сам партнёр в своём профиле. Менять его в форме нужно,
только когда партнёр потерял доступ к почте и не может войти. Перед этим
убедитесь, что к вам обратился именно партнёр: новый адрес получит доступ к
его кабинету.

После сохранения нового email:

- партнёра выбросит из кабинета на всех устройствах;
- на новый адрес придёт письмо со ссылкой для входа — по ней партнёр задаст
  пароль;
- на старый адрес придёт уведомление, что почту аккаунта сменил
  администратор;
- почта партнёра станет неподтверждённой: ссылка из письма подтвердит её
  заново;
- в карточке партнёра в строке **Email изменён администратором** появится
  эта смена — с датой и вашим именем. Если потом партнёр подпишет акт
  электронной подписью, окно подписи предупредит, что перед подписью email
  менял администратор.

Если письмо на новый адрес не ушло, форма сообщит об этом. Партнёр может
восстановить пароль на новый адрес сам на странице входа.

## Какой юридический статус выбрать

Юридический статус определяет, какие дополнительные поля нужно заполнить —
например, для самозанятого и для юридического лица они разные. Полный список
статусов и их полей — на странице
[Поля и юридические типы партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/).

## Как заполнить реквизиты выплат за партнёра

Блок **Реквизиты выплат** есть только при редактировании: у нового партнёра их
негде хранить, пока он не создан.

Обычно реквизиты указывает сам партнёр в своём кабинете. Но нередко компания
знает их и без него — тогда нажмите **Заполнить реквизиты**, выберите способ и
введите значения. Сохраняются они **отдельной кнопкой** — **Сохранить
реквизиты**, а не общей кнопкой формы.

Сохранённые реквизиты показаны не целиком: у номера счёта и телефона видны
только последние цифры. Чтобы изменить их, придётся ввести значение заново —
подставить скрытое в поле нельзя.

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

## Какие группы можно выбрать

Поле **Группы** — множественный выбор, партнёр может состоять сразу в
нескольких. Группы определяют, какие предложения партнёр увидит в своём
кабинете и по какой ставке ему начислится вознаграждение — подробнее на
странице [Группы партнёров](https://docs.agenum.ru/admin/settings/partner-groups/).

## Что делать, если форма не сохраняется

**Не выбрана группа.** Без хотя бы одной группы партнёра не сохранить —
добавьте одну в поле **Группы**.

**Партнёр с таким email уже есть.** Email должен быть уникальным в пределах
контура — проверьте, не заведён ли уже такой партнёр, через
[поиск в списке](https://docs.agenum.ru/admin/partner/).

**«Номер счёта не соответствует БИК».** В номере счёта или в БИК опечатка: счёт
содержит контрольную цифру, которая считается вместе с БИК. Сверьте оба
значения с реквизитами из банка и проверьте, что счёт рублёвый.

**«Пока есть активная заявка на выплату, реквизиты менять нельзя».** Сначала
закройте заявку на [карточке выплаты](https://docs.agenum.ru/admin/payout/view/).

**«Партнёр создан, но приглашение не ушло».** Партнёр сохранён, но письмо до
него не дошло. Отправьте его из [карточки партнёра](https://docs.agenum.ru/admin/partner/view/)
кнопкой **Отправить приглашение повторно**.

**«Email изменён, но письмо со ссылкой для входа не ушло».** Новый адрес
сохранён, а ссылка на него — нет. Партнёр может восстановить пароль на новый
адрес сам, на странице входа.

## Читать также

- [Список партнёров](https://docs.agenum.ru/admin/partner/)
- [Карточка партнёра](https://docs.agenum.ru/admin/partner/view/)
- [Группы партнёров](https://docs.agenum.ru/admin/settings/partner-groups/)

---

# Карточка партнёра

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/partner/view/

> Что видно в карточке партнёра — данные, статус, статистика лидов — как подтвердить партнёра и отправить ему приглашение повторно.

Карточка партнёра — страница одного партнёра: его данные, текущий статус и
статистика по лидам, которых он привёл. Открывается из
[списка партнёров](https://ваш-контур.agenum.ru/admin/partner) кликом по имени
партнёра. Карточка заблокированного партнёра тоже открывается — например, по
ссылке из его лида, выплаты или акта, хотя в выборе партнёров в этих разделах его
уже нет.

Под именем партнёра — две вкладки: **Общее** (всё, что описано ниже) и
**Баланс** — его деньги и движения по балансу, см.
[баланс партнёра](https://docs.agenum.ru/admin/partner/balance/).

## Что показано в карточке

**Данные партнёра** — email, ФИО, группы и юридический статус.

**Статус** — подтверждён ли партнёр, подтвердил ли он почту, задал ли пароль,
заблокирован ли, его активность — **Активен**, **Неактивен** или **Без лидов**
вместе с датой последнего лида (что это значит — в разделе
[Партнёры](https://docs.agenum.ru/admin/partner/#как-понять-активен-ли-партнёр)), последняя активность —
когда партнёр был в своём кабинете, или **Сейчас в кабинете**, если он там прямо
сейчас, — дата создания и последнего обновления записи. Если email партнёра когда-либо менял
администратор, здесь же видна строка **Email изменён администратором** — все
такие смены, новые сверху, с датой и именем администратора. История не
стирается: по ней видно, менялся ли адрес перед тем, как партнёр
[подписал акт](https://docs.agenum.ru/admin/payout/acts/) электронной подписью.

**Реквизиты выплат** — куда партнёру переводить вознаграждение. Номер счёта и
телефон показаны не целиком: видны только последние цифры. Полностью их можно
раскрыть на [карточке заявки на выплату](https://docs.agenum.ru/admin/payout/view/) — там, где по ним
и платят, и только с соответствующим правом.

**Статистика лидов** — сколько лидов партнёр привёл, в разбивке по статусам
заявки. Статусы перечислены в том же порядке, что на странице
[статусов лидов](https://docs.agenum.ru/admin/settings/lead-statuses/); статусы без лидов не
показываются.

## Как подтвердить партнёра

В блоке **Статус**, в строке **Подтверждён**, нажмите **Подтвердить**.
Партнёр станет подтверждённым сразу, без дополнительных проверок. Отменить
подтверждение можно там же кнопкой **Отменить**.

Подтверждение — ваше решение допустить партнёра к выплатам. С почтой оно не
связано: строка **Почта подтверждена** показывает, подтвердил ли партнёр свой
email сам — кодом из письма или переходом по ссылке. Чтобы запросить выплату,
партнёру нужно и то и другое.

## Как отправить партнёру приглашение повторно

Пароль партнёра вы не видите и не меняете. Если вы завели партнёра сами, а он
не успел воспользоваться приглашением — письмо потерялось или ссылка истекла, —
в строке **Пароль** нажмите **Отправить приглашение повторно**. Партнёру на
текущий email придёт новое письмо: по ссылке он задаст пароль и сразу войдёт в
кабинет.

- Ссылка действует 72 часа и срабатывает один раз.
- Новое приглашение отменяет предыдущее — работает только последнее письмо.
- Повторно отправить можно через минуту.
- Заблокированному партнёру приглашение не отправить — кнопки у него нет.

Кнопка есть, только пока партнёр ещё не задал пароль. Если пароль задан, а
партнёр его забыл, он восстановит его сам на
[странице входа](https://docs.agenum.ru/partner/registration/): код придёт на ту же почту, куда
ушло бы и ваше письмо.

Если у партнёра больше нет доступа к почте, смените ему email — см.
[смену email партнёра](https://docs.agenum.ru/admin/partner/create/).

## Как изменить данные партнёра

Кнопка **Редактировать** наверху страницы открывает
[форму редактирования](https://docs.agenum.ru/admin/partner/create/) — там же меняются группы,
юридический статус и реквизиты выплат.

## Что делать, если данные не совпадают с ожидаемыми

**Статистика лидов пустая.** Партнёр ещё не привёл ни одного лида — как
только появится первая заявка, она попадёт в статистику.

**В статистике строка «Неизвестный статус».** Статус лидов добавили, пока
карточка была открыта, — в другой вкладке или другой администратор. Обновите
страницу, и появится его название.

**В строке «Пароль» — «Не задан».** Партнёра завели вручную, и он ещё не
перешёл по ссылке из приглашения. Если письмо потерялось, отправьте
приглашение повторно.

**Партнёр просит сбросить ему пароль.** Если пароль у него уже задан, сбросить
его вы не можете — кнопки для этого нет. Подскажите партнёру восстановить
пароль самому на странице входа.

**Партнёр подтверждён, но выплату запросить не может.** Проверьте строку
**Почта подтверждена**: без подтверждённой почты заявку не создать. Партнёр
подтверждает её сам в своём [профиле](https://docs.agenum.ru/partner/profile/).

## Читать также

- [Список партнёров](https://docs.agenum.ru/admin/partner/)
- [Заведение и редактирование партнёра](https://docs.agenum.ru/admin/partner/create/)
- [Баланс партнёра](https://docs.agenum.ru/admin/partner/balance/) — деньги и движения по балансу
- [Карточка выплаты](https://docs.agenum.ru/admin/payout/view/) — где реквизиты раскрываются целиком

---

# Выплаты

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/payout/

> Список заявок на выплату партнёрам — статусы, фильтр по статусу и переход к карточке заявки.

Экран **Выплаты** — все заявки на выплату партнёрам вашего контура: и те, что
партнёр создал сам из своего кабинета, и те, что вы завели вручную.

## Что видно в списке

Каждая заявка — отдельная карточка:

| Поле | Что означает |
|---|---|
| Сумма выплаты | сколько партнёр получит — в рублях и копейках, например `1 500,00 ₽` |
| Статус | на каком этапе заявка |
| Партнёр | кому предназначена выплата |
| Дата создания | когда заявка появилась |
| Дата обработки | когда по ней приняли решение (пусто для новых заявок) |

Клик по карточке открывает [карточку выплаты](https://docs.agenum.ru/admin/payout/view/) — там же
принимают решение по заявке, а на вкладке **История** видно, кто его принял.

## Как отфильтровать выплаты по статусу

В выпадающем списке **Статус** отметьте один или несколько статусов — список
покажет только заявки в них. Без фильтра видны заявки во всех статусах.

## Что означает статус выплаты

| Статус | Что значит |
|---|---|
| Запрошена | заявка создана и ждёт решения |
| Одобрена | одобрена, ждёт отметки об отправке денег |
| Выплачена | деньги отправлены партнёру, заявка закрыта |
| Отклонена | отклонена на этапе «Запрошена» или «Одобрена» |
| Отменена | партнёр сам отменил заявку, пока она ещё рассматривалась |

:::tip
У партнёра может быть только одна активная заявка одновременно — в статусе
«Запрошена» или «Одобрена». Пока она не закрыта решением, новую он создать не
сможет ни сам, ни вы.
:::

## Как создать выплату вручную

Нажмите **Создать** в шапке страницы — откроется
[создание выплаты](https://docs.agenum.ru/admin/payout/create/).

## Где найти акты по выплатам

Если в контуре включён выпуск актов, акт по каждой выплате виден в её
[карточке](https://docs.agenum.ru/admin/payout/view/), а все акты разом — в разделе [Акты](https://docs.agenum.ru/admin/payout/acts/).

## Читать также

- [Создание выплаты](https://docs.agenum.ru/admin/payout/create/)
- [Карточка выплаты](https://docs.agenum.ru/admin/payout/view/)
- [Выплаты во внешнем API](https://docs.agenum.ru/api/payout/) — как эти же статусы выглядят в интеграции

---

# Акты

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/payout/acts/

> Все акты по выплатам партнёрам — как найти нужный, скачать PDF, посмотреть электронную подпись партнёра или отметить, что акт подписан вне Agenum.

Раздел [Акты](https://ваш-контур.agenum.ru/admin/act) — все акты, выпущенные по
выплатам партнёрам. Акт выпускается сам, когда заявку переводят в
«Выплачена», поэтому отдельно создавать его здесь не нужно: раздел служит для
поиска, скачивания и подписания.

:::tip
Раздел появляется в меню, только если в [общих настройках контура](https://docs.agenum.ru/admin/settings/application/)
включён переключатель **Выпускать акты по выплатам**.
:::

## Кому выпускается акт

Акт выпускается при выплате самозанятому, ИП или юрлицу — тем, кто сам
отчитывается о доходе. Физлицу без статуса акт не выпускается: выплата
проходит как обычно, просто без документа.

В акте — реквизиты вашей организации, данные партнёра, строки по предложениям
с числом лидов и суммой, сумма прописью и строка-основание. Список лидов с
датами и суммами — в приложении к акту. Персональные данные клиентов, которых
привёл партнёр, в акт не попадают.

Основание — загруженная [оферта партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/):
та редакция, которую партнёр принял до выплаты. Если он не принимал ни одной,
— редакция, действовавшая в день выплаты. Пока оферты нет, основанием служит
текст из [реквизитов организации](https://docs.agenum.ru/admin/settings/organization-requisites/).

## Что видно в списке актов

Каждый акт — карточка с заголовком **Акт №…: сумма**. Рядом с заголовком —
состояние подписи:

| Отметка | Что означает |
|---|---|
| **Не подписан** | акт ещё никто не подписал |
| **Подписан партнёром ПЭП** | партнёр подписал акт в своём кабинете простой электронной подписью |
| **Подписан вне платформы** | акт подписали на бумаге или в другой системе, а вы отметили это здесь |

| Поле | Что означает |
|---|---|
| Партнёр | ссылка на карточку партнёра |
| Заявка | ссылка на [карточку выплаты](https://docs.agenum.ru/admin/payout/view/), по которой выпущен акт |
| Дата акта | когда акт выпущен |
| Подписан партнёром | когда партнёр подписал акт электронной подписью — только у таких актов |
| Отметку поставил | кто и когда отметил акт подписанным вне платформы — сотрудник или API-ключ вашей внешней системы; только у таких актов |

Пустой список с надписью **Актов пока нет** значит, что ни одной выплаты с
актом в контуре ещё не было.

## Как найти нужный акт

Над списком три фильтра:

- **Партнёр** — акты одного партнёра, с поиском по списку.
- **Год** — номера актов идут заново каждый год, и номер `2026-17` однозначен
  только вместе с годом.
- **Подписание** — **Подписан** или **Не подписан**. «Подписан» включает оба
  способа: электронную подпись партнёра и отметку о подписании вне платформы.
  Удобно, чтобы собрать акты, по которым ещё ждёте подпись.

**Сбросить** снимает все фильтры.

## Как скачать акт

Нажмите **Скачать PDF** на карточке акта. Тот же файл можно скачать из
[карточки выплаты](https://docs.agenum.ru/admin/payout/view/), и тот же видит партнёр в своём
кабинете — файл не меняется после выпуска.

## Как партнёр подписывает акт электронной подписью

Партнёр может подписать акт сам, в разделе **Мои акты** своего кабинета: он
открывает акт, получает на почту одноразовый код и вводит его. Вам ничего
делать не нужно — карточка акта сама получит отметку **Подписан партнёром ПЭП**.

Подписать акт в кабинете партнёр может, только если действующая редакция
[оферты партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/) содержит
соглашение о простой электронной подписи, вы отметили это при загрузке, а
партнёр эту редакцию принял. Ещё нужна подтверждённая почта: на неё приходит
код. Как это видит партнёр — [Мои акты](https://docs.agenum.ru/partner/acts/).

Ваша сторона в кабинете акт не подписывает. Акт, выпущенный в Agenum, считается
подписанным вашей организацией с момента выпуска — если это записано в оферте.
Текст такого пункта — в разделе
[о соглашении о ПЭП](https://docs.agenum.ru/admin/settings/program-offer/#как-включить-в-оферту-соглашение-о-простой-электронной-подписи).

## Как посмотреть электронную подпись партнёра

Нажмите **Подпись партнёра** на карточке акта. В окне — всё, что доказывает
подпись:

| Строка | Что означает |
|---|---|
| Подписан | дата и время подписи |
| Подписант | кто подписал. У самозанятого и ИП — сам партнёр, у юрлица — человек, которого партнёр назвал при подписании |
| Должность, Основание полномочий | только у юрлица: должность подписанта и документ, по которому он подписывает (устав, доверенность) |
| Код отправлен на | адрес почты, на который ушёл код подписи |
| Почта подтверждена | когда партнёр подтвердил этот адрес |
| Пароль задан партнёром | когда партнёр последний раз сам задал пароль |
| Соглашение о подписи | редакция оферты с соглашением о ПЭП и когда партнёр её принял |
| Отпечаток файла (SHA-256) | контрольная сумма подписанного PDF — по ней видно, что подписан именно этот файл |

Подпись не меняется и не удаляется — ни вами, ни партнёром. PDF акта после
подписи остаётся тем же файлом.

:::caution
Если до подписи администратор менял партнёру email, окно предупредит об этом:
ссылку для входа и код подписи получает тот, у кого доступ к новому адресу.
Поэтому email партнёра меняют только по его обращению — см.
[смену email партнёра](https://docs.agenum.ru/admin/partner/create/). Все такие смены видны в
[карточке партнёра](https://docs.agenum.ru/admin/partner/view/).
:::

## Как отметить, что акт подписан вне платформы

Если акт подписали на бумаге или в системе электронного документооборота,
здесь отмечают сам факт.

1. Нажмите **Отметить подписанным** на карточке акта.
2. Подтвердите в окне **Отметить акт подписанным?** кнопкой **Отметить**.

Карточка получит отметку **Подписан вне платформы**, а в поле **Отметку
поставил** — ваше имя и время. Партнёр увидит в своём кабинете, что акт
подписан, и подписать его электронной подписью уже не сможет.

Ошиблись — нажмите **Снять отметку о подписании** и подтвердите **Снять
отметку**: акт снова будет числиться неподписанным.

Акт, который партнёр подписал электронной подписью, отметить вне платформы
нельзя: кнопки отметки на нём нет, вместо неё — **Подпись партнёра**. Если
партнёр подписал акт, пока вы ставили отметку, отметка не сохранится, и
появится сообщение, что акт уже подписан партнёром.

## Что делать, если акта нет или он с ошибкой

**Выплата есть, а акта в списке нет.** Откройте [карточку выплаты](https://docs.agenum.ru/admin/payout/view/):
блок **Акт** объясняет, почему акт не выпущен, и даёт кнопку **Выпустить акт**,
когда причина устранена.

**В акте неверные реквизиты организации.** Выпущенный акт не меняется — он
фиксирует данные на момент выпуска. Исправьте [реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/):
новые попадут в следующие акты. Аннулировать уже выпущенный акт в Agenum
нельзя.

## Читать также

- [Карточка выплаты](https://docs.agenum.ru/admin/payout/view/) — акт по конкретной заявке и выпуск, если он не получился сразу
- [Реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) — что печатается в акте от вашей стороны
- [Оферта партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/) — основание акта и соглашение об электронной подписи

---

# Создание выплаты

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/payout/create/

> Как создать выплату партнёру вручную — выбор партнёра и суммы, откуда берётся доступный остаток и что происходит после сохранения.

Партнёр обычно запрашивает выплату сам из своего кабинета. Экран
**Создание выплаты** нужен, когда деньги нужно отправить без его запроса —
например, по договорённости вне кабинета.

## Как создать выплату

1. В списке [Выплаты](https://ваш-контур.agenum.ru/admin/payout) нажмите **Создать**.
2. В поле **Партнеры** выберите партнёра.
3. Проверьте **Сумма, ₽** — по умолчанию подставляется минимальная сумма
   выплаты, разрешённая в контуре. Сумма вводится в рублях; копейки отделяйте
   точкой: `1500.50`.
4. При необходимости заполните **Комментарий к заявке**.
5. Нажмите **Создать**.

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

:::tip
Минимальная сумма выплаты настраивается в
[общих настройках контура](https://docs.agenum.ru/admin/settings/application/).
:::

## Откуда берётся сумма выплаты

Указать можно не больше, чем партнёру доступно для вывода: это вызревшие
начисления за вычетом уже выплаченных и ожидающих решения заявок. Если ввести
сумму больше доступной, сохранить не получится — появится сообщение с точным
доступным остатком.

Заблокированному партнёру создать выплату нельзя — в списке выбора его нет.

## Что происходит после сохранения

Заявка появляется в [списке выплат](https://docs.agenum.ru/admin/payout/) со статусом «Запрошена» —
так же, как если бы её создал сам партнёр. Дальше её нужно одобрить или
отклонить на [карточке выплаты](https://docs.agenum.ru/admin/payout/view/).

Пока у партнёра есть такая незакрытая заявка, создать ему ещё одну нельзя — ни
вам, ни ему самому из кабинета.

## Что делать, если не получается создать выплату

**«Партнер заблокирован».** Заблокированному партнёру выплаты не создаются —
сначала снимите блокировку в [списке партнёров](https://docs.agenum.ru/admin/partner/#как-заблокировать-партнёра).

**«Уже есть активная заявка на выплату».** У партнёра уже есть незакрытая
заявка в статусе «Запрошена» или «Одобрена» — дождитесь решения по ней или
откройте её и отклоните.

**Сообщение с доступной суммой вывода.** Введённая сумма больше того, что
партнёру сейчас доступно — уменьшите сумму или дождитесь новых начислений.

**Сообщение про реквизиты выплаты.** У партнёра не указано, куда переводить
деньги. Заполните реквизиты в его карточке или попросите сделать это его
самого. Если реквизиты вам не нужны вовсе, выключите **Требовать реквизиты для
выплат** в [общих настройках контура](https://docs.agenum.ru/admin/settings/application/).

**Сообщение про ИНН.** У партнёра не заполнен ИНН или в нём опечатка. Откройте
его карточку и впишите корректное значение: у физлица, самозанятого и ИП ИНН
состоит из 12 цифр, у юридического лица — из 10. Если ИНН вам не нужен вовсе,
выключите **Требовать ИНН для выплат** в
[общих настройках контура](https://docs.agenum.ru/admin/settings/application/).

**«Для акта по выплате у партнёра нужен корректный ИНН…».** В контуре включён
выпуск актов, а у самозанятого, ИП или юрлица ИНН не заполнен или не подходит
его статусу. ИНН печатается в акте, поэтому переключатель **Требовать ИНН для
выплат** здесь не помогает — впишите ИНН в карточке партнёра.

## Читать также

- [Список выплат](https://docs.agenum.ru/admin/payout/)
- [Карточка выплаты](https://docs.agenum.ru/admin/payout/view/)
- [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/)

---

# Карточка выплаты

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/payout/view/

> Что видно в заявке на выплату, как её одобрить, отклонить или отметить выплаченной, где взять акт по ней и посмотреть историю решений.

Карточка одной заявки на выплату открывается кликом по строке в
[списке выплат](https://ваш-контур.agenum.ru/admin/payout). Наверху две вкладки:
**Общее** и **История**.

## Что видно в карточке

| Поле | Что означает |
|---|---|
| Сумма выплаты | сколько получит партнёр — в рублях и копейках, например `1 500,00 ₽` |
| Статус | на каком этапе заявка |
| Партнёр | ссылка на карточку партнёра |
| Комментарий партнера | комментарий, который партнёр оставил при создании или отмене заявки |
| Комментарий админа | комментарий, оставленный при последнем решении по заявке |
| Дата создания | когда заявка появилась |
| Дата обновления | когда заявку в последний раз меняли |
| Дата выплаты | когда деньги отправили (пусто, пока не выплачена) |

Прочерк в поле означает, что оно не заполнено.

## Где посмотреть реквизиты и как увидеть их целиком

Блок **Реквизиты выплаты** показывает, куда переводить деньги: способ выплаты,
имя получателя и БИК банка — целиком, а номер счёта и телефон — только
последними цифрами. Рядом — ИНН партнёра на момент подачи заявки.

Это **снимок**, сделанный в момент создания заявки. Если партнёр потом изменил
реквизиты в своём кабинете, здесь останутся прежние — те, по которым заявка и
должна быть оплачена. Пока заявка не закрыта, менять реквизиты партнёру нельзя.

Кнопка **Показать реквизиты полностью** раскрывает номер счёта или телефон.
Она видна не всем: это отдельное право, которое назначается роли в
[настройках ролей](https://docs.agenum.ru/admin/settings/roles/) независимо от права оплачивать
заявки. Каждое раскрытие записывается в журнал контура — видно, кто и по какой
заявке смотрел.

:::tip
Полный номер счёта нужен только в момент перевода. Если вы сверяете заявку, а
не платите по ней, последних цифр обычно достаточно.
:::

## Как одобрить, отклонить или отметить выплату выполненной

Набор действий зависит от текущего статуса заявки:

- **Запрошена** — доступны **Отклонить** и **Одобрить**.
- **Одобрена** — доступны **Отклонить** и **Оплатить**.
- **Выплачена**, **Отклонена** или **Отменена** — решение уже принято, кнопок
  нет.

**Оплатить** ставит заявке статус «Выплачена» и фиксирует дату выплаты — эту
кнопку нажимают, когда деньги партнёру уже отправлены, а не как обещание
отправить их.

Если кнопка недоступна и при наведении показано «У вас нет прав на это
действие» — это действие не входит в ваши права в этом контуре.

## Как оставить комментарий к решению

Поле **Комментарий к изменению статуса** есть у заявок в статусах «Запрошена»
и «Одобрена» — впишите комментарий перед тем, как нажать **Отклонить**,
**Одобрить** или **Оплатить**. Комментарий уходит вместе с решением: он
попадает в историю заявки и виден партнёру.

## Где посмотреть акт по выплате

Если в контуре включён выпуск актов, у выплаченной заявки появляется блок
**Акт**. Акт выпускается сам в момент, когда вы нажимаете **Оплатить**, — с
номером вида `2026-17` и датой выплаты. Нумерация идёт подряд без пропусков и
каждый год начинается заново.

- **Акт №… от …** — номер и дата. Под ними — отметка: **Подписан партнёром ПЭП**
  с датой, если партнёр подписал акт в кабинете, **Подписан вне платформы** с
  датой или **Не отмечен подписанным**. Подробности подписи и отметка — в
  разделе [Акты](https://docs.agenum.ru/admin/payout/acts/).
- **Скачать PDF** — файл акта. Его же видит партнёр в своём кабинете.

Акт фиксирует заявку на момент выпуска: реквизиты организации, данные партнёра и
состав выплаты по предложениям. Если что-то из этого потом изменится, уже
выпущенный акт останется прежним.

Отметить акт подписанным можно в разделе [Акты](https://docs.agenum.ru/admin/payout/acts/).

:::tip
Блока нет вовсе, если выпуск актов выключен. Включается он переключателем
**Выпускать акты по выплатам** в [общих настройках контура](https://docs.agenum.ru/admin/settings/application/).
:::

## Что делать, если акт по выплате не выпущен

Выпуск акта никогда не мешает выплате: заявка становится «Выплаченной» в любом
случае. Если акт не получился, блок **Акт** показывает **Акт не выпущен** и
причину.

| Причина в карточке | Что сделать |
|---|---|
| Не заполнены реквизиты организации или нет основания акта | заполните [реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) или загрузите [оферту партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/) — ссылки на обе страницы есть прямо в блоке |
| Партнёр — физлицо без статуса или юридический статус не выбран | акт выпускается только самозанятым, ИП и юрлицам. Если статус у партнёра указан неверно, исправьте его по ссылке **Открыть карточку партнёра** |
| Не хватает данных партнёра | у партнёра не заполнены ФИО или наименование либо ИНН не подходит его статусу — поправьте в карточке партнёра |
| Состав заявки не сходится с её суммой | такой акт не выпускается — обратитесь в поддержку |

Когда причина устранена, в блоке появляется **Выпустить акт** — нажмите её, и
акт получит следующий свободный номер и сегодняшнюю дату. Данные партнёра и
организации возьмутся на момент нажатия, а дата выплаты и состав — из самой
заявки.

:::caution
ИНН в акт попадает из заявки — тот, что был у партнёра в момент её подачи.
Исправленный позже ИНН в акт по этой выплате уже не попадёт. Поэтому при
включённых актах заявку самозанятого, ИП или юрлица без корректного ИНН не
создать ни партнёру, ни вам.
:::

## Где посмотреть историю изменений

Вкладка **История** (`/payout/:id/history`) показывает все переходы заявки по
статусам: в какой статус её перевели, кто это сделал и какой комментарий
оставил.

Автором указан либо сотрудник, либо API-ключ, если статус сменили через
внешнюю интеграцию: тогда видно название ключа и в скобках — сотрудник, который
его создал. У заявки, которую подал партнёр, у первого статуса автора нет — стоит
прочерк.

## Что делать, если статус не меняется

**«Недопустимый переход статуса».** Кто-то уже сменил статус заявки — например,
партнёр отменил её сам, пока вы держали карточку открытой. Обновите страницу и
проверьте текущий статус.

## Читать также

- [Список выплат](https://docs.agenum.ru/admin/payout/)
- [Создание выплаты](https://docs.agenum.ru/admin/payout/create/)
- [Акты](https://docs.agenum.ru/admin/payout/acts/) — все акты контура и отметка о подписании
- [Настройка ролей](https://docs.agenum.ru/admin/settings/roles/) — кому доступно раскрытие реквизитов
- [Выплаты во внешнем API](https://docs.agenum.ru/api/payout/) — как эти же статусы и переходы выглядят в интеграции

---

# Профиль

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/profile/

> Личные данные сотрудника, аватар и вкладка безопасности — смена пароля.

Раздел **Профиль** — личные данные сотрудника, который вошёл в админку.
Наверху две вкладки: **Основное** и **Безопасность**.

## Как изменить личные данные

На вкладке **Основное** заполните **Имя**, **Фамилию**, при необходимости
**Отчество** и **Email**, затем нажмите **Сохранить**.

**Имя**, **Фамилия** и **Email** обязательны. Если введённый email уже занят
другим сотрудником, сохранить не получится — появится сообщение «Пользователь
с таким email уже есть».

## Как сменить аватар

Нажмите **Заменить** и выберите файл — подойдут изображения (JPEG, PNG, GIF,
WEBP, SVG) размером до 10 МБ. Кнопка **Удалить** рядом с аватаром убирает его
и возвращает заглушку по инициалам.

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

## Как сменить пароль

На вкладке [Безопасность](https://ваш-контур.agenum.ru/admin/profile/security)
введите **Текущий пароль**, затем **Новый пароль** и нажмите **Сохранить**.

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

:::tip
После смены пароля все остальные сеансы входа завершаются — если вы были
залогинены на другом устройстве, там понадобится войти заново. Сеанс, из
которого меняли пароль, остаётся активным.
:::

## Что делать, если не получается сменить пароль

**«Старый пароль введен неверно».** Проверьте **Текущий пароль** — без него
сменить пароль нельзя, даже если вы уже вошли в кабинет.

**Новый пароль не проходит проверку.** Убедитесь, что в нём не меньше
8 символов, а также есть цифра, строчная и заглавная буквы.

## Читать также

- [ЛК администратора](https://docs.agenum.ru/admin/) — остальные разделы админки
- [Уведомления](https://docs.agenum.ru/admin/notifications/) — ещё одна личная настройка сотрудника
- [Сотрудники](https://docs.agenum.ru/admin/settings/admins/) — где заводят учётные записи других сотрудников

---

# Настройки

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/

> Обзор раздела настроек админки — где что настраивается и на что это влияет.

Раздел **Настройки** — справочники и правила, общие для всего контура: они не
привязаны к конкретному предложению или партнёру, а действуют везде сразу.

## Что где настраивается

| Страница | Что настраивает |
|---|---|
| [Сотрудники](https://docs.agenum.ru/admin/settings/admins/) | администраторы, которые работают в этой админке |
| [Роли и права](https://docs.agenum.ru/admin/settings/roles/) | что каждый администратор может делать |
| [Категории предложений](https://docs.agenum.ru/admin/settings/categories/) | рубрики, по которым группируются предложения |
| [Шаблоны вознаграждения](https://docs.agenum.ru/admin/settings/award-templates/) | готовые наборы условий начисления, которые можно применить к предложению |
| [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/) | что включено во всей админке и значения по умолчанию для выплат |
| [Реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) | данные вашей стороны, которые печатаются в актах по выплатам |
| [Оферта партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/) | договор с партнёрами: редакции и кто их принял |
| [Ключи API](https://docs.agenum.ru/admin/settings/api-keys/) | доступ внешних систем к [Внешнему API](https://docs.agenum.ru/api/) |
| [Вебхуки](https://docs.agenum.ru/admin/settings/webhooks/) | адреса вашей системы, куда контур сам присылает события |
| [Поля и юридические типы партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/) | из чего состоит анкета партнёра |
| [Группы партнёров](https://docs.agenum.ru/admin/settings/partner-groups/) | категории, на которые делятся партнёры |
| [Статусы лидов](https://docs.agenum.ru/admin/settings/lead-statuses/) | воронка, по которой проходит заявка |
| [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/) | из чего состоит заявка (лид) |

:::tip
Часть страниц открывается не всем: доступ к ним зависит от тарифа контура или
от прав конкретного администратора.
:::

## Читать также

- [ЛК администратора](https://docs.agenum.ru/admin/) — остальные разделы админки
- [Роли и права](https://docs.agenum.ru/admin/settings/roles/) — кто и что может настраивать
- [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/) — что включено во всей админке

---

# Сотрудники

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/admins/

> Как завести администратора, назначить ему роль, заблокировать или удалить.

Администратор — сотрудник, у которого есть свой вход в эту админку. Экран
**Администраторы** в разделе [Настройки](https://ваш-контур.agenum.ru/admin/settings/admins)
управляет тем, кто из сотрудников сюда попадает и что каждому из них разрешено.

## Как завести администратора

1. Откройте **Администраторы** и нажмите **Создать администратора**.
2. Заполните **Email**, **Имя**, **Фамилию** и **Пароль** — отчество необязательно.
3. Выберите одну или несколько **Ролей**.
4. Нажмите кнопку сохранения.

:::tip
Пароль должен быть не короче 8 символов и содержать хотя бы одну цифру, одну
строчную и одну заглавную букву. Учётная запись создаётся сразу с этим паролем
— передайте его сотруднику сами, приглашение по почте система не отправляет.
:::

## Как назначить или изменить роль администратора

Нажмите **Изменить** на карточке сотрудника — откроется та же форма, что и при
создании, с уже заполненными данными. Смените роли в поле **Роли** и сохраните.
Каждая роль даёт свой набор прав — что именно входит в роль, настраивается на
странице [Роли и права](https://docs.agenum.ru/admin/settings/roles/).

Администратору можно назначить сразу несколько ролей — тогда его права
складываются из прав каждой.

## Как заблокировать или разблокировать администратора

Кнопка **Заблокировать** на карточке сотрудника закрывает ему доступ в админку,
не удаляя учётную запись: все его действия и настройки остаются как были.
**Разблокировать** возвращает доступ обратно.

## Как удалить администратора

Кнопка **Удалить** на карточке сотрудника удаляет учётную запись без
дополнительного подтверждения. Если сотрудник может ещё понадобиться, надёжнее
заблокировать его, а не удалять.

Удалить нельзя сотрудника, чьи действия должны оставаться объяснимыми: если он
отменял начисления партнёрам, отмечал акты подписанными или менял партнёрам
email. Удаление откажет с сообщением, что именно он делал, — такого сотрудника
блокируют.

## Что делать, если не получается сохранить администратора

**Сообщение «Пользователь с таким email уже есть».** Такой email уже
зарегистрирован в этой админке — для этого сотрудника уже есть учётная запись,
измените её вместо создания новой.

## Читать также

- [Роли и права](https://docs.agenum.ru/admin/settings/roles/) — что можно включить в роль
- [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/) — остальные глобальные настройки
- [Профиль и безопасность](https://docs.agenum.ru/admin/profile/) — как администратор меняет свой пароль сам

---

# Ключи API

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/api-keys/

> Как создать ключ для внешней интеграции, посмотреть его значение, отключить ненужный и почему использованный ключ нельзя удалить.

Ключ API — то, чем внешняя система подтверждает себя, обращаясь к
[Внешнему API](https://docs.agenum.ru/api/) вашего контура. Экран **API-ключи** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/api-keys) управляет
списком таких ключей.

:::tip
Раздел может быть недоступен на вашем тарифе — доступ к внешнему API входит не
во все тарифы. Что входит в ваш, видно в [Консоли](https://console.agenum.ru).
:::

## Как создать ключ

1. Впишите название в поле **Название ключа** — оно нужно только вам, чтобы
   различать ключи между собой.
2. Нажмите **Создать**.

## Как получить значение ключа

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

:::tip
Сохраните значение ключа сразу же — после перезагрузки страницы посмотреть его
снова нельзя. Если ключ потерян, создайте новый, а старый деактивируйте.
:::

## Что видно в списке ключей

Для каждого ключа показаны название, статус (**Активен** или **Неактивен**),
дата создания, дата последнего использования (или прочерк, если ключом ещё не
пользовались) и кто из администраторов его создал.

## Как деактивировать или удалить ключ

**Деактивировать** временно закрывает ключу доступ к API, не удаляя его —
подходящий вариант, если интеграция приостановлена, но может понадобиться
снова. **Активировать** включает ключ обратно.

**Удалить** убирает ключ насовсем; система переспросит перед удалением.
Удалить можно только ключ, которым ещё ничего не делали. Если интеграция уже
меняла статусы лидов, проводила выплаты, отменяла начисления или отмечала акты,
ключ останется автором этих записей — в истории будет видно «API-ключ «название»»
и кто его создал. Такой ключ можно только деактивировать.

## Что делать, если ключ API перестал работать

**Внешняя система перестала подключаться.** Проверьте, что ключ, которым она
пользуется, всё ещё **Активен** в списке — деактивированный или удалённый ключ
запросы больше не принимает. Ключ работает и от имени создавшего его
администратора: если этого администратора заблокировали, его ключи перестают
работать. Создайте новый ключ под действующим администратором.

**Не вижу раздел вовсе.** Скорее всего, доступ к внешнему API не входит в
тариф контура — проверьте это в [Консоли](https://console.agenum.ru).

## Читать также

- [Внешний API](https://docs.agenum.ru/api/) — что именно делает ключ доступным
- [Вебхуки](https://docs.agenum.ru/admin/settings/webhooks/) — события в вашу систему без опроса
- [Настройки](https://docs.agenum.ru/admin/settings/) — остальные справочники контура

---

# Общие настройки контура

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/application/

> Что включается и выключается глобально для всей админки и какие значения по умолчанию можно задать для выплат.

Экран **Глобальные настройки стенда** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/application) — то немногое,
что действует сразу на весь контур, а не на конкретное предложение или
партнёра.

## Что здесь можно включить и выключить

Переключатель **Показывать страницу «Роли»** управляет тем, виден ли вообще в
меню раздел [Роли и права](https://docs.agenum.ru/admin/settings/roles/). Выключение не удаляет
настроенные роли и права администраторов — оно только прячет страницу из меню.

Переключатель **Требовать ИНН для выплат** включён по умолчанию: пока он стоит,
партнёр не сможет создать заявку на выплату, если его ИНН не заполнен или
заполнен с ошибкой. Вы тоже не сможете создать заявку за такого партнёра.

Выключать его стоит, если вознаграждение у вас неденежное — баллы, скидки,
внутренняя программа для сотрудников. Тогда ИНН вам не нужен, а требовать его
от партнёров означало бы собирать лишние персональные данные.

:::tip
Выключение не стирает уже заполненные ИНН и не убирает поле из анкеты. Если оно
вам не нужно совсем, снимите с него обязательность или скройте от партнёров в
[настройке полей](https://docs.agenum.ru/admin/settings/partner-field-types/).
:::

Переключатель **Требовать реквизиты для выплат** работает так же и тоже включён
по умолчанию: пока он стоит, заявку не создать, если партнёр не указал, куда
переводить деньги. Выключайте по той же причине — если вознаграждение
неденежное и реквизиты вам не нужны.

Два переключателя независимы: ИНН нужен для бухгалтерии, реквизиты — чтобы
перевести деньги, и требовать можно любой из них по отдельности.

Переключатель **Выпускать акты по выплатам** выключен по умолчанию. Когда он
включён, каждая выплата самозанятому, ИП или юрлицу получает
[акт](https://docs.agenum.ru/admin/payout/acts/), а в меню появляется раздел **Акты**. Физлицам без
статуса акт не выпускается, выплата проходит как обычно.

Перед включением заполните [реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) —
без них выплаты пройдут, но без актов. И учтите: пока выпуск актов включён,
самозанятый, ИП или юрлицо без корректного ИНН не сможет создать заявку, даже
если **Требовать ИНН для выплат** выключен. ИНН печатается в акте, и
исправить его в акте после выплаты уже нельзя.

## Какие значения по умолчанию здесь задаются

| Настройка | На что влияет |
|---|---|
| **Период удержания выплат по умолчанию, дней** | сколько дней по умолчанию ждать после сделки, прежде чем вознаграждение по новому предложению можно выплатить |
| **Минимальная сумма для вывода, ₽** | партнёр не сможет запросить выплату на сумму меньше этой |

Обе настройки вводятся в единицах, названных прямо в подписи поля: удержание —
в днях, минимальная сумма — в рублях. Копейки в сумме отделяйте **точкой**:
`100.50`. Запятая и любой другой нечисловой ввод превращаются в ноль — сумма
сохранится нулевой, ограничение перестанет действовать.

Значение удержания выплат применяется только к **новым** предложениям — на уже
созданные оно не влияет. У каждого числового поля своя кнопка **Сохранить**:
значения применяются по отдельности, а не одной общей кнопкой.

## Что делать, если общие настройки контура ведут себя не так

**Не вижу переключатель «Роли», хотя точно был.** Проверьте права: изменение
этих настроек доступно не всем администраторам.

**Партнёр не может запросить выплату меньшей суммы.** Это ожидаемо — сумма
ниже минимальной, заданной здесь, не проходит вообще ни у одного партнёра.
Если ограничение больше не нужно, уменьшите значение.

**Партнёр жалуется, что выплата не создаётся из-за ИНН.** Проверьте, заполнен
ли у него ИНН и нет ли в нём опечатки. Если поле скрыто от партнёров, впишите
ИНН сами в его карточке — сам он этого сделать не сможет. Если ИНН вам не нужен
вовсе, выключите **Требовать ИНН для выплат**.

**Партнёр жалуется, что выплата не создаётся из-за реквизитов.** У него не
заполнено, куда переводить деньги. Он может указать это сам в своём кабинете,
либо впишите реквизиты в [его карточке](https://docs.agenum.ru/admin/partner/create/). Если реквизиты
вам не нужны вовсе, выключите **Требовать реквизиты для выплат**.

**Партнёр-ИП жалуется на ИНН, хотя «Требовать ИНН для выплат» выключен.**
Включён выпуск актов: самозанятому, ИП и юрлицу корректный ИНН нужен для акта
независимо от этого переключателя.

## Читать также

- [Роли и права](https://docs.agenum.ru/admin/settings/roles/) — раздел, который включает переключатель здесь
- [Выплаты](https://docs.agenum.ru/admin/payout/) — где значения удержания и минимальной суммы применяются
- [Акты](https://docs.agenum.ru/admin/payout/acts/) — что выпускается при включённом переключателе актов
- [Создание предложения](https://docs.agenum.ru/admin/offer/create/) — где значение удержания можно изменить для конкретного предложения

---

# Шаблоны вознаграждения

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/award-templates/

> Конструктор условий начисления — из чего состоит шаблон, какие бывают типы вознаграждения и как шаблон применяется к предложению.

Шаблон вознаграждения — сохранённый набор условий, по которым партнёру
начисляется вознаграждение за лида. Шаблоны настраиваются один раз в
[Настройках](https://ваш-контур.agenum.ru/admin/settings/award-templates), а
потом подставляются в предложения — так одинаковые условия не приходится
собирать заново для каждого предложения.

## Из чего состоит шаблон

Шаблон — это название и список условий. Каждое условие описывает три вещи:

| Что задаётся | Смысл |
|---|---|
| Статус лида | при переходе лида в какой статус условие срабатывает; обязателен — условия «за любой статус» нет |
| Тип и получатели | кому именно достанется вознаграждение |
| Тип вознаграждения и значение | сколько партнёр получит |

В одном шаблоне может быть сколько угодно условий — например, одно на статус
«Сделка совершена» для всех партнёров и отдельное, повышенное, для конкретной
группы партнёров.

## Кому может достаться вознаграждение

| Тип | Кому |
|---|---|
| Все | всем партнёрам без исключения |
| Партнёры | только выбранным конкретным партнёрам |
| Уровни | партнёрам, у которых один из выбранных уровней |
| Группы партнёров | всем партнёрам из выбранных [групп](https://docs.agenum.ru/admin/settings/partner-groups/) |

## Какие бывают типы вознаграждения

| Тип | Что означает |
|---|---|
| Фиксированная | партнёр получает заданную сумму один раз — за перевод лида в статус; она вводится в поле **Вознаграждение, сумма в ₽** — в рублях, копейки через точку |
| Процент | партнёр получает процент от суммы **каждой** сделки по лиду — и первой, и [добавленных позже](https://docs.agenum.ru/admin/lead/view/#как-добавить-сделку-или-сумму); вводится в поле **Вознаграждение, процент** |
| Нет | вознаграждение по этому условию не начисляется |

Тип «Нет» полезен, чтобы явно исключить сегмент партнёров — например, чтобы
одна группа не получала ничего, пока остальные получают процент.

## Какое условие сработает, если партнёру подходят несколько

Условия на один и тот же статус лида выстраиваются по точности — от самого
адресного к самому общему:

1. **Партнёры** — условие на конкретного партнёра;
2. **Уровни**;
3. **Группы партнёров**;
4. **Все**.

Работает только самый точный ряд, в котором для партнёра нашлось условие на
этот статус; остальные ряды не учитываются. Например, при «Все — 100 ₽» и
«Партнёры: Иванов — 500 ₽» Иванов получит 500 ₽, а не 600 ₽ и не 100 ₽.

Внутри победившего ряда:

- если в нём есть условие с типом «Нет» — партнёр не получает ничего, даже
  если рядом есть фиксированная сумма или процент;
- иначе начисляются **и** фиксированная сумма, **и** процент, если заданы
  оба: например, 300 ₽ за сделку плюс 5 % от её суммы;
- если в ряду несколько фиксированных сумм (или несколько процентов) на один
  статус, сработает та, что заведена раньше. Такие дубли лучше не заводить.

:::tip
«Нет» на группу не отменяет персональное условие: партнёр с собственным
условием получит его, даже если его группе выставлено «Нет».
:::

## Как создать или изменить шаблон

1. Нажмите **Создать новый шаблон** — или **Изменить** на существующем.
2. Впишите **Название** шаблона.
3. Переключателем **Шаблон по умолчанию** можно пометить шаблон как основной —
   пометка снимается с других шаблонов автоматически, отмеченным может быть
   только один.
4. Добавьте условия кнопкой **Добавить условие**, заполните каждое по таблицам
   выше и уберите лишние кнопкой **Удалить** рядом с условием.
5. Нажмите кнопку сохранения.

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

## Как шаблон применяется к предложению

На странице создания или редактирования предложения есть кнопка **Загрузить
условия из шаблона** — она копирует условия выбранного шаблона в это
предложение. Дальше их можно донастроить прямо там же, кнопкой **Редактор
условий**: это меняет вознаграждение только этого предложения и не трогает
сам шаблон.

## Что делать, если шаблон вознаграждения не сохраняется или не действует

**Удалил шаблон, а в предложениях условия остались.** Так и должно быть:
загрузка шаблона копирует условия в предложение, а не связывает их — удаление
или изменение шаблона задним числом на уже созданные предложения не влияет.

**Не могу сохранить условие.** Проверьте, что для него выбраны статус лида,
тип получателя («Все», «Партнёры» и так далее) и тип вознаграждения — без
этого условие считается незаполненным. Форма подскажет, в каком по счёту
условии не выбран статус.

**Партнёр получил не ту сумму, что ожидалась.** Скорее всего, ему подошло
более точное условие — персональное или по уровню. Порядок описан выше, в
разделе о том, какое условие срабатывает.

## Читать также

- [Создание предложения](https://docs.agenum.ru/admin/offer/create/) — где шаблон применяется
- [Группы партнёров](https://docs.agenum.ru/admin/settings/partner-groups/) — на кого ещё можно настроить вознаграждение

---

# Категории предложений

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/categories/

> Как создать, переименовать и удалить категорию предложения.

Категория — рубрика, по которой можно сгруппировать предложения при их
создании. Экран **Категории предложения** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/categories) управляет
общим для контура списком таких рубрик.

## Как создать категорию

Впишите название в поле **Название новой категории** внизу списка и нажмите
**Создать** — либо просто нажмите Enter в самом поле.

## Как переименовать категорию

Нажмите **Редактировать** на нужной категории, измените название в поле и
нажмите **Сохранить** (или Enter). **Отменить** возвращает исходное название
без сохранения.

## Как удалить категорию

Нажмите **Удалить** на нужной категории. Перед удалением появится
подтверждение с числом предложений, которые сейчас относятся к этой категории.

## Что делать, если категория не удаляется или название занято

**Хочу удалить категорию, но у неё есть предложения.** Удаление всё равно
пройдёт — предложения не удаляются вместе с категорией, но перестанут быть
отнесены к ней. Число предложений в диалоге подтверждения помогает не удалить
категорию по ошибке.

**Сообщение «Категория с таким названием уже есть».** Название категории
должно быть уникальным в пределах контура — выберите другое или отредактируйте
существующую категорию.

## Читать также

- [Список предложений](https://ваш-контур.agenum.ru/admin/offer) — где категории используются
- [Создание предложения](https://docs.agenum.ru/admin/offer/create/) — где категория выбирается для конкретного предложения
- [Настройки](https://docs.agenum.ru/admin/settings/) — остальные справочники контура

---

# Типы полей лидов

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/lead-field-types/

> Конструктор анкеты лида — какие данные собираются в заявке, как создать поле, скрыть его и использовать в интеграции.

Лид — это заявка от клиента, которого привёл партнёр. Из чего состоит такая
заявка, решаете вы: имя, телефон, город, сумма — набор полей у каждого контура
свой.

Экран **Типы полей лидов** — конструктор этого набора. Он находится в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/lead-field-types) и общий
для всего контура: один и тот же набор полей действует во всех предложениях.

## Как создать поле лида

1. Откройте **Типы полей лидов** и нажмите **Создать**.
2. Заполните **Системное имя** — короткий латинский идентификатор вида
   `system_name`, по которому поле узнаёт ваша система.
3. Заполните **Название** — как поле будет подписано в интерфейсе.
4. Выберите **Тип**.
5. Отметьте **Обязательное поле**, если заявка без него не имеет смысла.
6. Нажмите **Сохранить**.

:::tip
Обязательное поле обязательно везде: заявку без него не создать ни вручную из
админки, ни через внешний API. Отмечайте так только то, без чего заявку правда
нельзя обработать.
:::

## Какие бывают типы полей

| Тип | Что в него попадает | Пример |
|---|---|---|
| Строка | любой текст | имя, комментарий |
| Число | целое или дробное значение | сумма, количество |
| Да / Нет | переключатель с двумя состояниями | согласие на звонок |
| Список | одно значение из заранее заданных | город, источник |

Для типа **Список** внизу формы появляется блок **Опции**: кнопка **Добавить**
заводит новое значение, стрелки меняют порядок, крестик убирает лишнее. Пока в
списке нет ни одной опции, сохранить поле нельзя.

Порядок опций — это порядок, в котором их увидит тот, кто заполняет заявку.

## Зачем нужно системное имя

Название поля пишется для людей и может меняться сколько угодно. Системное имя
пишется для программ: по нему ваша система узнаёт поле, когда отдаёт заявку
через внешний API.

Системное имя уникально в пределах контура. Если такое уже занято, при
сохранении появится сообщение «Тип поля с таким системным именем уже
существует».

## Что нельзя изменить после создания

**Системное имя** и **Тип** при редактировании заблокированы — иначе уже
собранные заявки перестали бы соответствовать своему полю. Если ошиблись,
заведите новое поле, а старое скройте.

Менять после создания можно:

- **Название** — подпись в интерфейсе;
- **Обязательное поле** — требовать заполнения или нет;
- **Опции** списка — состав и порядок значений.

## Как скрыть или удалить поле

**Скрыть** убирает поле из форм и фильтров, но сохраняет всё, что по нему уже
собрано. Скрытые поля видны на этой же странице, если включить флажок
**Показать скрытые**; вернуть поле обратно — кнопкой **Показать**.

**Удалить** стирает поле насовсем и работает только до того, как по нему
появились первые данные. Если хоть один лид его заполнил, вместо удаления
придёт сообщение «Невозможно удалить тип поля, так как есть связанные поля
лидов. Используйте скрытие».

## Где появятся настроенные поля

| Где | Что видно |
|---|---|
| Форма создания и редактирования лида | все нескрытые поля, обязательные — со звёздочкой |
| Фильтры в списке лидов | поиск заявок по значению поля |
| Внешний API | нескрытые поля в списке полей лида |

Скрытое поле пропадает из всех трёх мест сразу, но данные в старых заявках
остаются на месте.

## Что делать, если поле не работает как ожидалось

**Поле не появилось в форме лида.** Проверьте, не скрыто ли оно: включите
**Показать скрытые** и нажмите **Показать**.

**Не сохраняется поле типа «Список».** Добавьте хотя бы одну опцию — без опций
кнопка **Сохранить** остаётся неактивной.

**Интеграция не находит поле.** Она ищет по идентификатору из списка полей
лида, а не по названию. Убедитесь, что поле не скрыто.

## Читать также

- [ЛК администратора](https://docs.agenum.ru/admin/) — остальные разделы админки
- [Справочники внешнего API](https://docs.agenum.ru/api/reference/) — как эти же поля выглядят в интеграции

---

# Статусы лидов

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/lead-statuses/

> Конструктор воронки лида — какие статусы есть всегда, как добавить свои, настроить порядок и системное имя для интеграции.

Статусы лида описывают его путь: от появления заявки до сделки или отказа.
Экран **Статусы лидов** в разделе [Настройки](https://ваш-контур.agenum.ru/admin/settings/lead-statuses) —
конструктор этого пути, общий для всего контура.

## Как устроена воронка статусов

В воронке всегда есть три фиксированные точки:

- **Первичный статус** — его лид получает автоматически в момент создания,
  сколько бы полей ни было заполнено. Он один на контур.
- **Целевой статус** — означает состоявшуюся сделку. Именно перевод лида в
  него запускает начисление вознаграждения партнёру. Он тоже один.
- **Статус отмены** — лид, который не стал сделкой.

Между первичным и целевым можно добавить сколько угодно своих промежуточных
статусов — например, «Новый», «В работе», «Ожидает оплаты» (конкретные
названия — только пример, у каждого контура они свои). Их можно
переименовывать, красить и переставлять местами; три фиксированные точки
воронки трогать местами нельзя.

## Как создать статус

1. Откройте **Статусы лидов** и нажмите **Создать**.
2. Заполните **Системное имя** — короткий идентификатор вида `system_name`,
   по которому статус узнаёт внешняя система.
3. Заполните **Название** — как статус будет подписан в интерфейсе.
4. При желании заполните **Описание**.
5. Выберите **Цвет** из палитры — десять вариантов, им подсвечивается бейдж
   статуса в списке лидов.
6. Нажмите **Сохранить**.

Новый статус всегда становится промежуточным и добавляется в конец порядка;
сделать его первичным, целевым или статусом отмены нельзя — эти три уже
существуют с самого начала.

:::tip
Системное имя нужно, если вы меняете статус лида из своей системы через
[внешний API](https://docs.agenum.ru/api/lead/) — там статус указывается либо по нему, либо по
идентификатору.
:::

## Как менять порядок статусов

Переставлять местами можно только промежуточные статусы — у каждого в списке
есть стрелки ↑ и ↓. После перестановки нажмите **Сохранить порядок** —
без этого новый порядок не запомнится. Первичный и целевой статусы всегда
остаются на своих местах — в начале и в конце воронки.

## Как статус влияет на вознаграждение

Начисление партнёру запускает перевод лида в статус, за который в
предложении настроено вознаграждение. Сюда же относится добавление сделки,
когда лид уже в целевом статусе. Какую сумму или процент начислить,
настраивается в [шаблонах вознаграждений](https://docs.agenum.ru/admin/settings/award-templates/)
и в [условиях вознаграждения предложения](https://docs.agenum.ru/admin/offer/create/#как-настроить-вознаграждение).
Шаблон с типом «Процент» можно привязать только к целевому статусу: к
любому другому система привязать его не позволит.

Первичный статус в условиях вознаграждения выбрать нельзя. Лид получает его
при создании, а не переходом, поэтому платить за него было бы не за что.

Если лид ушёл в статус отмены раньше, чем начисление по нему успели
посчитать, начисление не появится совсем: отмена делает его неположенным.

## Что нельзя удалить

Первичный статус, целевой статус и статус отмены удалить нельзя никогда —
можно только переименовать, поменять описание и цвет.

Промежуточный статус можно удалить, только пока он нигде не задействован:
по нему нет ни одного лида, ни одной записи в истории переходов, ни одного
начисления партнёрам, и он не выбран ни в одном условии вознаграждения
предложений. Как только статус кто-то получил — удаление заблокировано;
остаётся переименовать его или оставить как есть.

## Что делать, если статус лида не сохраняется или не удаляется

**Не сохраняется статус.** Системное имя должно быть уникальным в пределах
контура — если оно уже занято, появится сообщение об этом.

**Не получается удалить статус.** Сообщение подскажет причину. Если по
статусу уже есть лиды, история переходов или начисления — его можно только
отредактировать. Если он используется в настройках вознаграждения — сначала
уберите или перенастройте эти условия в предложениях, затем повторите
удаление.

**Не получается привязать шаблон вознаграждения «Процент» к статусу.** Этот
тип вознаграждения работает только с целевым статусом — выберите его.

## Читать также

- [Справочники внешнего API](https://docs.agenum.ru/api/reference/) — как статусы отдаются интеграции, а [Лиды](https://docs.agenum.ru/api/lead/) — как статус меняется
- [Карточка лида](https://docs.agenum.ru/admin/lead/view/) — где статус меняют на практике
- [Шаблоны вознаграждений](https://docs.agenum.ru/admin/settings/award-templates/)

---

# Реквизиты организации

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/organization-requisites/

> Какие реквизиты вашей организации печатаются в актах по выплатам партнёрам и как их заполнить.

Экран **Реквизиты организации** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/organization-requisites) —
данные вашей стороны, которые печатаются в [актах по выплатам](https://docs.agenum.ru/admin/payout/acts/)
как реквизиты заказчика.

## Зачем заполнять реквизиты организации

Без них акты не выпускаются: выплата пройдёт, а в её карточке появится причина
«Не заполнены реквизиты организации». Заполнить реквизиты стоит до того, как
включать **Выпускать акты по выплатам** в [общих настройках контура](https://docs.agenum.ru/admin/settings/application/).

Пока реквизиты пусты, над формой написано: «Пока реквизиты не заполнены, акты не
выпускаются». После сохранения там же видно дату последнего изменения.

## Как заполнить реквизиты

1. Выберите **Форма организации**: **Юридическое лицо** или **ИП**. От неё
   зависит набор полей ниже.
2. Заполните поля:

   | Поле | Что вписать |
   |---|---|
   | **Полное наименование** / **ФИО предпринимателя** | как в ЕГРЮЛ или ЕГРИП |
   | **ИНН** | 10 цифр у юрлица, 12 у ИП |
   | **КПП (необязательно)** | только у юрлица |
   | **ОГРН** / **ОГРНИП** | основной регистрационный номер |
   | **Юридический адрес** | адрес регистрации |
   | **Должность подписанта** | например, «Генеральный директор» |
   | **ФИО подписанта** | кто подписывает акты от вашей стороны |
   | **Основание (необязательно)** | договор, на который ссылается акт, например «Договор № 1 от 01.01.2026» |
   | **Формулировка услуги (необязательно)** | как называется услуга в строках акта |

3. Нажмите **Сохранить**.

Если поля неактивны — у вас есть право только на просмотр реквизитов.

## Что такое основание и формулировка услуги в акте

**Основание** — строка акта о том, по какому договору оказаны услуги. Если вы
загрузили [оферту партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/), акт
ссылается на неё, и это поле не используется. Пока оферты нет, акт берёт текст
отсюда. Если нет ни оферты, ни текста, акты не выпускаются.

**Формулировка услуги** — что написано в строках акта. Если поле пустое, в акт
попадает «Услуги по привлечению клиентов в рамках партнёрской программы».

:::caution
Формулировка должна совпадать с договором с партнёром. Агентский договор
самозанятому не подходит: пишите «оказание услуг», а не «агентское
вознаграждение».
:::

## Что будет с уже выпущенными актами после изменения реквизитов

Ничего: выпущенный акт фиксирует реквизиты на момент выпуска и больше не
меняется. Новые реквизиты попадут только в следующие акты — в том числе в те,
что вы выпустите вручную кнопкой **Выпустить акт** в [карточке выплаты](https://docs.agenum.ru/admin/payout/view/).

## Читать также

- [Акты](https://docs.agenum.ru/admin/payout/acts/) — все выпущенные акты и отметка о подписании
- [Оферта партнёрской программы](https://docs.agenum.ru/admin/settings/program-offer/) — основание акта вместо текста
- [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/) — переключатель выпуска актов

---

# Поля и юридические типы партнёра

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/partner-field-types/

> Конструктор анкеты партнёра — юридические статусы, их реквизиты и как настроить набор полей.

Когда партнёр указывает реквизиты для выплат, состав анкеты зависит от того,
кто он — физлицо, самозанятый, ИП или юрлицо. Экран **Настройка полей
партнёров** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/partner-field-types)
управляет и набором полей, и тем, какие из них нужны каждому статусу.

## Какие бывают юридические статусы партнёра

Физическое лицо, самозанятый, ИП и юридическое лицо — набор статусов
фиксированный, завести новый или удалить существующий нельзя. Единственное,
что с ним можно сделать — скрыть ненужный кнопкой **Скрыть** в таблице
«Юридические статусы партнеров» (**Показать** возвращает его обратно).

## Как настроить поля для юридического статуса

1. Нажмите **Редактировать** у нужного статуса в таблице «Юридические статусы
   партнеров».
2. В таблице «Поля статуса» настройте каждое поле:
   - **Порядок** — стрелки двигают поле выше или ниже в анкете партнёра;
   - **Обязательное** — без него партнёр не сможет сохранить анкету;
   - **Скрыто от партнёра** — поле исчезает из его анкеты, но остаётся
     доступно вам в карточке партнёра. Скрытое поле обязательным быть не может;
   - **Отвязать** — убрать поле из этого статуса.
3. Чтобы добавить поле, кликните по нему в блоке «Добавить поле» ниже — там
   перечислено всё, что ещё не подключено к статусу.
4. Нажмите **Сохранить**.

Обязательность, скрытость и порядок действуют **только в этом статусе**. Одно
и то же поле может быть обязательным для ИП и необязательным для физлица.

Этот шаг не создаёт новые поля, а только подключает уже существующие к
статусу — их заводят отдельно, в блоке «Типы полей партнера» ниже.

:::tip
Если отвязать поле, по которому у партнёров уже сохранены значения, оно не
исчезнет, а станет скрытым — иначе введённые данные потерялись бы. После
сохранения появится уведомление, какие именно поля были скрыты.
:::

## Как создать поле партнёра

1. В блоке «Типы полей партнера» нажмите **Создать**.
2. Заполните **Системное имя** — короткий латинский идентификатор вида
   `system_name`, по которому поле узнаёт внешняя система.
3. Заполните **Название** — как поле будет подписано в интерфейсе.
4. Выберите **Тип**.
5. Нажмите кнопку сохранения.

Обязательность здесь не задаётся: она зависит от юридического статуса и
настраивается в его редакторе.

## Какие бывают типы полей партнёра

| Тип | Что в него попадает | Пример |
|---|---|---|
| Строка | любой текст | название банка, ИНН |
| Число | целое или дробное значение | номер счёта |
| Да / Нет | переключатель с двумя состояниями | согласие на обработку данных |
| Список | одно значение из заранее заданных | форма собственности |

Для типа **Список** внизу формы появляется блок **Опции**: кнопка
**Добавить** заводит новое значение, стрелки меняют порядок, крестик убирает
лишнее. Пока в списке нет ни одной опции, сохранить поле нельзя.

## Что нельзя изменить у поля партнёра после создания

**Системное имя** и **Тип** при редактировании заблокированы — иначе уже
собранные анкеты перестали бы соответствовать своему полю. Если ошиблись,
заведите новое поле, а старое отключите от юридических статусов.

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

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

ИНН, ОГРНИП, КПП, ОГРН и полное наименование создаются вместе с контуром. У них
нет кнопки **Удалить**, а системное имя не меняется даже через повторное
создание: на эти поля опирается сам сервис.

**Название менять можно** — если в вашей нише поле принято называть иначе,
переименуйте, на работу это не повлияет.

ИНН отличается от остальных: его нельзя отвязать ни от одного юридического
статуса, кнопка **Отвязать** у него недоступна. Партнёру всегда должно быть
куда его записать — без ИНН вы не сможете его выплатить и не сможете сопоставить
его со своей бухгалтерией. При этом ИНН можно **скрыть от партнёра** и
заполнять самому в его карточке, а также снять с него обязательность, если на
регистрации он вам не нужен.

:::tip
Скрыв ИНН, вы берёте его заполнение на себя: партнёр не сможет вывести
средства, пока вы не впишете ИНН в его карточку. Под таблицей полей об этом
появится предупреждение.
:::

Остальные четыре системных поля отвязывать можно. По умолчанию они
необязательны: реквизиты организации и предпринимателя определяются по ИНН в
государственных реестрах, поэтому требовать их от партнёра нужно не всегда.

## Что делать, если поле не удаляется

**«Невозможно удалить тип поля, так как есть связанные поля партнеров».** По
этому полю уже сохранены данные хотя бы в одной анкете партнёра — удалить его
нельзя, только отключить от юридического статуса, чтобы оно не появлялось в
новых анкетах.

**«Невозможно удалить тип поля, так как есть связанные юридические статусы».**
Поле всё ещё подключено к одному из статусов — сначала уберите его в таблице
«Юридические статусы партнеров», потом удаляйте.

**У поля нет кнопки «Удалить».** Это одно из системных полей — их удалять
нельзя, можно только отвязать от статуса или скрыть от партнёра.

## Как проверяется ИНН

ИНН сверяется по контрольным цифрам — тому же правилу, по которому его
проверяет налоговая. Значение с опечаткой не сохранится ни в анкете партнёра,
ни в его карточке у вас.

Длина зависит от статуса: у юридического лица ИНН из 10 цифр, у физлица,
самозанятого и ИП — из 12. Поэтому при смене юридического статуса партнёра
ранее введённый ИНН может перестать подходить — сервис сообщит об этом сразу,
в момент смены, и попросит указать корректный.

Остальные поля партнёра на формат не проверяются: их содержимое сервису
неизвестно.

## Где появятся настроенные поля партнёра

Поля, подключённые к юридическому статусу партнёра, показываются в его
[регистрации](https://docs.agenum.ru/partner/registration/) и на вкладке с реквизитами в
[профиле](https://docs.agenum.ru/partner/profile/) — в зависимости от того, какой статус партнёр
выбрал.

## Читать также

- [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/) — тот же конструктор, но для анкеты лида
- [Регистрация партнёра](https://docs.agenum.ru/partner/registration/) — где партнёр впервые заполняет эти поля
- [Профиль и реквизиты](https://docs.agenum.ru/partner/profile/) — где партнёр может их изменить

---

# Группы партнёров

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/partner-groups/

> Зачем нужны группы партнёров, как их создать и на что влияет группа по умолчанию.

Группа партнёров — способ разделить партнёров на категории: например, по
источнику привлечения или по типу площадки. Группа влияет на то, какие
предложения партнёр увидит в кабинете, и может участвовать в настройке
вознаграждения — партнёрам одной группы можно назначить особые условия.

## Как создать группу

1. Откройте [Группы партнёров](https://ваш-контур.agenum.ru/admin/settings/partner-groups).
2. Впишите название в поле вверху страницы.
3. Нажмите **Создать**.

Название группы должно быть уникальным в контуре.

## Как переименовать или удалить группу

Кнопка **Изменить** у группы открывает поле названия для редактирования,
**Сохранить** фиксирует новое имя.

Кнопка **Удалить** работает только для групп без партнёров — если хотя бы
один партнёр состоит в группе, сначала переведите его в другую группу.

## Что означает группа «По умолчанию»

Переключатель **По умолчанию** отмечает группу, в которую автоматически
попадает партнёр, если при регистрации группа не была указана явно. Группа по
умолчанию всегда ровно одна: включение переключателя у одной группы
выключает его у прежней.

:::tip
Группу по умолчанию нельзя ни удалить, ни снять с неё этот признак напрямую —
сначала назначьте группой по умолчанию другую.
:::

## На что влияет группа партнёра

- какие предложения партнёр увидит — рекламодатель может скрыть предложение
  для всех групп, кроме выбранных, или наоборот;
- на какое вознаграждение партнёр может рассчитывать — в настройке
  вознаграждения по предложению группу можно указать как условие;
- по группе партнёров можно фильтровать в [списке партнёров](https://docs.agenum.ru/admin/partner/).

## Что делать, если группу не получается удалить

Сообщение «Нельзя удалить группу, в которой есть партнёры» означает, что в
группе ещё остались партнёры — переведите их в другую группу через
[редактирование партнёра](https://docs.agenum.ru/admin/partner/create/) и повторите удаление.

Сообщение «Нельзя удалить дефолтную группу» означает, что это группа по
умолчанию — сначала назначьте по умолчанию другую группу.

## Читать также

- [Список партнёров](https://docs.agenum.ru/admin/partner/)
- [Заведение и редактирование партнёра](https://docs.agenum.ru/admin/partner/create/)
- [Список предложений](https://docs.agenum.ru/admin/offer/)

---

# Оферта партнёрской программы

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/program-offer/

> Как загрузить оферту для партнёров, отметить соглашение об электронной подписи, выпустить новую редакцию и посмотреть, кто её принял.

Экран **Оферта партнёрской программы** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/program-offer) — договор
вашей организации с партнёрами. Вы загружаете PDF, партнёры принимают его в
своём кабинете, а [акты по выплатам](https://docs.agenum.ru/admin/payout/acts/) ссылаются на него как
на основание.

## Что происходит, когда оферта загружена

- Файл действующей редакции открыт всем посетителям кабинета партнёра, в том
  числе до регистрации.
- При [регистрации](https://docs.agenum.ru/partner/registration/) партнёр отмечает, что принимает
  оферту, — без этого не зарегистрироваться.
- Перед выводом средств партнёр должен принять действующую редакцию. Если он её
  ещё не принимал, кабинет покажет форму принятия прямо на экране создания
  заявки.
- В кабинете партнёра появляется раздел **Оферта** — текущая редакция и те,
  что он принимал раньше.
- В акте строка «Основание» ссылается на редакцию с датой.
- Если в действующей редакции есть соглашение о простой электронной подписи и
  вы отметили это при загрузке, партнёры, принявшие её, могут
  [подписывать акты в кабинете](https://docs.agenum.ru/admin/payout/acts/) кодом из письма.

Заявки, которые создаёте вы или ваша система через [внешний API](https://docs.agenum.ru/api/payout/),
принятия оферты не требуют: принять её за партнёра нельзя.

:::tip
Пока оферта не загружена, ничего из этого нет, а основанием в акте служит текст
из [реквизитов организации](https://docs.agenum.ru/admin/settings/organization-requisites/).
:::

## Как загрузить оферту или новую редакцию

1. В блоке **Новая редакция** нажмите **Выбрать PDF**. Подходит только PDF до
   9 МБ.
2. Укажите **Дата редакции**. Она не может быть позже сегодняшней и раньше
   действующей редакции.
3. Если в тексте есть соглашение об электронной подписи, отметьте **Редакция
   содержит соглашение об электронной подписи** — см.
   [какое соглашение включить](https://docs.agenum.ru/admin/settings/program-offer/#как-включить-в-оферту-соглашение-о-простой-электронной-подписи).
4. Нажмите **Загрузить**.

Отметку о соглашении после загрузки не поменять, как и сам файл. Ошиблись —
загрузите эту же редакцию заново той же датой с правильной отметкой.

Новая редакция не заменяет прежние: они остаются в списке, потому что на них
ссылаются принятия и акты. Действующей становится самая новая по дате
редакции. Партнёрам нужно принять её заново перед следующим выводом средств —
отдельного уведомления о новой редакции они не получают.

**Дата, равная действующей, допустима** — так загружают исправленный файл,
если в прежнем нашли опечатку уже после того, как его кто-то принял.

:::caution
Партнёр, которого вы завели сами или которому платите через API, оферту в
кабинете не принимал. Для таких выплат акт ссылается на редакцию, действовавшую
в день выплаты. Это работает, только если в самой оферте сказано, что участие в
партнёрской программе означает её принятие, — проверьте, что такой пункт в
вашем тексте есть. Рекомендуемый текст — в разделе
[о пункте про принятие оферты](https://docs.agenum.ru/admin/settings/program-offer/#какой-пункт-о-принятии-оферты-включить-в-её-текст).
:::

## Какой пункт о принятии оферты включить в её текст

Партнёр, которого вы завели сами или которому платите через API, оферту в
кабинете не принимал. Его договор с вами держится на том, что он участвует в
программе: регистрируется, получает вознаграждение. Закон считает такие
действия принятием оферты (п. 3 ст. 438 ГК РФ), если это сказано в ней самой.
Без такого пункта ссылка на оферту в его акте ни на чём не стоит.

Оферту пишете вы, и её содержание определяете тоже вы: Agenum её стороной не
является. Ниже — рекомендуемая формулировка, а не готовый документ. Подставьте
свои термины и нумерацию и покажите текст юристу.

> **X.1.** Участие в партнёрской программе, в том числе регистрация в Личном
> кабинете и получение вознаграждения, означает принятие Партнёром Оферты в
> редакции, действующей на момент этого действия.
>
> **X.2.** Организация публикует новую редакцию Оферты в Личном кабинете.
> Новая редакция применяется с момента публикации. Продолжая участвовать в
> партнёрской программе после публикации, Партнёр принимает новую редакцию.
> Партнёр, который не согласен с новой редакцией, прекращает участие в
> программе.
>
> **X.3.** Действующая редакция Оферты доступна в Личном кабинете, в том числе
> до регистрации. Отдельно о новой редакции Организация Партнёра не уведомляет.

**Почему новая редакция — это новое принятие, а не право менять договор.**
Партнёр-физлицо не ведёт предпринимательскую деятельность, а с таким
контрагентом право одностороннего изменения договора нельзя оставить за собой
(п. 2 ст. 310 ГК РФ). Поэтому в тексте выше новая редакция действует для
партнёра, только когда он продолжает участие, а не по одному вашему решению.

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

## Как включить в оферту соглашение о простой электронной подписи

Партнёр может подписать акт в своём кабинете простой электронной подписью (ПЭП)
— кодом, который приходит на его подтверждённую почту. Такая подпись имеет силу,
только если в оферте есть соглашение о ней. Поэтому подписание включается не
переключателем, а самой офертой:

1. Включите в текст оферты пункты из этого раздела.
2. Загрузите её новой редакцией и отметьте **Редакция содержит соглашение об
   электронной подписи**.
3. Партнёры принимают новую редакцию — и у их актов появляется кнопка
   **Подписать**.

Подписывать могут только партнёры, принявшие **действующую** редакцию с
отметкой. Если вы выпустите новую редакцию без соглашения, подписание у всех
пропадёт, даже у тех, кто принимал прежнюю. Как выглядит подписанный акт у
вас — [Акты](https://docs.agenum.ru/admin/payout/acts/).

Основание — соглашение сторон о том, что документ, подписанный ПЭП, равнозначен
бумажному с собственноручной подписью (ч. 2 ст. 6 Федерального закона № 63-ФЗ
«Об электронной подписи»). В соглашении должны быть правила, по которым
определяют, кто подписал документ, и обязанность хранить ключ подписи в тайне.

Это рекомендуемая формулировка, как и пункт о принятии оферты: Agenum стороной
соглашения не является, текст и его проверку юристом определяете вы.

> **Y.1.** Акты о выплате вознаграждения и другие документы, которые
> Организация формирует для Партнёра в Личном кабинете, Партнёр вправе
> подписать в Личном кабинете простой электронной подписью.
>
> **Y.2.** Стороны договорились, что документ, подписанный Партнёром в Личном
> кабинете, подписан простой электронной подписью Партнёра и равнозначен
> документу на бумаге, подписанному собственноручно (ч. 2 ст. 6 Федерального
> закона от 06.04.2011 № 63-ФЗ «Об электронной подписи»).
>
> **Y.3.** Ключ простой электронной подписи — одноразовый код, который Личный
> кабинет направляет на адрес электронной почты Партнёра, подтверждённый в
> Личном кабинете, для подписания конкретного документа. Документ подписывается
> вводом этого кода в Личном кабинете, вход в который выполнен по паролю
> Партнёра.
>
> **Y.4.** Документ считается подписанным тем Партнёром, на которого
> зарегистрирована учётная запись, из которой выполнено подписание. Личный
> кабинет сохраняет дату и время подписания, адрес электронной почты, на
> который направлен код, и отпечаток файла подписанного документа.
>
> **Y.5.** Если Партнёр — юридическое лицо, при подписании указываются фамилия,
> имя, отчество, должность и основание полномочий лица, подписывающего документ.
> Партнёр обеспечивает, что документы от его имени подписывает только его
> единоличный исполнительный орган или лицо, уполномоченное доверенностью, и
> отвечает за достоверность указанных сведений.
>
> **Y.6.** Партнёр хранит пароль от Личного кабинета и доступ к адресу
> электронной почты в тайне и не передаёт их третьим лицам. Если они стали или
> могли стать известны другим лицам, Партнёр сразу меняет пароль и сообщает об
> этом Организации. Действия в Личном кабинете до такого сообщения считаются
> действиями Партнёра.
>
> **Y.7.** Организация меняет адрес электронной почты Партнёра в Личном кабинете
> только по его обращению, если Партнёр утратил доступ к прежнему адресу, и
> предварительно проверяет, что обращается именно Партнёр.
>
> **Y.8.** Акт о выплате вознаграждения, сформированный Организацией в Личном
> кабинете, считается подписанным Организацией с момента его формирования.

**Ваша подпись.** В кабинете акт подписывает только партнёр. Пункт Y.8 нужен,
чтобы акт, подписанный партнёром, считался подписанным обеими сторонами: без
него ваша подпись под актом осталась бы открытым вопросом.

**Партнёр — организация.** Аккаунт в кабинете один, а подписывать документы
вправе не любой сотрудник, а руководитель или представитель по доверенности.
При подписании партнёр указывает, кто подписывает и на каком основании, — эти
данные видны вам в окне подписи акта. Если вы обычно собираете доверенности,
запросите копию до первого подписания.

**Пароль знает только партнёр.** Даже если вы [завели партнёра сами](https://docs.agenum.ru/admin/partner/create/),
пароль он задаёт по ссылке из письма — вы его не задаёте и не видите, а код
подписи приходит на его почту. Единственный способ, которым вы влияете на ключ
подписи, — смена email партнёра: на новый адрес уходят и ссылка для входа, и
коды подписи. Поэтому пункт Y.7 ограничивает такую смену обращением самого
партнёра, все такие смены видны в [карточке партнёра](https://docs.agenum.ru/admin/partner/view/), а
подпись, сделанная после смены, помечена в окне подписи акта.

## Что видно в списке редакций

Каждая редакция — карточка **Редакция от …**. У самой новой — отметка
**Действующая**.

| Поле | Что означает |
|---|---|
| Загружена | когда и кем загружен файл |
| Размер | размер PDF |
| Приняли | сколько партнёров приняли эту редакцию |
| Соглашение об электронной подписи | **Есть** — партнёры, принявшие редакцию, подписывают акты в кабинете, пока она действующая |

**Скачать** открывает файл редакции.

## Как посмотреть, кто принял оферту

Нажмите **Принявшие** на карточке редакции — кнопка активна, если редакцию
принял хотя бы один партнёр. В окне **Приняли редакцию от …** — партнёры с
email и временем принятия, имя ведёт в карточку партнёра.

Принятие хранится отдельно для каждой редакции: партнёр, принявший прошлую,
в списке новой не появится, пока не примет и её.

## Как удалить редакцию

**Удалить** на карточке, затем подтвердите **Удалить** в окне **Удалить
редакцию?**.

Удалить можно только редакцию, которую ещё никто не принял и на которую не
ссылается ни один акт. Если редакцию принимали, кнопка неактивна с подсказкой
«Удалить нельзя: редакцию уже принимали партнёры». Если на неё ссылается акт,
удаление откажет с сообщением, что редакция указана в акте. В обоих случаях
редакцию не удаляют, а заменяют новой.

## Что делать, если оферта не загружается

**«Оферта загружается в PDF».** Выбран файл другого формата — сохраните
документ в PDF.

**«Файл больше 9 МБ».** Уменьшите файл: сожмите картинки или сохраните без
встроенных шрифтов.

**«Файл не похож на PDF».** У файла расширение PDF, но внутри другой формат —
пересохраните документ в PDF заново.

**«Дата редакции не может быть в будущем».** Редакцию «на будущее» загрузить
нельзя — загрузите её в день, когда она вступает в силу.

**«Дата редакции раньше действующей…».** Новая редакция не может действовать
задним числом. Укажите дату не раньше той, что у действующей.

## Читать также

- [Реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) — основание акта, пока оферты нет
- [Акты](https://docs.agenum.ru/admin/payout/acts/) — где оферта попадает в строку «Основание» и как выглядит подпись партнёра
- [Оферта в кабинете партнёра](https://docs.agenum.ru/partner/program-offer/) — как её видит и принимает партнёр

---

# Роли и права

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/roles/

> Как устроен редактор ролей, какие права можно выдать и как собрать роль администратора.

Роль — набор прав, который можно назначить [администратору](https://docs.agenum.ru/admin/settings/admins/).
Один администратор может состоять сразу в нескольких ролях — тогда его права
складываются из прав каждой. Экран **Роли и права** находится в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/roles).

:::tip
Страница открывается, только если в [общих настройках контура](https://docs.agenum.ru/admin/settings/application/)
включена опция «Показывать страницу «Роли»». Если раздел не открывается —
проверьте эту настройку там.
:::

## Как устроен редактор ролей

Экран — таблица. Столбцы — существующие роли, строки — права, сгруппированные
по разделам админки. У каждой группы есть стрелка, разворачивающая список
конкретных прав внутри неё. На пересечении роли и права стоит галочка: включена
— роль это может, выключена — не может.

Отметка галочки в таблице ничего не сохраняет сама по себе. У названия каждой
роли — три кнопки: карандаш переключает название в режим редактирования,
галочка рядом с ним сохраняет и новое название, и всё, что вы отметили в
столбце этой роли, а корзина удаляет роль сразу, без подтверждения.

## Какие бывают права

Права сгруппированы по разделам: Предложения, Категории предложений, Партнёры,
Юридические статусы партнёров, Группы партнёров, Лиды, Статусы лидов, Типы
полей лидов, Выплаты, Материалы, Уровни, Роли, Администраторы, API-ключи,
Промокоды, Партнёрские ссылки, Настройки приложения, Оферта партнёрской
программы.

Внутри почти каждого раздела — одинаковый набор: **Просмотр**, **Изменение**,
**Удаление**. У части разделов есть более точечные права сверх этого —
например, у Выплат это **Подтверждение выплат**, **Начисление выплат**,
**Просмотр реквизитов выплат**, **Просмотр актов** и **Изменение актов**
(выпуск акта и отметка о подписании), у Настроек приложения — **Просмотр
реквизитов организации** и **Изменение реквизитов организации**, у Администраторов — **Блокировка
администратора**, у Лидов — **Смена статуса лида** и **Сделка по лиду**.

:::tip
**Просмотр реквизитов выплат** стоит особняком: без него сотрудник видит в
заявке только последние цифры счёта. Это отдельное право, а не часть
**Начисления выплат**, — чтобы сверять и одобрять заявки мог один человек, а
видеть полные банковские данные партнёров только тот, кто действительно платит.
Каждое раскрытие записывается в журнал контура.
:::

Отметка галочки у группы целиком (например, у «Предложения») включает или
выключает сразу все права внутри неё; отметка у конкретного права внутри
группы меняет только его.

## Как собрать роль

1. В форме **Создать новую роль** внизу таблицы впишите **Название**.
2. В поле **Разрешения** отметьте нужные права — здесь они показаны плоским
   списком, без группировки по разделам.
3. Нажмите **Создать**.

Новая роль сразу появляется отдельным столбцом в таблице выше — дальше её
можно донастраивать так же, как любую другую.

## Что делать, если роли не редактируются или раздел не виден

**Не вижу форму создания роли или чекбоксы неактивны.** У вас нет прав на
изменение ролей — таблица открыта только для просмотра.

**Отметил права роли, но при обновлении страницы они не применились.** После
изменений в столбце роли нужно нажать галочку у её названия — без этого
изменения не сохраняются.

**Не вижу раздел «Роли» в настройках вовсе.** Он выключен в [общих настройках
контура](https://docs.agenum.ru/admin/settings/application/) — включите там опцию «Показывать
страницу «Роли»».

## Читать также

- [Сотрудники](https://docs.agenum.ru/admin/settings/admins/) — где роли назначаются администраторам
- [Общие настройки контура](https://docs.agenum.ru/admin/settings/application/) — переключатель, который включает эту страницу
- [ЛК администратора](https://docs.agenum.ru/admin/) — остальные разделы админки

---

# Вебхуки

Раздел: ЛК администратора. Адрес: https://docs.agenum.ru/admin/settings/webhooks/

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

Вебхуки нужны, когда лиды и выплаты ведутся ещё и в вашей CRM или учётной системе.
Вместо того чтобы она раз в несколько минут спрашивала контур «что изменилось», контур
сам отправляет ей событие сразу после изменения. Экран **Вебхуки** в разделе
[Настройки](https://ваш-контур.agenum.ru/admin/settings/webhooks) — список адресов, на
которые уходят события.

Как разобрать событие на стороне вашей системы, описано для разработчика в разделе
[Внешний API — Вебхуки](https://docs.agenum.ru/api/webhooks/).

:::tip
Раздел может быть недоступен на вашем тарифе — вебхуки входят в доступ к внешнему API.
Что входит в ваш тариф, видно в [Консоли](https://console.agenum.ru).
:::

## Как подключить адрес

1. Нажмите **Добавить адрес**.
2. В поле **Адрес** вставьте адрес приёмника, который дал разработчик вашей системы.
   Он должен начинаться с `https://`.
3. Добавьте описание — для себя, например «CRM, отдел продаж».
4. Отметьте **События**, которые нужны вашей системе. Галочка у названия группы
   (**Лиды**, **Баланс**, **Выплаты**, **Акты**) выбирает всю группу.
5. Нажмите **Добавить**.

Адресов может быть до десяти — например, отдельный для CRM и для бухгалтерии.

:::caution
Если адрес находится за пределами России, отправка на него — трансграничная передача
персональных данных партнёров. Уведомить об этом Роскомнадзор по ст. 12 закона
№ 152-ФЗ должна ваша организация как оператор данных — до того, как включить такой адрес.
:::

## Как получить секрет подписи

Сразу после добавления адреса в его карточке появляется секрет — им ваша система
проверяет, что событие пришло именно от контура. **Показать** раскрывает его,
**Копировать** копирует в буфер обмена, **Готово** закрывает блок.

:::tip
Секрет показывается один раз. Если ушли со страницы, не сохранив его, нажмите
**Сменить секрет** — появится новый, а старый перестанет подходить сразу. Передайте
новый секрет разработчику до смены, иначе часть событий не пройдёт проверку и уйдёт
повторно позже.
:::

## Как проверить, что адрес принимает события

Нажмите **Проверить** у адреса — контур отправит туда пробное событие и покажет
результат: «Доставлено: ответ 200 за 140 мс» или причину неудачи, например «сервер
ответил 500» или «нет ответа за 10 секунд». Пробное событие ничего не меняет и в журнал
не попадает. Проверять можно не чаще пяти раз в минуту.

## Что показывает карточка адреса

- адрес — без параметров после `?`: в них часто лежит токен доступа к вашей системе.
  Полный адрес виден в форме **Изменить**;
- статус: **Активен**, **Выключен** или **Выключен автоматически**;
- сколько событий выбрано и когда адрес добавлен;
- **Неудач подряд** — если последние отправки не прошли, с какого времени.

## Как следить за доставкой событий

Кнопка **Журнал** у адреса открывает список отправленных на него событий. Для каждого
видно событие, когда оно произошло, статус доставки, число попыток, последний исход и
время следующей попытки. Фильтры — по статусу и по событию. Кнопка **Ответ** показывает,
что вернул сервер вашей системы.

| Статус | Что значит |
|---|---|
| **Ждёт отправки** | ещё не отправлено или ждёт следующей попытки |
| **Доставлено** | ваша система подтвердила приём |
| **Не доставлено** | все попытки исчерпаны |

Если ваша система не ответила, контур повторяет отправку сам: через минуту, пять минут,
полчаса и дальше реже — всего восемь попыток примерно за полтора суток.

**Повторить** отправляет событие ещё раз — одной попыткой. Если событие давнее, повтор
может быть недоступен: подробности события удаляются, когда отправлять его больше
некуда, и контур ответит «Событие устарело, повторять нечего».

## Как выключить, изменить или удалить адрес

- **Выключить** — события на адрес перестают уходить, пока вы его не включите.
  Те, что ждали повтора, уйдут после включения; новые, случившиеся за это время, — нет.
- **Изменить** — поменять адрес, события и описание. Секрет при этом не меняется.
- **Удалить** — адрес пропадает вместе с журналом; система переспросит перед удалением.

## Что делать, если события перестали доходить до вашей системы

**Адрес выключен автоматически.** Так бывает, когда ваша система больше трёх суток
подряд не принимала события. Почините приёмник, нажмите **Проверить** и, если проверка
прошла, — **Включить**. События за время простоя на адрес не придут — их ваша система
забирает сверкой через API.

**В журнале «Ждёт отправки» и растёт число попыток.** Ваша система отвечает ошибкой или
не успевает ответить за 10 секунд. Причина — в колонке последнего исхода и по кнопке
**Ответ**.

**Адрес не сохраняется.** Контур принимает только адреса `https://`, доступные из
интернета, без логина и пароля в самом адресе. Текст ошибки подскажет, что не так.

## Читать также

- [Внешний API — Вебхуки](https://docs.agenum.ru/api/webhooks/) — формат событий и проверка подписи для разработчика
- [Ключи API](https://docs.agenum.ru/admin/settings/api-keys/) — доступ вашей системы к API
- [Настройки](https://docs.agenum.ru/admin/settings/) — остальные настройки контура

---

# Внешний API

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/

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

Внешний API нужен, когда лиды и выплаты живут в вашей системе, а не только в
админке: заявки заводит ваш сайт, статусы двигает ваша CRM, а решение по выплате
принимает ваша бухгалтерия. Через него проходит весь путь целиком — от заявки
клиента до выплаты партнёру и акта по ней.

Это единственный раздел документации, написанный для разработчика. Остальные
описывают те же сущности со стороны интерфейса.

:::tip
Доступ к API входит не во все тарифы. Если запросы возвращают ошибку доступа,
проверьте тариф в [Консоли](https://docs.agenum.ru/console/).
:::

## Базовый адрес

Все методы живут на адресе вашего контура:

```
https://ваш-контур.agenum.ru/api/external
```

## Где взять ключ доступа

Ключ создаётся в админке, в [настройках — раздел с ключами API](https://docs.agenum.ru/admin/settings/api-keys/).
Ключей может быть несколько: удобно завести отдельный на каждую интегрируемую
систему, чтобы потом отключать их по одному и видеть, какая система что сделала.

Значение показывается **один раз при создании** — сохраните его сразу, повторно
посмотреть его нельзя. Потерянный ключ не восстанавливают, а заводят заново.

Ключ можно деактивировать: деактивированный перестаёт работать немедленно, а
история его использования остаётся. Ключ, которым уже что-то делали — меняли
статусы, проводили выплаты, отменяли начисления, — удалить нельзя, только
деактивировать: иначе пропал бы ответ на вопрос «кто это сделал».

Ключ действует от имени администратора, который его создал. Если этого
администратора заблокировать, его ключи перестают работать сразу.

## Как авторизоваться

Ключ передаётся заголовком `x-api-key` в каждом запросе:

```http
GET /api/external/partner HTTP/1.1
Host: ваш-контур.agenum.ru
x-api-key: ваш-ключ
```

Возможные ответы при неудачной авторизации:

| Ситуация | Ответ |
|---|---|
| заголовок `x-api-key` не передан | `401`, «x-api-key не передан» |
| такого ключа нет | `401`, «API-ключ не найден» |
| ключ деактивирован | `401`, «API-ключ деактивирован» |
| администратор, создавший ключ, заблокирован | `401`, «API-ключ отключён: администратор, выпустивший его, заблокирован» |

## Какие методы есть

| Метод | Путь | Что делает |
|---|---|---|
| `GET` | `/lead-fields` | [поля лида](https://docs.agenum.ru/api/reference/), настроенные в вашем контуре |
| `GET` | `/lead-status` | [статусы лида](https://docs.agenum.ru/api/reference/) вашего контура |
| `GET` | `/offer`, `/offer/{id}` | [предложения](https://docs.agenum.ru/api/offer/) и одно предложение |
| `GET` | `/lead` | [список лидов](https://docs.agenum.ru/api/lead/) с фильтрами |
| `POST` | `/lead` | [создать лид](https://docs.agenum.ru/api/lead/) |
| `GET` | `/lead/{id}` | [карточка лида](https://docs.agenum.ru/api/lead/) с начислениями и сделками |
| `GET` | `/lead/{id}/status-history` | [история статусов лида](https://docs.agenum.ru/api/lead/) |
| `PUT` | `/lead/{id}/status` | [сменить статус лида](https://docs.agenum.ru/api/lead/) |
| `PUT` | `/lead/{id}/add-deal` | [добавить сделку к лиду](https://docs.agenum.ru/api/lead/) |
| `PUT` | `/lead/{id}/accrual/{entryId}/reverse` | [отменить начисление](https://docs.agenum.ru/api/lead/) по лиду |
| `GET` | `/partner`, `/partner/{id}` | [партнёры](https://docs.agenum.ru/api/partner/) и карточка партнёра |
| `GET` | `/partner/{id}/payout-requisites` | [реквизиты партнёра](https://docs.agenum.ru/api/partner/), замаскированные |
| `GET` | `/partner/{id}/balance` | [баланс партнёра](https://docs.agenum.ru/api/ledger/) |
| `GET` | `/partner/{id}/ledger` | [движения по балансу партнёра](https://docs.agenum.ru/api/ledger/) |
| `GET` | `/ledger` | [лента движений всех партнёров](https://docs.agenum.ru/api/ledger/) |
| `GET` | `/payout`, `/payout/{id}` | [выплаты](https://docs.agenum.ru/api/payout/) и карточка выплаты |
| `POST` | `/payout` | [создать выплату](https://docs.agenum.ru/api/payout/) |
| `GET` | `/payout/{id}/requisites` | [реквизиты, по которым платить](https://docs.agenum.ru/api/payout/) |
| `PUT` | `/payout/{id}/status` | [сменить статус выплаты](https://docs.agenum.ru/api/payout/): подтвердить, отметить выплаченной или отклонить |
| `POST` | `/payout/{id}/act` | [выпустить акт](https://docs.agenum.ru/api/act/) по выплаченной заявке |
| `GET` | `/act`, `/act/{id}` | [акты по выплатам](https://docs.agenum.ru/api/act/) и один акт |
| `GET` | `/act/{id}/pdf`, `/act/{id}/signature/pdf` | [PDF акта и лист подписания](https://docs.agenum.ru/api/act/) |
| `PUT` | `/act/{id}/signed` | [отметить акт подписанным](https://docs.agenum.ru/api/act/) вне платформы |

`{id}` во всех методах — UUID.

## В каких единицах передаются суммы

Все денежные поля API — **копейки, целым числом**. `15000` в поле `amount` —
это 150 рублей. Дробное значение не принимается: запрос с ним вернёт ошибку
валидации.

Это касается и суммы выплаты, и суммы сделки по лиду, и движений по балансу — в
обе стороны, и в запросах, и в ответах. Рубли живут только в интерфейсе
кабинетов: там сумму вводят и показывают в рублях, а по сети она всё равно идёт
в копейках.

:::tip
Если вы интегрировались до перехода на копейки, пересчитайте суммы: прежние
методы принимали рубли, и старый код отправит сумму в сто раз меньше нужной.
:::

## Как устроены списки

Все списки постраничные. Номер страницы — `page` (с единицы), размер — `size`
(по умолчанию 10, максимум 100). Ответ:

```json
{ "page": 1, "total": 137, "nextPage": 2, "data": [] }
```

`total` — сколько записей подходит под фильтр всего, `nextPage` — номер
следующей страницы или `null`, если эта последняя. Исключение — справочники
полей и статусов лида: они короткие и приходят одним массивом.

Даты в ответах и фильтрах — в формате ISO 8601, например
`2026-10-01T00:00:00.000Z`.

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

Всё, что вы меняете ключом — статус лида, статус выплаты, отмена начисления,
отметка акта, — записывается с автором-ключом. Администратор в интерфейсе видит
в истории «API-ключ «CRM»» с именем того, кто ключ создал.

В ответах API автор приходит одним объектом:

| Значение | Что означает |
|---|---|
| `{ "type": "apiKey", "id": "…", "title": "CRM" }` | действие сделано ключом внешнего API |
| `{ "type": "admin", "id": "…" }` | действие сделал администратор в интерфейсе |
| `null` | автора нет: действие партнёра или системы, например статус при создании лида |

Имена и почта сотрудников через API не отдаются — только идентификатор.

## Как повторить запрос и не создать дубль

Если ответ не дошёл из-за обрыва связи, запрос можно безопасно повторить:

- **Лид и сделка.** Передайте `externalId` — идентификатор записи в вашей
  системе. Повтор с тем же значением вернёт уже созданную запись, вторая не
  появится. Подробнее — в разделе [Лиды](https://docs.agenum.ru/api/lead/).
- **Смена статуса лида.** Повтор в тот же статус вернёт `409` с
  `"reason": "AlreadyInStatus"` — для повтора это успех.
- **Создание выплаты.** Пока у партнёра есть незакрытая заявка, повтор вернёт
  `409` с `"reason": "ActivePayoutExists"`.
- **Смена статуса выплаты.** Повтор того же перехода вернёт `409` «Недопустимый
  переход статуса» — заявка уже в нужном статусе, проверьте её карточкой.

Машинный `reason` лежит в теле ответа рядом с `message`. Опирайтесь на него, а не
на текст: текст может поменяться.

## Как забирать изменения опросом

Быстрее всего изменения доходят [вебхуками](https://docs.agenum.ru/api/webhooks/): контур сам присылает
событие на ваш адрес. Опрос нужен для сверки — после простоя вашей системы или раз в
сутки, потому что вебхук может не дойти, а события старше 30 дней не хранятся.
Изменения опросом забирают так:

- лиды — `GET /lead?updatedFrom=…`: лиды, изменённые начиная с момента;
- выплаты — `GET /payout?updatedFrom=…`;
- деньги партнёров — `GET /ledger?createdFrom=…`: начисления, отмены, резервы
  под выплаты. Начисление и сделка не меняют дату изменения лида, поэтому видны
  только в этой ленте.

С таким фильтром записи идут от старых к новым. Точкой отсчёта служит время
записи, а оно неточное: запись, сделанная долгой операцией, может появиться с
моментом раньше уже прочитанного. Поэтому:

1. Запоминайте самый поздний момент из прочитанных записей.
2. Следующий опрос начинайте с этого момента **минус запас** — несколько минут.
3. Записи, которые уже видели, отбрасывайте по `id`.
4. Читайте первую страницу и сдвигайте момент, а не листайте `page` подряд:
   запись, изменённая во время обхода, уезжает в конец списка, и соседняя
   строка между страницами потеряется.

## Читать также

- [Лиды](https://docs.agenum.ru/api/lead/) — заявки: создание, статусы, сделки, отмена начислений
- [Начисления и баланс](https://docs.agenum.ru/api/ledger/) и [Выплаты](https://docs.agenum.ru/api/payout/) — деньги партнёров
- [Вебхуки](https://docs.agenum.ru/api/webhooks/) — события push-запросами вместо опроса
- [API-ключи](https://docs.agenum.ru/admin/settings/api-keys/) — где ключи создаются и отключаются

---

# Акты

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/act/

> Методы внешнего API для актов по выплатам — список и карточка, PDF акта и листа подписания, выпуск акта позже и отметка «подписан вне платформы».

Акт оказанных услуг выпускается по выплаченной заявке — один на заявку, если в
контуре включён выпуск актов. Через внешний API акты можно найти, скачать,
выпустить позже, если при выплате это не получилось, и отметить подписанными,
когда партнёр подписал их вне платформы — например, в вашей системе ЭДО.

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

:::tip
Акты выпускаются, только если их выпуск включён в
[общих настройках контура](https://docs.agenum.ru/admin/settings/application/) и заполнены
[реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/).
:::

## Как получить список актов

```http
GET /api/external/act?year=2026&signed=false&page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный — формат в разделе [Внешний API](https://docs.agenum.ru/api/). Новые акты сверху.

| Параметр | Что фильтрует |
|---|---|
| `year` | год выпуска |
| `partnerId` | акты одного партнёра |
| `signed` | `true` — подписанные любым способом, `false` — неподписанные |

```json
{
  "id": "a1…",
  "number": "2026-17",
  "year": 2026,
  "amount": 15000,
  "issuedAt": "2026-10-03T09:00:00.000Z",
  "partnerId": "3d21…",
  "payoutRequest": { "id": "7c1f…", "number": 43 },
  "pdfSha256": "9f2c…",
  "signedOutsideAt": null,
  "partnerSignedAt": "2026-10-04T11:20:00.000Z",
  "signedMarkedBy": null
}
```

| Поле | Что означает |
|---|---|
| `number` | номер акта: год и порядковый номер внутри года |
| `amount` | сумма акта в копейках — равна сумме выплаты |
| `payoutRequest` | заявка, по которой выпущен акт |
| `pdfSha256` | отпечаток файла акта — по нему сверяют скачанный PDF |
| `partnerSignedAt` | когда партнёр подписал акт простой электронной подписью в кабинете |
| `signedOutsideAt` | когда акт отметили подписанным вне платформы |
| `signedMarkedBy` | кто поставил отметку: формат автора — в разделе [Внешний API](https://docs.agenum.ru/api/) |

Заполнено не больше одного из двух способов подписи.

## Как получить один акт

```http
GET /api/external/act/{id}
x-api-key: ваш-ключ
```

Тот же объект, что в списке.

## Как скачать PDF акта

```http
GET /api/external/act/{id}/pdf
x-api-key: ваш-ключ
```

Приходит файл `application/pdf` с именем `act-<номер>.pdf`. Акт неизменен после
выпуска: sha256 скачанного файла совпадает с `pdfSha256`.

Если партнёр подписал акт в кабинете, у него есть ещё лист подписания —
отдельный PDF с данными подписи:

```http
GET /api/external/act/{id}/signature/pdf
x-api-key: ваш-ключ
```

У акта без такой подписи листа нет — метод вернёт `404`.

:::tip
В акте ИНН и ФИО партнёра, поэтому каждое скачивание по ключу записывается в
журнал контура.
:::

## Как выпустить акт позже

Если при выплате акт не выпустился — например, не были заполнены реквизиты
организации, — выплата всё равно проходит, а в её карточке приходит
`actUnavailableReason`. Устраните причину и выпустите акт:

```http
POST /api/external/payout/{id}/act
x-api-key: ваш-ключ
```

`{id}` — заявка на выплату. В ответ приходит выпущенный акт.

| `actUnavailableReason` | Что означает |
|---|---|
| `ActsDisabled` | выпуск актов в контуре выключен |
| `OrgRequisitesMissing` | не заполнены реквизиты организации или основание акта |
| `LegalTypeNotSupported` | акт выпускается только самозанятым, ИП и юрлицам |
| `PartnerDataMissing` | у партнёра не хватает ФИО или наименования, либо ИНН в заявке не подходит его статусу |
| `SnapshotInvariantBroken` | состав заявки не сходится с её суммой — обратитесь в поддержку |

## Как отметить акт подписанным вне платформы

Если партнёр подписал акт не в кабинете, а иначе — бумагой или через вашу ЭДО, —
поставьте отметку:

```http
PUT /api/external/act/{id}/signed
x-api-key: ваш-ключ
Content-Type: application/json

{ "signed": true }
```

`"signed": false` снимает отметку. Автором отметки записывается ваш ключ, в ответ
приходит акт. Повторная отметка не меняет ни автора, ни время первой. Подписать
акт за партнёра через API нельзя — простой электронной подписью он подписывает
только сам, в кабинете.

## Какие ошибки возвращают методы актов

| Ответ | Сообщение | Что делать |
|---|---|---|
| `404` | Акт не найден | проверьте `id` |
| `404` | Заявка не найдена | при выпуске акта — проверьте `id` заявки |
| `404` | Лист подписания есть только у акта, подписанного партнёром в личном кабинете | у этого акта листа нет |
| `409` | Акт выпускается только по выплаченной заявке | сначала переведите заявку в `Paid` |
| `409` | Акт по этой заявке уже выпущен | акт есть — найдите его в карточке заявки |
| `409` | текст причины, `reason` — код из таблицы выше | устраните причину и повторите выпуск |
| `409` | Акт подписан партнёром электронной подписью… | отметка «вне платформы» к такому акту не ставится и не снимается |

## Читать также

- [Выплаты](https://docs.agenum.ru/api/payout/) — заявка, по которой выпускается акт
- [Акты](https://docs.agenum.ru/admin/payout/acts/) — те же акты в интерфейсе администратора
- [Реквизиты организации](https://docs.agenum.ru/admin/settings/organization-requisites/) — без них акт не выпустится

---

# Лиды

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/lead/

> Методы внешнего API для работы с заявками — список и карточка лида, создание без дублей, привязка к партнёру, смена статуса, сделки и отмена начисления.

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

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/). Поля и статусы лида,
из которых собираются запросы, — в разделе [Справочники](https://docs.agenum.ru/api/reference/).

## Как создать лид

```http
POST /api/external/lead
x-api-key: ваш-ключ
Content-Type: application/json

{
  "externalId": "crm-10457",
  "sessionId": "3f2a…",
  "fields": [
    { "fieldTypeId": "0f8c…", "value": "ivan@example.com" },
    { "fieldTypeId": "b31a…", "value": "msk" }
  ]
}
```

| Поле | Обязательное | Описание |
|---|---|---|
| `fields` | да | значения полей заявки |
| `externalId` | нет | идентификатор заявки в вашей системе, до 128 символов — защищает от дублей, см. ниже |
| `sessionId` | нет | переход по партнёрской ссылке |
| `promocode` | нет | промокод, которым воспользовался клиент |
| `linkId` | нет | партнёрская ссылка, если перехода по ней не было |
| `partnerId` | нет | партнёр, которого вы знаете сами |
| `offerId` | нет | предложение — обязательно вместе с `partnerId`, может уточнять `promocode` |

Значение поля передаётся по его типу:

| Тип поля | Что передавать в `value` |
|---|---|
| `String` | строку |
| `Number` | число |
| `Boolean` | `true` или `false` |
| `List` | `id` одной из опций поля — не название опции |

Значение, которое не подходит типу поля, отклоняется целиком: в списке — строка не из
`id` его опций, в числе — текст, во флаге — что-то кроме `true` и `false`. Опции поля
приходят в [справочнике полей](https://docs.agenum.ru/api/reference/). Пустая строка означает «не заполнено» и
проверяется только на обязательность.

В ответ приходит созданный лид: его `id`, `externalId`, начальный статус,
привязанные партнёр и предложение и все заполненные поля. Начальный статус —
тот, который в контуре помечен как первичный.

## Как не создать дубль лида при повторном запросе

Если ответ на создание не дошёл, повторить запрос безопасно, когда в нём есть
`externalId`. Лид с таким `externalId` уже есть — метод вернёт его, а не создаст
второй. Это работает и для двух одновременных запросов: оба получат один и тот
же лид.

`externalId` уникален в пределах контура: одно значение — один лид. По нему же
лид можно найти — `GET /lead?externalId=crm-10457`.

## Как привязать лид к партнёру

Заявку связывают с партнёром одним из четырёх способов: `sessionId`,
`promocode`, `linkId` или `partnerId` вместе с `offerId`. **Если не передать
ничего, лид создастся ничьим:** вознаграждение по нему никому не начислится.

Способ передаётся ровно один. Запрос с двумя сразу — например, `linkId` и
`partnerId` — вернёт ошибку, а не выберет один молча. `null` и пустая строка
способом не считаются.

**По ссылке.** Партнёр размещает свою короткую ссылку, а мы, отправляя клиента
на целевую страницу, дописываем к её адресу параметр `session`:

```
https://example.com/landing?session=3f2a…
```

Задача вашей страницы — сохранить это значение (например, в скрытом поле формы
или в cookie) и отдать его как `sessionId` при создании лида. Одна сессия — один
лид: повторный запрос с тем же `sessionId` вернёт ошибку.

**По промокоду.** Передайте сам код в `promocode`. Код должен быть активным:
промокоды на проверке и отключённые не принимаются. Одинаковые заявки по одному
промокоду в течение суток считаются повтором и отклоняются — так отсекаются
дубли от повторной отправки формы. `offerId` рядом с промокодом уточняет
предложение, если один код заведён на несколько.

**По ссылке без перехода.** Если клиент пришёл не по короткой ссылке, а вы знаете,
чья это ссылка, передайте её `id` в `linkId`: партнёр и предложение возьмутся из
ссылки. `offerId` вместе с `linkId` или `sessionId` не передаётся — у ссылки
предложение своё.

**Партнёр известен вам самим** — например, клиента порекомендовали по телефону.
Передайте `partnerId` и `offerId`: так же заводит заявку администратор вручную.
Предложение должно быть доступно этому партнёру.

### Если у партнёра нет доступа к предложению

Доступ закрывают [настройки доступа](https://docs.agenum.ru/admin/offer/create/#кому-будет-видно-предложение)
предложения или блокировка партнёра. Дальше всё зависит от того, кто выбрал
партнёра:

- **`linkId` и `partnerId`** выбираете вы — запрос вернёт `400` «Оффер
  недоступен», лид не создаётся;
- **`sessionId` и `promocode`** принёс клиент — лид создаётся на
  предложение **без партнёра** (`partner: null`), и вознаграждение по нему не
  начисляется. Клиента вы не теряете. Повтор той же заявки по промокоду всё
  равно отклоняется как дубль.

Переход по ссылке такого партнёра ведёт клиента на страницу предложения без
параметра `session` — передавать вам будет нечего, и лид тоже придёт без партнёра.

## Как получить список лидов

```http
GET /api/external/lead?partnerIds=3d21…&createdFrom=2026-10-01T00:00:00Z&page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный — формат в разделе [Внешний API](https://docs.agenum.ru/api/). Каждый лид — тот же
объект, что приходит при создании.

| Параметр | Что фильтрует |
|---|---|
| `statusId` | лиды в одном статусе |
| `partnerIds`, `offerIds` | лиды партнёров или предложений — `id` через запятую |
| `createdFrom`, `createdTo` | период создания лида |
| `updatedFrom` | лиды, изменённые начиная с момента — для синхронизации |
| `externalId` | лид по идентификатору из вашей системы |
| `fieldFilters` | по значениям полей: JSON-массив `[{"fieldTypeId":"…","value":"…"}]`. Строки ищутся по вхождению без учёта регистра, остальные типы — по точному значению |

Без `updatedFrom` новые лиды идут первыми. С ним — от старых изменений к новым:
так их забирают опросом. Как не потерять изменения между опросами, описано в
разделе [Внешний API](https://docs.agenum.ru/api/).

## Как получить карточку лида

```http
GET /api/external/lead/{id}
x-api-key: ваш-ключ
```

К полям лида из списка карточка добавляет:

| Поле | Что означает |
|---|---|
| `dealTransaction` | сделки по лиду: `id`, `amount` в копейках, `externalId`, `createdAt` |
| `partnerPromocode` | промокод, по которому пришёл лид, или `null` |
| `clickSession` | переход по партнёрской ссылке и сама ссылка, или `null` |
| `ledgerEntries` | движения по балансу партнёра, связанные с лидом: начисления и их отмены, новые сверху |

У каждого движения есть `type` (`Accrual` — начисление, `Reversal` — отмена),
`amount` в копейках со знаком, `availableAt` — когда сумма станет доступна к
выводу, `comment` — причина отмены, `createdBy` — автор отмены (формат в разделе
[Внешний API](https://docs.agenum.ru/api/); у начисления и у автоматической отмены — `null`).

У начисления дополнительно есть `settlement` — куда делись его деньги:

| Поле | Что означает |
|---|---|
| `paid` | уже выплачено партнёру |
| `inPayout` | входит в заявку, которая ещё не выплачена |
| `reversed` | отменено |
| `free` | остаётся на балансе партнёра |
| `payouts` | заявки, в которые ушли деньги: `id`, `number`, `status`, `amount` |

Сумма всегда сходится: `amount = paid + inPayout + reversed + free`.

## Как получить историю статусов лида

```http
GET /api/external/lead/{id}/status-history
x-api-key: ваш-ключ
```

```json
[
  { "id": "h1…", "createdAt": "2026-10-01T10:00:00.000Z", "status": { "id": "s1…", "systemName": "new", "title": "Новый" }, "changedBy": null },
  { "id": "h2…", "createdAt": "2026-10-03T12:00:00.000Z", "status": { "id": "s2…", "systemName": "deal", "title": "Сделка" }, "changedBy": { "type": "apiKey", "id": "k1…", "title": "CRM" } }
]
```

Записи идут от старых к новым. Первая — статус при создании лида, автора у неё
нет. Статусы вашего контура — в разделе [Справочники](https://docs.agenum.ru/api/reference/).

## Как сменить статус лида

```http
PUT /api/external/lead/{id}/status
x-api-key: ваш-ключ
Content-Type: application/json

{ "systemName": "in_progress" }
```

Статус указывается либо по `id`, либо по `systemName` — тому, что задан в
настройках статусов вашего контура. Хотя бы одно из двух передать обязательно.

При переводе в **целевой** статус — тот, что означает состоявшуюся сделку, —
нужно передать ещё и `amount` с суммой сделки **в копейках, целым числом**:
`15000` — это 150 рублей. Дробное значение метод не примет. Исключение: в
предложении включено «Разрешить сделки по предложению без суммы», тогда сумму
можно не передавать, а если передаёте — допустим ноль.

Смена статуса запускает начисление вознаграждения партнёру, поэтому именно этот
метод обычно и вызывается из CRM. Начисление появляется через несколько секунд
после ответа — ищите его в [ленте движений](https://docs.agenum.ru/api/ledger/), а не в ответе метода.
Перевод в отменяющий статус сразу гасит ещё не созревшие начисления по лиду.

В истории статусов автором смены будет ваш ключ.

Повторный перевод в статус, в котором лид уже находится, вернёт `409` с
`"reason": "AlreadyInStatus"` и ничего не изменит. Если запрос повторяется после
обрыва связи, это означает, что первый дошёл.

## Как добавить сделку к лиду

Если по одной заявке проходит несколько сделок, каждую следующую добавляют
отдельно:

```http
PUT /api/external/lead/{id}/add-deal
x-api-key: ваш-ключ
Content-Type: application/json

{ "amount": 15000, "externalId": "deal-881" }
```

Сумма — **копейки, целым числом**; в примере это 150 рублей. Минимум — одна
копейка (`1`), максимум — 20 000 000 рублей (`2000000000`). Ноль и дробные
значения метод не принимает, в отличие от смены статуса, где ноль легален.

`externalId` — идентификатор сделки в вашей системе, необязательный. Повтор с
тем же `externalId` по тому же лиду вернёт уже добавленную сделку, а не создаст
вторую — и второе начисление партнёру не появится.

Метод работает только когда лид уже находится в целевом статусе: до этого
добавлять сделки не к чему.

С каждой добавленной сделки партнёру начисляется процент, если он задан в
условиях вознаграждения. Фиксированная сумма с добавленной сделки не
начисляется: она платится один раз — за перевод лида в статус.

## Как начислять процент с каждого платежа клиента (RevShare)

Если приведённый клиент платит не один раз, а регулярно — подписка, абонемент,
повторные заказы, — партнёру можно платить процент с каждого платежа. Отдельного
режима для этого нет и не нужен: каждый платёж передаётся в Agenum сделкой по
тому же лиду, а процент начисляется автоматически. Интеграция строится на
стороне вашей CRM или биллинга:

1. **Первый платёж** — переведите лида в целевой статус и передайте `amount`
   ([смена статуса](https://docs.agenum.ru/api/lead/#как-сменить-статус-лида)). Сумма перевода становится первой
   сделкой: с неё начисляются и фиксированная сумма, и процент, если заданы оба.
2. **Каждый следующий платёж** — вызовите `add-deal` с суммой платежа. В
   `externalId` передавайте идентификатор платежа в вашей системе: если запрос
   повторится после обрыва связи, второго начисления не будет.
3. **Возврат денег клиенту** — [отмените начисление](https://docs.agenum.ru/api/lead/#как-отменить-начисление-по-лиду)
   по этому платежу.

```http
PUT /api/external/lead/{id}/add-deal
x-api-key: ваш-ключ
Content-Type: application/json

{ "amount": 99000, "externalId": "payment-2026-11" }
```

Процент считается от суммы каждой сделки отдельно и созревает по своему
[периоду удержания](https://docs.agenum.ru/admin/offer/create/#удержание-вывода-вознаграждения),
отсчитанному от момента начисления.

Срока у RevShare в Agenum нет: процент начисляется с каждой сделки, пока вы их
присылаете. Если по условиям программы партнёр получает процент, например,
только за первый год подписки, ваша система перестаёт передавать платежи по
этому лиду, когда год истёк.

## Как отменить начисление по лиду

Если клиент вернул товар или сделка оказалась фиктивной, начисленное партнёру
вознаграждение можно отменить. `entryId` — `id` начисления из `ledgerEntries`
[карточки лида](https://docs.agenum.ru/api/lead/#как-получить-карточку-лида).

```http
PUT /api/external/lead/{id}/accrual/{entryId}/reverse
x-api-key: ваш-ключ
Content-Type: application/json

{ "reason": "Клиент вернул товар" }
```

`reason` обязателен, от 3 до 500 символов — его увидит партнёр. В ответ приходит
запись отмены с отрицательной суммой.

Что можно отменить:

- начисление, которое ещё не выплачено, — целиком, даже если удержание уже
  закончилось;
- частично выплаченное — только остаток, выплаченное остаётся у партнёра;
- если начисление входит в заявку, которая ещё не выплачена, сначала отклоните
  заявку, затем отмените начисление.

Автором отмены записывается ваш ключ.

## Какие ошибки возвращают методы лидов

| Ответ | Сообщение | Что делать |
|---|---|---|
| `400` | Обязательное поле «…» не заполнено | добавьте поле в `fields`, список — в [справочнике полей](https://docs.agenum.ru/api/reference/) |
| `400` | Поле «…»: значение должно быть id одной из опций списка | передайте `id` опции из справочника полей, а не её название |
| `400` | Поле «…»: значение должно быть числом / true или false / строкой | значение не подходит типу поля |
| `400` | Тип поля … не найден | `fieldTypeId` устарел, перечитайте список полей |
| `400` | Передайте один источник атрибуции, а не несколько: … | оставьте один из `sessionId`, `promocode`, `linkId`, `partnerId` |
| `400` | Для лида с partnerId укажите offerId | добавьте `offerId` |
| `400` | offerId не передаётся вместе с sessionId или linkId… | уберите `offerId` — предложение берётся из ссылки |
| `400` | fieldFilters — JSON-массив фильтров | проверьте JSON в параметре `fieldFilters` |
| `400` | Лид уже создан для этой сессии | по этому переходу заявка уже есть |
| `400` | Лид с таким набором полей уже создан | дубль по промокоду за сутки; прежний лид приходит в теле ответа |
| `400` | Укажите id или systemName статуса | передайте одно из полей |
| `400` | При переводе в статус «…» необходимо указать сумму сделки | добавьте `amount` |
| `400` | Сумма сделки указывается в копейках целым числом | уберите дробную часть — 150 рублей это `15000` |
| `400` | Сумма сделки не может быть отрицательной | при смене статуса допустимы ноль и больше |
| `400` | Сумма сделки должна быть больше нуля | в `add-deal` ноль не принимается, минимум — `1` |
| `400` | Отменить можно только начисление | `entryId` указывает на другое движение — возьмите `id` записи с `type: Accrual` |
| `404` | Лид не найден | проверьте `id` |
| `404` | Сессия не найдена | значение `session` не дошло до вашей формы или было изменено |
| `404` | Ссылка не найдена | проверьте `linkId` |
| `404` | Партнёр не найден | проверьте `partnerId` |
| `404` | Промкод не найден или неактивен | код не существует или ещё не подтверждён |
| `400` | Оффер недоступен | у партнёра из `linkId` или `partnerId` нет доступа к предложению или он заблокирован |
| `404` | Предложение недоступно | предложение в черновике, ещё не началось или уже закончилось |
| `404` | Начисление не найдено | у этого лида нет начисления с таким `entryId` |
| `409` | Лид уже находится в статусе «…» (`reason: AlreadyInStatus`) | лид уже в нужном статусе — повтор можно считать успехом |
| `409` | Статус лида уже изменён — обновите карточку | статус поменяли параллельно; перечитайте лид и решите, нужна ли смена |
| `409` | Добавлять сделки можно только в статусе «…» | сначала переведите лид в целевой статус |
| `409` | Начисление уже отменено | отменять нечего |
| `409` | Начисление входит в заявку на выплату №… | отклоните заявку и повторите отмену |
| `409` | Начисление полностью выплачено партнёру… | выплаченное не отменяется |
| `409` | На балансе партнёра недостаточно средств для отмены начисления | баланс уже уменьшен другими операциями |

## Читать также

- [Внешний API](https://docs.agenum.ru/api/) — базовый адрес, ключи, повторы и синхронизация
- [Справочники](https://docs.agenum.ru/api/reference/) — поля и статусы лида
- [Предложения](https://docs.agenum.ru/api/offer/) — `offerId` для заявки с известным партнёром
- [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/) — где администратор настраивает состав заявки

---

# Начисления и баланс

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/ledger/

> Методы внешнего API для денег партнёров — баланс, движения по балансу партнёра и общая лента движений для синхронизации с учётной системой.

Деньги партнёра учитываются движениями: каждое начисление, отмена, резерв под
выплату и возврат резерва — отдельная запись. Записи не меняются и не удаляются,
поэтому по ним всегда можно восстановить, откуда у партнёра его баланс. Через
внешний API можно получить баланс партнёра, его движения и общую ленту движений
всех партнёров — по ней учётная система забирает начисления.

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

## Как получить баланс партнёра

```http
GET /api/external/partner/{id}/balance
x-api-key: ваш-ключ
```

```json
{ "available": 400000, "onHold": 120000, "pendingAmount": 100000 }
```

| Поле | Что означает |
|---|---|
| `available` | доступно к выводу, в копейках. Сумма в незакрытых заявках уже вычтена |
| `onHold` | в удержании: начисления, срок которых ещё не наступил |
| `pendingAmount` | зарезервировано незакрытыми заявками на выплату — для справки, из `available` уже вычтено |

Заявку на выплату можно создать на сумму не больше `available`.

## Какие бывают движения по балансу

| `type` | Знак | Что означает |
|---|---|---|
| `Accrual` | + | начисление вознаграждения за лида |
| `Reversal` | − | отмена начисления: при отказе по лиду или вручную |
| `PayoutHold` | − | резерв под заявку на выплату, списывается при её создании |
| `PayoutRelease` | + | возврат резерва, если заявку отклонили или партнёр её отменил |
| `Adjustment` | ± | ручная корректировка |
| `Fine` | − | штраф |

Выплата отдельного движения не создаёт: деньги списаны резервом в момент
создания заявки.

## Что означают поля движения

```json
{
  "id": "e1…",
  "partnerId": "3d21…",
  "amount": -10000,
  "type": "Reversal",
  "availableAt": "2026-10-15T00:00:00.000Z",
  "leadId": "d4e5…",
  "payoutRequestId": null,
  "leadStatusId": null,
  "reversedEntryId": "a7b8…",
  "comment": "Клиент вернул товар",
  "createdAt": "2026-10-12T09:30:00.000Z",
  "createdBy": { "type": "apiKey", "id": "k1…", "title": "CRM" }
}
```

| Поле | Что означает |
|---|---|
| `amount` | сумма в копейках со знаком |
| `availableAt` | с этого момента сумма доступна к выводу; у отмены — та же дата, что у отменённого начисления |
| `leadId` | лид, за который начислено или отменено |
| `payoutRequestId` | заявка на выплату — у резерва и возврата резерва |
| `leadStatusId` | статус лида, при переходе в который сработало начисление |
| `reversedEntryId` | у отмены — какое начисление она гасит |
| `comment` | причина ручной отмены |
| `createdBy` | автор ручной отмены; у остальных движений `null`. Формат — в разделе [Внешний API](https://docs.agenum.ru/api/) |

## Как получить движения одного партнёра

```http
GET /api/external/partner/{id}/ledger?page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный, новые движения сверху. Принимает те же фильтры, что и
общая лента: `type` и `createdFrom`.

## Как забирать начисления в учётную систему

```http
GET /api/external/ledger?createdFrom=2026-10-12T09:00:00Z&type=Accrual&size=100
x-api-key: ваш-ключ
```

Общая лента движений всех партнёров. Параметры: `createdFrom` — движения,
записанные начиная с момента, `partnerId` — одного партнёра, `type` — один вид
движения.

С `createdFrom` записи идут от старых к новым, без него — новые сверху.
Начисление за смену статуса лида записывается через несколько секунд после
ответа метода смены статуса, поэтому ждите его здесь, а не в ответе.

:::tip
Читайте ленту с запасом по времени и отбрасывайте уже виденные записи по `id`:
движение долгой операции может появиться с моментом раньше уже прочитанного.
Порядок опроса — в разделе [Внешний API](https://docs.agenum.ru/api/).
:::

## Какие ошибки возвращают методы баланса

| Ответ | Сообщение | Что делать |
|---|---|---|
| `400` | ошибка валидации `type` или `createdFrom` | `type` — одно из значений таблицы выше, `createdFrom` — дата ISO 8601 |
| `404` | Партнёр не найден | проверьте `id` партнёра |

## Читать также

- [Лиды](https://docs.agenum.ru/api/lead/) — откуда берутся начисления и как отменить начисление
- [Выплаты](https://docs.agenum.ru/api/payout/) — как деньги с баланса уходят партнёру
- [Партнёры](https://docs.agenum.ru/api/partner/) — список партнёров и их карточки
- [Баланс партнёра в интерфейсе администратора](https://docs.agenum.ru/admin/partner/balance/) — те же деньги на экране

---

# Предложения

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/offer/

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

Предложение (оффер) — то, что партнёры продвигают: товар или услуга с целевой
страницей и условиями вознаграждения. Через внешний API предложения можно только
читать — например, чтобы взять `offerId` для заявки с известным партнёром или
показать условия в своей системе. Заводят и меняют предложения в
[интерфейсе администратора](https://docs.agenum.ru/admin/offer/).

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

## Как получить список предложений

```http
GET /api/external/offer?status=active&page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный — формат в разделе [Внешний API](https://docs.agenum.ru/api/).

| Параметр | Что фильтрует |
|---|---|
| `status` | `active` — работают сейчас (по умолчанию), `pending` — начнут работать позже, `archive` — закончились, `draft` — черновики |
| `title` | по названию |
| `ids`, `categories` | по `id` предложений или категорий через запятую |
| `tools` | по способу привлечения: `Link`, `Promocode` |

## Как получить одно предложение

```http
GET /api/external/offer/{id}
x-api-key: ваш-ключ
```

| Поле | Что означает |
|---|---|
| `title`, `description`, `link` | название, описание и целевая страница |
| `tools` | как партнёры приводят клиентов: `Link` — по ссылке, `Promocode` — по промокоду |
| `isDraft` | черновик: партнёры предложение не видят |
| `startAt`, `endAt`, `unlimited` | период работы; при `unlimited: true` даты не действуют |
| `payoutHoldDays` | сколько дней начисление удерживается, прежде чем станет доступно к выводу; `null` — по настройкам контура |
| `dealWithoutAmount` | сделку можно зафиксировать без суммы |
| `defaultBenefit` | что получает клиент — текст для партнёров |
| `categories` | категории предложения |
| `awardSettings` | условия вознаграждения партнёрам: кому (`entityType`: всем, группам, конкретным партнёрам, уровням), сколько (`awardType`: `Fixed` — сумма `amount` в копейках, `Percent` — процент `percent` от сделки, `None` — без вознаграждения) и за какой статус лида (`leadStatusId`) |

## Какие ошибки возвращают методы предложений

| Ответ | Сообщение | Что делать |
|---|---|---|
| `400` | ошибка валидации `status` | допустимы `active`, `pending`, `draft`, `archive` |
| `404` | Предложение не найдено | проверьте `id` |

## Читать также

- [Лиды](https://docs.agenum.ru/api/lead/) — создание лида с предложением
- [Предложения](https://docs.agenum.ru/admin/offer/) — те же предложения в интерфейсе администратора

---

# Партнёры

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/partner/

> Методы внешнего API для партнёров — список с фильтрами, карточка с дополнительными полями, юридический тип, уровень, группы и реквизиты выплаты.

Партнёр — тот, кто приводит клиентов по реферальной ссылке или промокоду. Через
внешний API партнёров можно только читать: найти в списке, получить карточку с
дополнительными полями и реквизиты выплаты — например, чтобы сверить их с
записями в своей CRM. Заводят и меняют партнёров в
[интерфейсе администратора](https://docs.agenum.ru/admin/partner/). Деньги партнёра — баланс и
движения — в разделе [Начисления и баланс](https://docs.agenum.ru/api/ledger/).

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

## Как получить список партнёров

```http
GET /api/external/partner?search=ivan&page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный — формат в разделе [Внешний API](https://docs.agenum.ru/api/). Без параметра
`sort` партнёры отсортированы по дате регистрации, от новых к старым.

Порядок задаёт параметр `sort`:

| Значение | Порядок |
|---|---|
| `createdAt_desc` | по дате регистрации, сначала новые — по умолчанию |
| `createdAt_asc` | по дате регистрации, сначала старые |
| `name_asc`, `name_desc` | по фамилии, затем имени и email; партнёры без фамилии и имени — в конце в обоих направлениях |
| `leads_desc`, `leads_asc` | по числу лидов партнёра; при равенстве — сначала новые |
| `lastLeadAt_desc`, `lastLeadAt_asc` | по дате последнего нового лида; партнёры без лидов — в конце в обоих направлениях, при равенстве — сначала новые |

Любое другое значение — `400`. Порядок устойчив между страницами: при равных
значениях партнёры не переезжают со страницы на страницу.

Заблокированных партнёров в списке нет ни при каких параметрах: `isBlocked=true`
вернёт пустой список. Карточка заблокированного по `id` при этом отдаётся — на
него ссылаются его лиды, выплаты и акты.

| Параметр | Что фильтрует |
|---|---|
| `search` | по вхождению в email, имя или фамилию, без учёта регистра |
| `ids` | конкретные партнёры — `id` через запятую |
| `groups`, `levels` | партнёры групп или уровней — `id` через запятую |
| `isConfirmed` | `true` или `false` — по признаку |
| `activity` | `active`, `inactive` или `noLeads` — по [активности партнёра](https://docs.agenum.ru/api/partner/#как-понять-активен-ли-партнёр). Любое другое значение — `400` |
| `offerId` | только партнёры, которым доступно это предложение; заблокированные не входят. Несуществующее предложение — `404` |

```json
[
  {
    "id": "3d21…",
    "email": "partner@example.com",
    "firstName": "Иван",
    "middleName": null,
    "lastName": "Иванов",
    "isConfirmed": true,
    "emailConfirmedAt": "2026-08-01T10:05:00.000Z",
    "isBlocked": false,
    "activity": "active",
    "lastLeadAt": "2026-10-20T07:05:00.000Z",
    "lastActivityAt": "2026-10-29T09:14:00.000Z",
    "isOnline": false,
    "legalType": { "id": "a1c9…", "type": "IE" },
    "level": { "id": "9b7e…", "number": 1, "description": "Базовый" },
    "groups": [{ "id": "f001…", "title": "VIP" }],
    "createdAt": "2026-08-01T10:00:00.000Z",
    "updatedAt": "2026-09-01T12:30:00.000Z",
    "leadsCount": { "s1…": 12, "s2…": 3 }
  }
]
```

## Что означают поля партнёра

| Поле | Что означает |
|---|---|
| `id` | идентификатор партнёра |
| `email` | почта, которой партнёр входит в личный кабинет |
| `firstName`, `middleName`, `lastName` | имя партнёра; не заполнено — `null` |
| `isConfirmed` | администратор допустил партнёра к выплатам; с почтой не связано |
| `emailConfirmedAt` | когда партнёр подтвердил email — кодом или переходом по ссылке из письма; `null` — не подтверждён. Выплату партнёр запросит только при `isConfirmed: true` и заполненном `emailConfirmedAt` |
| `isBlocked` | вход в личный кабинет заблокирован администратором |
| `activity` | активность партнёра по лидам: `active`, `inactive` или `noLeads` — см. [ниже](https://docs.agenum.ru/api/partner/#как-понять-активен-ли-партнёр) |
| `lastLeadAt` | когда на партнёра пришёл последний новый лид; `null` — лидов не было |
| `lastActivityAt` | когда партнёр последний раз был в личном кабинете; `null` — не заходил |
| `isOnline` | партнёр сейчас в личном кабинете — открыта вкладка с кабинетом |
| `legalType` | юридический тип партнёра — см. ниже; `null`, если тип не выбран |
| `level` | уровень партнёра, влияет на условия вознаграждения; `null`, если уровень не назначен |
| `groups` | группы, в которые включён партнёр |
| `createdAt`, `updatedAt` | даты регистрации и последнего изменения записи |
| `leadsCount` | число лидов партнёра по статусам: ключ — `id` статуса, значение — количество. Статусы без лидов не приходят |

Значений дополнительных полей — ИНН, паспортных данных, реквизитов организации —
в списке нет: они приходят в [карточке партнёра](https://docs.agenum.ru/api/partner/#как-получить-карточку-партнёра).

## Как понять, активен ли партнёр

Активность партнёра в Agenum — это лидогенерация: приводит ли он новых клиентов.
Считается она только по **новым** лидам — смена статуса уже созданного лида на
активность не влияет. Удаление лида её тоже не отменяет.

| `activity` | Что означает |
|---|---|
| `active` | за последние 30 дней на партнёра пришёл хотя бы один новый лид |
| `inactive` | лиды были, но последний — больше 30 дней назад |
| `noLeads` | лидов не было ни разу — например, партнёр только зарегистрировался |

Значение считается на момент запроса, поэтому партнёр сам перейдёт из
`active` в `inactive`, если перестанет приводить клиентов. Дата, от которой
считается, — в поле `lastLeadAt`.

Лид, который пришёл по ссылке или промокоду партнёра, потерявшего доступ к
предложению, остаётся без партнёра и его активность не продлевает.

:::tip
Активность не влияет на лимит партнёров по тарифу: неактивный партнёр и партнёр
без лидов занимают место так же, как активный. Место освобождает только блокировка.
:::

Присутствие в кабинете — отдельный признак: `isOnline` и `lastActivityAt`
показывают, заходит ли партнёр в личный кабинет, а не приводит ли клиентов.

## Какой бывает юридический тип партнёра

Юридический тип определяет, какие дополнительные поля (паспортные данные,
реквизиты ИП, реквизиты организации) администратор запрашивает у партнёра при
регистрации. Состав полей, их обязательность и видимость задаются отдельно для
каждого типа: одно и то же поле бывает обязательным у ИП и необязательным у
физлица. Настраивается это в разделе
[Поля и юридические типы партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/).

| `legalType.type` | Что означает |
|---|---|
| `Individual` | физическое лицо |
| `SelfEmployed` | самозанятый |
| `IE` | индивидуальный предприниматель |
| `LegalEntity` | юридическое лицо |

## Как получить карточку партнёра

```http
GET /api/external/partner/{id}
x-api-key: ваш-ключ
```

Карточка — те же поля, что в списке, и ещё два:

| Поле | Что означает |
|---|---|
| `legalType.fields` | поля, которые положено заполнить партнёру его юридического типа: `id`, `systemName`, `label`, `type`, `required`, `hidden` — скрыто от партнёра в его форме, `order` |
| `fields` | заполненные значения: `stringValue`, `intValue`, `boolValue` или `idValue` (для списка) — по типу поля, и само поле в `fieldType` |

Значения сопоставляют с полями по `fieldType.id` или по `fieldType.systemName`.
ИНН лежит в поле с `systemName: "inn"` — по карточке заранее видно, кому не
хватит ИНН для заявки на выплату.

## Как получить реквизиты выплаты партнёра

```http
GET /api/external/partner/{id}/payout-requisites
x-api-key: ваш-ключ
```

Приходят текущие реквизиты партнёра в том же формате, что у
[реквизитов заявки](https://docs.agenum.ru/api/payout/), но **замаскированными**: у номера счёта и
телефона видны только последние цифры, `masked: true`. Если реквизиты не
заполнены — `{ "requisite": null }`.

По этому методу удобно проверить, что реквизиты есть, до создания заявки.
Полное значение для платежа отдаёт только
[метод реквизитов заявки](https://docs.agenum.ru/api/payout/): платят по тому, что зафиксировано в
заявке, а не по текущим реквизитам.

## Какие ошибки возвращают методы партнёров

| Ответ | Сообщение | Что делать |
|---|---|---|
| `404` | Партнёр не найден | проверьте `id` |
| `404` | Предложение не найдено | `offerId` в фильтре списка не существует |

Общие ошибки авторизации по `x-api-key` — в разделе [Внешний API](https://docs.agenum.ru/api/).

## Читать также

- [Начисления и баланс](https://docs.agenum.ru/api/ledger/) — баланс и движения партнёра
- [Выплаты](https://docs.agenum.ru/api/payout/) — создание выплаты по `partnerId` из этого списка
- [Поля и юридические типы партнёра](https://docs.agenum.ru/admin/settings/partner-field-types/) — где администратор настраивает юридический тип

---

# Выплаты

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/payout/

> Методы внешнего API для работы с выплатами партнёрам — список и карточка заявки, создание заявки, реквизиты для перечисления, смена статуса и выпуск акта.

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

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

## Какие бывают статусы выплаты

| Статус | Что означает |
|---|---|
| `Requested` | заявка создана, ждёт решения |
| `Approved` | подтверждена, ждёт перечисления |
| `Paid` | деньги перечислены партнёру |
| `Rejected` | отклонена |
| `Canceled` | партнёр отменил заявку сам, в личном кабинете |

Заявка создаётся сразу в статусе `Requested`. Перевести её в `Approved`, `Paid`
или `Rejected` можно и через внешний API, и из [админки](https://docs.agenum.ru/admin/payout/) — этим
методом или соответствующей кнопкой в карточке заявки. Статус `Canceled`
доступен только партнёру: ни администратор, ни внешний API отменить чужую
заявку не могут.

:::tip
Перед переводом заявки в `Paid` деньги партнёру нужно перечислить
самостоятельно — метод только фиксирует факт выплаты в Agenum, платёж он не
проводит.
:::

## Как получить список выплат

```http
GET /api/external/payout?statuses=Requested,Approved&page=1&size=50
x-api-key: ваш-ключ
```

Ответ постраничный — формат в разделе [Внешний API](https://docs.agenum.ru/api/).

| Параметр | Что фильтрует |
|---|---|
| `statuses` | статусы заявки через запятую |
| `partnerId` | заявки одного партнёра |
| `updatedFrom` | заявки, изменённые начиная с момента — для синхронизации |

Без `updatedFrom` новые заявки идут первыми. С ним — от старых изменений к
новым: так их забирают опросом, см. [Внешний API](https://docs.agenum.ru/api/).

Элемент списка:

```json
{
  "id": "7c1f…",
  "number": 42,
  "partner": { "id": "3d21…", "firstName": "Иван", "lastName": "Иванов", "middleName": null, "email": "partner@example.com" },
  "amount": 15000,
  "status": "Paid",
  "requisiteId": "9b3e…",
  "requisite": { "type": "BankAccount" },
  "innSnapshot": "500100732259",
  "partnerComment": null,
  "adminComment": "Ежемесячная выплата",
  "createdAt": "2026-08-01T10:00:00.000Z",
  "updatedAt": "2026-08-03T09:00:00.000Z",
  "processedAt": "2026-08-03T09:00:00.000Z"
}
```

| Поле | Что означает |
|---|---|
| `number` | номер заявки для людей — его видят администратор и партнёр в интерфейсе и он печатается в акте |
| `partner` | партнёр, которому предназначена выплата |
| `amount` | сумма выплаты в копейках: `15000` — это 150 рублей |
| `requisiteId` | идентификатор реквизитов, по которым заявка должна быть оплачена; `null`, если контур реквизиты не собирает |
| `requisite.type` | способ выплаты: `BankAccount` — банковский счёт, `Sbp` — перевод по номеру телефона |
| `innSnapshot` | ИНН партнёра на момент создания заявки; может быть `null`, если проверка ИНН в контуре выключена |
| `partnerComment` | комментарий партнёра — заполняется, когда он сам создаёт или отменяет заявку в личном кабинете |
| `adminComment` | комментарий администратора либо ваш комментарий при создании или смене статуса через API |
| `processedAt` | дата перевода в `Paid`; `null`, пока заявка не выплачена |

## Как создать заявку на выплату

```http
POST /api/external/payout
x-api-key: ваш-ключ
Content-Type: application/json

{
  "partnerId": "3d21…",
  "amount": 15000,
  "adminComment": "Ежемесячная выплата"
}
```

| Поле | Обязательное | Описание |
|---|---|---|
| `partnerId` | да | id партнёра из [списка партнёров](https://docs.agenum.ru/api/partner/) |
| `amount` | да | сумма выплаты в копейках, целым числом: `15000` — это 150 рублей, максимум — 2 000 000 рублей (`200000000`) |
| `adminComment` | нет | комментарий к заявке |

Реквизиты в теле запроса не передаются: заявка берёт актуальные реквизиты
партнёра и запоминает их. Заполнить реквизиты через внешний API нельзя — это
делает либо сам партнёр в личном кабинете, либо администратор в его
[карточке](https://docs.agenum.ru/admin/partner/create/).

Перед созданием заявки метод проверяет: партнёр существует и не заблокирован, у
него нет другой активной заявки (в статусе `Requested` или `Approved`), сумма
не меньше минимальной, заданной в настройках контура, и не превышает баланс,
доступный партнёру к выводу, ИНН партнёра заполнен и проходит проверку по
контрольным цифрам, а реквизиты выплаты указаны.

Если в контуре включён выпуск актов по выплатам, у самозанятого, ИП и юрлица
ИНН проверяется всегда — даже при выключенном **Требовать ИНН для выплат**: он
печатается в акте. Принятия оферты партнёрской программы метод не требует —
это проверяется только у заявок, которые партнёр подаёт сам из кабинета.

Проверку ИНН можно отключить для всего контура переключателем **Требовать ИНН
для выплат** в общих настройках — он включён по умолчанию. Пока он включён,
ИНН партнёра сохраняется в заявку: значение фиксируется на момент создания и не
меняется, даже если позже ИНН в профиле исправят.

:::tip
Список партнёров ИНН не отдаёт, поэтому заранее узнать, у кого он не заполнен,
через API нельзя — отказ придёт в ответ на создание заявки.
:::

В ответ приходит созданная заявка со статусом `Requested` и историей статусов
из одной записи:

```json
{
  "id": "7c1f…",
  "number": 43,
  "partner": { "id": "3d21…", "firstName": "Иван", "lastName": "Иванов", "middleName": null, "email": "partner@example.com" },
  "amount": 15000,
  "status": "Requested",
  "requisiteId": "9b3e…",
  "requisite": { "type": "BankAccount" },
  "innSnapshot": "500100732259",
  "partnerComment": null,
  "adminComment": "Ежемесячная выплата",
  "createdAt": "2026-09-08T10:00:00.000Z",
  "updatedAt": "2026-09-08T10:00:00.000Z",
  "processedAt": null,
  "allocations": [
    {
      "amount": 15000,
      "entry": { "id": "l001…", "type": "Accrual", "amount": 20000, "availableAt": "2026-08-20T00:00:00.000Z", "createdAt": "2026-08-06T12:00:00.000Z", "leadId": "d4e5…" }
    }
  ],
  "act": null,
  "history": [
    {
      "id": "e001…",
      "status": "Requested",
      "comment": "Ежемесячная выплата",
      "createdAt": "2026-09-08T10:00:00.000Z",
      "changedBy": { "type": "apiKey", "id": "k001…", "title": "CRM" }
    }
  ],
  "actUnavailableReason": null
}
```

Ответ на создание и смену статуса — это [карточка заявки](https://docs.agenum.ru/api/payout/#как-получить-карточку-заявки). К полям списка она добавляет:

| Поле | Что означает |
|---|---|
| `allocations` | состав заявки: из каких начислений собрана сумма. `amount` — сколько взято из начисления, `entry.amount` — его полная сумма: начисление может войти в заявку частично. `entry.type` — `Accrual` (начисление за лида, `leadId` заполнен) или `Adjustment` (ручная корректировка) |
| `act` | акт по выплате: `{ "id", "number", "issuedAt", "signedOutsideAt", "partnerSignedAt" }`. Появляется после перевода в `Paid`, если в контуре включён выпуск актов и акт выпустился. `number` — строка вида `"2026-17"`, `signedOutsideAt` — когда администратор или интеграция отметили акт подписанным вне платформы, иначе `null`; `partnerSignedAt` — когда партнёр подписал акт простой электронной подписью в кабинете, иначе `null`. Заполнено не больше одного из двух. До выплаты и без акта — `null` |
| `history` | история статусов от старых к новым: `status`, `comment`, `createdAt` и `changedBy` — автор смены в формате из раздела [Внешний API](https://docs.agenum.ru/api/); у заявки, поданной партнёром, автор первой записи — `null` |
| `actUnavailableReason` | только у выплаченной заявки без акта: почему акта нет — см. [Акты](https://docs.agenum.ru/api/act/); иначе `null` |

Сам акт, его PDF и отметка о подписании — в разделе [Акты](https://docs.agenum.ru/api/act/).

## Как получить карточку заявки

```http
GET /api/external/payout/{id}
x-api-key: ваш-ключ
```

Тот же формат, что в ответе на создание: поля списка, состав заявки
`allocations`, акт `act`, история `history` и `actUnavailableReason`.

Имена и почта сотрудников, которые меняли статус, через API не отдаются —
только их идентификатор.

## Как получить реквизиты для перечисления

```http
GET /api/external/payout/{id}/requisites
x-api-key: ваш-ключ
```

Списки и карточка заявки реквизитов не содержат — только `requisiteId` и способ
выплаты. Значения отдаёт отдельный метод, и отдаёт их **целиком**: он и нужен
затем, чтобы ваша бухгалтерская система сформировала платёж.

```json
{
  "requisite": {
    "id": "9b3e…",
    "type": "BankAccount",
    "recipientName": "Иванов Иван Иванович",
    "accountNumber": "40702810638050013199",
    "bic": "044525225",
    "phone": null,
    "sbpBankName": null,
    "createdAt": "2026-09-01T10:00:00.000Z",
    "archivedAt": null,
    "masked": false
  }
}
```

| Поле | Что означает |
|---|---|
| `type` | `BankAccount` — заполнены `accountNumber` и `bic`; `Sbp` — заполнен `phone` |
| `recipientName` | имя получателя платежа так, как оно указано в банке |
| `accountNumber` | номер счёта, 20 цифр; `null` у `Sbp` |
| `bic` | БИК банка получателя, 9 цифр; `null` у `Sbp` |
| `phone` | номер телефона в формате `+7XXXXXXXXXX`; `null` у `BankAccount` |
| `sbpBankName` | банк получателя, если партнёр его указал |
| `archivedAt` | момент, когда партнёр заменил эти реквизиты новыми; `null`, если они всё ещё актуальны |
| `masked` | всегда `false` — этот метод отдаёт полное значение |

Возвращаются реквизиты **из заявки**, а не текущие реквизиты партнёра: если он
успел их заменить, `archivedAt` будет заполнен, но платить нужно по тому, что
отдал метод. Если контур реквизиты не собирает, в `requisite` придёт `null`.

:::tip
В интерфейсе администратора те же значения показаны обрезанными, и раскрыть их
может только сотрудник с правом **Просмотр реквизитов выплат**. Ключ внешнего
API получает их без дополнительных условий — он и так умеет переводить заявку в
`Paid`. Обращайтесь с ним соответственно: каждый вызов этого метода записывается
в журнал контура.
:::

## Как изменить статус выплаты

```http
PUT /api/external/payout/{id}/status
x-api-key: ваш-ключ
Content-Type: application/json

{ "status": "Approved", "comment": "Проверено" }
```

| Поле | Обязательное | Описание |
|---|---|---|
| `status` | да | `Approved`, `Paid` или `Rejected` |
| `comment` | нет | комментарий к смене статуса |

Допустимый переход зависит от текущего статуса заявки:

| Новый статус | Из какого статуса |
|---|---|
| `Approved` | только из `Requested` |
| `Paid` | только из `Approved` |
| `Rejected` | из `Requested` или `Approved` |

В ответ приходит [карточка заявки](https://docs.agenum.ru/api/payout/#как-получить-карточку-заявки). По `history`
видно, кто и когда менял статус: `changedBy` с `type: "apiKey"` — через внешний
API, `type: "admin"` — из админки.

При переводе в `Paid` в контуре с включёнными актами сразу выпускается акт — он
приходит в поле `act`. Если акт выпустить не удалось, выплата всё равно
проходит, а причина — в `actUnavailableReason`; устранив её, акт можно
[выпустить позже](https://docs.agenum.ru/api/act/).

## Какие ошибки возвращают методы выплат

| Ответ | Сообщение | Что делать |
|---|---|---|
| `400` | Партнер обязателен | передайте `partnerId` |
| `400` | Сумма выплаты обязательна и указывается в копейках целым числом | передайте `amount` целым числом копеек — без дробной части |
| `400` | Сумма выплаты должна быть больше нуля | минимум — одна копейка (`1`) |
| `400` | Партнер заблокирован | у заблокированного партнёра заявку не создать |
| `400` | Некорректная сумма вывода | сумма должна быть положительным числом |
| `400` | Минимальная сумма вывода: … | увеличьте сумму до указанной в сообщении; в тексте ошибки сумма приводится в рублях, а передаётся в копейках |
| `400` | Доступно для вывода: … | сумма превышает баланс, доступный партнёру к выводу |
| `400` | Для вывода средств заполните ИНН в профиле | у партнёра не заполнен ИНН — внесите его в карточке партнёра или через интерфейс администратора |
| `400` | ИНН в профиле указан некорректно… | ИНН не проходит проверку по контрольным цифрам: 12 знаков у физлица, самозанятого и ИП, 10 у юридического лица |
| `400` | Для акта по выплате у партнёра нужен корректный ИНН — заполните его в карточке партнёра | включён выпуск актов, а у самозанятого, ИП или юрлица ИНН не заполнен или не подходит статусу — переключатель «Требовать ИНН для выплат» эту проверку не снимает |
| `400` | Для вывода средств заполните реквизиты выплаты в профиле | партнёр не указал, куда переводить деньги — это делает он сам или администратор в его карточке |
| `400` | Допустимые статусы: Approved, Paid, Rejected | передайте один из этих трёх статусов |
| `404` | Партнер не найден | проверьте `partnerId` |
| `409` | Уже есть активная заявка на выплату (`reason: ActivePayoutExists`) | дождитесь решения по прежней заявке или её отмены партнёром; при повторе запроса это значит, что первый дошёл |
| `404` | Заявка не найдена | проверьте `id` |
| `409` | Недопустимый переход статуса | заявки с таким `id` нет, либо её текущий статус не допускает такой переход — см. таблицу переходов выше |

## Читать также

- [Внешний API](https://docs.agenum.ru/api/) — базовый адрес, ключи и остальные методы
- [Партнёры](https://docs.agenum.ru/api/partner/) и [Начисления и баланс](https://docs.agenum.ru/api/ledger/) — кому и на какую сумму можно создать выплату
- [Акты](https://docs.agenum.ru/api/act/) — акт по выплаченной заявке
- [Выплаты](https://docs.agenum.ru/admin/payout/) — тот же список и карточка заявки в интерфейсе администратора

---

# Справочники

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/reference/

> Справочники внешнего API — поля лида и статусы лида, откуда брать fieldTypeId для заявки и id или systemName для смены статуса.

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

Все пути ниже даны относительно базового адреса `/api/external`, каждый запрос
требует заголовок `x-api-key` — см. [Внешний API](https://docs.agenum.ru/api/).

## Как получить список полей лида

Состав полей у каждого контура свой: их настраивает администратор. Начинать
интеграцию нужно с этого метода — из него берутся идентификаторы, которыми потом
заполняется заявка.

```http
GET /api/external/lead-fields
x-api-key: ваш-ключ
```

```json
[
  {
    "id": "0f8c…",
    "systemName": "email",
    "label": "Электронная почта",
    "type": "String",
    "options": null,
    "required": true,
    "hidden": false
  },
  {
    "id": "b31a…",
    "systemName": "city",
    "label": "Город",
    "type": "List",
    "options": [{ "id": "msk", "name": "Москва" }],
    "required": false,
    "hidden": false
  }
]
```

| Поле | Что означает |
|---|---|
| `id` | идентификатор поля, его же передают в `fields[].fieldTypeId` |
| `systemName` | имя поля, заданное администратором для интеграции |
| `label` | подпись поля в интерфейсе |
| `type` | `String`, `Number`, `Boolean` или `List` |
| `options` | допустимые значения для `List`, иначе `null` |
| `required` | без этого поля заявка не создастся |

Отдаются только нескрытые поля. Скрытое поле пропадает из ответа, но данные
прошлых заявок по нему сохраняются.

:::tip
Не кэшируйте `id` навсегда: администратор может завести новое поле или скрыть
старое, не предупреждая разработчика. Разумнее перечитывать список при старте
и держать сопоставление по `systemName`.
:::

## Как получить статусы лида

```http
GET /api/external/lead-status
x-api-key: ваш-ключ
```

```json
[
  { "id": "s1…", "systemName": "new", "title": "Новый", "description": null, "order": 1, "color": "1", "type": "Primary" },
  { "id": "s2…", "systemName": "deal", "title": "Сделка", "description": null, "order": 2, "color": "1", "type": "Target" }
]
```

Список приходит одним массивом. Для смены статуса лида передают `id` или
`systemName` отсюда. Названия и системные имена в примере — условные, у вашего
контура они свои.

| `type` | Что означает |
|---|---|
| `Primary` | статус новой заявки, в нём лид создаётся |
| `Default` | промежуточный статус воронки |
| `Target` | состоявшаяся сделка: при переходе в него нужна сумма, по нему начисляется процент |
| `Cancel` | отказ: переход в него гасит ещё не созревшие начисления по лиду |

:::tip
Опирайтесь на `systemName`, а не на `id` и не на `title`: системное имя
администратор задаёт специально для интеграции, а название в интерфейсе может
поменять в любой момент.
:::

## Читать также

- [Лиды](https://docs.agenum.ru/api/lead/) — создание лида по полям и смена статуса
- [Типы полей лидов](https://docs.agenum.ru/admin/settings/lead-field-types/) и [Статусы лидов](https://docs.agenum.ru/admin/settings/lead-statuses/) — где администратор настраивает справочники

---

# Вебхуки

Раздел: Внешний API. Адрес: https://docs.agenum.ru/api/webhooks/

> Как получать события контура push-уведомлениями — какие события есть, формат запроса, проверка подписи, повторы и что делать с дублями.

Вебхук — запрос, который контур сам отправляет на адрес вашей системы, когда в нём
что-то произошло: создан лид, сменился статус, выплачена заявка. Опрашивать API по
таймеру не нужно — изменение приходит через секунды.

Адреса заводятся в админке, в [настройках вебхуков](https://docs.agenum.ru/admin/settings/webhooks/). Там же
выбираются события, выдаётся секрет подписи и виден журнал доставок.

:::tip
Вебхуки входят в доступ к внешнему API — он есть не во всех тарифах. Проверить
тариф можно в [Консоли](https://docs.agenum.ru/console/).
:::

## Какие события приходят

| Событие | Когда |
|---|---|
| `lead.created` | лид создан — формой, по ссылке, вручную или через API |
| `lead.updated` | изменены поля лида |
| `lead.status_changed` | сменился статус лида |
| `lead.deleted` | лид удалён |
| `ledger.entry_created` | движение по балансу партнёра: начисление, отмена, резерв под выплату, возврат резерва |
| `payout.requested` | создана заявка на выплату |
| `payout.approved` | заявка подтверждена |
| `payout.paid` | заявка выплачена |
| `payout.rejected` | заявка отклонена |
| `payout.canceled` | партнёр отменил свою заявку |
| `act.signed` | акт подписан — партнёром или отметкой «подписан вне платформы» |
| `act.unsigned` | отметка о подписании акта снята |

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

## Как выглядит запрос

`POST` на ваш адрес, тело — JSON:

```json
{
  "id": "0b8e7c3a-…",
  "type": "lead.status_changed",
  "createdAt": "2026-10-29T09:15:02.123Z",
  "actor": { "type": "apiKey", "id": "5f2d…" },
  "data": { "id": "…", "statusId": "…", "previousStatusId": "…" }
}
```

| Поле | Что это |
|---|---|
| `id` | идентификатор события, совпадает с заголовком `webhook-id` |
| `type` | событие из таблицы выше |
| `createdAt` | когда событие произошло |
| `actor` | кто это сделал: `{ "type": "admin", "id" }`, `{ "type": "apiKey", "id" }` или `null` — партнёр, клиент по форме или система |
| `data` | снимок объекта на момент события |

**`data` — то же, что отдаёт API** по этому объекту:

| Событие | `data` совпадает с |
|---|---|
| `lead.*` | [карточкой лида](https://docs.agenum.ru/api/lead/) `GET /lead/{id}`; у `lead.status_changed` рядом `previousStatusId`, у `lead.deleted` — карточка до удаления |
| `ledger.entry_created` | элементом [ленты движений](https://docs.agenum.ru/api/ledger/) `GET /ledger` |
| `payout.*` | [карточкой выплаты](https://docs.agenum.ru/api/payout/) `GET /payout/{id}`, без `actUnavailableReason` |
| `act.*` | [карточкой акта](https://docs.agenum.ru/api/act/) `GET /act/{id}`; `pdfSha256` бывает `null`, если PDF ещё не собран |

Заголовки:

| Заголовок | Значение |
|---|---|
| `webhook-id` | идентификатор события — одинаковый у всех повторов |
| `webhook-timestamp` | время отправки, секунды Unix |
| `webhook-signature` | `v1,` и подпись в base64 |
| `user-agent` | `Agenum-Webhooks/1` |

## Как проверить подпись

Подпись устроена по стандарту [Standard Webhooks](https://www.standardwebhooks.com/):
для большинства языков есть готовая библиотека проверки, достаточно передать ей секрет,
заголовки и тело запроса **как оно пришло**, до разбора JSON.

Вручную: HMAC-SHA256 от строки `{webhook-id}.{webhook-timestamp}.{тело}`, ключ — байты
секрета после префикса `whsec_`, декодированные из base64.

```js
import { createHmac, timingSafeEqual } from 'node:crypto';

const verify = (secret, headers, rawBody) => {
  const key = Buffer.from(secret.slice('whsec_'.length), 'base64');
  const expected = createHmac('sha256', key)
    .update(`${headers['webhook-id']}.${headers['webhook-timestamp']}.${rawBody}`)
    .digest('base64');
  const received = headers['webhook-signature'].split(' ').map((s) => s.replace(/^v1,/, ''));
  return received.some((s) => s.length === expected.length && timingSafeEqual(Buffer.from(s), Buffer.from(expected)));
};
```

Отклоняйте запросы, у которых `webhook-timestamp` отличается от текущего времени больше
чем на несколько минут: так перехваченный запрос нельзя будет прислать повторно.

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

## Что должен ответить ваш сервер

- Любой код `2xx` — событие доставлено. Тело ответа не важно.
- Ответ должен прийти **за 10 секунд**. Долгую обработку делайте после ответа, в
  очереди.
- Редиректы не выполняются: `3xx` считается неудачей. Указывайте конечный адрес.
- Адрес — только `https`, публичный: адреса внутренних сетей отклоняются.

## Повторы при неудаче

Если сервер не ответил, ответил не `2xx` или не уложился в 10 секунд, событие уходит
повторно через 1 минуту, 5 минут, 30 минут, 2 часа, 5 часов, 10 и ещё 10 часов —
всего 8 попыток, около полутора суток. После этого доставка помечается как неудачная.

Если адрес не принимает события **больше трёх суток подряд** и набрал не меньше 20
неудач подряд, он выключается автоматически. События, произошедшие пока адрес выключен,
на него не уходят; включить его обратно можно в админке.

## Дубли и порядок событий

Доставка гарантирует «хотя бы один раз»: одно событие может прийти дважды — например,
если ваш сервер принял его, но ответ не дошёл. Порядок прихода не гарантирован.

- **Дубли** отсекайте по `webhook-id`: у повтора он тот же.
- **Устаревшие снимки** — по `data.updatedAt`: если у вас уже запись новее, событие
  можно пропустить.
- **Эхо своих действий** — по `actor`: изменения, которые сделала сама ваша система
  через API, придут с `{ "type": "apiKey", "id": "<id вашего ключа>" }`.

Вебхуки не заменяют сверку. Раз в сутки или после простоя своей системы догоняйте
изменения [опросом](https://docs.agenum.ru/api/#как-забирать-изменения-опросом): события старше 30 дней в
контуре не хранятся.

## Как проверить приёмник

Кнопка **Проверить** у адреса в админке отправляет событие `webhook.test` с пустым
`data` и показывает, что ответил сервер. Такие события в журнал доставок не попадают и
повторно не отправляются.

## Читать также

- [Настройки вебхуков](https://docs.agenum.ru/admin/settings/webhooks/) — где завести адрес и посмотреть журнал
- [Внешний API](https://docs.agenum.ru/api/) — авторизация, списки и синхронизация опросом
- [Лиды](https://docs.agenum.ru/api/lead/) и [Выплаты](https://docs.agenum.ru/api/payout/) — что лежит в `data`