Dokumentation | API-Referenz

Übersicht

Das Vertragsmodul ermöglicht die Verfolgung der Mietbeziehungshistorie für jede Immobilie. Das System garantiert, dass zu jedem Zeitpunkt nur ein Vertrag aktiv sein kann.

Hauptfunktionen

Verfolgung der Vertragshistorie pro Immobilie
Verwaltung von Unterzeichnungs-, Start- und Enddaten
Automatische Kontrolle sich überschneidender Vertragsdaten
Verknüpfung des Mieters mit dem Vertrag
Angabe des Miettyps (langfristig, kurzfristig)

Zugriffsrechte

Zugriff auf Verträge hängt von der Benutzerrolle in der Immobilie ab.

Rolle	Ansicht	Hinzufügen	Bearbeiten	Löschen
Vermieter	Ja	Ja	Ja	Ja
Vermietervertreter	Ja	Ja	Ja	Ja
Mieter	Ja	Nein	Nein	Nein
Mietervertreter	Ja	Nein	Nein	Nein
Wartungspersonal	Nein	Nein	Nein	Nein

Vertragsfelder

Jeder Vertrag enthält folgende Felder:

Feld	Erforderlich	Beschreibung
Vertragsname	Optional	Vertragsbezeichnung. Wenn nicht angegeben - wird "-" sein
Mieter	Erforderlich	Mieter-Benutzer aus dem System
Mietart	Erforderlich	Miettyp aus Referenzdaten
Unterzeichnungsdatum	Erforderlich	Datum der Vertragsunterzeichnung
Startdatum	Erforderlich	Datum des Vertragsbeginns
Enddatum	Optional	Enddatum. Leerwert = unbefristet

Kontrolle sich überschneidender Daten

Wichtig!

Das System kontrolliert streng, dass sich Vertragsdaten nicht überschneiden. Zu jedem Zeitpunkt kann nur ein aktiver Vertrag für eine Immobilie bestehen. Bei dem Versuch, einen Vertrag mit sich überschneidenden Daten zu erstellen oder zu bearbeiten - wird ein Fehler angezeigt.

Beispiel:

Vertrag A: 01.01.2025 - 31.12.2025
Vertrag B mit Startdatum 01.06.2025 wird blockiert, da dieses Datum in den Zeitraum von Vertrag A fällt

Vertragsstatusse

Der Vertragsstatus wird automatisch basierend auf Daten bestimmt:

Aktiv

Das aktuelle Datum liegt zwischen Startdatum und Enddatum (oder ohne Enddatum)

Abgelaufen

Das Enddatum des Vertrages liegt in der Vergangenheit

Zukünftig

Das Startdatum des Vertrages liegt in der Zukunft

Mietarten

Bei der Erstellung eines Vertrages muss die Mietart angegeben werden:

Typ	Beschreibung
Langzeitmiete	Vermietung für einen Zeitraum von 1 Monat oder mehr
Kurzzeitmiete	Vermietung für weniger als 1 Monat (täglich, wöchentlich)

Wie füge ich einen Vertrag hinzu

1

Zur Immobilie gehen

Öffnen Sie die Immobilienkarte, in der Sie einen Vertrag erstellen möchten.

2

"Verträge" auswählen

Im Immobilienmenü klicken Sie auf "Verträge", um zur Vertragsliste zu gelangen.

3

Auf "Hinzufügen" klicken

Klicken Sie auf "Vertrag hinzufügen", um das Erstellungsformular zu öffnen.

4

Formular ausfüllen

Wählen Sie Mieter, Mietart, geben Sie Daten ein und klicken Sie auf "Speichern".

Vertragsdokumente

An jeden Vertrag können gescannte Kopien von Dokumenten angehängt werden: Hauptvertrag, Zusatzvereinbarungen, Protokolle usw.

Erlaubte Formate

PDF, JPG, JPEG, PNG
Maximale Dateigröße: 10 MB

Dokumentzugriffsrechte

Rolle	Ansicht	Hochladen	Löschen
Vermieter	Ja	Ja	Ja
Vermietervertreter	Ja	Ja	Ja
Mieter	Ja	Ja	Nein
Mietervertreter	Ja	Ja	Nein

Löschbeschränkungen

Dokumente können nur vom Immobilieneigentümer und seinem Vertreter gelöscht werden. Mieter und sein Vertreter können Dokumente nur ansehen und herunterladen.

REST API

Verträge können über API verwaltet werden:

Service-Layer-Hinweis

API-Endpoints

GET    /api/v1/properties/{id}/contracts         # Liste der Immobilienverträge
POST   /api/v1/properties/{id}/contracts         # Vertrag erstellen
GET    /api/v1/contracts/{id}                    # Vertrag abrufen
PUT    /api/v1/contracts/{id}                    # Vertrag aktualisieren
DELETE /api/v1/contracts/{id}                    # Vertrag löschen
GET    /api/v1/properties/{id}/contracts/active  # Aktiver Vertrag

Vertragsdokument-API

Dokument-Endpoints

GET    /api/v1/contracts/{id}/documents         # Liste der Vertragsdokumente
POST   /api/v1/contracts/{id}/documents         # Dokument hochladen
DELETE /api/v1/contracts/{id}/documents/{docId} # Dokument löschen (nur Eigentümer)

Vollständige API-Dokumentation ist in Swagger verfügbar:

API-Dokumentation öffnen

Allgemeine Informationen