Get Benefit Plan Rollover Setting

https://api.wealthcare.com/system/Services/Plan/BenefitPlanRolloverSetting/{tpaId}/{employerId}/Details

This operation is used to retrieve rollover configuration for a specific plan.

Path parameters

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.

Request body

planId string Required

Unique Identifier to distinguish this plan from others within the administrator. This value is the source Plan ID.

Note: The Source Plan is the benefit plan where fund rollover dollars are drawn.

Min Length:	0
Max Length:	18

planYrStartDte string <date-time> Required

Date that funds are available for services. This value is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn. Format is YYYYMMDD.
planYrEndDte string <date-time> Required

Date after which services are not eligible for payment, unless there is an extension. This value is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn. Format is YYYYMMDD.
acctTypeCde string Required

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.). This is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn
fundRolloverTypeCde enum<string> Required

Determines whether rules being created are for primary or secondary fund rollover. If using Secondary Fund Rollover, Primary Fund Rollover rules must be specified first. Attempting to setup Secondary Fund Rollover rules without first specifying Primary Fund Rollover rules will result in an error during processing.

Possible values: None Primary Secondary

Response

TpaId string

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
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.
PlanId string

Unique Identifier to distinguish this plan from others within the administrator. This value is the source Plan ID.

Note: The Source Plan is the benefit plan where fund rollover dollars are drawn.
PlanYrStartDte string

Date that funds are available for services. This value is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn. Format is YYYYMMDD.
PlanYrEndDte string

Date after which services are not eligible for payment, unless there is an extension. This value is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn. Format is YYYYMMDD.
AcctTypeCde string

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.). This is for the source plan. The Source Plan is the benefit plan where fund rollover dollars are drawn
TargetPlanKey integer <int32>

A system generated key used to uniquely identify the target plan. The targe plan is the benefit plan where fund rollover dollars are deposited.
TargetAcctTypeCde string

Plan Account Type Code (FSA, DCA, etc.) for the benefit plan to which fund rollover dollars are deposited when fund rollover occurs.
TargetPlanId string

Plan ID of target plan where funds will be deposited with fund rollover. The Target Plan is the benefit plan where fund rollover dollars are deposited.
TargetPlanYrStartDte string

Plan Year Start Date for Target plan where funds are moving. The Target Plan is the benefit plan where fund rollover dollars are deposited. Format is YYYYMMDD.
TargetPlanYrEndDte string

Plan Year END Date for Target plan where funds are moving. The Target Plan is the benefit plan where fund rollover dollars are deposited. Format is YYYYMMDD.
FundRolloverTypeCde enum<string>

Determines whether rules being created are for primary or secondary fund rollover. If using Secondary Fund Rollover, Primary Fund Rollover rules must be specified first. Attempting to setup Secondary Fund Rollover rules without first specifying Primary Fund Rollover rules will result in an error during processing.

Possible values: None Primary Secondary
RolloverDte string

The date upon which funds will roll from one year to the next. Must be on or after the source plan's end date. Format is mm/dd/yyyy.
PlanRolloverSettingOptions enum<string>

Use this field to enable various options for your rollover. Refer to the Fund Rollover Guide in Online Resources for more information on these settings. To use multiple options, sum the numeric indicators (e.g., to use override target plan balance max and exclude zero or negative balance source accounts, enter 40; 8+32). See the bitwise guide for more information.

1 = Auto-link dependent to target account (option 16 must be included when this option is included) 2 = Manage balance max at account level 4 = Fund rollover amount set at account level 8 = Override Target Plan Balance Max 16 = WCA creates target fund account (Use this option to tell WealthCare Admin to create Participant Target Accounts during fund rollover process) 32 = Exclude zero or negative balance source accounts (option 16 must be included when this option is included) 64 = Include target account balance 128 = Include Terminated Accounts 256 = Copy Deductible Flag from source plan (only valid if WCA is creating the target fund account) 512 = Copy Subgroups from source plan (only valid if WCA is creating the target fund account) 1024 = Copy Account Segment from source plan (only valid if WCA is creating the target fund account)

Possible values: None AutolinkDependents ManageBalanceMaxAtAccount ManageRolloverAmountAtAccount OverrideBalanceMax CreateAccountOnRollover ExcludeZeroBalanceSourceAccounts IncludeTargetAcctBalForRolloverMin IncludeTerminatedAccounts CopyDeductibleFlag CopySubgroups CopyAccountSegment GracePeriodCarryoverRolloverSetup OverrideTargetAnnualMin
RolloverEligibilityDateType enum<string>

This setting determines the effective date of the participant and dependent accounts when WCA creates the employee and dependent accounts.

Possible values: NotSet FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanAccountEligDate
RolloverLastAutoDepositDateType enum<string>

This date is the auto-deposit start date and applies to both employee and employer payroll contributions, whether they are amounts set at the employee level or for fixed employer funding.

Possible values: None FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanStartDate SourcePlanAccountEligDate
RolloverAmt number <double>

Maximum amount of Funds to be rolled over.

Can be used in conjunction with Rollover rate (%). For example, you can set a rule of 50% up to $500 by populating both fields.

For Individual/Family HRX plans, this is the family amount.
RolloverRate number <double>

Indicates % of remaining Family funds to be rolled over on rollover date.

Can be used in conjunction with Rollover amount. For example, you can set a rule of 50% up to $500 by populating both fields.
RolloverBalanceMax number <double>

Maximum amount of Funds to be rolled over.

If an Individual/Family type HRA plan (HRX), this is the Family Funds Amount.
IndividualRolloverAmt number <double>

Only used for Individual/Family HRA (HRX) plans.

Maximum amount of Individual Funds to be rolled over. Can be used in conjunction with Individual Rollover rate (%). For example, you can set a rule of 50% up to $500 by populating both fields.
IndividualRolloverRate number <double>

Only used for Individual/Family HRA plans.

Indicates % of remaining individual funds to be rolled over on rollover date. Can be used in conjunction with Individual Rollover amount. For example, you can set a rule of 50% up to $500 by populating both fields.
IndividualBalanceMax number <double>

This amount indicates the maximum balance that is allowed for the Individual Amount within the participant’s account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the Individual Amount balance after funds have rolled into this account does not exceed the Fund Rollover Individual Balance Max specified.

Only set for individual amount in an Individual/Family HRA account.