Dokumentacja | Dokumentacja API

Przegląd

Moduł rekompensat za remont umożliwia śledzenie kosztów napraw poniesionych przez najemców, które mogą być zaliczone na poczet czynszu. Do każdej rekompensaty można dołączyć wiele dokumentów potwierdzających.

Śledzenie wydatków

Rejestruj koszty napraw z kwotami, datami i opisem wykonanych prac.

Wiele dokumentów

Dołączaj wiele paragonów, faktur i protokołów odbioru do każdej rekompensaty.

Potwierdzenie właściciela

Właściciele nieruchomości potwierdzają lub odrzucają wnioski o rekompensatę po weryfikacji.

Przepływ pracy

Typowy przepływ pracy dla rekompensat za remont:

1

Utwórz rekompensatę

Najemca lub właściciel tworzy wpis o rekompensacie z datą, kwotą i opisem.

2

Dołącz dokumenty

Prześlij paragony, faktury lub protokoły odbioru jako dokumenty potwierdzające.

3

Weryfikacja właściciela

Właściciel nieruchomości weryfikuje rekompensatę i dołączone dokumenty.

4

Potwierdzenie

Właściciel potwierdza lub odrzuca rekompensatę. Potwierdzone kwoty mogą być zaliczone na poczet czynszu.

Uprawnienia

Prawa dostępu do rekompensat za remont:

Akcja	Kto może
Tworzenie	Właściciele, najemcy i ich przedstawiciele
Podgląd	Wszyscy użytkownicy z dostępem do nieruchomości
Edycja	Tylko autor rekompensaty
Usuwanie	Tylko autor rekompensaty
Potwierdzenie/Odrzucenie	Tylko właściciele nieruchomości i ich przedstawiciele
Dołączanie dokumentów	Autor lub właściciel/przedstawiciel

Statusy potwierdzenia

Każda rekompensata ma status potwierdzenia:

Nie

Domyślny status dla nowych rekompensat. Oczekuje na weryfikację przez właściciela.

Tak

Właściciel potwierdził rekompensatę. Kwota może być zaliczona na poczet czynszu.

REST API

Dostęp do rekompensat za remont przez REST API (wymaga autoryzacji JWT):

Uwaga dotycząca warstwy usługowej

GET    /api/v1/properties/{id}/repair-compensations                  - Lista rekompensat
POST   /api/v1/properties/{id}/repair-compensations                  - Utwórz rekompensatę
GET    /api/v1/properties/{id}/repair-compensations/{rid}            - Szczegóły rekompensaty
PUT    /api/v1/properties/{id}/repair-compensations/{rid}            - Aktualizuj rekompensatę
DELETE /api/v1/properties/{id}/repair-compensations/{rid}            - Usuń rekompensatę
POST   /api/v1/properties/{id}/repair-compensations/{rid}/confirm    - Potwierdź
POST   /api/v1/properties/{id}/repair-compensations/{rid}/unconfirm  - Usuń potwierdzenie
POST   /api/v1/properties/{id}/repair-compensations/{rid}/documents  - Dołącz dokument
DELETE /api/v1/properties/{id}/repair-compensations/{rid}/documents/{did} - Odłącz dokument

Przykładowa odpowiedź

{
  "data": [
    {
      "id": 1,
      "property_id": 5,
      "compensation_date": "2026-01-10",
      "amount": "15000.00",
      "amount_formatted": "15 000.00 ₴",
      "currency": {
        "id": 1,
        "code": "UAH",
        "symbol": "₴"
      },
      "tenant": {
        "id": 15,
        "name": "John Tenant"
      },
      "owner_confirmed": true,
      "documents_count": 3,
      "comment": "Kitchen sink replacement and pipe repair",
      "created_by": {
        "id": 15,
        "name": "John Tenant"
      },
      "created_at": "2026-01-10T14:30:00+00:00"
    }
  ],
  "total": 1,
  "totalAmount": "15000.00",
  "page": 1,
  "totalPages": 1
}

Swagger / OpenAPI

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

Rekompensaty za remont