💡 Overview

To send tenant data to Livble, use the POST /portal_info/:id endpoint.
This section explains how to structure the request and correctly populate the required fields.

🕐 When To Update Tenant Data (Recommended)

In order to ensure a seamless user experience and prevent payment conflicts,
it is recommended to update the tenant's data in the following cases:

• When a charge is added or updated.
• When the tenant makes a payment (not using Livble)

📖 API Reference

Before proceeding, review the API Reference to familiarize yourself with the request schema.
This guide complements the API reference by offering detailed explanations and examples.

👁️ lease Object Overview

This section highlights key fields in the lease object that require additional explanations.
It is meant to compliment the API reference by providing extra context, so make sure to review that first.

🔘 lease.open_balance Field:

The tenant’s outstanding balance for the lease, in cents.
This is the default amount shown to the tenant when they access the portal.

🔘 lease.payments_enabled Field:

Whether online payments are enabled to the lease.

⚠️ This field directly determines if Livble can push rent for the lease.

🔘 lease.autopay_amount_in_cents Field:

If the tenant is enrolled in automatic payments for the lease, what is the monthly payment amount?

• If autopay is set for a fixed amount each month, pass that amount.
• If autopay is enabled but the exact amount is unknown, pass 1.
• If the tenant is not enrolled in autopay, pass null.
• 📖Read More Here

🔘 lease.partial_payments_allowed Field:

Indicates whether the tenant can make partial payments.

• If the tenant can pay an arbitrary amount, pass true.
• Otherwise, pass false.
  • For example if the tenant must always pay the current open_balance in full.
  • Even if the tenant can choose to pay only some of the charges but not all them,
    if the selected charges must all be paid in full, then false should still be passed.

🔘 lease.historical_payments Field:

The payments made by the tenant for the lease.

Send all payments made by the tenant.
If the history is too long, send payments from the last 12 months.

⚠️ Payment amounts should always be positive.

🔘 lease.charges Field:

A list of all charges associated with the lease, including past, current, and future charges.

⚠️ Important Note:
Please send all charges that were added for the lease, including:

• Security deposit charges.
• Fully paid historical charges.
• Future charges (even if not yet added to open_balance).
• And as a general note, don't exclude any charge.

🔍 Determine Your Portal Type

Some values in the request body may fields differ depending on how your portal handles payments.
To address that we have made guides for different portal types, each with an example and extra context.

The guides below will:

• Demonstrate how to derive the relevant values from a demo portal.
• Explain key considerations that are specific to your portal type.
• Provide an example for a full working request payload that you can test immediately.

Refer to the appropriate guide based on your portal type:

• 📜 Ledger Based Portal Guide: The tenant pays for the open balance, with no option to select specific charges.
• 🪙 Charge Based Portal Guide: The tenant must choose specific charges to pay for.