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

Огляд

Квитанція групує один або кілька платежів та нарахувань в єдиний документ для підтвердження. Сума квитанції авторозраховується як сума всіх привʼязаних алокацій. Суму кожної алокації можна змінити на місці, автоматично створюючи записи коректувань з постачальниками.

Авторозрахунок суми

Сума квитанції = сума всіх привʼязаних платежів + нарахувань + разових витрат. Ручне введення суми не потрібне — все розраховується автоматично.

Коректування на місці

Змініть суму будь-якої алокації прямо на сторінці квитанції. Система автоматично створить коректування з постачальником послуг із різницею.

Разові витрати

Додайте разові витрати (ремонт, послуги) прямо з квитанції. Система автоматично створить нарахування + платіж + алокацію.

Двостороннє підтвердження

І орендодавець, і орендар повинні підтвердити квитанцію незалежно для повної валідації.

Підтримка багатовалютності

Квитанції автоматично конвертуються у валюту країни об'єкта, якщо валюта квитанції відрізняється.

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

Прикріпіть скан банківського підтвердження або касового документа у форматі PDF, JPG, PNG або HEIC.

Архітектура

Квитанції зʼєднуються з платежами через алокації. Коли сума алокації відрізняється від оригінального платежу, автоматично створюється звʼязок коректування та коректування з постачальником.

Receipt Авторозрахунок суми, примітки, підтвердження

↕

PaymentAllocation Звʼязок квитанція ↔ платіж з редагованою сумою

↙ ↘

Payment Оригінальний платіж від орендаря

AdjustmentLink оригінал → скоригована сума, різниця

↓

ServiceProviderAdjustment Коригування балансу з постачальником послуг

Процес коректування

Коли ви змінюєте суму алокації на сторінці квитанції:

1

Редагування суми

Натисніть іконку олівця біля суми платежу. Введіть нову суму у валюті обʼєкта.

2

Створення звʼязку коректування

Система створює ReceiptAdjustmentLink із збереженням: оригінальна сума, скоригована сума та різниця. Один звʼязок на алокацію.

3

Коректування з постачальником

Якщо платіж повʼязаний з витратою з постачальником (Payment → ExpenseCharge → PropertyExpense → ExpenseProvider), ServiceProviderAdjustment створюється/оновлюється автоматично. Автопідтвердження від сторони створювача.

4

Автоочищення

Якщо скоригована сума = оригінальній (різниця = 0), звʼязок коректування та коректування з постачальником автоматично видаляються.

Випадок без постачальника: Орендні нарахування та прості платежі не мають постачальника послуг. У цьому випадку створюється лише AdjustmentLink (без ServiceProviderAdjustment).

Підтвердження та правила редагування

Квитанції використовують двосторонню систему підтвердження, яка контролює права на редагування:

Не підтверджено

За замовчуванням. Жодна сторона не підтвердила. Повне редагування доступне.

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

Одна сторона підтвердила. Підтверджена сторона може відкликати. Інша сторона може редагувати.

Повністю підтверджено

Обидві сторони підтвердили. Квитанція заблокована — без редагування, без привʼязки/відвʼязки платежів, без змін документів.

Правило блокування: Коли ІНША сторона підтверджує, редагування блокується для вас. Приклад: якщо орендар підтвердив, орендодавець більше не може змінювати суми, привʼязувати платежі чи завантажувати документи. Залишаються лише кнопки підтвердження/відкликання.

Зв'язок з платежами

На сторінці квитанції ви можете привʼязати існуючі платежі або створити нові разові витрати:

Привʼязати існуючий платіж

Оберіть з доступних платежів/нарахувань у списку. Сума автоматично заповнюється у валюті обʼєкта. Ви можете змінити її для створення коректування.

Додати разову витрату

Введіть назву та суму. Система створить: ExpenseCharge (тип ONE_TIME) → Payment → Allocation. Обовʼязкові обидва поля.

Відʼєднати платіж

Видалити платіж з квитанції. Це також автоматично видаляє повʼязаний звʼязок коректування та коректування з постачальником.

Дізнатися більше: Для детальної інформації про платежі дивіться Платежі.

Редагування на місці

Сторінка перегляду квитанції підтримує редагування на місці без переходу на окрему форму:

Примітки (WYSIWYG)

Натисніть іконку олівця для відкриття редактора тексту (Summernote). Підтримує жирний, курсив, списки та посилання. Зберігає через AJAX без перезавантаження сторінки.

Суми платежів

Натисніть іконку олівця біля суми платежу для зміни. Зберігає через AJAX. Автоматично створює/оновлює/видаляє коректування.

Завантаження документа

Перетягніть або оберіть файл. Підтримує JPG, PNG, PDF, HEIC (макс. 20 МБ). Документи автоматично синхронізуються з Google Drive.

Правила видимості

Роль	Може бачити
LANDLORD / AGENT	Всі квитанції для об'єктів у власності
TENANT / AGENT	Квитанції, пов'язані з їх контрактами та платежами

REST API

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

GET    /api/v1/receipts                              - Список моїх квитанцій
GET    /api/v1/properties/{id}/receipts              - Список квитанцій об'єкта
GET    /api/v1/properties/{id}/receipts/{rid}        - Отримати деталі квитанції

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