Skip to main content

BenefitsOfferingRolloverConfiguration

Describes the availability and state of the Rollover feature for a Benefits Offering. Rollover enables an amount up to a limit to be carried over to the new enrollment period for the offering.

type BenefitsOfferingRolloverConfiguration {
  available: Boolean!
  enabled: Boolean!
  id: ID!
  limit: DecimalString
  mutuallyExclusiveWith: [ConfigurableBenefitsOfferingFeature!]
  validationRules: BenefitsOfferingRolloverValidationConfiguration
}

Fields​

BenefitsOfferingRolloverConfiguration.available ● Boolean! non-null scalar​

If true, Rollover is available for this Offering type. This is a read-only attribute. If false, enabled must be false and all attributes MUST BE unsettable.

BenefitsOfferingRolloverConfiguration.enabled ● Boolean! non-null scalar​

If true, Rollover is enabled for this Offering.

BenefitsOfferingRolloverConfiguration.id ● ID! non-null scalar​

The ID of this configurable feature.

BenefitsOfferingRolloverConfiguration.limit ● DecimalString scalar​

The configured Rollover limit. If absent, enabled MUST be false. If present, enabled MUST be true.

BenefitsOfferingRolloverConfiguration.mutuallyExclusiveWith ● [ConfigurableBenefitsOfferingFeature!] list enum​

If present, this feature is mutually exclusive with all features defined here. Client can configure this feature, or one or more of the features in this definition, but this feature cannot be configured if any features in this definition are configured. Client should use this for UI/X controls.

BenefitsOfferingRolloverConfiguration.validationRules ● BenefitsOfferingRolloverValidationConfiguration object​

Validation rules governing the Rollover feature. Present only if the feature is available.

Member of​

BenefitsOfferingConfiguration object