RENTPRO API END POINTS FOR YSG PROPERTIES
RentPro is envisioned as a comprehensive property rental management system. The API endpoints will serve as the backbone of the platform, enabling seamless communication between client applications (web, mobile) and the server. This proposal outlines the purpose, scope, and expected outcomes of developing RentPro’s API layer.
Purpose: Retrieve details of all properties managed in RentPro. Data Returned: Property ID, name, address, type, owner info, total units, rent value
Purpose: Access information about individual units within a property. Data Returned: Unit ID, property ID, size, type, rent amount, amenities.
Purpose: Provide tenant details for each unit. Data Returned: Tenant ID, name, contact info, lease start/end dates, payment history.
Purpose: Track occupancy status of units. Data Returned: Unit ID, status (occupied, vacant, under maintenance).
Purpose: Generate a rent roll report for properties. Data Returned: Property ID, unit ID, tenant name, monthly rent, payment status.
Purpose: Identify tenants with outstanding rent payments. Data Returned: Tenant ID, unit ID, due amount, due date.
Purpose: List all currently vacant units. Data Returned: Unit ID, property ID, size, rent amount, vacancy date.
Purpose: List all currently occupied units. Data Returned: Unit ID, property ID, tenant name, lease details.
Purpose: Provide income reports for properties over a given period. Data Returned: Property ID, UnitID, Tenant Name, Invoice No, total amount, Amount Paid, outstanding
Purpose: Retrieve analytical data in numbers for key metrics Data Returned: No of properties, no of units, no of tenants, no of landlords, vacant units, occupied units, active rents, expired rents, total rent value
Read our documentation to get started
Documentation