Move Outs Overview

The Move Outs API provides endpoints for managing the move-out process when tenants vacate their rental units.

Key Concepts

Move Out Status

Move outs can be in various states:

  • SCHEDULED - Move-out date has been scheduled
  • COMPLETED - Move-out process has been completed
  • CANCELED - Move-out has been canceled

Move Out Details

Move outs track the transition from occupancy to vacancy:

  • Scheduled Date: Planned date for the move-out
  • Actual Date: When the move-out actually occurred
  • Status Tracking: Current state of the move-out process
  • Reason: Reason for the move-out (voluntary, eviction, etc.)
  • Type: Classification of the move-out type

Move Out Relationships

  • Properties: Move-outs occur at specific properties
  • Units: Associated with the specific unit being vacated
  • Households: Connected to the household moving out
  • Leases: Typically ends or transfers the lease agreement

Available Endpoints

EndpointSummaryMethod
/moveOutsList Move OutsGET
/moveOutsCreate Move OutPOST
/moveOuts/{moveOutId}Read Move OutGET
/moveOuts/{moveOutId}Update Move OutPUT
/moveOuts/{moveOutId}Delete Move OutDELETE