📘 API Documentation: List Rent Roll

Base URL

https://property.ysgcloud.com.ng

Endpoint

/api/listrentroll

Authentication

No authentication required. If added later, use Authorization: Bearer <token>.

Request

• Method: GET
• Headers: Accept: application/json

Response

Returns an array of rent roll objects with the following fields:

• PropertyNo
• UnitNo
• UnitName
• TenantName
• StartDate
• ExpirDate
• RentAmount
• RentStatus

Example Success Response

[
  {
    "PropertyNo": "P001",
    "UnitNo": "U001",
    "UnitName": "Flat A",
    "TenantName": "Samuel Johnson",
    "StartDate": "2025-01-01",
    "ExpirDate": "2025-12-31",
    "RentAmount": 150000,
    "RentStatus": "Paid"
  },
  {
    "PropertyNo": "P001",
    "UnitNo": "U002",
    "UnitName": "Flat B",
    "TenantName": "Mary Adams",
    "StartDate": "2025-02-01",
    "ExpirDate": "2026-01-31",
    "RentAmount": 200000,
    "RentStatus": "Pending"
  }
]

Error Response

{
  "status": "error",
  "message": "Invalid request or server error"
}

Example Usage

JavaScript (Browser)

<script>
fetch("https://property.ysgcloud.com.ng/api/listrentroll")
  .then(response => {
      if (!response.ok) throw new Error("Network error");
      return response.json();
  })
  .then(rentroll => {
      console.log("Retrieved rent roll:", rentroll);
      rentroll.forEach(r => {
          console.log(
              `PropertyNo: ${r.PropertyNo}, UnitNo: ${r.UnitNo}, UnitName: ${r.UnitName}, Tenant: ${r.TenantName}, 
Start: ${r.StartDate}, Expiry: ${r.ExpirDate}, Amount: ${r.RentAmount}, Status: ${r.RentStatus}`
          );
      });
  })
  .catch(err => console.error("Error:", err));
</script>

Postman

GET Request

• Method: GET
• URL: https://property.ysgcloud.com.ng/api/listrentroll
• Headers: Accept: application/json

Live Demo

Open your browser console to see the retrieved rent roll data: