Документация | Справочник API

Обзор

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

Ключевые возможности

Отслеживание истории договоров по объекту
Управление датами подписания, начала и окончания
Автоматический контроль пересечения дат договоров
Привязка нанимателя к договору
Указание типа аренды (долгосрочная, краткосрочная)

Права доступа

Доступ к договорам зависит от роли пользователя в объекте.

Роль	Просмотр	Добавление	Редактирование	Удаление
Наймодатель	Да	Да	Да	Да
Представитель наймодателя	Да	Да	Да	Да
Наниматель	Да	Нет	Нет	Нет
Представитель нанимателя	Да	Нет	Нет	Нет
Обслуживающий персонал	Нет	Нет	Нет	Нет

Поля договора

Каждый договор содержит следующие поля:

Поле	Обязательность	Описание
Наименование	Необязательно	Наименование договора. Если не указано - будет "-"
Наниматель	Обязательно	Пользователь-наниматель из системы
Тип аренды	Обязательно	Тип аренды из справочника
Дата подписания	Обязательно	Дата подписания договора
Дата начала	Обязательно	Дата начала действия договора
Дата окончания	Необязательно	Дата окончания. Пустое значение = бессрочный

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

Важно!

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

Пример:

Договор А: 01.01.2025 - 31.12.2025
Договор Б с датой начала 01.06.2025 будет заблокирован, так как эта дата попадает в период договора А

Статусы договоров

Статус договора определяется автоматически на основе дат:

Активный

Текущая дата находится между датой начала и датой окончания (или без даты окончания)

Завершён

Дата окончания договора в прошлом

Будущий

Дата начала договора в будущем

Типы аренды

При создании договора нужно указать тип аренды:

Тип	Описание
Долгосрочная аренда	Аренда на срок от 1 месяца и более
Краткосрочная аренда	Аренда на срок менее 1 месяца (посуточная, понедельная)

Как добавить договор

1

Перейдите к объекту

Откройте карточку объекта недвижимости, в котором хотите создать договор.

2

Выберите "Договора"

В меню объекта нажмите кнопку "Договора" для перехода к списку договоров.

3

Нажмите "Добавить"

Нажмите кнопку "Добавить договор" для открытия формы создания.

4

Заполните форму

Выберите нанимателя, тип аренды, укажите даты и нажмите "Сохранить".

Документы договора

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

Допустимые форматы

PDF, JPG, JPEG, PNG
Максимальный размер файла: 10 МБ

Права доступа к документам

Роль	Просмотр	Загрузка	Удаление
Наймодатель	Да	Да	Да
Представитель наймодателя	Да	Да	Да
Наниматель	Да	Да	Нет
Представитель нанимателя	Да	Да	Нет

Ограничение на удаление

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

REST API

Договорами можно управлять через API:

Примечание уровня сервиса

Эндпоинты API

GET    /api/v1/properties/{id}/contracts         # Список договоров объекта
POST   /api/v1/properties/{id}/contracts         # Создать договор
GET    /api/v1/contracts/{id}                    # Получить договор
PUT    /api/v1/contracts/{id}                    # Обновить договор
DELETE /api/v1/contracts/{id}                    # Удалить договор
GET    /api/v1/properties/{id}/contracts/active  # Активный договор

API документов договора

Эндпоинты документов

GET    /api/v1/contracts/{id}/documents         # Список документов договора
POST   /api/v1/contracts/{id}/documents         # Загрузить документ
DELETE /api/v1/contracts/{id}/documents/{docId} # Удалить документ (только владелец)

Полная документация API доступна в Swagger:

Открыть документацию API

Общие сведения