Onboarding - ADP Data Target Requirements
Onboarding - ADP Data Target Requirement
DataBlend supports the standard API call to create onboarding leveraging the ADP API.
Custom fields are not currently supported by ADP as part of the Onboarding API call.
The following fields are supported:
| DataBlend Query Field Example | ADP Object (API) | Required | Notes |
| 92033 | onboardingtemplatecode | Yes | |
| 1/20/2025 | hiredate | Yes | |
| inprogress | statuscode | Yes | |
| BOS | payrollgroupcode | Yes | |
| Smith | familyname | Yes | |
| John | givenname | Yes | |
| SSN | governmentidnamecode | Yes | |
| AppliedFor | governmentidstatuscode | Yes | |
| acabenefiteligibilitycode | |||
| acabenefiteligibilitydate | |||
| additionalincomeamount | |||
| additionaltaxamount | |||
| addressline1 | |||
| addressline2 | |||
| addressline3 | |||
| allowancetypecode | |||
| bargainingunitcode | |||
| benefitseligibilityclasscode | |||
| birthdate | |||
| business_emailuri | |||
| business_faxareadialing | |||
| business_faxcountrydialing | |||
| business_faxdialnumber | |||
| business_landlineareadialing | |||
| business_landlinecountrydialing | |||
| business_landlinedialnumber | |||
| business_mobileareadialing | |||
| business_mobilecountrydialing | |||
| business_mobiledialnumber | |||
| business_notificationindicator | |||
| business_pagerareadialing | |||
| business_pagercountrydialing | |||
| business_pagerdialnumber | |||
| city | |||
| countrycode | |||
| coveredindicator | |||
| customfieldcode | |||
| customfieldnamecode | |||
| dailyrateamount | |||
| deliverypoint | |||
| disabilitytypecode | |||
| disabledindicator | |||
| emailuri | |||
| employerorganizationlocationnamecode | |||
| employmenteligibilityoptioncode | |||
| ethnicitycode | |||
| faxareadialing | |||
| faxcountrydialing | |||
| faxdialnumber | |||
| futawithholdingstatus | |||
| gendercode | |||
| generationaffix | |||
| governmentid | |||
| hirereasoncode | |||
| homeorganizationunitnamecode | |||
| homeorganizationunittypecode | |||
| homeshoreindicator | |||
| homeworklocationnamecode | |||
| hourlyrateamount | |||
| hoursquantity | |||
| identificationmethodcode | |||
| industryclassificationcode | |||
| jobcode | |||
| laborunioncode | |||
| landlineareadialing | |||
| landlinecountrydialing | |||
| landlinedialnumber | |||
| languagecode | |||
| legalfamilyname | |||
| legalgivenname | |||
| locallivedinjurisdictionindicator | |||
| localtaxallowancequantity | |||
| localtaxcode | |||
| localtaxtypecode | |||
| localworkedinjurisdictionindicator | |||
| managementpositionindicator | |||
| maritalstatuscode | |||
| maritalstatuseffectivedatetime | |||
| middlename | |||
| mobileareadialing | |||
| mobilecountrydialing | |||
| mobiledialnumber | |||
| multiplejobindicator | |||
| nickname | |||
| notificationindicator | |||
| occupationalclassificationcode | |||
| officertypecode | |||
| onboardingexperiencecode | |||
| overtimeeligibilityindicator | |||
| pagerareadialing | |||
| pagercountrydialing | |||
| pagerdialnumber | |||
| paycyclecode | |||
| paygradecode | |||
| payperiodrateamount | |||
| payrollfilenumber | |||
| payrollschedulegroupcode | |||
| personaladdressline1 | |||
| personaladdressline2 | |||
| personaladdressline3 | |||
| personalcity | |||
| personalcountrycode | |||
| personalpostalcode | |||
| personalsubdivisioncode | |||
| personalsubdivisioncode2 | |||
| positionid | |||
| postalcode | |||
| preferredgenderpronouncode | |||
| prehireindicator | |||
| qualificationaffix | |||
| racecode | |||
| recordingbasiscode | |||
| remunerationtypecode | |||
| renumerationrate | |||
| reportstopositionid | |||
| salutationcode | |||
| selfemployedworkertypecode | |||
| 399032 | soccode | ||
| socialinsuranceprogramnamecode | |||
| standardhoursquantity | |||
| stateadditionaltaxamount | |||
| statecode | |||
| statelivedinjurisdictionindicator | |||
| statetaxallowancequantity | |||
| statetaxfilingstatuscode | |||
| stateworkedinjurisdictionindicator | |||
| stringfieldsnamecode | |||
| stringfieldsstringvalue | |||
| subdivisioncode | |||
| subdivisioncode2 | |||
| suihealthcoveragecode | |||
| suistatecode | |||
| taxallowanceamount | |||
| taxallowancequantity | |||
| taxfilingstatuscode | |||
| taxwithholdingstatus | This caused issues for May Cabinets so omit this field. | ||
| tippedworkerindicator | |||
| tobaccouserindicator | |||
| wageentitycode | |||
| wagelawnamecode | |||
| workerid | |||
| workerscompensationcoverageclasstypecode | |||
| workerscompensationcoveragestatus | |||
| workerscompensationcoveragetypecode | |||
| workerscompensationjobclassificationtypecode | |||
| workertypecode | |||
| worklocationaddressline1 | |||
| worklocationaddressline2 | |||
| worklocationaddressline3 | |||
| worklocationcity | |||
| worklocationcountrycode | |||
| worklocationpostalcode | |||
| worklocationsubdivisioncode | |||
| worklocationsubdivisioncode2 |
More questions about API requirements? Please visit the ADP API site: https://developers.adp.com/guides/api-guides