Dokumentacja | Dokumentacja API

Przegląd

Moduł umów pozwala śledzić historię stosunków najmu dla każdej nieruchomości. System zapewnia, że w danym momencie może być aktywna tylko jedna umowa.

Kluczowe funkcje

Śledzenie historii umów dla nieruchomości
Zarządzanie datami podpisania, rozpoczęcia i zakończenia
Automatyczna walidacja nakładających się dat umów
Powiązanie najemcy z umową
Określenie typu najmu (długoterminowy, krótkoterminowy)

Uprawnienia dostępu

Dostęp do umów zależy od roli użytkownika w nieruchomości.

Rola	Przeglądanie	Dodawanie	Edytowanie	Usuwanie
Gospodarz	Tak	Tak	Tak	Tak
Agent wynajmujący	Tak	Tak	Tak	Tak
Najemca	Tak	Nie	Nie	Nie
Agent najemcy	Tak	Nie	Nie	Nie
Personel konserwacyjny	Nie	Nie	Nie	Nie

Pola umowy

Każda umowa zawiera następujące pola:

Pole	Wymagane	Opis
Nazwa	Opcjonalne	Nazwa umowy. Jeśli nie podano - będzie "-"
Najemca	Wymagane	Użytkownik-najemca z systemu
Typ najmu	Wymagane	Typ najmu ze słownika
Data podpisania	Wymagane	Data podpisania umowy
Data rozpoczęcia	Wymagane	Data rozpoczęcia umowy
Data zakończenia	Opcjonalne	Data zakończenia. Puste = umowa bezterminowa

Kontrola nakładających się dat

Ważne!

System ściśle kontroluje, aby daty umów się nie nakładały. W danym momencie dla nieruchomości może być aktywna tylko jedna umowa. Błąd zostanie wyświetlony podczas próby utworzenia lub edycji umowy z datami nakładającymi się na istniejącą.

Przykład:

Umowa A: 01.01.2025 - 31.12.2025
Umowa B z datą rozpoczęcia 01.06.2025 zostanie zablokowana, ponieważ ta data przypada w okresie umowy A

Statusy umów

Status umowy jest określany automatycznie na podstawie dat:

Aktywny

Bieżąca data znajduje się między datą rozpoczęcia a datą zakończenia (lub bez daty zakończenia)

Wygasła

Data zakończenia umowy jest w przeszłości

Przyszła

Data rozpoczęcia umowy jest w przyszłości

Typy najmu

Podczas tworzenia umowy należy określić typ najmu:

Typ	Opis
Wynajem długoterminowy	Wynajem na okres od 1 miesiąca i dłużej
Wynajem krótkoterminowy	Wynajem na okres krótszy niż 1 miesiąc (dzienny, tygodniowy)

Jak dodać umowę

1

Przejdź do nieruchomości

Otwórz kartę nieruchomości, w której chcesz utworzyć umowę.

2

Wybierz "Umowy"

W menu nieruchomości kliknij przycisk "Umowy", aby przejść do listy umów.

3

Kliknij "Dodaj"

Kliknij przycisk "Dodaj umowę", aby otworzyć formularz tworzenia.

4

Wypełnij formularz

Wybierz najemcę, typ najmu, określ daty i kliknij "Zapisz".

Dokumenty umowy

Do każdej umowy można załączyć zeskanowane kopie dokumentów: główną umowę, aneksy, akty itp.

Dozwolone formaty

PDF, JPG, JPEG, PNG
Maksymalny rozmiar pliku: 10 MB

Uprawnienia dostępu do dokumentów

Rola	Przeglądanie	Przesyłanie	Usuwanie
Gospodarz	Tak	Tak	Tak
Agent wynajmujący	Tak	Tak	Tak
Najemca	Tak	Tak	Nie
Agent najemcy	Tak	Tak	Nie

Ograniczenie usuwania

Tylko właściciel nieruchomości i jego przedstawiciel mogą usuwać dokumenty. Najemcy i ich przedstawiciele mogą tylko przeglądać i przesyłać dokumenty.

REST API

Umowami można zarządzać przez API:

Uwaga dotycząca warstwy usługowej

Punkty końcowe API

GET    /api/v1/properties/{id}/contracts         # Lista umów nieruchomości
POST   /api/v1/properties/{id}/contracts         # Utwórz umowę
GET    /api/v1/contracts/{id}                    # Pobierz umowę
PUT    /api/v1/contracts/{id}                    # Zaktualizuj umowę
DELETE /api/v1/contracts/{id}                    # Usuń umowę
GET    /api/v1/properties/{id}/contracts/active  # Aktywna umowa

API dokumentów umowy

Punkty końcowe dokumentów

GET    /api/v1/contracts/{id}/documents         # Lista dokumentów umowy
POST   /api/v1/contracts/{id}/documents         # Prześlij dokument
DELETE /api/v1/contracts/{id}/documents/{docId} # Usuń dokument (tylko właściciel)

Pełna dokumentacja API jest dostępna w Swagger:

Otwórz dokumentację API

Informacje ogólne