get_lease_expiration_detail_by_month_report
Retrieve lease expiration details by month with filters for properties, date range, unit status, and tags to manage upcoming renewals.
Instructions
Retrieves a report detailing lease expirations by month, filterable by properties, date range, and other criteria. 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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from_date | Yes | The start date for the reporting period (YYYY-MM-DD). Required. | |
| to_date | Yes | The end date for the reporting period (YYYY-MM-DD). Required. | |
| properties | No | Filter results based on properties, groups, portfolios, or owners | |
| unit_visibility | No | Filter units by status. Defaults to "active" | active |
| tags | No | Filter by unit tags (comma-separated string) | |
| filter_lease_date_range_by | No | Which date field to use for the date range filter. Defaults to "Lease Expiration Date" | Lease Expiration Date |
| exclude_occupancies_with_move_out | No | Exclude occupancies that have a move-out date. Defaults to "0" (false) | 0 |
| exclude_month_to_month | No | Exclude occupancies that are month-to-month. Defaults to "0" (false) | 0 |
| columns | No | Array of specific columns to include in the report. Valid columns: property, property_name, property_id, property_address, property_street, property_street2, property_city, property_state, property_zip, unit, unit_tags, unit_type, move_in, lease_expires, lease_expires_month, market_rent, sqft, tenant_name, deposit, rent, phone_numbers, unit_id, occupancy_id, tenant_id, owner_agent, tenant_agent, rent_status, legal_rent, owners_phone_number, owners, last_rent_increase, next_rent_adjustment, next_rent_increase, lease_sign_date, last_lease_renewal, notice_given_date, move_out, tenant_tags, affordable_program, computed_market_rent. If not specified, all columns are returned. |