Customers Overview
The Customers API provides endpoints for managing customer information throughout their lifecycle, from application to move-out.
Key Concepts
Customer Status
Customers can be in various states throughout their relationship:
APPLICANT- Customer is in the application processRESIDENT- Customer is currently residing in a unitPRIOR- Former customer who has moved out
Customer Information
Customers contain comprehensive personal and contact information:
- Personal Details: First name, last name, middle name, preferred name, and suffix
- Demographics: Birth date and gender information
- Contact Information: Email and phone details
- Household Association: Linked to specific households
- Property Association: Connected to specific properties
Customer Relationships
- Households: Customers belong to household units
- Work Orders: Associated maintenance requests and service orders
- Transactions: Financial transaction history
- Assets: Associated assets and belongings
- Attachments: Documents and files related to the customer
