Dokumentation | API-Referenz

Überblick

Das Strafmodul ermöglicht es Objekteigentümern, finanzielle Strafen zu verfolgen und zu dokumentieren, die Mietern für Verstöße gegen Mietvertragsbedingungen auferlegt werden.

Strafenverfolgung

Erfassen Sie finanzielle Strafen mit Datum, Betrag, Währung und detaillierter Beschreibung.

Verknüpfung mit Vertragsblöcken

Verknüpfen Sie Strafen mit bestimmten Vertragsklauseln, die verletzt wurden.

Dokumente

Hängen Sie Fotos und Dokumente als Beweismaterial an.

Zahlungsverknüpfung

Strafen können mit überfälligen Zahlungen verknüpft werden

Währungsunterstützung

Erfassen Sie Strafen in verschiedenen Währungen mit automatischer Symbolanzeige.

Arbeitsablauf

Typischer Arbeitsablauf zur Dokumentation von Strafen:

1

Strafe dokumentieren

Eigentümer erfasst Strafe mit Datum, Betrag, Währung und Beschreibung.

2

Vertragsblöcke auswählen

Verknüpfen Sie die Strafe mit bestimmten Vertragsklauseln, die verletzt wurden.

3

Beweise anhängen

Laden Sie Fotos und Dokumente als Beweismaterial hoch.

4

Historie verfolgen

Erstellen Sie Strafenhistorie für Mieter/Vertrag zur späteren Verwendung.

Zugriffsrechte

Zugriffsrechte für Strafen:

Aktion	Wer kann
Erstellen	Objekteigentümer und ihre Vertreter
Anzeigen	Eigentümer, Mieter und ihre Vertreter (können Strafen gegen sich sehen)
Bearbeiten	Objekteigentümer und ihre Vertreter
Löschen	Objekteigentümer und ihre Vertreter
Dokumente anhängen	Objekteigentümer und ihre Vertreter

REST API

Zugriff auf Strafen über REST API (JWT-Authentifizierung erforderlich):

Service-Layer-Hinweis

GET    /api/v1/properties/{id}/penalties           - Strafenliste
POST   /api/v1/properties/{id}/penalties           - Strafe erstellen
GET    /api/v1/properties/{id}/penalties/{pid}     - Details abrufen
PUT    /api/v1/properties/{id}/penalties/{pid}     - Strafe aktualisieren
DELETE /api/v1/properties/{id}/penalties/{pid}     - Strafe löschen
POST   /api/v1/properties/{id}/penalties/{pid}/documents      - Dokument anhängen
DELETE /api/v1/properties/{id}/penalties/{pid}/documents/{did} - Dokument entfernen

Beispielantwort

{
  "data": [
    {
      "id": 1,
      "property_id": 5,
      "contract_id": 12,
      "penalty_date": "2026-01-10",
      "amount": 500.00,
      "paid_amount": 250.00,
      "remaining_amount": 250.00,
      "is_paid": false,
      "currency": {
        "id": 3,
        "code": "UAH",
        "symbol": "₴"
      },
      "description": "Late rent payment penalty for December 2025",
      "violator": {
        "id": 15,
        "name": "John Tenant"
      },
      "documents_count": 2,
      "blocks_count": 1,
      "created_at": "2026-01-10T14:30:00+00:00"
    }
  ],
  "total": 1,
  "page": 1,
  "totalPages": 1
}

Swagger / OpenAPI

Vollständige API-Dokumentation mit interaktivem Testen ist in Swagger UI verfügbar: /api/v1/doc

Strafmaßnahmen