API · Reference
Wszystkie endpointy
Pełna lista endpointów REST API Mieszkanie.app w wersji v1. Każdy wymaga uwierzytelnienia tokenem Bearer (Clerk) i zwraca odpowiedzi w UTF-8 JSON. Komunikaty błędów są po polsku.
| Metoda | URL | Opis | Wymagany scope |
|---|---|---|---|
| Apartments | |||
| GET | /v1/apartments | Lista wszystkich mieszkań na koncie | apartments.read |
| POST | /v1/apartments | Utwórz nowe mieszkanie | apartments.write |
| GET | /v1/apartments/{id} | Szczegóły mieszkania z umowami | apartments.read |
| PATCH | /v1/apartments/{id} | Zmień etykietę, adres lub cennik | apartments.write |
| DELETE | /v1/apartments/{id} | Zarchiwizuj mieszkanie | apartments.write |
| PATCH | /v1/apartments/{id}/tariffs | Zaktualizuj cennik mediów | apartments.write |
| Leases (umowy) | |||
| GET | /v1/leases | Lista umów najmu | leases.read |
| POST | /v1/leases | Dodaj nową umowę | leases.write |
| GET | /v1/leases/{id} | Pobierz umowę z najemcami | leases.read |
| PATCH | /v1/leases/{id} | Zmień warunki, kwoty lub datę końca | leases.write |
| POST | /v1/leases/{id}/terminate | Wcześniejsze zakończenie umowy | leases.write |
| Tenants (najemcy) | |||
| GET | /v1/tenants | Lista najemców z aktywnymi umowami | tenants.read |
| POST | /v1/tenants/{id}/secure-link | Wygeneruj bezpieczny link 30 dni | tenants.write |
| DELETE | /v1/tenants/{id} | Anonimizuj najemcę po zakończeniu umowy | tenants.write |
| Settlements (rozliczenia) | |||
| GET | /v1/settlements | Lista rozliczeń z filtrem okresu | settlements.read |
| POST | /v1/settlements | Utwórz szkic rozliczenia za okres | settlements.write |
| GET | /v1/settlements/{id} | Szczegóły rozliczenia z pozycjami | settlements.read |
| POST | /v1/settlements/{id}/approve | Zatwierdź i wyślij do najemcy | settlements.write |
| POST | /v1/settlements/{id}/correct | Wystaw korektę zamiast istniejącego | settlements.write |
| GET | /v1/settlements/{id}/pdf | Pobierz PDF zestawienia | settlements.read |
| Documents (dokumenty) | |||
| POST | /v1/documents | Wgraj fakturę, paragon lub odczyt licznika | documents.write |
| GET | /v1/documents/{id} | Pobierz dokument z metadanymi | documents.read |
| GET | /v1/documents/{id}/file | Pobierz źródłowy plik (PDF/JPG) | documents.read |
| Webhooks | |||
| GET | /v1/webhooks | Lista skonfigurowanych endpointów | webhooks.read |
| POST | /v1/webhooks | Dodaj nowy endpoint subskrypcji | webhooks.write |
| POST | /v1/webhooks/{id}/test | Wyślij testowe zdarzenie ping | webhooks.write |
Wyświetlonych: 26 z 26. Brak endpointa, którego potrzebujesz? Napisz api@mieszkanie.app.