Документація | Довідник 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

Штрафні санкції