Skip to main content

BenefitsOffering

A Benefit Offering is a single Benefit offered within a Benefits Program. Offering examples include: an annual HSA benefit, an annual FSA benefit, a Post-tax flexible spending benefit, etc.

type BenefitsOffering {
code: String @deprecated
configuration: BenefitsOfferingConfiguration!
description: String!
endDate: DateString
id: ID!
internalName: String
name: String!
startDate: DateString!
status: BenefitsOfferingStatus!
substantiationRequirement: SubstantiationRequirementType
type: BenefitsOfferingAccountType!
}

Fields

BenefitsOffering.code ● String deprecated scalar

DEPRECATED: Use `type`.

The short, enum-like code describing the account type represented by this offering (e.g., FSA, DCFSA, FLEX, HSA, etc.)

BenefitsOffering.configuration ● BenefitsOfferingConfiguration! non-null object

The configuration of the Benefit Offering -- it's spend limits, recurrence interval, etc.

BenefitsOffering.description ● String! non-null scalar

A user-displayable, possibly multi-line description of this Benefit Offering.

BenefitsOffering.endDate ● DateString scalar

The date the Benefits Offering "ends". If absent, this is an open-ended Benefit Offering.

BenefitsOffering.id ● ID! non-null scalar

The unique, public ID of this Benefit Offering.

BenefitsOffering.internalName ● String scalar

The internal name of this Benefit Offering.

BenefitsOffering.name ● String! non-null scalar

The user-displayable name of this Benefit Offering.

BenefitsOffering.startDate ● DateString! non-null scalar

The date the Benefits Offering "starts".

BenefitsOffering.status ● BenefitsOfferingStatus! non-null enum

The status of this Benefit Offering.

BenefitsOffering.substantiationRequirement ● SubstantiationRequirementType enum

The substantiation requirement for this Benefit Offering

BenefitsOffering.type ● BenefitsOfferingAccountType! non-null enum

The category of the underlying account provided by this Offering (e.g., HSA, FSA).

Member of

ClaimForReimbursement object ● ClaimForReimbursementAdministrativeView object