ADP Lyric New Hire Standard Data Fields

This article provides detailed information on the standard and recommended setup for the ADP Lyric Bi-Directional Integration, designed to ensure maximum stability and minimize errors.

Recruiting Only
Recruiting & Onboarding

 Notes

• Emergency Contact and Direct Deposit data are not available for Recruiting Only clients.
• Tax data (Federal Tax or State Tax fields) is not available to send for a Canadian hire.
• What are External Identifiers? - As part of your System of Record setup, ClearCompany retains Job Title, Department, and Location ADP codes in relation to our Roles, Departments, and Offices, respectively. A data source of External Identifier means we are automatically sending the correct ADP code based on the onboarding packet or requisition associated with the new hire.

---

Recruiting Only

Create Employee (Recruiting Only)

Field	Required	Source Field	Notes
onboardingTemplateCode.code		Fixed Value	ADP Hire Template
legalName.givenName	Yes	Standard Field	First Name
legalName.familyName	Yes	Standard Field	Last Name
legalAddress.lineOne		Standard Field	Address Line 1
legalAddress.lineTwo		Standard Field	Address Line 2
legalAddress.cityName		Standard Field	City
legalAddress.subdivisionCode.code		Standard Field	USA
legalAddress.countryCode		Fixed Value	Fixed Value: 1
legalAddress.postalCode		Standard Field	Zip Code
communication.emails[0].emailUri		Standard Field	Email Address
communication.mobiles[0].formattedNumber		Standard Field	Phone Number
hireDate	Yes	Offer Letter Custom Field	yyyy-MM-dd
hireReasonCode.code		Fixed Value	New Hire
homeWorkLocation.address.typeCode.code		Fixed Value	Office Based
homeWorkLocation.locationID		External Identifier: Office	Office
assignedWorkLocations[0]address.typeCode.code		Fixed Value	Office Based
assignedWorkLocationPercentage.percentage		Fixed Value	Fixed Value: 100
locationID		External Identifier: Office
classificationCode.code		Custom Requisition Field	Workers Comp Code
workerTypeCode.code		Custom Requisition Field
legalEntityID		Custom Requisition Field
workAssignmentTitle		Standard Field	Position Title
job.jobCode.code		External Identifier: Role	New Positions only
ReportsTo[0].positionID		External Identifier: Hiring Manager	New Positions only
workAssignmentID		Custom Requisition Field	Existing Positions only
assignmentTermCode.code		Custom Requisition Field	Employee Type Regular Seasonal Temp
workLevelCode		Custom Requisition Field	Full Time/Part Time
payrollGroupCode		Custom Requisition Field
remunerationBasisCode.code		Custom Requisition Field	Pay Type
baseRemuneration.annualRateAmount.amount		Offer Letter Custom Field
baseRemuneration.hourlyRateAmount.amount		Offer Letter Custom Field
assignedOrganizationalUnits[0].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[0].nameCode.code		Custom Requisition Field
assignedOrganizationalUnits[1].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[1].nameCode.code		Custom Requisition Field
assignedOrganizationalUnits[2].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[2].nameCode.code		Custom Requisition Field
costCenterID		Custom Requisition Field
costCenterPercentage.percentage		Fixed Value	100

---

Recruiting & Onboarding

Create Employee (Recruiting & Onboarding)

Field	Required	Source Field	Notes
onboardingTemplateCode.code		Fixed Value
legalName.givenName	Yes	Standard Field	First Name
legalName.familyName	Yes	Standard Field	Last Name
legalAddress.lineOne		Standard Field	Address Line 1
legalAddress.lineTwo		Standard Field	Address Line 2
legalAddress.cityName		Standard Field	City
legalAddress.subdivisionCode.code		Standard Field	Must be concatenated State
legalAddress.countryCode		Fixed Value	USA
legalAddress.postalCode		Standard Field	Zip Code
communication.emails[0].emailUri		Standard Field	Email Address
communication.mobiles[0].formattedNumber		Standard Field	Phone Number
governmentIDs[0].id		Standard Field	SSN
governmentIDs[0].nameCode.code		Fixed Value	SSN
ethnicityCode.code		EEO Form	Valid Values Not Specified Latino Asian Native Black Native Islander White Two or More Races
genderCode.code		Personal Data Sheet	Valid Values Male Female Non-Binary
maritalStatusCode.code		Personal Data Sheet	Valid Values Civil Partnership Domestic Partner Legally Separated Married Single Widowed Divorced Common Law
birthDate		Personal Data Sheet	Birth Date requires the format MM/DD/YYYY
hireDate	Yes	Offer Letter Custom Field	Hire Date is required in the format MM/DD/YYYY
hireReasonCode.code		Fixed Value	New Hire
homeWorkLocation.address.typeCode.code		Fixed Value	OfficeBased
homeWorkLocation.locationID		External Identifier: Office
assignedWorkLocations[0]address.typeCode.code		Fixed Value	OfficeBased
assignedWorkLocationPercentage.percentage		Fixed Value	100
locationID		External Identifier: Office
classificationCode.code		Custom Requisition Field	Synced from ADP Lyric from:   Associate Type Associate Subtype Associate Classification
workerTypeCode.code		Custom Requisition Field	Workers Comp Code
legalEntityID		Custom Requisition  Field
workAssignmentTitle		Standard Field	Position Title
job.jobCode.code		External Identifier: Role	New Positions only
ReportsTo[0].positionID		External Identifier: Hiring Manager	New Positions only
workAssignmentID		Custom Requisition Field	Existing Positions only
assignmentTermCode.code		Custom Requisition Field	Employee Type (regular/seasonal/ temp/etc)
workLevelCode		Custom Requisition Field	Full Time/Part Time
payrollGroupCode		Custom Requisition Field
remunerationBasisCode.code		Custom Requisition Field	Pay Type
baseRemuneration.annualRateAmount.amount		Offer Letter Custom Field
baseRemuneration.hourlyRateAmount.amount		Offer Letter Custom Field
assignedOrganizationalUnits[0].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[0].nameCode.code		Custom Requisition Field
assignedOrganizationalUnits[1].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[1].nameCode.code		Custom Requisition Field
assignedOrganizationalUnits[2].unitTypeCode.code		Fixed Value
assignedOrganizationalUnits[2].nameCode.code		Custom Requisition Field
costCenterID		Custom Requisition Field
costCenterPercentage.percentage		Fixed Value	100
militaryStatusCode.code		EEO Form	Protected Not Protected Do Not Identify
militaryStatusCode.name		EEO Form	Protected Not Protected Do Not Identify

Emergency Contact (Recruiting + Onboarding)

Field	Required	Source Field	Notes
personName.givenName		Personal Data Sheet
personName.familyName		Personal Data Sheet
communication.mobiles[0].formattedNumber		Personal Data Sheet
relationshipTypeCode.code		Personal Data Sheet	Domestic Partner Former Spouse

Direct Deposit (Recruiting + Onboarding)

Field	Required	Source Field	Notes
Account Type		Direct Deposit Form	Valid Values Checking Savings
Account Number		Direct Deposit Form
Routing ID		Direct Deposit Form	Bank's Routing Number
Distribution Percentage		Fixed Value
Distribution Amount		Direct Deposit Form
Account Type [2]		Direct Deposit Form	Additional Account if necessary
Account Number [2]		Direct Deposit Form
Routing ID [2]		Direct Deposit Form
Distribution  Percentage		Direct Deposit Form
Distribution Amount		Direct Deposit Form

---

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