Get Employer HRA Plan
Retrieves the details of a specific Employer Health Reimbursement Arrangement (HRA) plan using the unique identifiers: TPA ID and Employer ID. This operation is useful for administrators to access and review the configuration and parameters of an existing HRA plan.
-
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
Unique ID given to the plan.
Min Length: 0 Max Length: 18 -
accountTypeCode string
3 digit code for the account type.
-
planYearStartDate string <date-time>
Plan's start date.
-
planYearEndDate string <date-time>
Plan's end date.
-
verboseMode boolean
-
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.
-
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.
-
PlanId string
Unique ID given to the plan.
-
AccountTypeCode string
3 digit code for the account type.
-
PlanYearStartDate string <date-time>
Plan's start date.
-
PlanYearEndDate string <date-time>
Plan's end date.
-
GracePeriodEndDate string <date-time>
Plan's run out date.
-
SpendingLimitPeriod enum<string>
Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.
Possible values:NoneMonthYearQuarter -
SpendingDepositAmount number <double>
Maximum amount to be deposited, during the spending Limit period.
-
SpendingTransactionAmount number <double>
Maximum amount to be withdrawn, during the spending limit period.
-
AllowPartialManualTransaction boolean
Determine if this account type allows partial payments of Manual Transactions.
-
AutoDepositBypass boolean
Set this flag to 1 to discontinue any future scheduled auto deposits. Setting this flag to 0 enables auto deposits and catching up on any missed auto deposits, even those that occurred while this flag was set to 1.
-
PayCycleTypeCode enum<string>
This determines the pay cycle for auto deposits.
Possible values:NoAutoDepositAnnualBiWeeklyMonthlySemiMonthlyWeeklyQuarterly -
ConvenienceFeePayor enum<string>
Determines who pays the convenience fee.
Possible values:NoneTpaEmployerEmployee -
ConvenienceFeeAmount number <double>
Convenience amount charged for each POS transaction. Only used if Employee is paying the fee.
-
MaxTransactionAmount number <double>
Maximum amount to be exchanged per transaction.
-
MaxTotalAmount number <double>
Maximum amount to be paid out of this account type over the account’s date range.
-
DefaultPlanOptions enum<integer>
Set this field if the administrator wishes to use the default plan functionality. A sum value should be sent if the administrator wishes to use the combination of defaults. Ex. if the administrator wants to create a Plan with Plan design defaults and MTC defaults, they have to set this field as 3 (1 + 2).
Possible values:None (0)Plan (1)MTC (2)LifeEventBalanceManagement (4)EnableCoverageTiers (8)EnableSpecialDeposit (16)ServiceCategory (32)ManualClaimPercentCoverage (64)EnableDeductible (128)HidePlanFromParticpiant (256) -
HraType enum<string>
Type of HRA.
Possible values:NoneIndividualFamilyAmtSingleFundHra -
FundRollover boolean
Determines if there will be a rollover.
-
FundRolloverOwner enum<string>
Determines who owns the rollover.
Possible values:NoneMBITPA -
FundRolloverStatus enum<string>
Status of the rollover.
Possible values:NotApplicableNotCompletedInProcessCompletedPartial -
FundRolloverDate string
Date the rollover is set to occur.
-
FundRolloverType enum<string>
Type of rollover.
Possible values:NoneAllFundsCapPercentageCapAndPercentage -
IndividualRolloverAmount number <double>
Rollover amount at the individual level.
-
FamilyRolloverAmount number <double>
Rollover amount at the family level.
-
IndividualRolloverRate number <double>
Rollover rate at the individual level.
-
FamilyRolloverRate number <double>
Rollover rate at the family level.
-
IndividualLifetimeMaximum number <double>
Maximum amount to be accumulated over a lifetime at an individual level.
-
FamilyLifetimeMaximum number <double>
Maximum amount to be accumulated over a lifetime at a family level.
-
IndividualNextPeriodMaximum number <double>
Maximum for the next period at an individual level.
-
FamilyNextPeriodMaximum number <double>
Maximum for the next period at a family level.
-
AllowRolloverFundstoOriginalPlan boolean
Indicates if there can be a rollover to the original plan.
-
RolloverReachbackperiod integer <int32>
This indicates the number of plan periods available for manual and POS transactions. In addition, the field indicates how many plan periods to include in any calculation in the Lifetime Maximum field. Possible values 1–5.
-
FundRolloverPriorityType enum<string>
Fund rollover priority type.
Possible values:NoneFIFOLIFO -
RolloverImplementationType integer <int32>
Determines the type of rollover that occurs for the funds remaining in the HRA on the rollover date. The choices are All Funds, Cap, %, or % up to a Cap. Note: When WCA determines the rollover amount, it ensures that the total of the rollover amount and the next or period's election amount do not exceed any lifetime maximum.
-
AllowAutoReimbSettings integer <int32>
This field indicates whether or not the plan will allow auto pay provider reimbursements. 1. = No (Default)=Yes
-
AutoReimbParticipantDefault enum<integer>
This field indicates whether or not the plan will allow auto pay provider reimbursements.
Possible values:NoYes -
ReimburseAmountsAppliedToDeductibleAccount boolean
This field indicates whether or not the plan will reimburse amounts applied to the deductible tracking plan type (DTR). If the account is setup to reimburse amounts applied to the DTR plan, the DTR plan must be a higher priority plan and the claim must be submitted using Service Category Codes (SCCs) to make sure the manual claim splits properly.