lease
ERP

Get Leases

get/v1/leases

Request

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

Query parameters

cursorstring nullable
end_atstring nullable
owner_idstring nullable
search_textstring nullable
search_typestring nullable
smart_liststring nullable
start_atstring nullable
property_idstring nullable

Response

Successful Response

additional_guestsinteger nullable

Number of additional guests allowed.

additional_value_guestnumber nullable

Additional charge per extra guest.

billing_modestring nullable

Billing mode for the lease (e.g., monthly, quarterly).

categorystring nullable

Category of the lease.

subcategorystring nullable

Subcategory of the lease.

codestring nullable

Unique code identifying the lease.

field_valuesobject[]

Custom field values in key-value format.

create_onlending_itemboolean nullable

Indicates if onlending item should be created.

credit_card_installment_percentagenumber nullable

Percentage applied for credit card installment.

credit_card_pass_on_fixed_rateboolean nullable

Indicates if fixed rate should be passed on credit card payments.

credit_card_pass_on_installments_feeboolean nullable

Indicates if installment fees should be passed on credit card payments.

credit_card_auto_chargeboolean nullable

Indicates if invoices should be charged automatically on the due date using the card the payer marked for automatic debit.

credit_card_percentagenumber nullable

Credit card percentage fee applied.

daily_valuenumber nullable

Daily rental value.

deal_keystring nullable

Key associated with the deal.

durationstring nullable
duration_typestring nullable
end_atstring nullable
federal_income_taxobject[]

Federal income tax details.

fine_chargeinteger nullable

Fixed fine charge for late payment.

fine_percent_late_paymentinteger nullable

Fine percentage for late payment.

first_rental_in_next_invoiceboolean nullable

Indicates if the first rental should be charged in the next invoice.

guaranteedboolean nullable

Indicates if the lease is guaranteed.

guarantee_amount_monthsinteger nullable

Number of months covered by the guarantee.

guestsinteger nullable

Maximum number of guests allowed.

include_in_dimobboolean nullable

Indicates if the lease should be included in DIMOB reporting.

indeterminateboolean nullable

Indicates if the lease is indeterminate.

initial_valuenumber nullable

Initial lease value.

interest_chargeinteger nullable

Fixed interest charge for late payment.

interest_percent_late_paymentnumber nullable

Interest percentage applied for late payment.

in_progressboolean nullable

Indicates if the lease is currently in progress.

invoice_shortcutboolean nullable

Indicates if invoice shortcut is enabled.

irrfboolean nullable

Indicates if IRRF (withholding tax) is applied.

irrf_management_fee_discountboolean nullable

Indicates if IRRF management fee discount is applied.

irrf_simplified_discountboolean nullable

Indicates if simplified IRRF discount is applied.

last_annual_readjustment_atstring nullable

Date of the last annual readjustment in 'YYYY-MM-DD' format.

lease_typestring nullable

Type of lease (e.g., residential, commercial).

next_invoicestring nullable

Date of the next invoice generation in 'YYYY-MM-DD' format.

next_invoice_due_datestring nullable

Due date of the next invoice in 'YYYY-MM-DD' format.

next_invoice_end_atstring nullable

End date of the next invoice period in 'YYYY-MM-DD' format.

next_invoice_generate_instring nullable

Date when the next invoice should be generated in 'YYYY-MM-DD' format.

next_invoice_start_atstring nullable

Start date of the next invoice period in 'YYYY-MM-DD' format.

next_invoice_valuenumber nullable

Value of the next invoice. Must be explicitly provided at lease creation.

newCodePropertystring nullable

Code of the new property if updated.

nota_fiscalboolean nullable

Indicates if nota fiscal (invoice) is generated.

nota_fiscal_productobject nullable

Indicate if notas fiscal has product

onlending_chargeboolean nullable

Indicates if onlending charges apply.

payment_maximum_installmentsinteger nullable

Maximum number of allowed payment installments.

send_due_notification_to_sponsorboolean nullable

Indicates if due notifications should be sent to the sponsor.

send_guarantee_closeduedate_to_tenantboolean nullable

Indicates if guarantee close due date notifications should be sent to tenant.

send_insurance_closeduedate_to_tenantboolean nullable

Indicates if insurance close due date notifications should be sent to tenant.

send_invoice_to_tenantboolean nullable

Indicates if invoices should be sent to the tenant.

send_onlending_to_landlordboolean nullable

Indicates if onlending details should be sent to the landlord.

send_overdue_notification_to_tenantboolean nullable

Indicates if overdue notifications should be sent to tenant.

send_notification_invoice_paid_after_due_dateboolean nullable

Indicates if the real estate agency should be notified when an invoice is paid after the due date.

send_nota_fiscal_in_invoice_createboolean nullable

Indicate if the nota fiscal should be sent when the invoice is created (This field will only be used when the management type is owned properties).

service_feeinteger nullable

Service fee amount applied.

sourcestring nullable
start_atstring nullable
statusstring nullable

Current status of the lease (default: active).

valuestring nullable
only_checklist_in_databoolean nullable

If true, only checklist information will be included in the data.

update_beneficiariesboolean nullable

If true, beneficiaries will be updated with the provided data.

beneficiaries_in_databoolean nullable
guarantee_in_databoolean nullable
insurances_in_databoolean nullable
field_values_in_databoolean nullable
items_in_databoolean nullable

Example response

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

Changes

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