How do I report my property occupancy to Apartments.com using Yardi?

Reporting Occupancy Using Yardi

Important: Verify that unit lease status is enabled in Yardi before reporting occupancy to Apartments.com.

Reporting Occupancy to Apartments.com using Yardi requires the following:

  1. ILS & Guest Card Configuration
  2. Creating a Property List
  3. Configuring Admin Permissions
  4. Configuring Your Apartments.com Admin User
  5. Applying Property Configurations in Bulk
  6. Adding a Waitlist Unit

ILS & Guest Card Configuration

  1. Navigate to the Yardi Voyager portal and log in to your account.

  1. Select Interfaces, Configuration, and then Review Interface Vendors in the left navigation dashboard.

the Interface Configuration page appears.

  1. Select the Entity Type dropdown and select ILS/Guest Card. Select Submit to continue.

The ILS & Guest Card Configuration page appears.

  1. Search for and select Apartments.com in the Interface Configuration pop-up.


The Apartments.com ILS & Guest Card Configuration page appears.

  1. Verify that the Name, Code, and Type fields match the content in the screenshot below. Under the Export Resident / Guest Activity Options, verify that 90 days and Schema v4.0 are selected and that the Use Floor plan data checkbox is unchecked.

  1. Configure the Export Resident/Guest Activity options to match your preferences.
  2. Verify that the Export all guest cards, ignore interface association checkbox is checked.
  3. Verify that your Tenant and Prospect Import/Export options are complete.
  4. Select Save to finalize ILS & Guest Card Configuration.

Creating a Property List

  1. Select Setup, Property, and then Review Property List in the left navigation dashboard.

The Property List Page appears.

  1. Select Submit to continue.

The Property/Entity List page appears.

  1. Search for an existing property list where you want to report occupancy to Apartments.com and select it.

  1. Enter .apts in the Property List field and Apartments.com Property List in the Description field.

  1. Select Save As to create an Apartments.com copy of the original property list.

Configuring Admin Permissions

  1. Select Roles and then Administration in the left navigation dashboard.

The System Administration page appears.

  1. Select Add Users under the Security options.

The Employee / User Setup page appears.

  1. Enter Apartments.com user information in the User Setup fields.
    1. Enter apts.com in the Code field.
    2. Enter .com in the Lastname field.
    3. Enter Apartments in the Firstname field.

  1. Enter interfac and select interfac (Interface User) in the Group field under the Security tab.

  1. Enter .apt and select .apts (Apartments.com Property List, , ,) in the Property field.

  1. Enter a username and password for your Apartments.com account. Configure the settings so that your password does not expire.

  1. Select Save to save your progress.

  1. Select the Privileges tab and check the Interface User and Receive Stack/SQL Trace Messages boxes.

  1. Select Save to save your progress.
  2. Select the Program Rights tab and check the Property Mgmt. box.

  1. Select Save to save your progress.
  2. Select the Regional Settings tab and select us under the Country dropdown.

  1. Select Save. Your Apartments.com admin user is created.

Configuring Your Apartments.com Admin User

Important: After creating your admin user, make sure you grant it Read/Write access to Interfaces: Web Service - ILS/Guest Card. Refer to the steps below for more information:

  1. Navigate to the main dashboard, locate and select Set Permissions, and then select interface as your group.

The Set Permissions page appears.

  1. Verify Interfaces: Web Service - ILS/Guest Card is entered in the Description field.
  2. Set the Access Type to Read/Write.
  3. Select Least Restrictive from the Set all Permissions dropdown.
  4. Select Set All and Save.

Your Apartments.com admin user is granted Read/Write access to Interfaces: Web Service - ILS/Guest Card.

Applying Property Configurations in Bulk

  1. Select Interfaces, Configuration, and then Bulk Property Interface Configuration in the left navigation dashboard.

The Interface Configuration page appears.

  1. Enter .apts into the Property field and select .apts (Apartments.com Property List, , ,). 

  1. Select the Interface Type dropdown and select ILS/Guest Card.

  1. Verify the Configure/Remove dropdown is set to Configure and Apartments.com selected in the Available Agencies list.

  1. Select Save to apply all property configurations and start reporting occupancy to Apartments.com.

Adding a Waitlist Unit

Note: Adding a waitlist unit is optional. Following these steps are not required to report property occupancy to Apartments.com using Yardi.

  1. Navigate to your Basic iData Role. Select Setup, Unit, and then Add Unit in the left navigation dashboard.

The Add Unit screen appears.

  1. Enter your property code in the Property field, set the Rental Types as Residential, and then select Submit.

The Unit screen appears.

  1. Enter all relevant unit information including the unit type and then select Save.

Important: The unit code should include the text WAIT before the code itself.

Your waitlist unit is created.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.