Документація | Довідник API

Огляд

Модуль відшкодування ремонту дозволяє вести облік витрат на ремонт, здійснених наймачами, які можуть бути зараховані в рахунок плати за найм. До кожного відшкодування можна прикріпити кілька підтверджуючих документів.

Облік витрат

Фіксуйте витрати на ремонт із сумами, датами та описом виконаних робіт.

Кілька документів

Прикріплюйте кілька чеків, рахунків та актів виконаних робіт до кожного відшкодування.

Підтвердження власником

Власники об'єктів підтверджують або відхиляють запити на відшкодування після перегляду.

Робочий процес

Типовий робочий процес відшкодування ремонту:

1

Створення відшкодування

Наймач або власник створює запис про відшкодування з датою, сумою та описом.

2

Прикріплення документів

Завантажте чеки, рахунки або акти виконаних робіт як підтверджуючі документи.

3

Перевірка власником

Власник об'єкта перевіряє відшкодування та прикріплені документи.

4

Підтвердження

Власник підтверджує або відхиляє відшкодування. Підтверджені суми можуть бути зараховані в рахунок оренди.

Права доступу

Права доступу для відшкодувань ремонту:

Дія	Хто може
Створення	Власники, наймачі та їх представники
Перегляд	Усі користувачі з доступом до об'єкта
Редагування	Тільки автор відшкодування
Видалення	Тільки автор відшкодування
Підтвердження/Відхилення	Тільки власники об'єкта та їх представники
Прикріплення документів	Автор або власник/представник

Статуси підтвердження

Кожне відшкодування має статус підтвердження:

Ні

Статус за замовчуванням для нових відшкодувань. Очікує перевірки власником об'єкта.

Так

Власник підтвердив відшкодування. Сума може бути зарахована в рахунок оренди.

REST API

Доступ до відшкодувань ремонту через REST API (потрібна JWT авторизація):

Примітка рівня обслуговування

GET    /api/v1/properties/{id}/repair-compensations                  - Список відшкодувань
POST   /api/v1/properties/{id}/repair-compensations                  - Створити відшкодування
GET    /api/v1/properties/{id}/repair-compensations/{rid}            - Деталі відшкодування
PUT    /api/v1/properties/{id}/repair-compensations/{rid}            - Оновити відшкодування
DELETE /api/v1/properties/{id}/repair-compensations/{rid}            - Видалити відшкодування
POST   /api/v1/properties/{id}/repair-compensations/{rid}/confirm    - Підтвердити
POST   /api/v1/properties/{id}/repair-compensations/{rid}/unconfirm  - Зняти підтвердження
POST   /api/v1/properties/{id}/repair-compensations/{rid}/documents  - Прикріпити документ
DELETE /api/v1/properties/{id}/repair-compensations/{rid}/documents/{did} - Відкріпити документ

Приклад відповіді

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

Повна документація API з інтерактивним тестуванням доступна в Swagger UI: /api/v1/doc

Відшкодування ремонту