get_rent_roll_itemized_report
Fetches a detailed, itemized rent roll report filtered by properties, unit status, tags, GL accounts, date, and selected columns.
Instructions
Returns rent roll itemized report for the given filters. IMPORTANT: All ID parameters (properties_ids, property_groups_ids, portfolios_ids, owners_ids, gl_account_ids) must be numeric strings (e.g. '123'), NOT names. CRITICAL: gl_account_ids are internal database IDs, NOT GL account numbers! Do not use GL account numbers like '4630', '4635' - use the Chart of Accounts Report first to lookup the correct gl_account_ids.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| properties | No | ||
| unit_visibility | No | Filter units by status. Defaults to "active". | active |
| tags | No | Tags filter | |
| gl_account_ids | No | Array of GL account IDs (internal database IDs, NOT GL account numbers). These are numeric strings like "123", "456". Do NOT use GL account numbers like "4630", "4635". Use the Chart of Accounts Report to lookup gl_account_ids by GL account number or name. | |
| as_of_date | Yes | Report date in YYYY-MM-DD format | |
| 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, property_type, occupancy_id, unit_id, unit, unit_tags, unit_type, bd_ba, tenant, status, sqft, market_rent, computed_market_rent, advertised_rent, total, other_charges, monthly_rent_square_ft, annual_rent_square_ft, deposit, lease_from, lease_to, last_rent_increase, next_rent_adjustment, next_rent_increase_amount, next_rent_increase, move_in, move_out, past_due, nsf, late, amenities, additional_tenants, monthly_charges, rent_ready, rent_status, legal_rent, preferential_rent, tenant_tags, tenant_agent, property_group_id, portfolio_id. If not specified, all columns are returned. |