Dokumentacja | Dokumentacja API

Przegląd

Moduł kar umownych umożliwia właścicielom nieruchomości śledzenie i dokumentowanie kar finansowych nałożonych na najemców za naruszenie warunków umowy najmu.

Śledzenie kar

Rejestruj kary finansowe z datą, kwotą, walutą i szczegółowym opisem.

Odniesienia do bloków umowy

Łącz kary z konkretnymi punktami umowy, które zostały naruszone.

Dokumenty

Załączaj zdjęcia i dokumenty jako dowody kary.

Powiązanie z płatnościami

Kary mogą być powiązane z zaległymi płatnościami

Obsługa walut

Rejestruj kary w różnych walutach z automatycznym wyświetlaniem symbolu.

Przepływ pracy

Typowy przepływ pracy przy dokumentowaniu kar:

1

Dokumentowanie kary

Właściciel rejestruje karę z datą, kwotą, walutą i opisem.

2

Wybór bloków umowy

Połącz karę z konkretnymi punktami umowy, które zostały naruszone.

3

Załączanie dowodów

Prześlij zdjęcia i dokumenty jako dowody.

4

Śledzenie historii

Buduj historię kar dla najemcy/umowy do wykorzystania w przyszłości.

Uprawnienia

Prawa dostępu do kar umownych:

Akcja	Kto może
Tworzenie	Właściciele nieruchomości i ich agenci
Podgląd	Właściciele, najemcy i ich agenci (mogą przeglądać kary przeciwko nim)
Edycja	Właściciele nieruchomości i ich agenci
Usuwanie	Właściciele nieruchomości i ich agenci
Załączanie dokumentów	Właściciele nieruchomości i ich agenci

REST API

Dostęp do kar przez REST API (wymaga uwierzytelnienia JWT):

Uwaga dotycząca warstwy usługowej

GET    /api/v1/properties/{id}/penalties           - Lista kar
POST   /api/v1/properties/{id}/penalties           - Utwórz karę
GET    /api/v1/properties/{id}/penalties/{pid}     - Pobierz szczegóły
PUT    /api/v1/properties/{id}/penalties/{pid}     - Aktualizuj karę
DELETE /api/v1/properties/{id}/penalties/{pid}     - Usuń karę
POST   /api/v1/properties/{id}/penalties/{pid}/documents      - Załącz dokument
DELETE /api/v1/properties/{id}/penalties/{pid}/documents/{did} - Odłącz dokument

Przykładowa odpowiedź

{
  "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

Pełna dokumentacja API z interaktywnym testowaniem jest dostępna w Swagger UI: /api/v1/doc

Kary umowne