Документація | Довідник 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

Загальні відомості