Lease Calculate
ERP

Lease-Calculate

post/v1/lease/calculate

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/lease/calculate
  • Auth: API key in header X-Imobzi-Secret

Query parameters

typestring nullable

Request body

durationinteger nullable

Duration of the lease, as an integer. Required for period-based calculations (e.g., type=period_by_duration, start_at_by_duration).

duration_typestring nullable

Unit of duration. Allowed values: 'month', 'year', 'day'. ⚠️ Plural forms (e.g., 'months') are not accepted.

method'installments' | 'in_cash' nullable

Calculation method. Used mainly in type=vacation_rental_installments. Accepted values are not fully documented; expected like 'split_equal'. Required if type is vacation_rental_installments

installments_amountinteger nullable

Number of installments. Required when method splits the value (e.g., vacation_rental_installments with split_equal).

start_atstring nullable

Lease start date. Date format depends on type:

  • DD-MM-YYYY for invoice, onlending, period_by_duration, period_by_end_at, start_at_by_duration.
  • ISO YYYY-MM-DD for invoice_reference and possibly lease_rescission_value.
end_atstring nullable

Lease end date (ISO YYYY-MM-DD). Required for invoice_reference, period_by_end_at, and start_at_by_duration.

onlendingobject nullable

Onlending configuration. Requires start_at, in_progress, due_day, has_invoice, first_rental_in_next_invoice, and beneficiaries[].

lease_valuenumber nullable

Total lease value. Preferred for beneficiary and onlending calculations. ⚠️ Do not confuse with 'value', which is used in invoice/management_fee.

next_invoice_end_atstring nullable

End date of the next invoice period (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now.

next_invoice_start_atstring nullable

Start date of the next invoice period (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now.

next_invoice_due_datestring nullable

Due date of the next invoice (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now.

billing_modestring nullable

Billing mode (e.g., monthly, quarterly).

first_rental_in_next_invoiceboolean nullable

Whether the first rental should be included in the next invoice. Required in type=invoice and onlending.

has_invoiceboolean nullable

Whether invoices are generated for this lease. Required in type=invoice and onlending.

in_progressboolean nullable

Whether the lease is currently active. Required in type=onlending and generate_next_invoice_now.

irrfboolean nullable

Whether IRRF (withholding tax) is applied.

irrf_management_fee_discountboolean nullable

Whether IRRF applies a discount on management fee.

irrf_simplified_discountboolean nullable

Whether simplified IRRF discount is applied.

lease_codestring nullable

Unique lease code identifier.

valuenumber nullable

Monetary value used in invoice, management_fee, and simple calculations. ⚠️ Not used for beneficiary distribution; for that, use lease_value.

rescission_datestring nullable

Rescission date if the lease is terminated early (ISO YYYY-MM-DD). Required in type=lease_rescission_value, but module may also require next_invoice_* fields.

reference_datestring nullable

Reference date for adjustments (ISO YYYY-MM-DD).

indeterminateboolean nullable

Whether the lease has an indeterminate (open-ended) duration.

calculate_from_imobziboolean nullable

Calculate negative value when come Imobzi

Example request

{
  "beneficiary": {
    "bank_data": {
      "code": "001",
      "name": "Banco do Brasil"
    }
  },
  "beneficiaries": [
    {
      "bank_data": {
        "code": "001",
        "name": "Banco do Brasil"
      }
    }
  ]
}

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.