Dokumentacja | Dokumentacja API

Przegląd

Moduł "Majątek wynajmującego" pozwala właścicielom nieruchomości śledzić przedmioty (meble, sprzęt AGD itp.), które są przekazywane najemcy do użytkowania wraz z lokalem. Każdy element może mieć tłumaczenia dla wsparcia wielojęzycznego oraz załączone dokumenty do zapisu stanu.

Śledzenie majątku

Rejestracja majątku z nazwą, datą, opisem i opcjonalną szacunkową wartością.

Wsparcie wielojęzyczne

Dodawanie tłumaczeń nazw majątku w różnych językach.

Załączniki dokumentów

Załączanie zdjęć i dokumentów jako dowodu stanu majątku.

Szacunkowa wycena

Rejestracja opcjonalnej szacunkowej wartości w różnych walutach na potrzeby ubezpieczeniowe.

Przepływ pracy

Typowy przepływ pracy przy dokumentowaniu majątku wynajmującego:

1

Zarejestruj majątek

Właściciel rejestruje majątek z nazwą, datą i opisem.

2

Dodaj szacunkową wartość

Opcjonalnie dodaj szacunkową wartość i walutę na potrzeby ubezpieczeniowe.

3

Dodaj zdjęcia

Prześlij zdjęcia dokumentujące stan majątku z opcjonalnymi komentarzami.

4

Dodaj tłumaczenia

Dodaj tłumaczenia nazwy majątku dla dokumentacji wielojęzycznej.

Uprawnienia

Prawa dostępu do majątku wynajmującego:

Akcja	Kto może
Tworzenie	Właściciele i ich agenci
Podgląd	Właściciele, najemcy i ich agenci
Edycja	Właściciele i ich agenci
Usuwanie	Właściciele i ich agenci
Załączanie dokumentów	Właściciele i ich agenci
Zarządzanie tłumaczeniami	Właściciele i ich agenci

REST API

Dostęp do majątku przez REST API (wymaga uwierzytelnienia JWT):

Uwaga dotycząca warstwy usługowej

Majątek

GET    /api/v1/properties/{id}/tenant-assets            - Lista majątku
POST   /api/v1/properties/{id}/tenant-assets            - Utwórz
GET    /api/v1/properties/{id}/tenant-assets/{aid}      - Szczegóły
PUT    /api/v1/properties/{id}/tenant-assets/{aid}      - Aktualizuj
DELETE /api/v1/properties/{id}/tenant-assets/{aid}      - Usuń

Dokumenty

POST   /api/v1/properties/{id}/tenant-assets/{aid}/documents      - Załącz dokument
DELETE /api/v1/properties/{id}/tenant-assets/{aid}/documents/{did} - Odłącz dokument

Tłumaczenia

GET    /api/v1/properties/{id}/tenant-assets/{aid}/translations       - Lista tłumaczeń
POST   /api/v1/properties/{id}/tenant-assets/{aid}/translations       - Dodaj tłumaczenie
PUT    /api/v1/properties/{id}/tenant-assets/{aid}/translations/{tid} - Aktualizuj tłumaczenie
DELETE /api/v1/properties/{id}/tenant-assets/{aid}/translations/{tid} - Usuń tłumaczenie

Przykładowa odpowiedź

{
  "data": [
    {
      "id": 1,
      "property_id": 5,
      "name": "Samsung TV 55\"",
      "description": "Smart TV with mounting bracket",
      "asset_date": "2025-03-15",
      "estimated_value": 15000.00,
      "currency": {
        "id": 1,
        "code": "UAH",
        "symbol": "₴"
      },
      "created_by": {
        "id": 8,
        "name": "Owner Name"
      },
      "documents_count": 3,
      "translations_count": 2,
      "created_at": "2025-03-15T10:30:00+00:00"
    }
  ],
  "total": 1,
  "page": 1,
  "totalPages": 1
}

Swagger / OpenAPI

Pełna dokumentacja API dostępna w Swagger /api/v1/doc