Документация | Справочник API

Обзор

Модуль "Имущество наймодателя" позволяет владельцам недвижимости вести учёт имущества (мебель, техника и т.д.), которое передаётся нанимателю в пользование вместе с помещением. Каждый объект может иметь переводы для многоязычной поддержки и прикреплённые документы для фиксации состояния.

Учёт имущества

Регистрация имущества с названием, датой, описанием и ориентировочной стоимостью.

Многоязычность

Добавление переводов названий имущества на разных языках.

Документы и фото

Прикрепление фото и документов для фиксации состояния имущества.

Оценка стоимости

Указание ориентировочной стоимости в разных валютах для страховых целей.

Процесс работы

Типичный процесс документирования имущества наймодателя:

1

Регистрация имущества

Владелец регистрирует имущество с названием, датой и описанием.

2

Указать стоимость

По желанию указать ориентировочную стоимость и валюту для страхования.

3

Добавить фото

Загрузить фото для фиксации состояния имущества с комментариями.

4

Добавить переводы

Добавить переводы названия имущества для многоязычной документации.

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

Права доступа к имуществу наймодателя:

Действие	Кто может
Создание	Владельцы и их агенты
Просмотр	Владельцы, нанимательы и их агенты
Редактирование	Владельцы и их агенты
Удаление	Владельцы и их агенты
Прикрепление документов	Владельцы и их агенты
Управление переводами	Владельцы и их агенты

REST API

Доступ к имуществу через REST API (требуется JWT-аутентификация):

Примечание уровня сервиса

Имущество

GET    /api/v1/properties/{id}/tenant-assets            - Список имущества
POST   /api/v1/properties/{id}/tenant-assets            - Создать
GET    /api/v1/properties/{id}/tenant-assets/{aid}      - Детали
PUT    /api/v1/properties/{id}/tenant-assets/{aid}      - Обновить
DELETE /api/v1/properties/{id}/tenant-assets/{aid}      - Удалить

Документы

POST   /api/v1/properties/{id}/tenant-assets/{aid}/documents      - Прикрепить документ
DELETE /api/v1/properties/{id}/tenant-assets/{aid}/documents/{did} - Открепить документ

Переводы

GET    /api/v1/properties/{id}/tenant-assets/{aid}/translations       - Список переводов
POST   /api/v1/properties/{id}/tenant-assets/{aid}/translations       - Добавить перевод
PUT    /api/v1/properties/{id}/tenant-assets/{aid}/translations/{tid} - Обновить перевод
DELETE /api/v1/properties/{id}/tenant-assets/{aid}/translations/{tid} - Удалить перевод

Пример ответа

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

Полная документация API доступна в Swagger /api/v1/doc