Overview
Defined Contribution planBalance (DCpB) provides the ability to view balance information for a specific user. The DCpB API can return eligible data from one or more plan(s) based on user eligibility.
Use Cases
Users can access and view the following information:
Plan Balance
Opening Balance
Rolling 12-Month Balance
User Gain/Loss Amount
Rate of Return
Vested Balance
Investment Fund Election
Contribution Election
User Status in the Plan
Employer Match
Composition of a Form
Please refer to the sample return value of the “GET Return view metadata”, for a sample metadata JSON describing a view.
Operations Guide
You will find operations for the following:
definedContributionPlans – Provides data that includes plan rules as well as user balances in the form of plan balance, opening balance, rolling 12-month balance, user gain/loss amount, rate of return, etc. Gives data for the contribution election and future investment elections, employer match data along with plan match rules. Additionally, it provides balances' data break-up based on account and funds.
planAccountBalances – Returns user balances divided into different accounts and it gives information like account balance, vested balance, and vested percentage in each of the accounts.
planAccountGroup – Returns the plan balance information associated with a group of accounts. This object also includes future investment elections associated with the account group.
planAssetFundTable - Displays user plan balances divided into asset classes. It also shows fund level details for the funds that are associated with an asset class. The cumulative fund balance will equal the asset class balance.
planFundTable – Displays fund level details for the funds that are associated with an asset class.
currentContribution - Provides data that includes contribution rules as well as user contribution election related details for the plan like next escalation date, total contribution percentage, total contribution per pay check amount, etc.
contributionRates - Provides contribution election data for users enrolled in a plan.
employerMatch - Contains information associated with the users employer match data with plan match rules.
matchTiers - Contains the employer match tier rules defined for a specific plan.
contributionRatesMatch - Provides a list of all contribution rates that are included in the employer match calculation for the plan.
planFutureInvestmentElections - Stores plan investment election information.
planInvestmentElectionFundTable - Provides investment election data for users enrolled in a plan with the fund election percentage.
planAutoRebalanceElections - Displays plan auto rebalance election information like next auto rebalance date and chosen auto rebalance frequency for a user.
planParticipationStatuses - Returns user plan participation status. Determines if user is eligible to participate in a plan or if user is actively participating in a plan. Participation means a user has enrolled in a plan, has made investment choices, and can manage their plan investments ongoing.
Error Handling
hasNoPlanBalance - Returns if a request is made for a user who is not enrolled in a plan.