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

Обзор

Модуль штрафных санкций позволяет владельцам объектов отслеживать и документировать финансовые штрафы, наложенные на нанимательов за нарушение условий договора найма.

Отслеживание штрафов

Записывайте финансовые штрафы с датой, суммой, валютой и подробным описанием.

Ссылки на блоки договора

Связывайте штрафы с конкретными пунктами договора, которые были нарушены.

Документы

Прикрепляйте фото и документы в качестве доказательной базы.

Привязка к платежам

Штрафы можно привязать к конкретным просроченным платежам для отслеживания

Поддержка валют

Записывайте штрафы в разных валютах с автоматическим отображением символа.

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

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

1

Документирование штрафа

Владелец записывает штраф с датой, суммой, валютой и описанием.

2

Выбор блоков договора

Свяжите штраф с конкретными пунктами договора, которые были нарушены.

3

Прикрепление доказательств

Загрузите фото и документы в качестве подтверждающих доказательств.

4

Отслеживание истории

Создайте историю штрафов для нанимателя/договора для последующего использования.

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

Права доступа к штрафным санкциям:

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

REST API

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

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

GET    /api/v1/properties/{id}/penalties           - Список штрафов
POST   /api/v1/properties/{id}/penalties           - Создать штраф
GET    /api/v1/properties/{id}/penalties/{pid}     - Получить детали
PUT    /api/v1/properties/{id}/penalties/{pid}     - Обновить штраф
DELETE /api/v1/properties/{id}/penalties/{pid}     - Удалить штраф
POST   /api/v1/properties/{id}/penalties/{pid}/documents      - Прикрепить документ
DELETE /api/v1/properties/{id}/penalties/{pid}/documents/{did} - Открепить документ

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

{
  "data": [
    {
      "id": 1,
      "property_id": 5,
      "contract_id": 12,
      "penalty_date": "2026-01-10",
      "amount": 500.00,
      "paid_amount": 250.00,
      "remaining_amount": 250.00,
      "is_paid": false,
      "currency": {
        "id": 3,
        "code": "UAH",
        "symbol": "₴"
      },
      "description": "Late rent payment penalty for December 2025",
      "violator": {
        "id": 15,
        "name": "John Tenant"
      },
      "documents_count": 2,
      "blocks_count": 1,
      "created_at": "2026-01-10T14:30:00+00:00"
    }
  ],
  "total": 1,
  "page": 1,
  "totalPages": 1
}

Swagger / OpenAPI

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

Штрафные санкции