1. HappyCo
  2. PMS Integrations
  3. Setup & Configuration
  4. Yardi
Xochilt
Updated

Setting up your Yardi Integration

Xochilt
Updated

Overview

This article walks through the required steps to connect HappyCo to Yardi. For an overview of what the integration does and what data syncs between the two systems, see the Yardi Integration Overview →

Prerequisites

  • A Yardi administrator with access to Interfaces and Admin settings
  • A HappyCo account with Administrator access

How to Set it Up

These steps must be completed by your internal Yardi Administrator directly in Yardi Voyager.

 

Step 1: Install the HappyCo Service Request Package

Verify that the HappyCo Service Request (happyco9) vendor package is available in your Yardi environment. If you have a self-hosted environment, you'll need to install the .pkg file directly.

If you can't locate the package, contact your Yardi Representative or the Yardi Interfaces team to request access.

Note: If you see a package labeled HappyCo2, this has been deprecated and should not be used.

 

Step 2: Configure the Security Group

In the security group that your HappyCo vendor interface user belongs to, grant the following access:

  • Read/Write access to all permissions associated with Interfaces: Web Service - Common Data
  • Read/Write access to all permissions associated with Interfaces: Web Service - Resident Data
  • Read/Write access to all permissions associated with Interfaces: Web Service - Service Request
  • Read/Write access to all permissions associated with Interfaces: Web Service - ILS & Guest Card
  • Read/Write access to all permissions associated with Interfaces: Web Service - Billing & Payments
  • Read access to the Property-Interface_Configuration permission

 

Step 3: Configure the Common Data Interface

Navigate to Interfaces, select Common Data as the type, and search for happyco9 - HappyCo Service Request. Adjust the following settings on that screen:

General

  • Ignore Exclude Units Flag: Off
    • This prevents units such as Model, Admin, or Wait from being synced into HappyCo
  • Export Deposit Information: On
    • This allows us to collect lease data to help determine which residents are current
  • Export Unit Attributes: On
    • Needed for a new feature coming out to pull in unit level attributes into HappyCo

Resident data permissions

You will see a table of resident-related permissions. Several of these are needed to sync your resident data into HappyCo.

  • Name: Read
  • Address: Read
  • Phone Numbers: Read
  • Vehicle: Read
  • Ledger: Read
  • Lease Charges: Read
  • Lease Offers: Read
  • Scheduled Lease Renewals: Read
  • Rentable Items: Read
  • User Defined: Read/Write
  • Pets: Read
  • Email: Read
  • Employer: Read

Import/Export Attachment Types

Choose which attachment types you'd like your completed inspection PDFs sent back to Yardi as. You need to select at least one type, and you can select up to three (one each for On Notice, Move Out, and Move In inspections).

  • Click a type to select it. Selected types turn grey.
  • We recommend selecting all possible types. This helps avoid errors later if you change which attachment type you use, or if an attachment type is deleted.

Write down the names of the types you select. You'll need them again in Step 6. 

 

Step 4: Configure the Service Request Interface

Similar to step 3, navigate to Interfaces and this time select Service Request as the type. Search for happyco9 - HappyCo Service Request. Adjust the following settings on that screen:

Export Options

  • Export excluded units: Off
    • This prevents units such as Model, Admin, or Wait from being synced into HappyCo
  • Export employee email address: On
    • This will be used for a new feature coming out to sync work order assignees with your PMS
  • Export employee phone numbers: On
    • This will be used for a new feature coming out to sync work order assignees with your PMS
  • Include employee detail Id: On
    • This will be used for a new feature coming out to sync work order assignees with your PMS
  • Honor Common Data Permission settings: On

File Extension Export Permissions

  • Set all extensions to Read access. 
    • This allows HappyCo to view all photo and attachment types when syncing work orders.

 

Step 5: Bulk Property Configuration

Bulk configure all properties for HappyCo Service Request

  • In Yardi's sidebar, go to Interfaces (switch to Basic iData if Interfaces isn't visible) > Configuration > Bulk Property Configuration. 
    • Enter your property list, select the Service Requests interface, and select the HappyCo Service Request agency. 
    • Repeat this step, this time selecting the Billing & Payments Interface and select the Yuhu Inc. agency

 

Step 6: Provide Your Vendor User Login Details

Send the following information to HappyCo so our team can confirm access and complete the remaining setup:

  • Username
  • Password
  • Server Name
  • Database
  • Platform
  • Web Services URL (must begin with https:// )
  • Name of the Import/Export Attachment Types selected in Step 3
    • Also note which you want set for your On Notice, Move Out, and Move In inspections (if you want them set to different types)

Extend Your Integration

The following features can be enabled as part of your Yardi integration:

  • Yardi Make Ready Board Sync — Mark units as Rent Ready directly from HappyCo. Set it up →
  • Work Order Photo Sync — Sync photos and attachments between HappyCo work orders and Yardi service requests. Set it up →
  • Resident Chargebacks — Automatically post resident charges from move-out inspections to the resident's Yardi ledger. Set it up →

 

Further Reading

Was this article helpful?
0 out of 0 found this helpful