UKG Ready New Hire Integration Standard Setup

This article provided detailed information on the standard and recommended setup for the UKG Ready New Hire Integration, designed to ensure maximum stability and minimize errors.

Supported Fields

The following fields are included by default in the integration.

Create Employee (Recruiting Only)

Field	Required	Source Field	Notes
username	Yes	Standard Field
first_name	Yes	Standard Field
last_name	Yes	Standard Field
employee_id	Yes	Standard Field
address.address_line_1	Yes	Standard Field
address.address_line_2		Standard Field
address.country	Yes	Fixed Value	USA
address.city	Yes	Standard Field
address.state	Yes	Standard Field
address.zip	Yes	Standard Field
use_separate_mailing_address		Fixed Value	False
phones.cell_phone_country_id	Yes	Fixed Value
phones.cell_phone_country_code	Yes	Fixed Value
phones.cell_phone	Yes	Standard Field
phones.home_phone_country_id		Standard Field
phones.home_phone_country_code		Standard Field
phones.home_phone		Standard Field
phones.preferred_phone		Fixed Value	Cell
primary_email	Yes	Standard Field
cost_centers_info.defaults[0]. index		External Identifier
cost_centers_info.defaults[0]. value.id		External Identifier
cost_centers_info.defaults[1]. index		External Identifier
cost_centers_info.defaults[1]. value.id		External Identifier
cost_centers_info.defaults[2]. index		External Identifier
cost_centers_info.defaults[2]. value.id		External Identifier
dates.hired	Yes	Offer Letter Custom Field
dates.started	Yes	Offer Letter Custom Field

Create Employee (Recruiting & Onboarding)

Field	Required	Source Field	Notes
username	Yes	Standard Field
first_name	Yes	Standard Field
last_name	Yes	Standard Field
employee_id	Yes	Standard Field
address.address_line_1	Yes	Standard Field
address.address_line_2		Standard Field
address.country	Yes	Fixed Value	USA
address.city	Yes	Standard Field
address.state	Yes	Standard Field
address.zip	Yes	Standard Field
use_separate_mailing_address		Fixed Value	False
phones.cell_phone_country_id	Yes	Fixed Value	USA
phones.cell_phone_country_code	Yes	Fixed Value
phones.cell_phone	Yes	Standard Field
phones.home_phone_country_id		Standard Field
phones.home_phone_country_code		Standard Field
phones.home_phone		Standard Field
phones.preferred_phone		Fixed Value	CELL
primary_email	Yes	Standard Field
cost_centers_info.defaults[0]. index		External Identifier
cost_centers_info.defaults[0]. value.id		External Identifier
cost_centers_info.defaults[1]. index		External Identifier
cost_centers_info.defaults[1]. value.id		External Identifier
cost_centers_info.defaults[2]. index		External Identifier
cost_centers_info.defaults[2]. value.id		External Identifier
dates.hired	Yes	Offer Letter Custom Field
dates.re_hired
dates.started	Yes	Offer Letter Custom Field
dates.birthday		Personal Data Sheet
national_id_numbers[0]. type	Yes	Fixed Value	SSN
national_id_numbers[0]. value	Yes	Standard Field
national_id_numbers[0]. primary	Yes	Fixed Value	true

Compensation

Fields	Required	Source Field	Notes
effective_from	Yes	Standard Field	Format: yyyy-MM-dd
employee.account_id	Yes	External Identifier
amount	Yes	Offer Letter Custom Field
amount_period	Yes	Requisition Custom Field
time	Yes	Requisition Custom Field
time_period		Requisition Custom Field	Valid Values Year Month Week Pay Period
num_pp_in_year		Fixed Value	Valid Values Year Month Week Pay Period

Contact

Field	Required	Source Field	Notes
first_name	Yes	Personal Data Sheet
last_name	Yes	Personal Data Sheet
relationship	Yes	Personal Data Sheet
employee_account_id	Yes	External Identifier
cell_phone.number	Yes	Personal Data Sheet
cell_phone.primary		Fixed Value
emergency		Fixed Value
email		Personal Data Sheet

Pay

Field	Required	Source Field	Notes
employee_type.id		Requisition Custom Field
pay_grade.id		Requisition Custom Field
payroll_classification	Yes	Fixed Value

Demographics

Field	Required	Source Field	Notes
Gender		Personal Data Sheet	Valid Values Male Female Non-Binary Undefined
ethinicity		System Field	Valid Values Hispanic or Latino White Black or African American Native Hawaiian or Other Pacific Islander Asian American Indian or Alaska Native Two or More Races

Direct Deposit CSV

Field	Required	Source Field	Notes
SSN		Standard Field
Name	Yes	Standard Field
Account Type	Yes	Direct Deposit Form	Valid Values Checking Savings Reserve Live Check
Start Date	Yes	Standard Field	Format: mm/dd/yyyy
End Date		Fixed Value
Calculation Method	Yes	Direct Deposit Form	Valid Values Entire/Remainder Flat $ Amount $ of Net Pay $ of Gross Earnings
Calculation Method Amount		Direct Deposit Form	Only used when Flat $ Amount is chosen for "Calculation Method"
Calculation Method Percent		Direct Deposit Form	Only used when % of Net Pay OR % of Gross Earnings is chosen from the "Calculation Method"
Sequence	Yes	Direct Deposit Form	If the calculation method is Entire/Remainder
Frequency	Yes	Fixed Value	Valid Values Annual EveryOtherSchedulePay EveryPay EveryScheduledMonthEvenPay EveryScheduleMonthOddPay EverySchedule Monthly Quarterly
ABA	Yes	Direct Deposit Form	Bank's Routing Number
Account Number	Yes	Direct Deposit Form
Prenote Sent Date	Yes	Fixed Value	This can also be pulled from a form field, standard field, or custom field.

Tax CSV

Only the identifying data is mandatory for this export (SSN for example). Everything else, including the Federal W-4 and state tax info, is conditional.

It’s important to note that any fields that are mandatory for manual tax information creation are also mandatory for tax information uploads in UKG Ready.

Field	Required	Source Field	Notes
SSN#	Yes	Standard Field
Federal Filing Status		ClearCompany Stock- Federal W4 Form Single or Married Filing Separately Married filing Jointly Head of Household Non-Residential Alien
2020 and forward Form W-4	Yes	Fixed Value	This is required if sending the Federal W-4.
Federal Withhold		ClearCompany Stock- Federal W4 Form	Valid Values Yes Block Exempt
Federal Multiple Jobs		ClearCompany Stock- Federal W4 Form	Step 2 Checkbox
Federal Claim Dependents		ClearCompany Stock- Federal W4 Form	Step 3 Claim Dependent Amount;
Federal Other Income		ClearCompany Stock- Federal W4 Form	Step 4a Other Income
Federal Deductions		ClearCompany Stock- Federal W4 Form	Step 4b Deductions

By following these guidelines, you can successfully transfer new hire data from ClearCompany to UKG and make use of the integrated features.