get_delinquency_as_of_report
Retrieve a delinquency as-of report for specified properties, date, and filters. Use numeric IDs for properties and filter by tenant status, balance, or tags.
Instructions
Returns delinquency as of report for the given filters. IMPORTANT: All ID parameters (properties_ids, etc.) must be numeric strings (e.g. '123'), NOT names. Use respective directory reports first to lookup IDs by name if needed. NOTE: tenant_statuses uses numeric codes: 0=Current, 1=Past, 2=Future, 3=Evict, 4=Notice.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| property_visibility | No | Filter properties by status. Defaults to "active". | active |
| properties | No | Optional. Filter by specific property-related IDs. | |
| occurred_on_to | Yes | Required. Date to run the report as of in YYYY-MM-DD format. | |
| delinquency_note_range | No | Optional. Filter by delinquency note range. | |
| tenant_statuses | No | Filter by tenant status. Valid values: "0"=Current, "1"=Past, "2"=Future, "3"=Evict, "4"=Notice. Defaults to ["0", "4"] (Current and Notice tenants). | |
| tags | No | Optional. Filter by property tags. | |
| amount_owed_in_account | No | Filter by amount owed in account. Defaults to "all". | all |
| balance_operator | No | Optional. Filter by balance amount with comparison operator. | |
| columns | No | Array of specific columns to include in the report. Valid columns: unit, name, tenant_status, tags, phone_numbers, move_in, move_out, primary_tenant_email, unit_type, property, property_name, property_id, property_address, property_street, property_street2, property_city, property_state, property_zip, amount_receivable, delinquent_subsidy_amount, 00_to30, 30_plus, 30_to60, 60_plus, 60_to90, 90_plus, this_month, last_month, month_before_last, delinquent_rent, delinquency_notes, certified_funds_only, in_collections, collections_agency, unit_id, occupancy_id, property_group_id |