Connecting HappyCo to Yardi takes six steps: your Yardi administrator configures the HappyCo Service Request (happyco9) interface in Yardi Voyager, then sends the vendor user login details to HappyCo. For what the integration does and what data syncs between the two systems, see the Yardi Integration Overview.
In this article
- Before you start
- Step 1: Install the HappyCo Service Request package in Yardi Voyager
- Step 2: Configure the Yardi security group for the HappyCo vendor user
- Step 3: Configure the Common Data interface
- Common Data: choose Import/Export Attachment Types
- Step 4: Configure the Service Request interface
- Service Request: File Extension Export Permissions
- Step 5: Bulk configure your properties in Yardi Voyager
- Step 6: Send your Yardi vendor user login details to HappyCo
- Extend your Yardi integration
- Troubleshooting: photos not syncing between HappyCo and Yardi work orders
- If a photo still won't save to Yardi
Before you start
- A Yardi administrator with access to Interfaces and Admin settings
- A HappyCo account with Administrator access
Steps 1 to 5 happen in Yardi Voyager
These steps must be completed by your internal Yardi Administrator directly in Yardi Voyager.
Step 1: Install the HappyCo Service Request package in Yardi Voyager
Check that the happyco9 package is available
Verify that the HappyCo Service Request (happyco9) vendor package is available in your Yardi environment. If you have a self-hosted environment, install the .pkg file directly.
Tip
If you can't locate the package, contact your Yardi Representative or the Yardi Interfaces team to request access.
Don't use the HappyCo2 package
If you see a package labeled HappyCo2, this has been deprecated and should not be used.
Step 2: Configure the Yardi security group for the HappyCo vendor user
In the security group that your HappyCo vendor interface user belongs to, grant the following access:
- Read/Write: all permissions for Interfaces: Web Service - Common Data
- Read/Write: all permissions for Interfaces: Web Service - Resident Data
- Read/Write: all permissions for Interfaces: Web Service - Service Request
- Read/Write: all permissions for Interfaces: Web Service - ILS & Guest Card
- Read/Write: all permissions for Interfaces: Web Service - Billing & Payments
- Read: the Property-Interface_Configuration permission
Step 3: Configure the Common Data interface
-
Open Interfaces
In Yardi Voyager, navigate to Interfaces. -
Select Common Data as the type
Set the type to Common Data. -
Find the HappyCo interface
Search for happyco9 - HappyCo Service Request and adjust the settings in the tables below on that screen.
| Setting | Value | What it does |
|---|---|---|
| Ignore Exclude Units Flag | Off | Prevents units such as Model, Admin, or Wait from being synced into HappyCo |
| Export Deposit Information | On | Allows HappyCo 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 |
| Permission | Access |
|---|---|
| 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 |
| Read | |
| Employer | Read |
Common Data: choose Import/Export Attachment Types
Select the attachment types for inspection PDFs
Under Import/Export Attachment Types, click each type completed inspection PDFs can be sent back to Yardi as. Selected types turn grey. You need to select at least one type.
Tip
Select 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 selected type names
Note the name of each type you selected. You'll send one of them to HappyCo in Step 6.
Step 4: Configure the Service Request interface
-
Open Interfaces
In Yardi Voyager, navigate to Interfaces. -
Select Service Request as the type
Set the type to Service Request. -
Find the HappyCo interface
Search for happyco9 - HappyCo Service Request and adjust the settings below on that screen.
| Setting | Value | What it does |
|---|---|---|
| Export excluded units | Off | Prevents units such as Model, Admin, or Wait from being synced into HappyCo |
| Export employee email address | On | Used for a new feature coming out to sync work order assignees with your PMS |
| Export employee phone numbers | On | Used for a new feature coming out to sync work order assignees with your PMS |
| Include employee detail Id | On | Used for a new feature coming out to sync work order assignees with your PMS |
| Honor Common Data Permission settings | On |
Service Request: 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 configure your properties in Yardi Voyager
-
Open Bulk Property Configuration
In Yardi's sidebar, go to Interfaces > Configuration > Bulk Property Configuration. TipIf Interfaces isn't visible, switch to Basic iData.
-
Configure the Service Requests interface
Enter your property list, select the Service Requests interface, and select the HappyCo Service Request agency. -
Configure the Billing & Payments interface
Repeat for the same properties, this time selecting the Billing & Payments Interface and the Yuhu Inc. agency.
Step 6: Send your Yardi vendor user login details to HappyCo
Send the following information to HappyCo so the team can confirm access and complete the remaining setup:
- Username (or email address if using YardiOne)
- Password
- Server Name
- Database
- Platform
- Web Services URL (must begin with https://)
- Name of one of the Import/Export Attachment Types selected in Step 3
YardiOne organizations
If your organization signs in to Yardi through YardiOne, send the email address assigned to your HappyCo vendor interface user as the Username instead.
Extend your Yardi 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. Setting up Make Ready Sync in Yardi
- Work Order Photo Sync: sync photos and attachments between HappyCo work orders and Yardi service requests. Setting up Work Order Photo Sync in Yardi
- Resident Chargebacks: automatically post resident charges from move-out inspections to the resident's Yardi ledger. Setting up Resident Chargebacks in Yardi
Troubleshooting: photos not syncing between HappyCo and Yardi work orders
Check File Extension Export Permissions in Yardi Voyager
Open the Service Request interface for happyco9 - HappyCo Service Request (Step 4) and confirm all extensions under File Extension Export Permissions are set to Read access.
Tip
This setting allows HappyCo to view all photo and attachment types when syncing work orders.
Check that Work Order Photo Sync is set up
Work Order Photo Sync is an extension to the Yardi integration, not part of the six setup steps above. Confirm it has been set up for your account.
If a photo still won't save to Yardi
Open a support ticket at HappyCo Support (support.happy.co). Include:
- The property name
- The Yardi work order number (or the matching HappyCo task)
- The photo file you tried to upload
- When you added it
- A screenshot showing the photo missing from the work order