Get Flex Account Coverage Period List
This is used to get a list of all an employee’s flex account coverage periods given the employee’s account information
-
tpaId string Required
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
employerId string Required
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
employeeId string Required
Unique identifier for the employee.
-
ExtensionData object
-
TpaId string
A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
-
EmprId string
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
SocSecNum string
Unique identifier for the employee.
-
PlanId string
Unique identifier that distinguishes this plan from all others you administer.
Min Length: 0 Max Length: 18 -
AcctTypeCde string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
-
PlanYrEndDte string <date-time>
(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
-
PlanYrStartDte string <date-time>
(YYYMMDD)Date that funds are available for services.
-
FlexAcctId string
A unique identifier for the employee's account, generated by WCA when the account was first set up.
-
AccountSegmentID string
Account Segment ID assigned to the coverage period for this account type
-
CoveragePeriodCreatedBy string
Returns the admin/user/function who created the coverage period. WCA Admin user
-
SubgroupName string
Subgroup Name assigned to the coverage period for this account type
-
ExtensionData object
-
TpaId string
A unique identifier for your administrator instance, generated by WCA when the instance was first set up.
-
EmployerId string
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
EmployeeId string
Unique identifier for the employee.
-
PlanId string
Unique identifier that distinguishes this plan from all others you administer.
-
PlanYrEndDate string
(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
-
PlanYrStartDate string
(YYYMMDD)Date that funds are available for services.
-
AccountTypeCode string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
-
AnnualElection number <double>
Annual Election Amount/Goal Amount for the Life Event (new goal amount = full amount, not difference from old to new goal) Note: Since this is an amount field anything > 0 is valid value
-
AvailBalance number <double>
Available Balance is the Disbursable Balance plus the Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period's balance. Note: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.
-
CoveragePeriodStartDate string
(YYYYMMDD) - Starting date for the coverage period.
-
CoveragePeriodEndDate string
(YYYYMMDD) - Ending date for the coverage period.
-
DisbBal number <double>
Disbursable Balance = Available Balance minus Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance. Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.
-
DisbPtd number <double>
The disbursable balance paid to date.
-
PreauthPTD number <double>
The pre-authorization paid to date.
-
LifeEventType string
Life event type code associated with the employee account coverage period.
-
LifeEventStatusCde enum<string>
0 = Active 1 = Suspended (no transactions permitted unless using an “override”).
Possible values:NoneSuspendedDelete -
FlexAcctId string
A unique identifier for the employee's account, generated by WCA when the account was first set up.
-
CoverageId string
This field is an ID assigned by WealthCare Admin to a coverage period within an Employee Account ID. Coverage IDs are only unique within an Account ID. If this field is included on the template, this field will indicate the Coverage Period ID to which the balance provided is associated (Account IDs with multiple coverage IDs represent qualified life even coverage periods). Field is always length of 10 with leading zeroes, such as “0000000001” The combination of Employee ID, Employee Account ID, Account Type Code, Plan Start Date, Plan End Date, Plan ID and Coverage ID creates a unique composite key for an employee coverage period.
-
CoverageTierId string
Coverage Tier designator (Ex.: Single, Family, etc.) for the employee account.ID of coverage tier to which this employee account is associated.
-
SubgroupID string
Subgroup ID assigned to the coverage period for this account type