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

# Глоссарий: Создание компании и её адрес

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

Справочник к странице [«Создание компании и её адрес»](/ru/logic/company-billing/setup).

## Понятия

Сквозные процессы и вспомогательные обработчики вокруг компании.

| Понятие                       | Значение                                                                                                                                                                                                              |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Менеджер компаний             | Аннотирует каждую компанию вычисляемыми полями «Ссылка (домен)» (основной домен .yume.cloud либо account.yume.cloud) и «Код типа» и сортирует по дате окончания периода.                                              |
| Создание компании             | Единой операцией создаёт запись компании в общих таблицах, стартовый 7-дневный период, домен \*.yume.cloud, членство владельца, лимиты и набор дефолтных справочников и настроек компании.                            |
| Генерация лимитов плана       | Создаёт недостающие лимиты компании (персонал, пункты проката, инвентарь по типам ТС) и сбрасывает кэш лимитов; вызывается при создании компании и при нехватке лимитов.                                              |
| Регистрация кастомного домена | Фоновая задача: проверяет DNS кастомного домена (сверка IP), вызывает внешний API регистрации и при успехе помечает домен верифицированным; при неудаче повторяет с задержкой — до 30 повторов с интервалом 15 минут. |
| Формат аккаунта компании      | Чтение и создание компании через API: валидирует поддомен (чёрный список и занятость), отдаёт вычисляемые ссылку-домен, код типа и лимиты, при создании запускает провижининг компании.                               |
| Проверка занятости поддомена  | Проверяет, свободен ли запрошенный поддомен; занятые и зарезервированные (из чёрного списка) считаются существующими.                                                                                                 |
| Заявка на демо                | Принимает заявку на демо (телефон, ФИО, сфера) и отправляет уведомление в Telegram-канал администраторов.                                                                                                             |
| Регистрация компании          | Создаёт нового пользователя (телефон, почта, пароль с проверкой уникальности), уведомляет администратора, провижионит для него компанию и добавляет членство; используется вне контекста конкретной компании.         |
| Вход компании                 | Устаревший вход компании, возвращающий токены без идентификатора компании; помечен на удаление после обновления iOS/Android.                                                                                          |

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

### Компания

*Основная запись компании: связывает её данные с владельцем. Данные компаний разделены на уровне базы, отдельного хранилища у компании нет — см. [«Разделение данных компаний»](/ru/logic/infrastructure).*

Менеджер добавляет вычисляемые поля «Ссылка (домен)» и «Код типа».

**Идентификация**

| Поле          | Тип   | Описание                 |
| ------------- | ----- | ------------------------ |
| Идентификатор | число | Первичный ключ компании. |
| Название      | текст | Название компании.       |
| Адрес         | текст | Адрес компании.          |

**Сроки**

| Поле              | Тип        | Описание                                             |
| ----------------- | ---------- | ---------------------------------------------------- |
| Начало периода    | дата/время | Начало текущего оплаченного/пробного периода.        |
| Окончание периода | дата/время | Дата окончания подписки; для новой компании +7 дней. |

**Оформление**

| Поле           | Тип         | Описание                           |
| -------------- | ----------- | ---------------------------------- |
| Логотип        | изображение | Логотип компании.                  |
| Фон            | изображение | Фоновое изображение.               |
| Фирменный цвет | текст (HEX) | Цвет бренда, по умолчанию #f25a29. |

**Связи**

| Поле         | Тип   | Описание                                                                                           |
| ------------ | ----- | -------------------------------------------------------------------------------------------------- |
| Владелец     | связь | Пользователь-владелец компании (хранится в общих таблицах, удаление запрещено при наличии связей). |
| Тип компании | связь | Категория/сфера деятельности (тип компании).                                                       |

**Локализация**

| Поле         | Тип    | Описание                                             |
| ------------ | ------ | ---------------------------------------------------- |
| Страна       | список | Страна из справочника стран, по умолчанию Казахстан. |
| Валюта       | список | Валюта из справочника валют, по умолчанию тенге.     |
| Часовой пояс | текст  | Часовой пояс компании, по умолчанию UTC.             |

**Прочее**

| Поле            | Тип         | Описание                            |
| --------------- | ----------- | ----------------------------------- |
| Доп. данные     | JSON        | Произвольные дополнительные данные. |
| Теги            | связь (M2M) | Теги компании.                      |
| Дата создания   | дата/время  | Из базовой модели.                  |
| Дата обновления | дата/время  | Из базовой модели.                  |

**Вычисляемые**

| Поле           | Тип   | Описание                                                                                                         |
| -------------- | ----- | ---------------------------------------------------------------------------------------------------------------- |
| Ссылка (домен) | текст | Вычисляется менеджером: основной домен .yume.cloud либо account.yume.cloud; в самой модели значение отсутствует. |
| Код типа       | текст | Вычисляется менеджером на основе типа компании.                                                                  |

### Домен компании

*Домен, привязанный к компании; хранит признак кастомного домена и статус его верификации.*

| Поле             | Тип        | Описание                                              |
| ---------------- | ---------- | ----------------------------------------------------- |
| Идентификатор    | число      | Первичный ключ.                                       |
| Домен            | текст      | Полное доменное имя.                                  |
| Компания         | связь      | Компания-владелец домена.                             |
| Основной домен   | флаг       | Признак основного домена.                             |
| Кастомный домен  | флаг       | Домен добавлен клиентом, требует внешней регистрации. |
| Верифицирован    | флаг       | Домен подтверждён (по умолчанию да).                  |
| Дата верификации | дата/время | Момент успешной проверки/регистрации.                 |

### Шаг онбординга компании

*Отметка о пройденном шаге онбординга для компании.*

Уникальная пара (компания, шаг).

| Поле             | Тип        | Описание                         |
| ---------------- | ---------- | -------------------------------- |
| Идентификатор    | число      | Первичный ключ.                  |
| Компания         | связь      | Компания.                        |
| Шаг              | текст      | Код пройденного шага онбординга. |
| Дата прохождения | дата/время | Когда шаг был отмечен.           |

### Профиль компании (витрина)

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

Отдельная сущность от компании; связь с компанией пересекается со списком её витринных профилей.

**Связи**

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

**Основное**

| Поле            | Тип         | Описание              |
| --------------- | ----------- | --------------------- |
| Активен         | флаг        | Виден ли профиль.     |
| Название        | текст       | Название в витрине.   |
| Описание        | текст       | Описание компании.    |
| Адрес           | текст       | Адрес.                |
| Ссылка на карте | текст (URL) | Ссылка на карту/2GIS. |

**Оформление**

| Поле            | Тип         | Описание                        |
| --------------- | ----------- | ------------------------------- |
| Иконка          | файл        | Иконка профиля.                 |
| Фон             | изображение | Фон профиля.                    |
| Доп. данные     | JSON        | Произвольные данные.            |
| Приём оплаты    | флаг        | Включён ли приём онлайн-оплаты. |
| Дата создания   | дата/время  | Из базовой модели.              |
| Дата обновления | дата/время  | Из базовой модели.              |

### Режим работы профиля

*График работы публичного профиля компании: дни недели и интервал времени.*

| Поле             | Тип          | Описание                                        |
| ---------------- | ------------ | ----------------------------------------------- |
| Идентификатор    | число        | Первичный ключ.                                 |
| Профиль компании | связь        | Профиль компании.                               |
| Дни недели       | список чисел | Дни недели 0–6, к которым применяется интервал. |
| Начало           | время        | Время открытия.                                 |
| Окончание        | время        | Время закрытия.                                 |
| Активен          | флаг         | Применяется ли данный интервал.                 |

### Привязка периодической задачи к компании

*Связывает периодическую задачу (django-celery-beat) с компанией, делая задачу зависимой от неё: прописывает идентификатор компании в заголовки задачи и, при необходимости, часовой пояс компании в расписание.*

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

| Поле                               | Тип         | Описание                                                                                   |
| ---------------------------------- | ----------- | ------------------------------------------------------------------------------------------ |
| Идентификатор                      | число       | Первичный ключ.                                                                            |
| Компания                           | связь       | Компания, к которой привязана задача.                                                      |
| Периодическая задача               | связь (1:1) | Задача django-celery-beat.                                                                 |
| Использовать часовой пояс компании | флаг        | Если включено, расписание пересчитывается в часовой пояс компании, иначе используется UTC. |

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

### Тип компании

*Справочник сфер деятельности и категорий компаний (прокат авто, самокатов и т.п.), используемый при регистрации и в витрине; это редактируемый справочник.*

| Поле          | Тип    | Описание                              |
| ------------- | ------ | ------------------------------------- |
| Идентификатор | число  | Первичный ключ.                       |
| Название      | текст  | Отображаемое название типа.           |
| Код           | текст  | Машинный код типа.                    |
| Иконка        | файл   | Иконка типа компании.                 |
| Опубликован   | флаг   | Виден ли тип в публичном списке.      |
| Активен       | флаг   | Доступен ли тип для выбора.           |
| Порядок       | число  | Порядок сортировки.                   |
| Страна        | список | Страна, для которой предназначен тип. |

### Страна

Поддерживаемые страны компаний.

* Казахстан (KZ)
* ОАЭ (UAE)

### Валюта

Поддерживаемые валюты компаний.

* Тенге (KZT)
* Доллар США (USD)
* Рубль (RUB)
* Евро (EUR)
* Узбекский сум (UZS)
* Киргизский сом (KGS)
* Дирхам ОАЭ (AED)
* Саудовский риял (SAR)

### Функциональные возможности

Перечень функций системы, доступных для типов компаний и настроек компании.

* Продукты
* Комплекты
* Услуги
* Инвентарь
* Автомобиль
* Сервис автомобильных штрафов
* Планирование транзакций (списание)
* Чек аренды
* Гибкая аренда
* Инвентарь (аренда)
* Продукт (аренда)
* Услуга (аренда)
* Депозит (аренда)
* Пауза (аренда)
* Период аренды
* Один инвентарь (аренда)
* Автопродление (аренда)
* Единая выдача (аренда)
* Единый возврат (аренда)
* Инвентаризация до
* Инвентаризация после
* Инвентаризация (медиа файлы)
* Запрос на инвентаризацию
* Сменный график (аренда)
* Бонусы (аренда)
