get-all-copy

Follows: Authentication • Caching • Polling • List Response Format • Scheduled Job

The renewal-summary endpoint returns the Renewal Summary report for your AppFolio® portfolio. Each row represents a single lease whose new start date falls inside the report window, with previous vs. new rent, dollar and percent change, term length, and current renewal status. The window defaults to this and the next six months; pass dateFrom / dateTo (MM/YYYY) for a custom range or dateRange for a relative preset. Filter by renewal state with the status parameter (All, Renewed, Not Renewed, Month To Month, Pending, Canceled By User).

Parameters

---

propertyIdselect

AppFolio ID of a Property to serve as a filter.

---

propertyGroupIdselect

AppFolio ID of a Property Group to serve as a filter.

---

ownerIdselect

AppFolio ID of an Owner to serve as a filter.

---

dateRangeselect

New lease start Range for report.

Default Value:  

this_and_next_6_months

Possible Values:  

this_month

this_quarter

this_year

this_year_to_month

last_month

last_quarter

last_year

trailing_3_months

trailing_6_months

trailing_12_months

rolling_12_months

this_and_next_3_months

this_and_next_6_months

---

dateFromdate_month

New lease start to given in MM/YYYY (e.g. 01/2021)

---

dateTodate_month

New lease start to given in MM/YYYY (e.g. 01/2021)

---

statusselect

Filter by renewal status. Default: All. Possible values: All, Renewed, Not Renewed, Month To Month, Pending, Canceled By User

Default Value:  

All

Possible Values:  

All

Renewed

Not Renewed

Month To Month

Pending

Canceled By User

---

 

Returns

---

The standard List Response Format with a data property containing an array of RenewalSummary objects.