Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

External Benefit Plans - ADP Data Target Requirements

anniversarymonthDataBlend supports the standard API calls to create external benefit plans in ADP Workforce Now leveraging the ADP SDK.

DataBlend Query Field Example ADP Object (API) Required? Notes
a1b2c3d4-e5f6-7890-abcd-ef1234567890  transmissionguid Yes  Transmission grouping key. Each unique value produces one POST to ADP. All rows sharing the same transmissionguid are combined into a single transmission. 
EMP001 

employerpartyid

 

 Yes Employer grouping key within a transmission. Rows sharing the same transmissionguid and employerpartyid are grouped under the same employer. 
EVT001  eventid Yes Client event grouping key within an employer. Rows sharing the same employer keys and eventid are grouped under the same client event. 
PLAN001  benefitplanidentifier Yes Benefit plan event grouping key within a client event. Rows sharing the same event keys and benefitplanidentifier are grouped under the same benefit plan event. 
CLASS001  benefitclassidentifier Yes Eligibility group grouping key within a benefit plan event. Rows sharing the same benefit plan keys and benefitclassidentifier are grouped under the same eligibility group. 
1 anniversarydayofmonth    Day of the month for the plan anniversary (1–31).
1 anniversarymonth   Month of the plan anniversary (1–12). 
ADP Workforce Now benefitadministratorplatform   Benefit administrator platform identifier in the transmission envelope (e.g. ADP Workforce Now).
Full Time benefitclassname   Display name for the eligibility group/benefit class.
Annual base salary benefitearningsdescription   Description of the benefit earnings definition.
BaseSalary benefitearningstype   Benefit earnings type (e.g. BaseSalary). One benefit earnings definition entry per row within an eligibility group.
BG001 billgroupidentifier   Bill group identifier for the eligibility group.
15 billingcutoffdayofmonth   Day of the month used as the billing cutoff.
FALSE carrierprovidesfmlaforclient   Indicates whether the carrier provides FMLA for the client. Values: true or false. 
Boston cityname   Employer city.
FALSE cobra   Indicates whether this is a COBRA plan. Values: true or false. 
TRUE cobraeligible   Indicates whether the plan is COBRA eligible. Values: true or false. 
Jane Smith contactperson   Contact person for the benefit plan.
FALSE contributionsplitbuyup   Indicates whether the contribution split applies to a buy-up option. Values: true or false. Distinct from ratebuyup. 
EMPLOYER contributortype   Contributor type for the contribution split (e.g. EMPLOYER, EMPLOYEE). One contribution split entry per row within an eligibility group.
USA countrycode   Employer country code.
Employee Only coveragetier   Coverage tier for the plan (e.g. Employee Only, Employee + Spouse).
2026-01-01T00:00:00Z creationdatetime   Timestamp of transmission creation. Format: ISO 8601 datetime.
500000 dollarmaximum   Maximum dollar amount for coverage.
10000 dollarminimum   Minimum dollar amount for coverage.
1/1/2026 effectivedate   Effective date for the eligibility group. Format: YYYY-MM-DD. 
Acme Corp employername   Legal name of the employer.
1/1/2026 eventdate   Date of the client event. Format: YYYY-MM-DD. 
Coverage eventtypecode   Type of client event (e.g. Coverage). 
12-3456789 federalemployeridentificationnumber   Employer federal EIN.
123 Main St firstlineaddress   Employer address line 1.
GRP123456 grouppolicynumber   Group policy number for the benefit plan.
TRUE hipaaeligible   Indicates whether the plan is HIPAA eligible. Values: true or false.
LifeInsurance insuranceparametertype   Insurance parameter type. One coverage parameter entry per row within an eligibility group.
MA123456 masteragreementnumber   ADP master agreement number for the employer.
800-555-1234 memberservicesphone   Member services phone number for the plan.
2 multipleofearnings   Multiple of earnings for coverage calculation (integer).
80 percentageofcontribution   Percentage of the premium contributed by this contributor (0–100).
Medical Plan A plandisplayname   Display name for the benefit plan.
2101 postalcode   Employer postal code.
FirstOfMonth probationruletype   Rule type applied during the probation period (e.g. FirstOfMonth).
NewHire probationtype   Type of probation rule (e.g. NewHire)). One probation rule entry per row within an eligibility group.
Medical producttype   Product type for the benefit plan (e.g. Medical, AD&D, Dental). 
0.15 rateamount   The rate amount.
FALSE ratebuyup   Indicates whether the rate applies to a buy-up option. Values: true or false. Distinct from contributionsplitbuyup. 
Age ratedifferentiatortype   Rate differentiator type (e.g. Age, Gender) . One rate entry per row within an eligibility group.
12/31/2027 rateguaranteeexpirationdate   Expiration date of the rate guarantee. Format: YYYY-MM-DD. 
DOLLARS_PER_1000_COVERED_VOLUME rateunittype   Unit type for the rate (e.g. DOLLARS_PER_1000_COVERED_VOLUME). 
ADP receivername   Name of the receiving system in the transmission envelope.
3 retroactiveterminationlimitmonths   Maximum number of months allowed for retroactive terminations.
RoundUp roundingrule   Rounding rule applied to benefit calculations for this eligibility group.
1 schemaversionidentifier   Schema version identifier for the transmission envelope.
Suite 100 secondlineaddress   Employer address line 2.
TRUE selfindicator   Self indicator for the benefit plan event. Values: true or false. Note: the API field name contains a hyphen (Self-Indicator); use the column name selfindicator in DataBlend. 
Acme Benefits sendername   Name of the sending system in the transmission envelope.
MA stateprovincecode   Employer state or province code.
EndOfMonth terminationrule   Rule used to determine the termination date for members of this eligibility group.
Production testproductioncode   Indicates whether the transmission is a test or production submission. Values: Test or Production.
  thirdlineaddress   Employer address line 3.
1/1/2026 transactiondate   Transaction date for the client event. Format: YYYY-MM-DD. 
FullFile transmissiontypecode   Type of transmission (e.g. FullFile).

More questions about ADP API requirements? Please visit the ADP API Explorer — External Benefit Plans.