get_work_order_report
Generate work order reports filtered by property, status, priority, date range, and other criteria for tracking maintenance and costs.
Instructions
Generates a report on work orders. IMPORTANT: All ID parameters (unit_ids, property_id, etc.) must be numeric strings (e.g. '123'), NOT names. Use respective directory reports first to lookup IDs by name if needed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| property_visibility | No | Filter properties by status. Defaults to "active". | active |
| unit_ids | No | Optional. Filter by specific unit IDs. | |
| property | No | Optional. Filter by a single property ID. | |
| parties_ids | No | Optional. Filter by specific occupancy IDs. | |
| party_contact_info | No | Optional. Filter by a specific vendor ID (company). | |
| assigned_user | No | Filter by assigned user ID or "All". Defaults to "All". | All |
| created_by | No | Filter by creator user ID or "All". Defaults to "All". | All |
| priority | No | Filter by priority. Defaults to "All". | All |
| from_inspection | No | Optional. Filter by whether the work order originated from an inspection. Defaults to false. | |
| current_estimate_approval_status | No | Filter by estimate approval status. Defaults to "All". | All |
| work_order_statuses | No | Optional. Filter by specific work order status IDs. | |
| work_order_types | No | Optional. Filter by specific work order types. | |
| unit_turn_category | No | Filter by unit turn category. Defaults to ["all"]. | |
| status_date_range_from | No | Optional. Start date for status date range filter (YYYY-MM-DD). | |
| status_date_range_to | No | Optional. End date for status date range filter (YYYY-MM-DD). | |
| status_date | No | Field to use for status date range filtering. Defaults to "all". | all |
| 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_address, unit_street, unit_street2, unit_city, unit_state, unit_zip, priority, work_order_type, service_request_number, service_request_description, home_warranty_expiration, work_order_number, job_description, instructions, status, vendor_id, vendor, unit_id, unit_name, occupancy_id, primary_tenant, primary_tenant_email, primary_tenant_phone_number, created_at, created_by, assigned_user, estimate_req_on, estimated_on, estimate_amount, estimate_approval_status, estimate_approved_on, estimate_approval_last_requested_on, scheduled_start, scheduled_end, work_completed_on, completed_on, last_billed_on, canceled_on, amount, invoice, unit_turn_id, corporate_charge_amount, corporate_charge_id, discount_amount, discount_bill_id, markup_amount, markup_bill_id, tenant_total_charge_amount, tenant_charge_ids, vendor_bill_amount, vendor_bill_id, vendor_charge_amount, vendor_charge_id, inspection_id, inspection_date, work_order_id, service_request_id, recurring, submitted_by_tenant, requesting_tenant, maintenance_limit, status_notes, follow_up_on, vendor_trade, unit_turn_category, work_order_issue, survey_id, vendor_portal_invoices |