Документация | Справочник 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

Возмещение ремонта