HR fields synced to Benefits – Ciphr

This guide outlines the required employee data in HR for the Benefits sync, how fields are mapped, and the most common causes of sync failures.

The integration covers the areas below that the Benefits platform needs to manage an employee's benefits:

Account
Personal Details
Address (primary)
Employment
Remuneration
Benefits fixed list fields - value not recognised error
Benefits fields requiring configuration

Fields marked Required must be populated in HR before the employee can sync successfully - missing required values are the most common cause of Failed status.

Account

Benefits field	HR source	Required
Email Address	Personal Details email (Home / Work / Services - chosen at tenant level)	Yes

Personal Details

Benefits field	HR source	Required
Salutation (Title)	Personal Details Title	Yes
Forenames	Personal Details Forenames	Yes
Surname	Personal Details Surname	Yes
Date of Birth	Personal Details Date of Birth	Yes
Gender	Personal Details Sex	Yes
NI Number	Personal Details National Insurance Number	No

Address (primary)

Benefits field	HR source	Required
Line 1 / Line 2 / Line 3	Personal Details Address Lines 1–3	No
Town	Personal Details Address Line 4	No
Postcode	Personal Details Post Code	No

Employment

Benefits field	HR source	Required
Start Date	Personal Details Start Date	No
Leave Date	Personal Details Date Left	No
Probation Date	Probation End Date (primary row)	No
Payroll Number	Employee Number	No
Job Title (metadata)	Primary Job Title	No
Grade (metadata)	Grade	No
Department (metadata)	Org Unit 1	No
Location (metadata)	Location	No
Job Classification (metadata)	Job Classification	No
Entity (metadata)	Multi-Entity	No
FTE / part-time modifier (metadata)	FTE on primary Job & Pay	No
Contact phone / Mobile phone (metadata)	Personal Details phone numbers	No
Benefit Level (benefits configuration)	Benefits Level picklist	No

Remuneration

Benefits field	HR source	Required
Amount	Annual Pay on primary Job & Pay	Yes
Start Date	Job & Pay Date From	No
Basis	Pay Basis	Yes
Frequency	Pay Frequency	Yes
Change Reason	Job & Pay Change Reason	Yes

Benefits fixed list fields - value not recognised error

The following fields are matched to a fixed list of values configured on the Benefits platform:

Title
Gender
Pay basis
Pay frequency
Job and Pay change reason

If HR holds a value that doesn't appear in the Benefits list (eg a custom Gender label), the sync will fail with a "value not recognised" error. Use one of the Benefits-recognised values or ask Ciphr to extend the list in the Benefits platform to resolve this.

Benefits fields requiring configuration

Some fields rely on configuration set up within the Benefits platform. These are typically stored as text fields under Contact, Job, and Benefits categories.

Contact
- Contact phone number
- Mobile phone number
Job
- Job Title
- Grade
- Department
- Location
- Job classification
- Entity
Benefits
- FTE/part time modifier

Related guides

Footer

Related to