Operational
Download Postman
REST API & Ledger Engine • v1.0.0

OASIS HEIGHTS
PROPERTY MANAGEMENT ENGINE

Enterprise real estate management system featuring open public listings, customer self-service portal, dynamic installment schedules, multi-tier RBAC authorization, and financial ledger architecture.

Explore All 22 API Modules Download Postman Collection (.json) Interactive Live Console
API Server
ONLINE
Uptime: measuring...
MySQL Database
CONNECTED
Query Ping: measuring...
Environment
DEV
Prisma ORM • Arbitrary Decimal
Registered API Modules
22 Modules
Dynamic RBAC • Decimal Accuracy

Ready for API Testing?

Download the complete Postman Collection (v2.1) pre-configured with all 22+ modules (Public API, Customer Portal, Admin CRM, Installments, Payments, Expenses, Carousels, Plans, Uploads, RBAC), environment variables (`{{base_url}}`, `{{access_token}}`), sample request bodies, and authentication flows.

Download Postman Collection (.json)

API Modules & Routes Reference

Complete interactive catalog of all endpoints served under /api/v1

Public API (Open) No Auth Required

1. Public API Engine

High-performance public endpoints for website portals, unit catalogs, booking appointments, and customer enquiries.

GET/api/v1/public/projects
GET/api/v1/public/projects/:id
GET/api/v1/public/projects/:id/properties
GET/api/v1/public/properties
GET/api/v1/public/properties/:id
POST/api/v1/public/appointments
POST/api/v1/public/enquiries
GET/api/v1/public/carousels
GET/api/v1/public/plans
GET/api/v1/public/plans/:id
Self-Service Customer Auth

2. Customer Portal

Customer dashboard, purchased unit payment plans, milestone installments, payment receipts, and balance summary.

GET/api/v1/customer-portal/profile
PUT/api/v1/customer-portal/profile
GET/api/v1/customer-portal/dashboard
GET/api/v1/customer-portal/payment-plans
GET/api/v1/customer-portal/payment-plans/:id
GET/api/v1/customer-portal/installments
GET/api/v1/customer-portal/payments
GET/api/v1/customer-portal/balance
Security Dual JWT

3. Authentication & Identity

Dual-token JWT authentication (Access & Refresh tokens), password changes, identity verification, and logout.

POST/api/v1/auth/login
POST/api/v1/auth/refresh
GET/api/v1/auth/me
POST/api/v1/auth/change-password
POST/api/v1/auth/logout
Developments Protected

4. Projects & Towers

Parent development projects, tower complexes, construction timelines, budgets, and property aggregations.

GET/api/v1/projects
POST/api/v1/projects
GET/api/v1/projects/:id
PUT/api/v1/projects/:id
DELETE/api/v1/projects/:id
Inventory Protected

5. Property & Unit Inventory

Flats, apartments, and commercial units linked by projectId, floor assignments, pricing, and availability states.

GET/api/v1/properties
POST/api/v1/properties
GET/api/v1/properties/:id
PATCH/api/v1/properties/:id/status
DELETE/api/v1/properties/:id
CRM Protected

6. Customer Management

Customer registries, CNIC/Passport KYC, contact details, linked payment plans, and financial statements.

GET/api/v1/customers
POST/api/v1/customers
GET/api/v1/customers/:id
GET/api/v1/customers/:id/payment-plans
GET/api/v1/customers/:id/payment-history
GET/api/v1/customers/:id/installment-schedule
GET/api/v1/customers/:id/remaining-balance
GET/api/v1/customers/:id/full-profile
PUT/api/v1/customers/:id
Financials Installments

7. Payment Plans

Dynamic installment generators, down payments, balloon installments, tenure schedules, and booking contracts.

GET/api/v1/payment-plans
POST/api/v1/payment-plans
GET/api/v1/payment-plans/:id
PUT/api/v1/payment-plans/:id
DELETE/api/v1/payment-plans/:id
Schedules Overdue Engine

8. Installment Schedules

Individual milestone tracking, overdue aging detection, paid vs. remaining balances, and status transitions.

GET/api/v1/installments
GET/api/v1/installments/overdue
GET/api/v1/installments/:id
PUT/api/v1/installments/:id
Ledger Transactional

9. Payments & Collections

Cash/Cheque/Online payment entries, auto-allocation to pending installments, and reversible receipts.

GET/api/v1/payments
POST/api/v1/payments
GET/api/v1/payments/:id
POST/api/v1/payments/:id/reverse
Costing Outgoing

10. Expenses & Costing

Record project and corporate expenditures with decimal precision, payment methods, receipts, and KPI breakdowns.

GET/api/v1/expenses
GET/api/v1/expenses/summary
POST/api/v1/expenses
PUT/api/v1/expenses/:id
DELETE/api/v1/expenses/:id
Categories Admin Managed

11. Expense Types

Admin-managed cost categories (Construction, Labor, Legal, Marketing, Utilities, Material) with expenditure totals.

GET/api/v1/expense-types
POST/api/v1/expense-types
GET/api/v1/expense-types/:id
PUT/api/v1/expense-types/:id
DELETE/api/v1/expense-types/:id
Bookings Admin

12. Appointments (Admin)

Manage customer site visits, consultation bookings, schedule management, and status updates (PENDING/CONFIRMED/COMPLETED/CANCELLED).

GET/api/v1/appointments
POST/api/v1/appointments
GET/api/v1/appointments/:id
PATCH/api/v1/appointments/:id/status
DELETE/api/v1/appointments/:id
Leads Admin

13. Enquiries & Leads

Website lead inquiries, property interests, customer feedback, status workflow (NEW/IN_PROGRESS/RESOLVED/CLOSED), and notes.

GET/api/v1/enquiries
POST/api/v1/enquiries
GET/api/v1/enquiries/:id
PATCH/api/v1/enquiries/:id/status
DELETE/api/v1/enquiries/:id
Media Banners

14. Carousels & Banners

Manage landing page hero slides, promotional banners, display order priority, CTA buttons, and status toggling.

GET/api/v1/carousels
POST/api/v1/carousels
GET/api/v1/carousels/:id
PUT/api/v1/carousels/:id
DELETE/api/v1/carousels/:id
Architecture Layouts

15. Floor Plans & Layouts

Architectural 2D/3D floor blueprints, unit dimensions, room layout specifications, and project plan assignments.

GET/api/v1/plans
POST/api/v1/plans
GET/api/v1/plans/:id
PUT/api/v1/plans/:id
DELETE/api/v1/plans/:id
Storage Multer Engine

16. File & Media Uploads

Multipart form-data file upload pipeline with MIME-type safety filters for project images, floor plans, CNIC KYC, and payment receipts.

POST/api/v1/uploads/image
POST/api/v1/uploads/document
POST/api/v1/uploads/single
POST/api/v1/uploads/multiple
DELETE/api/v1/uploads/:filename
Analytics Insights

17. Analytics & Reports

Executive KPI metrics, collection trends, overdue aging analysis, cash flow summaries, and real-time inventory statistics.

GET/api/v1/dashboard/summary
GET/api/v1/dashboard/collections
GET/api/v1/dashboard/inventory
Business Identity View / Upsert

18. System Preferences

Company details, NTN/Reg#, official phone/UAN, headquarters address, currency, and tax percentage configuration.

GET/api/v1/system-preferences
POST/api/v1/system-preferences
PUT/api/v1/system-preferences
Users Protected

19. User Accounts & Staff

System operators, administrators, staff users, assigned roles, password resets, and account statuses.

GET/api/v1/users
POST/api/v1/users
GET/api/v1/users/:id
PUT/api/v1/users/:id
POST/api/v1/users/:id/password
RBAC Dynamic Roles

20. Roles & Personas

Dynamic role management without legacy hardcoding. Manage Super Admin, Admin, Staff, Customer, and customized roles.

GET/api/v1/roles
POST/api/v1/roles
GET/api/v1/roles/:id
PUT/api/v1/roles/:id
Matrix Binding

21. Role Permissions

Bind accessibles and actions to specific roles to formulate dynamic accessible.action authorization matrix.

GET/api/v1/permissions
POST/api/v1/permissions
Registry Resources

22. Accessibles & Actions

Registered securable module resources (project, property, payment, expense, appointment, enquiry, carousel, plan, etc.) and action operations.

GET/api/v1/accessibles
POST/api/v1/accessibles
GET/api/v1/actions
POST/api/v1/actions

Interactive Live API Console

Test real responses directly against your active backend server instance

Status: Ready 
// Live JSON response will render here...
Click "Send Live Request" to execute query.
Copied to clipboard!