Administrative APIs | REST

Version:
Download Open API Specification

Add Benefit Plan Rollover Setting

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

This operation is used to add rollover configuration for a 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 Required

    Unique Identifier to distinguish this plan from others within the administrator. This value is the source Plan ID. 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.

  • targetAcctTypeCde string Required

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

  • targetPlanId string Required

    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.

    Min Length: 0
    Max Length: 18
  • targetPlanYrStartDte string <date-time> Required

    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 <date-time> Required

    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. Primary = 1 Secondary = 2

    Possible values: None Primary Secondary
  • rolloverDte string <date-time>

    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.

  • planRolloverOptions integer <int32>

    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)

  • rolloverEligDteType 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
  • autoDepositStartDteType 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. Leave blank to set an unlimited amount.

    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.

    Leave blank to have it default to 100%.

  • 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.

    Defaults to no maximum if not sent.

  • 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.

    Defaults to 100% if not sent.

  • trackingNumber string

    The tracking number is not used by WealthCare Admin but may be used for you to identify individual requests and their corresponding responses. If this field is sent on the request, WealthCare Admin will return this value on the response.

  • minimumRolloverAmountofFund number <double>

    Minimum rollover amount. If an amount is specified, then the source account must have a disbursable balance greater than or equal to the minimum rollover amount for rollover to occur.

    If the source account has a disbursable balance less than the minimum rollover amount, then the account will be EXCLUDED from fund rollover ($0 transaction appears on the account, with a reason indicating the fund rollover amount available was less than the minimum).

    Only positive dollar amounts are accepted. The amount must be greater than 0.00.

    The default value is NULL, which indicates there is no minimum rollover amount and no accounts will be excluded.

  • maxRolloverAmtofFunds enum<string>

    Maximum rollover type

    Possible values: AllFunds Cap Percentage CapAndPercentage
  • TrackingNumber string

    This field is not used by WealthCare Admin, but can be used to match requests to responses. This will be the same value as sent for TrackingNumber on the request.

  • ErrorCode integer <int32>

    A numeric code indicating the processing result of the request. 000000 indicates a success. Ask Alegeus Healthcare Payment Solutions for a copy of Error Codes for Alegeus Benefits Payment System

  • ErrorDescription string

    Human friendly description corresponding to ErrorCode to indicate either a success or why the request was not successfully processed.