Yardi API Configuration - Revenue Management Live Database

This guide documents the process and required configuration steps for enabling ApartmentIQ data exports from Yardi.

Written By Jaime Dorn (Super Administrator)

Updated at February 20th, 2026

Before You Start

  1. Check your Yardi Voyager plug-ins to ensure they meet the integration requirements: 
    1. Interfaces PIv28.03
    2. Common Data PIv23
    3. Revenue Management PIv19
  2. Contact your Yardi representative and request the vendor package for ApartmentIQ to be loaded to your database.

 

Steps to get started - Environment Details

  1. Live Configuration
    1. Provide server credentials to ApartmentIQ Daylight Team
      • Interface Username 
      • Password: (sent separately)
      • Server/Database Name
      • Voyager URL

 

Vendor Configuration Details 

Vendor Configuration (Revenue Management)

  1. Navigate to Interface Configuration → Revenue Management Agency for each Property.
  2. Select Revenue Management from the Entity Type drop-down list.
  3. Click Submit. A list of available vendors appears in the side menu.
  4. Select ApartmentIQ. The Revenue Management Configuration page for the selected vendor displays.
  5. Update Revenue Management Export Options to match below:
    1. Revenue Management Vendor Type 4
      1. ☑  Export All Guest Cards
      2. ☑  Export Charges By Month
      3. ☑  Export Guest Info For Model and Admin Units
      4. ☑  Export Guest Info For Down Units
      5. ☑  Export Lease IDs
      6. ☑  Do Not Export Tenant Names
      7. ☑  Only Deactivate Imported Pricing Type
         

 

  1. While on the Revenue Management Configuration screen, click the RM Charge Code Export Setup button. The Charge Code Export Configuration screen displays.
    1. Make sure ALL charge codes associated with each of the below are added:
      1. Rent 
      2. Concessions
      3. Month to Month charges
         

 

Common Data Configuration

  1. Navigate to Interfaces > Configuration > Review Interface Vendors for each Property.
  2. Under Entity Type (drop-down), choose Common Data
  3. Select ApartmentIQ
  4. Please ensure that the settings for the items below are set to Read. The rest can be set to None.
    1. Lease Charges: Read
    2. Lease Offers: Read
    3. Scheduled Lease Renewals: Read
    4. User Defined: Read

Example of screen (your selections will vary from screenshot):

 

Property Interface Configuration

To configure a single property for Revenue Management

  1. From the Functions menu, select Interface Configuration. The Revenue Management Configuration screen and list of available interfaces is displayed.
  2. Select Revenue Management from the interface list. The Revenue Management Configuration screen is displayed.
  3. Select Agency → ApartmentIQ.
     

 

  1. Update Revenue Management Options:
  • ☑  Use for Renewal Pricing (optional)
  • ☑  Allow Market Rent Update - (optional)
    • This is optional - please only select if you want to use Market Rent Update.
  • ☑  Do Not Export Tenant Names
  • Leave all other options unchecked unless otherwise directed.

 

  1. Update Rent Options (Optional)
    1. Updating Market Rent in Yardi is optional and should be enabled only if the customer wants ApartmentIQ to write market rent values back to Yardi.

If enabled:

  • Select Update Unit Market Rent and/or Update Unit Type Market Rent
  • Set Market Rent Update to Effective Rent
  • Select 12 month Rent or Enable Use Best Rate Term for Market Rent Update (recommended)
     

If disabled:

 ApartmentIQ will provide pricing recommendations without updating market rent in Yardi.

 

Yardi Voyager Integration Support

Yardi Integration Support: 

For technical assistance from Yardi Voyager, please log into Client Central and submit a case. You can also reach Yardi Voyager by phone at 1-800-866-1144

 

ApartmentIQ Integration Support: 

For technical assistance from ApartmentIQ, please reach out to jennifer@apartmentiq.io.