Get Employer Plan Metrics
This operation is used to retrieve metrics for a plan under an employer
-
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.
-
planId string Required
Unique Identifier to distinguish this plan from others within the administrator.
Min Length: 0 Max Length: 18 -
accountTypeCode string Required
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
-
planYearStartDate string <date-time> Required
(YYYMMDD)Date that funds are available for services.
-
planYearEndDate string <date-time> Required
(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
-
verboseMode boolean
Optional, if set to true, the response may return more details as to why a request was not successful
-
TpaId string
A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
-
EmployerId string
Unique identifier for the employer for which you want to retrieve metrics. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
PlanId string
Unique Identifier to distinguish this plan from others within the administrator.
-
AccountTypeCode string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
-
PlanYearStartDate string <date-time>
(YYYMMDD)Date that funds are available for services.
-
PlanYearEndDate string <date-time>
(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
-
TotalEnrolleesCount integer <int32>
Total number of flex accounts on this plan that are in a new, active, temporarily inactive, or terminated status.
-
TotalAnnualElection number <double>
Sum of all annual election amounts for flex accounts on this plan that are in a new, active, temporarily inactive, or terminated status.
-
TotalEmpeContribYtd number <double>
Sum of all employee contributions made this calendar year for accounts on this plan.
-
TotalEmprContribYtd number <double>
Sum of all employer contributions made this calendar year for accounts on this plan.
-
TotalOtherDepositYtd number <double>
Sum of all "other deposit" category deposits made this calendar year for accounts on this plan.
-
TotalDisbursedYtd number <double>
Sum of all disbursed amounts made this calendar year for accounts on this plan.
-
TotalForfeitureBal number <double>
Total amount forfeited for accounts under this plan. This is the sum of employee and employer contributions YTD less the total disbursed amount YTD.
-
TotalClaimsDisbursed number <double>
Sum of the transaction amounts for all disbursed claims on accounts under this plan.
-
TotalPosDisbursed number <double>
Sum of the transaction amounts for all disbursed POS transactions on accounts under this plan.