Leases Overview

The Leases API provides endpoints for managing rental lease agreements and their lifecycle throughout the tenancy period.

Key Concepts

Lease Terms

Leases define the rental agreement parameters:

  • Duration: Start and end dates for the lease period
  • Rent Amount: Monthly rental amount for the unit
  • Execution Status: Whether the lease has been signed (isExecuted)
  • Unit Assignment: Specific unit covered by the lease

Lease Relationships

  • Households: Leases are associated with specific household units
  • Properties: Connected to the property where the unit is located
  • Units: Specific unit being leased
  • Claims: Associated insurance or damage claims
  • Renewal Offers: Future lease renewal opportunities
  • Rent Changes: Historical rent adjustments during the lease term

Lease Lifecycle

  • Creation: Initial lease offer and terms setup
  • Execution: Lease signing and activation
  • Management: Ongoing lease administration and modifications
  • Renewal: Lease extension and renewal processes
  • Termination: Lease end and move-out procedures

Available Endpoints

EndpointSummaryMethod
/leasesList LeasesGET
/leasesCreate LeasePOST
/leases/{leaseId}Read LeaseGET
/leases/{leaseId}Update LeasePUT
/leases/{leaseId}/cancelCancel LeasePOST