Analyze Loss to Lease
analyze_loss_to_leaseLoss to lease — gap between market rent and in-place rent on occupied units.
Runs SummaryRentRoll (report 69) over a full month and sums RM's Loss to
Lease for occupied units by unit type, with market rent, in-place rent, the
loss, and loss-as-%-of-market. The #1 multifamily revenue-capture metric:
how far below market in-place rents sit and the renewal upside. Use for
"what's our loss to lease", "how far below market are we", "which unit types
have the biggest market gap". Requires market rent set on units. Always uses
the full calendar month of as_of_date (defaults to the current month).
``location`` (optional): a Rent Manager Location ID, a comma-separated
list, or ``"all"`` to run across every Location on this connection (see
``list_locations``). Blank = all Locations if the connection has several,
else its only Location. Output is labelled per Location; a Location that
can't be reached is listed as skipped. IDs (property, tenant, ...) belong
to one Location, so pass that Location when you filter by one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| location | No | ||
| portfolio | No | ||
| as_of_date | No | ||
| property_ids | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |