Documentation | API Reference

What are rental charges?

Rental charges are automatically generated monthly payments for rent based on active rental contracts. The system calculates charges based on the monthly rent amount specified in the contract and the actual number of rental days in each period.

Key Features

Automatic monthly billing
Proportional calculation for partial months
Flexible payment day
Unified interface with utility expenses
Multi-currency support

How It Works

1

Step 1: Contract Setup

Fill in MONTHLY_RENT_AMOUNT and RENT_PAYMENT_DAY fields in the rental contract

2

Step 2: Automatic Generation

The system will automatically generate rental charges monthly at 00:01

3

Step 3: Review and Management

Review and manage generated charges in the "Expenses" section

Payment Calculation Logic

Period Calculation

The system automatically determines the billing period based on the contract start date and payment day:

Period Determination Rules

If contract starts on the 1st, period starts from the 1st
If contract starts after payment day, first period will be short (proportional calculation)
If contract starts before payment day, first period starts from start date
Each subsequent period starts the day after the payment day of the previous period

Proportional Calculation

Daily rate = Monthly rent / Days in month
Proportional amount = Daily rate × Actual rental days

Example:
Monthly rent: €1,000
Contract starts: January 20
Charge day: 5th
Days in January: 31

First period: January 20 - February 4 (16 days)
Daily rate: €1,000 / 31 = €32.26
Amount: €32.26 × 16 = €516.13

Second period: February 5 - March 4 (28 days, full month)
Daily rate: €1,000 / 28 = €35.71
Amount: €35.71 × 28 = €1,000.00

Calculation Example

Scenario

Monthly rent: 10,000 UAH
Start date: January 15, 2026
Payment day: 5th

Generated Charges

Period	Days	Calculation	Amount
Jan 20 - Feb 04	16	(€1,200 / 31) × 16	€619.35
Feb 05 - Mar 04	28	(€1,200 / 28) × 28	€1,200.00
Mar 05 - Apr 04	31	(€1,200 / 31) × 31	€1,200.00

Contract Fields for Rental Charges

For automatic rental charge generation, the following fields must be filled in the rental contract:

Field Name	Required	Description
`MONTHLY_RENT_AMOUNT`	Required	Monthly rent amount. If not specified or equals 0, rental charges will not be generated.
`RENT_PAYMENT_DAY`	optional	Day of month for payment (1-28). If not specified, beginning of month is used.

Example

Rental Contract

Rental Charges API

The following API endpoints are available for working with rental charges:

Service layer note

GET /api/v1/rental-charges
    List Rental Charges
    
GET /api/v1/rental-charges/{id}
    Rental Charge Details
    
GET /api/v1/rental-charges/contract/{id}
    List Charges by Contract
    
GET /api/v1/rental-charges/contract/{id}/next
    Next Billing Period
    
POST /api/v1/rental-charges/contract/{id}/generate
    Generate Rental Charges
    
DELETE /api/v1/rental-charges/{id}
    Delete Rental Charge

API Example

GET /api/v1/rental-charges/contract/42/next
Authorization: Bearer <token>

Response:
{
  "can_charge": false,
  "reason": "period_not_ended",
  "next_period_start": "2026-02-05",
  "next_period_end": "2026-03-04",
  "next_charge_date": "2026-03-05",
  "rental_days": 28,
  "amount": 1200.00,
  "currency": "EUR"
}

Restrictions

Important

Automatic charges are generated daily at 00:01 (server timezone)
Automatically generated charges cannot be edited
Automatically generated charges can only be deleted by an administrator
Charges are generated only for active contracts
The system does not generate duplicate charges for already completed periods

View Charges

View generated charges in the property "Expenses" section

Troubleshooting

No Charges Found

If rental charges are not being generated automatically, check the following:

Check if MONTHLY_RENT_AMOUNT field is filled
Check contract start and end dates
Review contract currency settings
Check system logs for errors
Ensure the contract is active
Check if charge generation is not blocked for this contract
Contact administrator if the problem persists

Wrong Amount

If the charge amount is calculated incorrectly, it may be due to proportional calculation for a partial month. Check the payment period and number of days in the period.