Updating Tenant Data
Learn how to send tenant data to Livble
💡 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 repayment (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.
🔍 Determine Your Portal Type
Some request fields differ depending on how your portal handles payments.
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.
Updated 8 months ago