In this article, we'll cover the available Yardi Tools within Virtuoso Composer's user interface.
NOTE: This article will update as more Yardi Tools become available for use.
Yardi Acquisition Manager
CREATE ACQUISITION: Creates an Acquisition Deal by requiring an address and deal name, includes optional dynamic fields based on source table and column from sales comp mapping.
CREATE DEALS: Create Deal with dealname ,address,price and area .
GET CONTACT XREFS: Get list of contacts.
GET DEAL ACQUISITION LIST: Get list of Acquisition Deals.
GET DEAL ACQUISITION LISTFILTERED: Get list of filtered Acquisition Deals.
GET DEAL SUMMARY: Get summary of deal (Acquisitions / Dispositions).
GET DISPOSITION DEAL LIST: Get list of Disposition Deals.
GET DISPOSITION DEAL LISTFILTERED: Get list of filtered Disposition Deals.
GET LENDERS: Get list of lenders.
GET SALES COMP MAPPING: Get Sales Comp Mapping for source tables attributes, INVCRMALTERNATIVESBUT_ACQMGR, and InvestorCRMInvestment to the mapped datapoints.
Yardi Aspire
Create Full Aspire Course: Generates a complete Aspire learning course on the requested topic. This tool creates all course pages, applies university theme and style settings, supports tone and language adjustments, and can optionally generate a test with configurable question count and passing score. When a parameter is omitted, the system falls back to the university-level AI Advanced Settings defaults.
Export JSON to CSV/XLSX: Export a JSON array to CSV or XLSX. Returns base64, filename, and mimeType.
Get All Properties: Use this tool to list all properties in Aspire. Returns only property name.
Get all active curriculum badges: Use this tool to list all active curriculum badges in Aspire. Returns only badge name.
Get earned badges by user: Use this tool to get users earned badges. Input: badge_name = badge name, user_email = user email , user_property = user property name. If omitted, returns all users.
Get not earned badges by user: Use this tool to get users not earned badges. Input: badge_name = badge name, user_email = user email , user_property = user property name. If omitted, returns all users.
Get Supervisor: Use this tool to get the supervisor/manager information for a specific user. A user email address (required).
Get Training Compliance by Property: Use this tool to get training compliance metrics by property. Input property name (optional). If omitted, returns all properties.
Get Training Compliance by User: Use this tool to get training compliance metrics by user. Input : A user email address (optional); Property Name(optional). If omitted, returns all users.
Get Users With Past Due Training: Use this tool to get users with past due courses. Input: user_email = user email , user_property = user property name. If omitted, returns all users.
Send an Email to a User: Use this tool to send an email to a user in Aspire. Input: to_email = recipient email, subject = email subject, body = MUST be Base64-encoded message.
Yardi Compliance Manager
ADD LEASE CHARGE: Add a lease charge to a tenant.
ADJUST MOVE IN DATE: Adjust the move-in date.
ASSIGN RENTAL ASSISTANCE: Assigns Rental Assistance to a household.
CHECK APPLICATION CORRECTIONS STATUS: Check Application Corrections Status.
CHECK COMPLIANCE REVIEW STATUS: Check Compliance Review Status.
CHECK EXECUTE LEASE STATUS: List All or Specific Applicant's lease status.
GET AFF RENT ROLL: Retrieves the affordable rent roll data for a property as of a given date.
GET AVAILABLE UNITS: Retrieves a list of available units for a specified property or property list.
GET CERTS DUE DATA: Get a list of upcoming due certifications.
GET COMPLIANCE QUICK CHECK: Performs a quick compliance check for a property based on household income and family size.
GET DELINQUENCY DATA: Get a list of tenant delinquency data.
GET ELIGIBLE HOUSEHOLDSFOR RENTAL ASSISTANCE: Get a list of eligible households for rental assistance assignment.
GET ERRORS AND WARNINGS CHECK: Errors and Warning Status Check.
GET HOUSEHOLD SUMMARY: Household Compliance Summary.
GET INCOME INFO: Get Income info about a tenant.
GET MISSING RENT ADJUSTMENTS: Rent Adjustment.
GET NAURUNITS: Returns a list of over-income (NAUR) units for the specified property.
GET NON COMPLIANT LIHTCPROPERTIES: Returns a list of non-compliant LIHTC (Low-Income Housing Tax Credit) properties and their buildings.
GET PROPERTY LIST: Get a list of properties.
GET QUICK POST PREVIEW: Summarize Quick Post Preview.
GET UN SENT TRACSFILES: Gets Unsent TRACS Files for a property.
GET WAITLIST VIRTUOSO: Get Wait list data about a prospect in RentCafe Affordable.
LOCK CERTIFICATION: Lock a certification.
POST AFFORDABLE MOVE IN: Post affordable move in.
SUBMIT: Submits and receives TRACS Information to/from HUD.
SUMMARIZE LEASE CHARGE: Summarize Lease Charges.
Yardi CRM IQ
DELETE UNIT AMENITY: Deletes unit amenities based on natural language input or specific parameters. Supports commands like "Delete pool amenity from unit 101 at Seaside property" or "Remove laundry from all units at property ABC".
FOLLOW UP VIRTUOSO: Gets follow-up data filtered by property and optionally by agent and date. Designed for daily task list functionality. Includes follow-up type and channel information from prospect_history table.
GET ACTIVITY REGISTER CRMANALYTICS: Function is used for when user asks to RUN or GENERATE an Activity Register Report, which shows list of all activities (emails, calls, walk-ins. etc.) done by property for a given period.
GET ALERT TASK: Gets alert task data for a given property and date range.
GET APPOINTMENT TASK: Gets appointment task data for a given property and date range.
GET CONVERSATIONS TASK: Gets conversations task data for a given property and date range.
GET CONVERSION RATIO BOX SCORE SUMMARY DATA: Get all lead traffic - calls, emails, chats, texts, first contacts, shows, applications, and approvals - for a property or list of properties for a given date range, as well as the conversion ratio of that inbound traffic to prospects or tenants.
GET CRMANALYTICS LIMITED DATA: Generic function to get any CRM Analytics report with only specified columns returned.
GET EXCEPTIONS TASK: Gets exceptions task data for a given property and date range.
GET FOLLOW UP TASK: Gets follow up task data for a given property and date range.
GET GROSS POTENTIAL RENT CRMANALYTICS: Function is used for when user asks to RUN or GENERATE a gross potential rent report, which provides information about gross potential rent for a given property or list of properties as of a specified date.
GET GROSS POTENTIAL RENT CRMANALYTICS JSON: Function is used for when user asks to RUN or GENERATE a gross potential rent report, which provides information about gross potential rent for a given property or list of properties as of a specified date. Returns data in JSON format.
GET LEASE EXPIRATION CRMANALYTICS: Function is used for when user asks to RUN or GENERATE a lease expiration report, which provides information about lease expirations for a given property or list of properties as of a specified date.
GET NEW APPOINTMENT TASK: Gets new appointment task data for a given property and date range.
GET NEW CONVERSATIONS TASK: Gets new conversations task data for a given property and date range.
GET NEW FOLLOW UP TASK: Gets new follow up task data for a given property and date range.
GET NEW UNASSIGNED TASK: Gets new unassigned task data for a given property and date range.
GET PERFORMANCE: Get the performance for a given property.
GET PERFORMANCE METRIC SETTINGS: Get the performance metric settings for a given property.
GET PROSPECT UNITS VIRTUOSO: Retrieves available units for a given prospect, with optional filters such as property, unit status, amenities, floor plan, unit type, bedroom count, and price range.
GET RENT ROLL CRMANALYTICS: Function is used for when user asks to RUN or GENERATE a rent roll report, which summarizes market and resident rent amounts, deposits, resident balances, and occupancy of a given property or list of properties as of a specified date.
GET RESIDENT ACTIVITY BOX SCORE SUMMARY DATA: Summary of resident activity such as move-ins, move-outs, and evictions on a given property or list of properties for a given date range.
GET UNASSIGNED TASK: Gets unassigned task data for a given property and date range.
GET UNIT AMENITIES: Retrieves amenities for a specific unit based on natural language input or specific parameters. Supports commands like "Show amenities for unit 3118 at property resca01" or "What amenities does unit 101 have?"
GET UNIT AVAILABILITY BOX SCORE SUMMARY DATA: Get the average square feet, average rent, and rental status of all units, and overall occupied percentages of those units, for a property or list of properties for a given date range.
GET UNIT AVAILABILITY CRMANALYTICS: Function is used for when user asks to RUN or GENERATE a Unit Availability Report, which shows list of units statewise also shows unit rent, availability/ make ready date for a given property or list of properties as of a specified date.
GET UNIT AVAILABILITY CRMANALYTICS LIMITED DATA: Function returns limited data from Unit Availability Report. By default includes: Unit Code, Make Ready, Available Date, Bedrooms, Hold, Hold Until, Status. The columns can be customized by setting the RequiredColumns property in the filter.
GET UNIT HISTORY: Retrieves comprehensive historical data for a specific unit including current status, occupancy history, and detailed information. Supports sparse fieldsets via the fields parameter for optimized responses.
GET UNIT OCCUPANCY: Retrieves occupancy history and current tenant information for a specific unit.
GET UNITS DATA: Retrieves comprehensive unit data including status, availability, tenant information, and property details for a given property. Supports sparse fieldsets via the fields parameter for optimized responses.
PREVIEW DELETE UNIT AMENITY: Gets a preview of what would be deleted without actually performing the deletion.
PROPSECT SHOWING VIRTUOSO: Gets prospect showing data filtered by property and optionally by agent and date. Designed for daily task list functionality. Includes tour type data from prospect_history table.
PROPSECTONWAITLIST VIRTUOSO: Gets the list of prospects on the waitlist for the specified properties.
SCOUT: Scout - Answers natural-language questions about residents, vehicles, pets, units, balances, applications, maintenance, tours, renewals and occupancy. Uses AI-first approach: understand intent, route to known patterns or build dynamic queries.
SEND RENT ROLL REPORT EMAIL: Email rent roll report.
VIRTUOSO DISPATCH: Unified endpoint that intelligently dispatches agent requests based on natural language.
Yardi Facility Manager
ATTACH EQUIPMENT: Creates a link between a work order and a piece of equipment. Returns the updated list of linked equipment for the work order.
SEARCH ASSET: Gets detailed information for a specific asset.
SEARCH COMM INSPECTIONS: Gets a list of Inspections based on filter parameters. Defaults to Inspections within the past month. Returns inspection information including schedules, equipment, results, and completion status.
SEARCH COMPONENT AND EQUIPMENT TEMPLATES: Gets both component and equipment templates. Returns templates filtered by properties and PM template categories.
SEARCH EQUIPMENT: Gets a list of equipment based on filter parameters. Returns equipment information including assets, types, locations, and service details. Equipment items may have associated asset records for financial tracking.
SEARCH EQUIPMENT BY WORK ORDER: Returns equipment linked to a work order.
SEARCH EQUIPMENT HISTORY: Retrieves audit history for an equipment item.
SEARCH EQUIPMENT TEMPLATES: Gets equipment list templates filtered by PM template categories. Templates are used to standardize equipment configurations across properties.
SEARCH PMS: Gets a list of PMs based on filter parameters. Defaults to PMs within the past month. Returns preventive maintenance information including schedules, equipment, assignments, and completion status.
SEARCH WARRANTY INFORMATION: Retrieves warranty records filtered by optional parameters.
SEARCH WORK ORDERS: Searches for work orders based on filter parameters. Can search by specific workOrderId or use various filter combinations. Defaults to Work Orders within the past month if no parameters provided.
SEARCH WORK ORDERS BY EQUIPMENT: Returns work orders linked to an equipment.
UNATTACH EQUIPMENT: Removes a link between a work order and equipment. Returns the updated list of linked equipment for the work order.
Yardi Framework
GET AGENT ACTIVITY REPORT: Get Agent Activity Report - Tracks all agent-related activities.
GET AGENT AUDIT REPORT: Get Agent Audit Report - Displays changes to agent records for administrative audits.
GET AGENT DETAIL REPORT: Get Agent Detail Report - Lists all agents with full run summary.
GET AGENT SCHEDULE REPORT: Get Agent Schedule Report - Shows scheduled timings for all agents.
GET AUTO COMPLETE DATA: Get autocomplete data based on the specified autocomplete type.
GET AUTO COMPLETE TYPES: Get available autocomplete types that have distinct implementations registered.
GET CONTACT CONNECTIONS: Returns the contact connections to other objects and their iType values. ///
GET UNIT AVAILABILITY CRMANALYTICS: Function is used for when user asks to RUN or GENERATE a Unit Availability Report, which shows list of units statewise also shows unit rent, availability/ make ready date for a given property or list of properties as of a specified date.
LOG AIAGENT ACTIVITY: Logs an AI Agent activity to the Activity Feed using the AngularCafe framework.
SEARCH CONTACTS: Returns the contacts' code, name and email that match the search criteria.
SEND EMAIL: Sends an email using JSON.
Yardi GL Manager
AGING: Provides accounts payable aging data for month-end close assessment including unpaid payables in 30-day buckets and overdue invoice analysis.
ANALYZE DBPERFORMANCE: Database Performance Analyzer with optional report selection. Run individual or combined diagnostics: (1) Lead Blocker Detection - Identifies active blocking sessions causing database contention and performance degradation. (2) Table Size Analysis - Returns top 5 largest tables by storage consumption, identifying tables that may require purge operations to reclaim space and improve performance. (3) Compatibility Level Check - Displays SQL Server compatibility level and cardinality estimator settings to verify optimal configuration after upgrades.
ARTIE OUT BY GL: Provides AR Tying report to compare AR aging balances with Trial balance AR Account for reconciliation purposes.
ASSESS STEP: Validates an individual month-end close step for a property.
BANK BALANCE EXCEPTION REPORT: Provides bank balance exception data for month-end close assessment including reconciliation discrepancies and troubleshooting information.
BANK DIRECTORY: Provides bank account setup information and configuration details for month-end close validation.
BANK DIRECTORY REPORT: Provides bank directory data for month-end close assessment including bank account setup information and configuration details.
BANK PROPERTY FUNDS: Provides bank property funds information and cash management details for month-end assessment.
BANK REC HISTORY REPORT: Provides bank reconciliation status for month-end close assessment including posted reconciliations and historical data.
BANK REC IN PROGRESS REPORT: Provides bank reconciliation status for month-end close assessment including outstanding items and reconciliation differences.
BANK REGISTER REPORT: Provides bank register data for month-end close assessment including all checks, deposits, and bank transactions.
BATCH LOOKUP: Virtuoso API: Batch lookup for multiple books and accounts. Converts multiple book names and account codes to their IDs in a single request.
CHECK POSITIVE PAY TABLE: Check if BANKBUT_POSPAY table exists and is properly configured.
DEBUG HEADERS: Debug endpoint to show all available headers and context information. Use this to troubleshoot why the Uid header is not being detected.
EXPENSEDISTRIBUTION: Provides accounts payable expense distribution data for month-end close assessment including expense account totals and analysis.
EXPORT ACCOUNT TREE: Export Account Tree to CSV, XML, or XLSX format. Supports both TreeId and TreeCode - TreeCode takes precedence if both are provided.
FINANCIAL REPORT BALANCE SHEET: Generates a balance sheet showing assets, liabilities, and equity account balances as of a specified date. Returns paginated JSON output with automatic size reduction. Required: PropertyId[], BookId[], MonthFrom, MonthTo. Optional: ShowZero, PageNumber, PageSize, FieldsToReturn.
FINANCIAL REPORT BUDGET COMPARISON: Generates a budget comparison report comparing actual vs budgeted amounts with variance analysis (both dollar and percentage) for PTD and YTD periods. Returns paginated JSON output with automatic size reduction. Required: PropertyId[], BookId[], MonthFrom, MonthTo. Optional: ActualOrBudget, ShowZero, BudgetSource, PageNumber, PageSize, FieldsToReturn.
FINANCIAL REPORT CASH FLOW: Generates a cash flow statement showing cash-basis revenue and expenses with amounts and percentages for both period-to-date (PTD) and year-to-date (YTD). Returns paginated JSON output with automatic size reduction. Required: PropertyId[], BookId[], MonthFrom, MonthTo. Optional: ShowZero, PageNumber, PageSize, FieldsToReturn.
FINANCIAL REPORT TRIAL BALANCE: Generates a trial balance report showing forward balance, debits, credits, and ending balance for all accounts over a specified period. Returns paginated JSON output with automatic size reduction. Required: PropertyId[], BookId[], MonthFrom, MonthTo. Optional: ShowZero, PageNumber, PageSize, FieldsToReturn.
GENERATE POACCRUAL: Generate Purchase Order Accrual Report Preview for month-end close assessment including accrual calculations and journal entry preview.
GET ACCOUNT ID: Virtuoso API: Get account ID by account code. Converts an account code to its corresponding account ID.
GET ACCOUNT TREES: Get Account Trees - Supports both list and detail queries.
GET ALL CURRENCIES: Virtuoso API: Get all available currencies from the system. Returns distinct currencies from Intcurrency_info table.
GET ALL EXCHANGE RATE PROVIDERS: Virtuoso API: Get all available exchange rate providers from the system. Returns distinct exchange rate providers from CurExchIdx table.
GET ALL PERMISSIONS: Virtuoso API: Get all permissions from menuotheritems table. Returns all permission tokens with optional description filtering.
GET ALL RATE TYPES: Virtuoso API: Get all available exchange rate types from the system. Returns distinct exchange rate types from CurExchRateTypeNames table.
GET APANALYTICSHTMLS DATA: Provides accounts payable analytics including aging reports, expense distribution, payment history, and vendor analysis for month-end close assessment.
GET ARANALYTICS VIRTUOSO: Provides accounts receivable analytics for month-end close assessment including tenant aging reports and revenue analysis.
GET ARANALYTICSHTMLS DATA: Get rentprojectionreport.
GET AUTO COMPLETE: Provides GL-specific autocomplete data by type name for month-end close processing.
GET AUTO COMPLETE DATA SEG NAME: Provides segment name autocomplete data for GL segment configuration in month-end close processing.
GET AUTO COMPLETE TYPES: Provides a list of all available autocomplete types for month-end close filter configuration.
GET BANK BOOK SETUP ACCESS: Get Bank Book Setup Access By Bank Id.
GET BANK REC EXCEPTION DATA: Provides bank reconciliation exceptions and discrepancies that need resolution before month-end close.
GET BANK RECONCILIATION DATA: Provides bank reconciliation status including outstanding items, cleared items, and reconciliation differences for month-end close validation.
GET BANK REGISTER DATA: Provides bank register information including all checks, deposits, and bank transactions for month-end reconciliation.
GET BOOK ID: Virtuoso API: Get book ID by book name. Converts a book name to its corresponding book ID.
GET CASH FLOW STATEMENT: Generates a dedicated cash flow statement report.
GET CURRENCY ID: Virtuoso API: Get currency ID by currency code.
GET CURRENT USER: Virtuoso API: Get current user information from server-side headers. Extracts the Uid header and other user-related information from the HTTP request.
GET EXCHANGE RATE PROVIDER ID: Virtuoso API: Get exchange rate provider ID by provider code.
GET EXCHANGE RATE SETUP CURRENCIES: Virtuoso API: Get distinct currency code combinations from exchange rate setup. Returns unique combinations of from and to currencies that have exchange rates configured.
GET FILTER DATA: Provides GPR report filter configuration and parameter data for month-end analysis.
GET FINANCIALHTMLS DATA: Provides comprehensive financial reports including trial balance, income statement, balance sheet, and other key financial statements for month-end assessment.
GET GLACCOUNT DETAILS: Retrieves GL account details with comprehensive filtering options for Virtuoso AI agent integration. Returns account information including codes, descriptions, types, and account flags.
GET GPRREPORT VIRTUOSO: Provides gross potential rent market analysis for month-end close assessment including revenue projections and vacancy analysis.
GET JOURNAL BATCHES VIRTUOSO: Retrieves journal batches (iType = 13 for Journal Entry) based on request body parameters. Uses custom SQL generation to ensure ONLY Journal Entry batches (iType = 13) are returned. Includes batch-wise JE count and detail count for each batch. Supports filtering by specific batch IDs, date ranges, properties, status, and text search.
GET NOTES: Get existing notes for the specified filter parameters. Mandatory inputs: PropertyId (array, at least one), BookId (array, at least one), ReportType (string), MonthFrom (DateTime), MonthTo (DateTime). Optional inputs: TreeId, AcctCode, SegmentList, IsCustomNote, CFTemplateId.
GET OPEN BATCH SUMMARY: Retrieves summary of open/unposted batches with only essential columns for quick data analysis.
GET OPEN BATCHES: Retrieves all open/unposted batches for month-end close validation and batch management.
GET OPEN BATCHES COUNT: Retrieves count of open/unposted batches by type for dashboard and summary reporting.
GET PERMISSION CATEGORIES: Virtuoso API: Get all unique permission categories/prefixes. Analyzes sObjName patterns to return common permission categories.
GET PERMISSIONS BY GROUP: Virtuoso API: Search available permissions by keyword and group. Searches iSecurity2 table for permissions matching the provided keyword for a specific group. Supports both GroupId and GroupCode - GroupCode takes precedence if both are provided.
GET POSITIVE PAY DATA: Get positive pay data from BANKBUT_POSPAY table joined with bank table. Dynamically queries the table based on the schema defined in asusrddf. Joins with bank table on Hcode to return bank scode as BankCode. Note: Hcode (bank hMy ID) and BankCode (bank scode) are always included in results.
GET POSITIVE PAY SCHEMA: Get the table schema/column definitions for BANKBUT_POSPAY table. Returns column information from asusrddf table.
GET POST GPRHTMLS DATA: Provides gross potential rent market analysis including revenue projections, vacancy analysis, and market rent comparisons for month-end assessment.
GET PROPERTIES FROM LIST VIRTUOSO: Retrieves all property IDs (hmy values) from a specified property list as a comma-separated string.
GET RATE TYPE ID: Virtuoso API: Get exchange rate type ID by rate type code.
GET REPORT TYPES: Get available report types for financial notes.
GET STEPS: Lists all month-end close steps and their descriptions.
GET TRANSACTION REGISTER SUMMARY: Provides summarized transaction register data grouped by transaction type, property, or date range.
GET TWELVE MONTH BUDGET REPORT: Generates a twelve-month budget report for the specified properties, accounts, and filters.
GET USER DETAILS: Virtuoso API: Get user details by username or get all users in a group. Supports flexible filtering: single user lookup, group-based listing, property filtering.
GETBANKREPORTS EXPORT: Get bankreports.
GETFINANCIALREPORTDETAIL: Provides detailed drill-down information for financial reports including account details, transaction history, and supporting documentation for month-end validation.
IMPORT JOURNAL VIRTUOSO: Imports journal entries from a JSON payload in the Virtuoso format.
INSERT EXCHANGE RATE VIRTUOSO: Virtuoso API: Insert exchange rate data into IntExchangeRate table. Converts provider, rate type, and currency codes to IDs before insertion.
LOAD DEFAULTS: Load Default Bank Account.
PAYEELEDGER: Provides accounts payable payee ledger data for month-end close assessment including vendor transaction history and outstanding balances.
PAYEETOTAL: Provides accounts payable payee total data for month-end close assessment including vendor summary totals and payment summaries.
PAYMENTREGISTER: Provides accounts payable payment register data for month-end close assessment including check payments, vendor payments, and payment history.
POST JOURNAL BATCH VIRTUOSO: Posts a journal batch to the General Ledger.
POST NOTE: Post a new note with the specified parameters.
POST POACCRUAL: Post Purchase Order Accrual Journal for month-end close operations including journal entry creation and posting.
REBUILD GLVIRTUOSO: Rebuilds the General Ledger for specified properties starting from a given month.
RESET DATAMART VIRTUOSO: Resets the GPR history and tenant aging datamart for specified properties to trigger recalculation.
SEARCH TRANSACTION REGISTERS: Searches and retrieves transaction register data across multiple transaction types with comprehensive filtering options and field selection support.
UPDATE USER: Virtuoso API: Update user information including inactivation capability. Updates user details in pmuser table with proper validation and permission checks.
VALIDATE POACCRUAL: Validates PO Accrual parameters and checks for existing journal entries or warnings before posting.
VENDORDIRECTORY: Provides accounts payable vendor directory data for month-end close assessment including vendor information, contact details, and payment terms.
Yardi Investment Manager
BULK PUBLISH DOCUMENTS: Bulk publishes documents by updating their status and optionally sending notification emails and portal notifications to registered users.
GET CONTACT ACTIVITIES: Retrieves last 20 activities for a specific contact with text extracted from the HTML in emails, also includes activities on notes, calls, meetings, etc.
GET INVESTMENT PREFERENCES: Returns investor investment preferences using optional search filters.
GET PROPOSALSDATA: Returns list of proposals with optional filters for investor (ClientID) and opportunity (InvestmentID) when Maxinvestorsubscription is true (enforces a maximum total commitment amount per investor across all their proposals for that opportunity).
SEARCH INVESTORS: Search for investors using the hMy, code, or name, and returns all three.
Yardi Maintenance IQ
CANCEL ALL FOR TENANT: Cancels all work orders for a specific tenant.
CANCEL UNNECESSARY WORK ORDERS: Cancels unnecessary work orders after a passing inspection.
CANCEL WO: Cancels a work order for a specific tenant.
CHECK MOVE OUT NOTICE: Checks tenant move-out notice and date for a specific unit.
CHECK PROPERTY MOVE OUT NOTICES: Checks tenant move-out notices across an entire property.
CREATE DEFAULT WORK ORDERS: Creates default set of 7 proactive work orders for unit turns.
CREATE WO: Creates a new work order.
GET ASSETS: Virtuoso-enabled asset search (dynamic/slim payload). Returns only field groups related to filters provided in the request.
GET PRIORITY: Retrieves the list of currently available work order priorities.
GET STATUS LIST VIRTUOSO: Retrieves the list of currently available work order statuses.
GET UNIT TURN CONFIG: Gets unit turn configuration settings for a property.
GET UNIT TURN STATUS: Retrieves overall unit-turn status including work orders and inspection results.
GET WARRANTY INFORMATION: Retrieves warranty records filtered by optional parameters.
HANDLE INSPECTION CALLBACK: Handles asynchronous inspection result callback.
LIST INSPECTION TEMPLATES: Lists available inspection templates, optionally filtered by property or type.
SCHEDULE MOVE OUT INSPECTION: Schedules a move-out inspection on the vacate date.
SEARCH WORK ORDERS: Searches for work orders using a variety of filter parameters.
SEARCH WORK ORDERS DYNAMIC: Searches for work orders like searchwos but returns a slim, dynamic payload. Only includes field groups that correspond to filters provided in the request.
UPDATE UNIT TURN CONFIG: Updates unit turn configuration settings for a property.
UPDATE WORK ORDER PRIORITY: Updates the priority of a work order.
UPDATE WORK ORDER STATUS: Updates the status of a work order.
Yardi Procure to Pay
ACTIONABLE IRS: Get list of invoices requiring action.
ACTIONABLE POS: Get list of purchase orders requiring action.
APPROVE IR: Approves an invoice register and advances it through the workflow.
BULK APPROVE IRS: Bulk approve invoice registers based on criteria and filters.
CLOSE PARTIALLY PAID POS: Close partially paid purchase orders based on threshold and filters.
CLOSE PO: Close one or more purchase orders by their IDs.
FIND CHECKS: Finds checks with filtering capabilities optimized for Virtuoso.
GET CHECKS: Retrieves a list of BillPay checks based on various filter criteria.
GET CLOSABLE POS: Get list of purchase orders eligible for closing with filtering options.
GET IR: Gets a specific invoice register by its ID.
GET IRBUDGET: Get budget information for a specific invoice register by its ID.
GET PO: Gets a specific purchase order by its ID.
GET SERVICE CONTRACT INVOICES: Gets comprehensive list of invoice registers related to service contracts.
GET SERVICE CONTRACT PAYABLES: Gets comprehensive list of payables related to service contracts.
GET SERVICE CONTRACT POS: Gets comprehensive list of purchase orders related to service contracts with detailed information.
GET SERVICE CONTRACTS: Gets comprehensive service contract data including details, related POs, invoices, and payables.
GET VENDOR BY ID: Gets a specific vendor by its ID.
GET VENDORS: Gets a list of vendors with filtering capabilities.
REJECT IR: Rejects an invoice register with optional step notes.
SEARCH IR: Get list of invoices based on criteria.
SEARCH PO: Get list of purchase orders based on criteria.
SEARCH SERVICE CONTRACT IDS: Returns just service contract IDs matching criteria - optimized for AI context window.
SEARCH SERVICE CONTRACTS: Search for service contracts with comprehensive filtering, pagination, and sorting.
UPDATE VENDOR: Updates vendor information including fields in both vendor and person tables.
VALIDATE IR: Validates an invoice register.
Yardi DataConnect API
This tool allows you to access a Yardi Data Connect (YDC) SQL report and pull that into the logic for the agent.
Field Name | Field Description |
File Name | The file name of the report script. Pulls from available Yardi Data Connect reports. |
Parameters | Parameters in JSON formatting. For example:
|
Additional Metadata | Additional metadata to be added to the extracted documents. |
Omit Metadata Keys | Each document loader comes with a default set of metadata keys that are extracted from the document. You may use this field to omit some of the default metadata keys. The value should be a list of keys, separated by a comma (,). Use an asterisks (*) to omit all metadata keys except the ones you specify in the Additional Metadata field. |
IMPORTANT: The Parameters input is required at the tool level if the YDC script requires. A 400 error may return when not input when required.
Yardi Email Sender
The Yardi Email Sender tool allows you to have the agent send emails through Yardi email logic.
Select the Yardi Email Sender tool, then the Connect Credential.
Email formatting look improper?
The Yardi Email Sender tool supports HTML formatting, but your prompt must be explicit in requesting the HTML formatting.
For example, if you want a table to be returned in a tabular formatting, you'd explicitly provide the HTML table tags within the prompt.