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
Steps 1 through 3 are completed by your internal Yardi administrator. Once complete, provide the details from Step 4 to HappyCo and our team will finish the remaining configuration.
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 access to the Property-Interface_Configuration permission
Step 3: Configure the Service Request Interface
When configuring the Service Request interface for the HappyCo Service Request (happyco9) vendor package, set the following:
- Ignore Exclude Units Flag: Off — this prevents units such as Model, Admin, or Wait from being synced into HappyCo
- Export Deposit Information: On
- Resident data permissions — set the following to Read access: Name, Address, Phone Numbers, Lease Charges, Scheduled Lease Renewals, Rentable Items, Pets, Email
Attachment Type for Inspection Reports
To sync completed inspection reports back to Yardi, at least one Import/Export Attachment Type must be selected in the Common Data Configuration screen for the HappyCo Service Request package.
Note the name of the attachment type you select — you'll need to provide it in Step 4.
Bulk Property Configuration
Once the interface is configured, bulk configure the properties that will be live in HappyCo. 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.
Step 4: 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://— nothttp://) - Name of the Import/Export Attachment Type selected in Step 3
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 and sync the date back to Yardi automatically. 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 →