The BenefitsCarrierFeedOpenEnrollmentExports endpoint retrieves data for employee and dependents who have benefit elections that are in effect as of the plan year start date. This retrieved data is intended for transmission only once to a single carrier and typically follows the completion of an annual enrollment period. The returned data payload is in the JSON format.
Parameters
| Parameter Name | Type | Description |
|---|---|---|
| carrierXRefCode* | String | A reference code that maps to a given carrier |
| planStartDate* | String | The plan start date |
| planEndDate* | String | The plan end date |
| payrollEarningAccumulationXRefCodes | String | A comma delimited list of reference codes that map to a list of individual payroll earning accumulations |
| clientNamespace* | String | Uniquely identifies the client’s Dayforce instance to login |
Response
The following is an example response:
Copy
{
"Data": {
"Header": {
"RecordType": "string",
"FileFormatMajorVersion": "string",
"FileFormatMinorVersion": "string",
"CTCReceiverId": "string",
"CarrierName": "string",
"CarrierFEINNumber": "string",
"MasterPolicyNumber": "string",
"EmployerName": "string",
"EmployerFEINNumber": "string",
"EmployerDivisionNumber": "string",
"PlanStartDate": "2023-05-09T13:19:44.438Z",
"CreateDate": "2023-05-09T13:19:44.438Z",
"ClientId": "string",
"CorrelationId": "string"
},
"EmployeeRecords": [
{
"EmployeeDetails": {
"RecordType": "string",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"NameSuffix": "string",
"NationalId": "string",
"NationalIDExpiryDate": "2023-05-09T13:19:44.438Z",
"XRefCode": "string",
"EmployeeNumber": "string",
"CultureCode": "string",
"Citizenship": "string",
"SeniorityDate": "2023-05-09T13:19:44.438Z",
"IsVisibleMinority": true,
"IsAboriginal": true,
"BadgeNumber": "string",
"EmploymentStatus": "string",
"EmploymentStatusReasonCode": "string",
"EmploymentStatusStartDate": "2023-05-09T13:19:44.438Z",
"EmploymentStatusEndDate": "2023-05-09T13:19:44.438Z",
"NormalWeeklyHours": 0,
"NormalSemiMonthlyHoursTop": 0,
"NormalSemiMonthlyHoursBottom": 0,
"AverageDailyHours": 0,
"BaseSalary": 0,
"BaseRate": 0,
"PayGroupCode": "string",
"EmployeeGroupCode": "string",
"PayTypeCode": "string",
"PayClassCode": "string",
"DateOfBirth": "2023-05-09T13:19:44.438Z",
"GenderCode": 0,
"MaritalStatusCode": "string",
"IncomeFrequency": 0,
"TobaccoSubstanceUse": true,
"DateLastSmoked": "2023-05-09T13:19:44.438Z",
"TobaccoUseEffectiveStart": "2023-05-09T13:19:44.438Z",
"TobaccoUseEffectiveEnd": "2023-05-09T13:19:44.439Z",
"Height": 0,
"Weight": 0,
"DisabilityCode": true,
"DisabilityBeginDate": "2023-05-09T13:19:44.439Z",
"DisabilityEndDate": "2023-05-09T13:19:44.439Z",
"DepartmentJobNameCode": "string",
"WorkAssignmentEffectiveStart": "2023-05-09T13:19:44.439Z",
"WorkAssignmentEffectiveEnd": "2023-05-09T13:19:44.439Z",
"EmploymentIndicatorCode": "string",
"VirtualIndicator": true,
"PositionLedgerCode": "string",
"WorkedInState": "string",
"ManagerFirstName": "string",
"ManagerLastName": "string",
"ManagerEmail": "string",
"ManagerPhoneNumber": "string",
"PayRunCheckDate": "2023-05-09T13:19:44.439Z",
"PayPeriodStartDate": "2023-05-09T13:19:44.439Z",
"PayPeriodEndDate": "2023-05-09T13:19:44.439Z",
"PayFrequencyCode": 0,
"Ethnicity": "string",
"MedicareStatus": 0,
"MedicareReasonCode": 0,
"OriginalHireDate": "2023-05-09T13:19:44.439Z",
"TerminationDate": "2023-05-09T13:19:44.439Z",
"HireDate": "2023-05-09T13:19:44.439Z",
"DateOfDeath": "2023-05-09T13:19:44.439Z",
"InitialNoticeFlag": true,
"GenderIdentity": "string",
"Age": 0
},
"AddressDetails": [
{
"RecordType": "string",
"AddressType": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"City": "string",
"County": "string",
"StateCode": "string",
"CountryCode": "string",
"PostalCode": "string",
"EffectiveStart": "2023-05-09T13:19:44.439Z",
"EffectiveEnd": "2023-05-09T13:19:44.439Z"
}
],
"PropertyDetails": [
{
"RecordType": "string",
"PropertyTypeCode": "string",
"PropertyValue": "string",
"PropertyValueTypeCode": 0,
"EffectiveStartDate": "2023-05-09T13:19:44.439Z",
"EffectiveEndDate": "2023-05-09T13:19:44.439Z"
}
],
"OrgUnitDetails": [
{
"RecordType": "string",
"OrgUnitName": "string",
"OrgLevelCode": "string",
"OrgUnitCode": "string",
"LegalEntity": "string",
"OrgUnitWorkSiteZipCode": "string",
"OrgUnitLedgerCode": "string"
}
],
"UnionMembershipDetails": [
{
"RecordType": "string",
"UnionName": "string",
"UnionXrefCode": "string",
"MembershipEffectiveStartDate": "2023-05-09T13:19:44.439Z",
"MembershipDate": "2023-05-09T13:19:44.439Z"
}
],
"ContactDetails": [
{
"RecordType": "string",
"ContactInformation": "string",
"CountryCode": "string",
"ContactInformationCategoryCode": 0,
"ContactInformationType": "string"
}
],
"EmployeeElectionDetails": [
{
"RecordType": "string",
"ElectionId": 0,
"PlanTypeCode": "string",
"PlanSubTypeCode": "string",
"PlanXrefCode": "string",
"PlanCode": "string",
"PolicyNumber": "string",
"OptionCode": "string",
"CoverageStartDate": "2023-05-09T13:19:44.439Z",
"CoverageEndDate": "2023-05-09T13:19:44.439Z",
"EffectiveStartDate": "2023-05-09T13:19:44.439Z",
"EffectiveEndDate": "2023-05-09T13:19:44.439Z",
"EmployeePerPayCost": 0,
"EmployeeDeductionScheduleCode": "string",
"EmployeeAnnualCost": 0,
"EmployerPerPayCost": 0,
"EmployerDeductionScheduleCode": "string",
"EmployerAnnualCost": 0,
"CarrierPerPayCost": 0,
"CarrierAnnualCost": 0,
"EmployeeContributionAmount": 0,
"EmployeeContributionPercentage": 0,
"EmployerContributionAmount": 0,
"EmployerContributionPercentage": 0,
"CoverageAmount": 0,
"CoverageMultiplier": 0,
"RequestedCoverageAmount": 0,
"PreAgeReducedCoverageAmount": 0,
"EOIStatusCode": 0,
"RateXrefCode": "string",
"PlanStartDate": "2023-05-09T13:19:44.439Z",
"ElectionDate": "2023-05-09T13:19:44.439Z",
"PlanEndDate": "2023-05-09T13:19:44.439Z",
"CareProviderDetails": [
{
"RecordType": "string",
"ProviderIDQualifier": "string",
"ProviderId": "string",
"RelationshipCode": "string",
"EntityIDCode": "string"
}
]
}
],
"DependentDetails": [
{
"RecordType": "string",
"UniqueDependentId": 0,
"EmployeeNationalId": "string",
"NationalId": "string",
"NationalIDExpiryDate": "2023-05-09T13:19:44.439Z",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"DateOfBirth": "2023-05-09T13:19:44.439Z",
"GenderCode": 0,
"RelationshipCode": "string",
"MedicareStatusCode": 0,
"MedicareReasonCode": 0,
"StudentIndicator": true,
"DependentHandicapIndicator": true,
"DeathDate": "2023-05-09T13:19:44.439Z",
"EligibilityBeginDate": "2023-05-09T13:19:44.439Z",
"EligibilityEndDate": "2023-05-09T13:19:44.439Z",
"XRefCode": "string",
"TobaccoSubstanceUse": true,
"DateLastSmoked": "2023-05-09T13:19:44.439Z",
"Height": 0,
"Weight": 0,
"InitialNoticeFlag": true,
"SocialSecurityDisabilityAwardDate": "2023-05-09T13:19:44.439Z",
"DependentAge": 0,
"AddressDetails": [
{
"RecordType": "string",
"AddressType": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"City": "string",
"County": "string",
"StateCode": "string",
"CountryCode": "string",
"PostalCode": "string",
"EffectiveStart": "2023-05-09T13:19:44.439Z",
"EffectiveEnd": "2023-05-09T13:19:44.439Z"
}
],
"ContactDetails": [
{
"RecordType": "string",
"ContactInformation": "string",
"CountryCode": "string",
"ContactInformationCategoryCode": 0,
"ContactInformationType": "string"
}
],
"DependentElectionDetails": [
{
"RecordType": "string",
"EmployeeElectionId": 0,
"UniqueDependentId": 0,
"PlanTypeCode": "string",
"PlanSubTypeCode": "string",
"PlanXrefCode": "string",
"PlanCode": "string",
"PolicyNumber": "string",
"OptionCode": "string",
"CoverageStartDate": "2023-05-09T13:19:44.439Z",
"CoverageEndDate": "2023-05-09T13:19:44.439Z",
"EffectiveStartDate": "2023-05-09T13:19:44.439Z",
"EffectiveEndDate": "2023-05-09T13:19:44.439Z",
"PlanStartDate": "2023-05-09T13:19:44.439Z",
"CareProviderDetails": [
{
"RecordType": "string",
"ProviderIDQualifier": "string",
"ProviderId": "string",
"RelationshipCode": "string",
"EntityIDCode": "string"
}
]
}
]
}
],
"BeneficiaryDetails": [
{
"RecordType": "string",
"UniqueBeneficiaryId": 0,
"EmployeeNationalId": "string",
"NationalId": "string",
"NationalIDExpiryDate": "2023-05-09T13:19:44.439Z",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"DateOfBirth": "2023-05-09T13:19:44.439Z",
"GenderCode": 0,
"RelationshipCode": "string",
"XRefCode": "string",
"HomePhoneNumber": "string",
"AddressDetails": [
{
"RecordType": "string",
"AddressType": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"City": "string",
"County": "string",
"StateCode": "string",
"CountryCode": "string",
"PostalCode": "string",
"EffectiveStart": "2023-05-09T13:19:44.439Z",
"EffectiveEnd": "2023-05-09T13:19:44.439Z"
}
],
"ContactDetails": [
{
"RecordType": "string",
"ContactInformation": "string",
"CountryCode": "string",
"ContactInformationCategoryCode": 0,
"ContactInformationType": "string"
}
],
"BeneficiaryElectionDetails": [
{
"RecordType": "string",
"UniqueBeneficiaryId": 0,
"PlanTypeCode": "string",
"PlanSubTypeCode": "string",
"PlanXrefCode": "string",
"PlanCode": "string",
"PolicyNumber": "string",
"OptionCode": "string",
"CoverageStartDate": "2023-05-09T13:19:44.439Z",
"CoverageEndDate": "2023-05-09T13:19:44.439Z",
"BeneficiaryPercentage": 0,
"ContingentBeneficiaryIndicator": true,
"EffectiveStartDate": "2023-05-09T13:19:44.439Z",
"EffectiveEndDate": "2023-05-09T13:19:44.439Z",
"PlanStartDate": "2023-05-09T13:19:44.439Z"
}
]
}
],
"EarningGroupingResults": [
{
"RecordType": "string",
"LegalEntityReferenceCode": "string",
"EarningGroupingReferenceCode": "string",
"CurrentHours": 0,
"MTDHours": 0,
"QTDHours": 0,
"YTDHours": 0
}
],
"EarningGroupingCustomPeriodResults": [
{
"RecordType": "string",
"LegalEntityXrefCode": "string",
"EarningGroupingXrefCode": "string",
"CustomPeriodXrefCode": "string",
"Hours": 0
}
]
}
]
},
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}