Administrative APIs | REST

Selected Version:
Download Open API File

Add Benefit Plan Rollover Setting

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

This endpoint allows you to create a new benefit plan rollover setting for a specific employer and TPA. It is used to configure how funds should be rolled over from one benefit plan to another, ensuring compliance with the specified parameters.

Path parameters

Path parameters page anchor
  • 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.

Header parameters

Header parameters page anchor
  • api-version string Required

    The requested API version

    Value: 11.0

Request body

Request body page anchor
  • planId string Required
    Min Length: 0
    Max Length: 18
  • planYrStartDte string<date-time> Required
  • planYrEndDte string<date-time> Required
  • acctTypeCde string Required
  • targetAcctTypeCde string Required
  • targetPlanId string Required
    Min Length: 0
    Max Length: 18
  • targetPlanYrStartDte string<date-time> Required
  • targetPlanYrEndDte string<date-time> Required
  • fundRolloverTypeCde enum
    Possible values: None Primary Secondary
  • rolloverDte string<date-time>
  • planRolloverOptions integer<int32>
  • rolloverEligDteType enum
    Possible values: NotSet FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanAccountEligDate
  • autoDepositStartDteType enum
    Possible values: None FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanStartDate SourcePlanAccountEligDate
  • rolloverAmt number<double>
  • rolloverRate number<double>
  • individualRolloverAmt number<double>
  • individualRolloverRate number<double>
  • trackingNumber string
  • minimumRolloverAmountofFund number<double>
  • maxRolloverAmtofFunds enum
    Possible values: AllFunds Cap Percentage CapAndPercentage
  • planId string Required
    Min Length: 0
    Max Length: 18
  • planYrStartDte string<date-time> Required
  • planYrEndDte string<date-time> Required
  • acctTypeCde string Required
  • targetAcctTypeCde string Required
  • targetPlanId string Required
    Min Length: 0
    Max Length: 18
  • targetPlanYrStartDte string<date-time> Required
  • targetPlanYrEndDte string<date-time> Required
  • fundRolloverTypeCde enum
    Possible values: None Primary Secondary
  • rolloverDte string<date-time>
  • planRolloverOptions integer<int32>
  • rolloverEligDteType enum
    Possible values: NotSet FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanAccountEligDate
  • autoDepositStartDteType enum
    Possible values: None FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanStartDate SourcePlanAccountEligDate
  • rolloverAmt number<double>
  • rolloverRate number<double>
  • individualRolloverAmt number<double>
  • individualRolloverRate number<double>
  • trackingNumber string
  • minimumRolloverAmountofFund number<double>
  • maxRolloverAmtofFunds enum
    Possible values: AllFunds Cap Percentage CapAndPercentage
  • planId string Required
    Min Length: 0
    Max Length: 18
  • planYrStartDte string<date-time> Required
  • planYrEndDte string<date-time> Required
  • acctTypeCde string Required
  • targetAcctTypeCde string Required
  • targetPlanId string Required
    Min Length: 0
    Max Length: 18
  • targetPlanYrStartDte string<date-time> Required
  • targetPlanYrEndDte string<date-time> Required
  • fundRolloverTypeCde enum
    Possible values: None Primary Secondary
  • rolloverDte string<date-time>
  • planRolloverOptions integer<int32>
  • rolloverEligDteType enum
    Possible values: NotSet FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanAccountEligDate
  • autoDepositStartDteType enum
    Possible values: None FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanStartDate SourcePlanAccountEligDate
  • rolloverAmt number<double>
  • rolloverRate number<double>
  • individualRolloverAmt number<double>
  • individualRolloverRate number<double>
  • trackingNumber string
  • minimumRolloverAmountofFund number<double>
  • maxRolloverAmtofFunds enum
    Possible values: AllFunds Cap Percentage CapAndPercentage
  • planId string Required
    Min Length: 0
    Max Length: 18
  • planYrStartDte string<date-time> Required
  • planYrEndDte string<date-time> Required
  • acctTypeCde string Required
  • targetAcctTypeCde string Required
  • targetPlanId string Required
    Min Length: 0
    Max Length: 18
  • targetPlanYrStartDte string<date-time> Required
  • targetPlanYrEndDte string<date-time> Required
  • fundRolloverTypeCde enum
    Possible values: None Primary Secondary
  • rolloverDte string<date-time>
  • planRolloverOptions integer<int32>
  • rolloverEligDteType enum
    Possible values: NotSet FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanAccountEligDate
  • autoDepositStartDteType enum
    Possible values: None FundRolloverDate TargetPlanStartDate SourcePlanEndDatePlusOne SourcePlanStartDate SourcePlanAccountEligDate
  • rolloverAmt number<double>
  • rolloverRate number<double>
  • individualRolloverAmt number<double>
  • individualRolloverRate number<double>
  • trackingNumber string
  • minimumRolloverAmountofFund number<double>
  • maxRolloverAmtofFunds enum
    Possible values: AllFunds Cap Percentage CapAndPercentage

Response

Response body

Response body page anchor
  • TrackingNumber string
  • ErrorCode integer<int32>
  • ErrorDescription string
https://development.api.wealthcare.com/system/Services/Plan/BenefitPlanRolloverSetting/{tpaId}/{employerId}
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
The requested API version

Response

Response Headers 
No response yet.
Response Body 
No response yet.

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...