Skip to content

api-reference.md

Latest commit

 

History

History
27 lines (20 loc) · 1.23 KB

api-reference.md

File metadata and controls

27 lines (20 loc) · 1.23 KB
Raw

API Reference

The Rent_Flow API is structured into the following resource groups. Each link provides detailed documentation including request/response examples and functional descriptions.

API Resource Groups

  • Buildings API: Manage properties, addresses, and building-level tax settings.
  • Property Units API: Manage individual apartments, offices, and electricity meters.
  • Tenants API: Manage tenant profiles, contact info, and active status.
  • Charge Templates API: Configure rules for automated recurring billing.
  • Charges API: Handle individual billing records, payments, and manual charges.
  • Dashboard API: Access system-wide financial and occupancy metrics.

Global Conventions

Date/Time Format

All timestamps are returned in ISO-8601 format: YYYY-MM-DDTHH:mm:ssZ.

Status Codes

  • 200 OK: Request successful.
  • 201 Created: Resource created successfully.
  • 204 No Content: Resource deleted successfully.
  • 400 Bad Request: Validation error or malformed JSON.
  • 404 Not Found: Resource ID does not exist.
  • 500 Internal Server Error: Unexpected server error.