Skip to main content

EnrollIndividualInBenefitInput

An input type used when enrolling an Individual in a Benefit

input EnrollIndividualInBenefitInput {
  benefitId: ID!
  coverageLevelId: ID
  coverageType: HealthInsuranceCoverageType
  electionAmount: MoneyInput
  employeeInitialContributionAmount: MoneyInput
  employeeRecurringContributionAmount: MoneyInput
  employerInitialContributionAmount: MoneyInput
  employerRecurringContributionAmount: MoneyInput
  endDate: LocalDate
  individualId: ID!
  startDate: LocalDate
  verificationId: ID
}

Fields​

EnrollIndividualInBenefitInput.benefitId ● ID! non-null scalar​

The ID of the Benefit to enroll the Individual in

EnrollIndividualInBenefitInput.coverageLevelId ● ID scalar​

Coverage level public ULID. Must reference an active coverage level configured for this offering.

Required for TRADITIONAL_HRA enrollments — the resolver derives employerInitialContributionAmount, employerRecurringContributionAmount, and the per-period final-remainder amount from the coverage level record, so partners do not pass those amounts directly for Traditional HRA.

EnrollIndividualInBenefitInput.coverageType ● HealthInsuranceCoverageType enum​

The health insurance coverage type for HSA accounts. This field is optional and only applies to HSA offerings.

EnrollIndividualInBenefitInput.electionAmount ● MoneyInput input​

The annual election amount for the benefit enrollment. Subject to IRS contribution limits based on benefit type and coverage type. Amount should be provided in cents (lowestDenominationAmount). Only applicable for HSA and FSA benefit types, for now. This will change when we add support for additional benefit types.

EnrollIndividualInBenefitInput.employeeInitialContributionAmount ● MoneyInput input​

The amount of funds from an employee to be used as an initial contribution upon Benefit Enrollment. If provided, this must be positive, non-zero amount.

Not accepted for TRADITIONAL_HRA enrollments — contribution amounts are derived from the selected coverageLevelId. Supplying this field on a TRADITIONAL_HRA enrollment returns a BadRequestError.

EnrollIndividualInBenefitInput.employeeRecurringContributionAmount ● MoneyInput input​

The amount of funds from an employee to be contributed on a recurring schedule to the Benefit. If provided, this must be positive, non-zero amount.

Not accepted for TRADITIONAL_HRA enrollments — contribution amounts are derived from the selected coverageLevelId. Supplying this field on a TRADITIONAL_HRA enrollment returns a BadRequestError.

EnrollIndividualInBenefitInput.employerInitialContributionAmount ● MoneyInput input​

The amount of funds from an employer to be used as an initial contribution upon Benefit Enrollment. If provided, this must be positive, non-zero amount.

Not accepted for TRADITIONAL_HRA enrollments — contribution amounts are derived from the selected coverageLevelId. Supplying this field on a TRADITIONAL_HRA enrollment returns a BadRequestError.

EnrollIndividualInBenefitInput.employerRecurringContributionAmount ● MoneyInput input​

The amount of funds from an employer to be contributed on a recurring schedule to the Benefit. If provided, this must be positive, non-zero amount.

Not accepted for TRADITIONAL_HRA enrollments — contribution amounts are derived from the selected coverageLevelId. Supplying this field on a TRADITIONAL_HRA enrollment returns a BadRequestError.

EnrollIndividualInBenefitInput.endDate ● LocalDate scalar​

The End Date of the Individual Enrollment. If unspecified, defaults to the End Date of the Benefit.

EnrollIndividualInBenefitInput.individualId ● ID! non-null scalar​

The ID of the Individual to enroll in the program

EnrollIndividualInBenefitInput.startDate ● LocalDate scalar​

The Start Date of the Individual Enrollment. If unspecified, defaults to the Start Date of the Benefit.

EnrollIndividualInBenefitInput.verificationId ● ID scalar​

For Benefits that require verification, the ID of a Verification to validate prior to enrollment. The associated Verification must be in a valid state for enrollment and must belong to the Individual specified by individualId.

This field is optional - if omitted, the system will attempt to find an existing valid verification for the Individual. If no valid verification is found, enrollment will fail. For Benefits that do not require verification, this attribute is ignored.

Member Of​

enrollIndividualInBenefit mutation