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:
   1. The vendor package for ApartmentIQ to be loaded to your database
   2. A REST API token for ApartmentIQ (handled by the Interfaces SIPP Support team) — Yardi will generate the token and send it directly to ApartmentIQ.

Note: If you have access to Voyager 8, you can generate the REST API token yourself instead:

1. Log in with an admin role and navigate to Interfaces > Configurations > Vendor API Tokens.
2. Click Add Vendor and enter Vendor Name: ApartmentIQ and Email: integrationsupport@apartmentiq.io.
3. Click Send Email and Generate Token. The token will be emailed directly to the ApartmentIQ team.

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
   2. Provide REST API Token to ApartmentIQ Daylight Team

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
          

6. 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

Property Interface Configuration

⚠️ IMPORTANT: Do not enable Revenue Management for your property before your scheduled pricing go-live date.

Enabling the Revenue Management configuration for a property before the scheduled two-way pricing date will cause units to display "Call for Pricing" on the website instead of showing actual rent amounts.

Only update the Property Interface Configuration section (selecting ApartmentIQ as Revenue Management Agency) on the day before your scheduled pricing go-live date.  

If you accidentally enable Revenue Management before the scheduled date, contact integrationsupport@apartmentiq.io immediately.

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.
    

4. 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.

5. 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 integrationsupport@apartmentiq.io.