Reports Overview
These endpoints are deprecated and available by request only. Please contact our team to explore availability for your integration.
The Reports API provides endpoints for generating and managing custom reports for property management data.
Key Concepts
Report Generation
Reports provide structured data analysis and insights:
- Filters: Specify criteria to narrow down report data
- Fields: Select which data fields to include in the report
- Sorting: Control how report data is ordered
- Request Tracking: Track who requested each report
Report Configuration
- Property-Specific: Reports are scoped to individual properties
- Custom Fields: Select specific data fields for inclusion
- Data Filtering: Apply filters to focus on relevant information
- Output Control: Configure how data is presented and sorted
Report Management
- Creation: Generate new reports based on specified criteria
- Retrieval: Access generated reports and their data
- Deletion: Remove reports that are no longer needed
- History: Track all report generation activities
Report Data Sources
Reports can aggregate data from various resources:
- Properties: Core property information and metrics
- Households: Resident and occupancy data
- Leases: Lease terms and rental information
- Financial Data: Revenue, expenses, and payment records
