get_renewal_summary_report
Summarizes lease renewals. Filter by properties, date range, and renewal status.
Instructions
Provides a summary of lease renewals. IMPORTANT: All ID parameters (properties_ids, property_groups_ids, portfolios_ids, owners_ids) must be numeric strings (e.g. '123'), NOT names. Use respective directory reports first to lookup IDs by name if needed. NOTE: All string parameters should be properly quoted JSON strings (e.g. "active", not active).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| properties | No | Filter results based on properties, groups, portfolios, or owners | |
| unit_visibility | No | Filter units by status. Defaults to "active" | active |
| start_on_from | Yes | The start month for the reporting period based on lease start date (YYYY-MM). Required. | |
| start_on_to | Yes | The end month for the reporting period based on lease start date (YYYY-MM). Required. | |
| statuses | No | Filter by renewal status. Defaults to ["all"] | |
| include_tenant_transfers | No | Include tenant transfers in the report. Defaults to "0" (false) | |
| columns | No | Array of specific columns to include in the report. Valid columns: unit_name, property, property_name, property_id, property_address, property_street, property_street2, property_city, property_state, property_zip, unit_type, unit_id, occupancy_id, tenant_name, lease_start, lease_end, previous_lease_start, previous_lease_end, previous_rent, rent, respond_by_date, renewal_sent_date, countersigned_date, automatic_renewal_date, percent_difference, dollar_difference, status, term, lease_start_month, tenant_id, tenant_tags, tenant_agent, lease_uuid, lease_document_uuid, notice_given_date, move_out. If not specified, all columns are returned. |