Participant APIs | REST

Version:
Download Open API Specification

Get Account Details

https://api.wealthcare.com/participant/services/participant/accounts/details/{tpaId}/{employerId}/{participantId}

Get Participant Account Details - Includes account details, account balances, grace period dates, deductible status, display overrides and fund rollover information and more. You may also need to call other services to obtain additional information about accounts, such as Get Account Service Categories, Get Balance Due Amounts, Get Account Interval Tracker Details (for plans with monthly, quarterly or calendar year limits)

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

  • participantId string Required

    Participant Id

  • Accept-Language enum<string>

    Specify the participant’s language preference. The corresponding response will then return text/string values in the language specified, defaulting to English if not specified or if an invalid value is sent. Note: If Spanish or French is requested and a particular field does not have a translated value (Spanish or French), then the English text value will be returned.

    Possible values: es en fr
  • flexaccountkey integer <int32> Required

    A system generated ID for the benefit account being retrieved

  • accttypecode string Required

    The account type code for the benefit account

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

  • HsaAdvEligibility boolean

    Flag Used to identify the accountholder is eligible for HSA Advance: 1 - Eligible for HSA advance, 0 - Ineligible for HSA advance. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • CarryoverAmountCustomLabel string

    This item is configured on the Employer Plan in WCA. Use this custom label with the Carryover Amount provided on this service.

  • ExpiringAmountCustomLabel string

    This field is related to the carryover feature, if enabled. Expiring Amount Custom Label - this label is configured on the employer plan edit page.

  • CarryoverPeriodCustomMessage string

    This item is configured on the Employer Plan in WCA. Use this message to help explain to the participant how carryover works for this plan.

  • ExpiringAmount number <double>

    This field is related to the carryover feature, if enabled. The amount that will not carry over after the carryover period ends

  • RolloverBalance number <double>

    Total amount rolled over from prior year account to current year less any amount that rolled out.

  • CoverageContinuation boolean

    Flag to identify if plan has coverage continuation or not. Coverage Often called "Spend Down" - when enabled this option allows the participant to submit for dates of service after the termination date through the plan end date. 1 - When coverage continuation is set, 0 - When coverage continuation is not set

  • SourceFlexAcctKey integer <int32>

    Identifier for the flex account from which funds rolled or will roll to this account.

  • GracePeriodCarryoverBal number <double>

    Balance which is not spent within the plan year and will be carried over for the next year.

  • DeductibleMetDte string <date-time>

    Date on which deductible is met. Date will be in YYYYMMDD format

  • GracePeriodDeductibleStatus integer

    An integer indicating the grace period deductible status: 0 - No Deductible - This plan does not track whether a deductible is met or not., 1 - Deductible Not Met - the plan tracks a deductible, but the deductible has not been met. SCCs and MCCs are limited based upon plan setup., 2- Deductible Met - the deductible has been met (opens up eligible MCCs or SCCs for the participate - i.e., plan becomes 'full purpose'), 4 - No Deductible Limited - means the plan does not track a deductible and this account is a limited purpose account

  • GracePeriodDeductibleMetDte string <date-time>

    Date on which grace period deductible is met. Date will be in YYYYMMDD format. The system tracks whether a participant met their deductible in the grace period since the grace period is usually a new deductible year for the participant. If this date is not set, then the deductible for the new deductible year has not yest been met. Note: Flagging the deductible as met during the prior year's grace period also updates the deductible met status for the current year.

  • PreTaxAmtPtd string

    When the pretax limit feature is enabled, this will be the pre-tax amount paid to date.

  • PostTaxAmtPtd string

    When the pretax limit feature is enabled, this will be the post-tax amount paid to date (i.e., the amount in excess of the pre-tax limit set).

  • PlanOptions2 integer <int64>

    A bit field used to indicate additional plan level options. None = 0, Reimburse Amounts Applied to Deductible Account = 1, Automatically issue a card to dependents = 2, Auto-substantiate transactions using a merchant list = 4, Automatically issue a card to spouse only = 8, Hide this plan from participant portal and mobile = 16, Prevent claims from being entered for this plan = 32, Use Real Time Funding for this plan? = 64, Users allowed to edit amount when adding/editing Life event coverage tier = 128, For HSA accounts, admin/employer will not provide disclosure = 256, Allow employees to set External Deductible = 512, Plan Not Ready For Enrollment = 1024, Prevent Election Reduction = 2048, Alegeus use only = 4096, Prevent deductible from increasing = 8192, Future use = 16384, Allow partial payroll deposits = 32768, Apply Card Suspension Threshold Logic = 65536, Hide employer contribution information from participant = 131072, Show plan usage summary to participant = 262144, Hide deductible status messaging from participant = 524288, Enable HSA Advance Funding = 1048576, Enable Account Dormancy = 2097152, Show custom plan descriptions within coverage period details section of member portal = 4194304, Dependent care continuation is enabled = 8388608, Automatically offset balance due via FX claims = 16777216, Carryover enabled = 33554432, Require enrollment in next year account to be eligible for carryover = 67108864, Future use = 134217728, prevent participants from linking dependents to accounts under this plan = 268435456, prevent administrator users from linking dependents to accounts under this plan = 536870912, Future use = 1073741824, Dormancy's No Enrollment Agent has processed this plan after the plan ends = 2147483648, Deadline for claims to apply to current tax year vs. next tax year enabled= 4294967296, Plan uses date of service for tax year deadline = 8589934592, Plan uses reimbursement date for tax year deadline = 17179869184, Future use = 34359738368, Future use = 68719476736, Future use = 137438953472, Pre-tax limit enabled = 274877906944, Do not allow Participants to set Autopay preference = 549755813888, Hide Payroll Info and Charts from participant = 1099511627776, Hide Deadlines Chart and Data from participant = 2199023255552, Hide family details from participant = 4398046511104, Hide Coverage Period Details from participant= 8796093022208, Hide Tax Related info from participant = 17592186044416, Do not allow participants to set auto pay provider preference = 281474976710656, VestingEnabled = 562949953421312, PlanRenewalCommunicationSent45DaysBefore = 1125899906842624, PlanRenewalCommunicationSent30DaysBefore = 2251799813685248, HideDollarAmount = 4503599627370496

  • HidePayrollInfoAndCharts boolean

    Flag to identify if payroll info should be presented to participants. This flag corresponds to "Hide Payroll Info and Charts?" on the edit plan screen. This may be ignored if you are not displaying payroll info information on your UI. 1 - Hide payroll info and charts, 0 - Do not hide payroll info and charts

  • HideDeadlinesChartAndData boolean

    Flag to indicate if deadlines chart and data should be displayed to the participant. The flag is configured in the "Hide Deadlines Chart and Data?" section of the edit plan screen. If you are not creating a deadlines chart on your UI, this may be ignored. 1 - Hide deadlines chart and data, 0 - Do not hide deadlines chart and data

  • HideFamilyDetails boolean

    Flag to identify if family details (i.e., who is enrolled in the account from the family) should be presented to participants. This corresponds to "Hide Family Details?" on the edit plan screen. This may be ignored if you are not displaying family detail information on your UI. 1 - Hide family details, 0 - Do not hide family details

  • HideCoveragePeriodDetails boolean

    Flag to indicate whether this account should display the coverage period details to the participant. The flag is configured in the “Hide Coverage Period Details?” section of the edit plan screen. 1 - Hide coverage period details, 0 - Do not hide coverage period details

  • HideTaxRelatedInfo boolean

    Flag to identify if tax info should be presented to participants. This corresponds to "Hide Tax Related info?" on the edit plan screen. This may be ignored if you are not displaying tax info information on your UI. 1 - Hide tax related info (post tax amount paid / pre-tax amount paid), 0 - Do not hide tax related info. This feature “Tax Limits and Deadlines” must be enabled by Alegeus for an Administrator instance in order to use this feature.

  • CarryoverEnabled boolean

    0 - carryover is not enabled on the plan, 1 - carryover is enabled on the plan

  • CarryoverEligibility boolean

    0 - account is not eligible for carryover, 1 - account is eligible for carryover

  • CarryoverMinAmount number <double>

    The minimum available balance amount needed to be eligible for carryover

  • RolloverInLabel string

    If carryover is configured, then a label is provided in this field to use in place of "rollover in," which we'd recommend as a standard label.

  • RolloverOutLabel string

    If carryover is configured, then a label is provided in this field to use in place of "rollover out," which we'd recommend as a standard label.

  • RolloverInAmt number <double>

    The amount of funds credited to this account from another account based on Primary or Secondary Rollover rules set for the source account.

  • RolloverOutAmt number <double>

    The amount of funds that were debited from this account based on Primary or Secondary Rollover rules set for this account.

  • InterestApplicable boolean

    Flag used to identify if the account is a retiree interest bearing account.

  • InterestEligible boolean

    Flag used to identify if the account is eligible for interest.

  • InterestPaidPlanToDate number <double>

    Amount of interest paid; plan to date

  • VestingPercentage number <double>

    The vesting percentage of a retiree interest bearing account. Will be null if plan/account does not support vesting.

  • HighYieldEligibility boolean

    Flag to identify if the account has High Yield interest rates available.

  • HighYieldOptIn boolean

    Flag to identify if the account holder has opted into High Yield.

  • CoveragePeriodInfo array <object>

    Collection of Coverage Period information

    • CustomPlanDescription string

      The Custom Plan Description as provided on the Employer Plan.

    • ShowCustomPlanDescriptionInCoveragePeriods boolean

      Indicates whether the custom plan description should be displayed with coverage periods.

    • LifeEventCode string

      Code for life events enabled in coverage period

    • StartDate string <date-time>

      Date when coverage period starts

    • EndDate string <date-time>

      Date when coverage period ends

    • AnnualElection number <double>

      The annual election or allocation for the coverage period.

    • DispPTD number <double>

      Amount disbursed periodically for this account

    • DisbBal number <double>

      The amount of funds available for claims in this coverage period less preauth hold (i.e., AvailBal-PreAuthHold= DisbBal)

    • PreauthBal number <double>

      Amount on hold for the account.

    • AvailBal number <double>

      The amount of funds available for claims in this coverage period, not including preauth hold.

    • LifeEventDesc string

      Description of life events in coverage periods

    • SuspendActivity boolean

      Indicates whether the coverage period is a gap in coverage (true) or not. Claims cannot be submitted for reimbursement is the date of service is during a gap in coverage.

  • Spent number <double>

    The amount spent during the plan year for this account.

  • RemainingBalance number <double>

    This is the balance that, at this point in time, would be used by the rollover rules (max amount or percent) to determine what would rollover to the target account. If the source plan is an Individual/Family HRA, this will be the rollover family available balance minus the rollover family preauth balance. For all other plans, it is the available balance minus the preauth hold.

  • OnHoldAmount number <double>

    An amount that was previously approved for reimbursement, but the balance was not sufficient to pay the full amount. As future deposits are made to this account, this amount of those deposits is automatically reimbursed and the on-hold amount total is reduced.

  • BalanceDue number <double>

    The amount a participant has overspent from this account, including reversed reimbursed claims and ineligible card transactions. If offset feature and online repayment is enabled, then the system will offset the balance due with claims and/or the participant can repay this amount, respectively.

  • IsEmprPlanMonthlyLimit boolean

    Indicates if "Spending Limit Period" on the Edit Plan screen is set to Monthly: 1 - account has a monthly spending limit, 0 - account does not have a monthly spending limit

  • MonthlyDepositLimit number <double>

    Maximum amount that can be deposited to this account during the spending limit period (While the label is "monthlydepositlimit," the system was upgraded to include additional frequency/interval periods at the plan level. The limit can be Monthly, Quarterly or Calendar Year. Use the Get Account Interval Tracker Details service to obtain the deposit and spending limit remaining for each interval period.

  • MonthlySpendingLimit number <double>

    Maximum amount that can be deposited to this account during the spending limit period. If the amount is -1 (null) and there is a monthly deposit limit, then the spending is capped at whatever has been deposited to the account during the interval. (While the label is “monthlyspendinglimit,” the system was upgraded to include additional frequency/interval periods at the plan level. The limit can be Monthly, Quarterly or Calendar Year. Use the Get Account Interval Tracker Details service to obtain the deposit and spending limit remaining for each interval period.)

  • EmprPlanAllowFundRollover boolean

    Flag to identify whether the plan allows fund rollover. 0 - fund rollover not allowed, 1 - fund rollover allowed

  • PrimaryFundRolloverDate string <date-time>

    Based on the primary fund rollover rules setup for the employer plan, this date is when funds will be deducted from this account and credited to the target account.

  • PrimaryFundRolloverAmount number <double>

    The maximum amount to rollover for an account not enabled with coverage tiers. Use this field only if coverage tiers are not enabled. If coverage tiers are enabled, then use the amount in the fund rollover collection.

  • PrimaryFundRolloverRate integer <int32>

    The rate to use to determine the percent of remining funds are to rollover for accounts with coverage tier based fund rollover. Use this field only if coverage tiers are not enabled. If coverage tiers are enabled, then use the amount in the fund rollover collection.

  • PrimaryFundsRolloverAccountPlanStartDate string <date-time>

    If only primary rollover is used (and not secondary), this field is the plan year start date for the target account for primary fund rollover. If secondary rollover is used, PyFundsRolloverAccountPlanStartDate should be used for the primary target account (I.e., if PyFundsRolloverAccountPlanStartDate is populated, use that value instead of this one).

  • PrimaryFundsRolloverAccountPlanEndDate string <date-time>

    If only primary rollover is used (and not secondary), this field is the plan year end date for the target account for primary fund rollover. If secondary rollover is used, PyFundsRolloverAccountPlanEndDate should be used for the primary target account (I.e., if PyFundsRolloverAccountPlanEndDate is populated, use that value instead of this one).

  • PrimaryFundRolloverRule integer

    Based on the primary fund rollover rules setup for the employer plan, this value indicates how much will rollover on the rollover date: 0 = No funds will rollover, 1 = All remaining fund, 2 = a % of remaining funds, 4 = a % of remining funds up to a set cap 8 = the lesser of the remaining funds or the set cap amount

  • PyIndividualRolloverAmount number <double>

    When secondary rollover is configured, and if the source plan is an Individual/Family HRA, this will be the maximum amount (i.e., cap) of individual funds (if configured for primary rollover) that will rollover. This field can be ignored for other plan types.

  • PyIndividualRolloverRate integer <int32>

    If the source plan is an Individual/Family HRA, this will be the percentage of remaining funds in the account that may be rolled over to the target account (if configured for primary rollover) for each Individual's account. This field can be ignored for other plan types.

  • PrimaryFundsRolloverAccount string

    Account type code for the target account for primary fund rollover (i.e., the account type code where funds will rollover)

  • IsPrimaryRollover boolean

    Indicates if this account has primary fund rollover enabled for the account, based on configuration for Fund Rollover: 1 - account is primary rollover, 0 - account is not primary rollover

  • SecondaryFundRolloverDate string <date-time>

    After secondary rollover a secondary rollover method is allowed. On this date, secondary rollover will occur.

  • SecondaryFundRolloverAmount number <double>

    The maximum amount to rollover during secondary rollover for an account not enabled with coverage tiers. Use this field only if coverage tiers are not enabled. If coverage tiers are enabled, then use the amount in the fund rollover collection.

  • SecondaryFundRolloverRate integer <int32>

    The rate to use to determine the percent of remining funds are to rollover during secondary fund rollover for accounts with coverage tier based fund rollover. Use this field only if coverage tiers are not enabled. If coverage tiers are enabled, then use the amount in the fund rollover collection.

  • SecondaryFundsRolloverAccount string

    The target account for secondary fund rollover of funds from this account.

  • IsSecondaryRollover boolean

    Indicates if the account has secondary rollover enabled, based on configuration for Fund Rollover. Note: Secondary runs after primary rollover has been completed). 1 - account is secondary rollover, 0 - account is not secondary rollover

  • PyFundsRolloverAccountPlanStartDate string <date-time>

    When secondary rollover is configured, this will be the plan year start date for the target account for primary fund rollover. If secondary rollover is not configured/this value is not populated, then use PrimaryFundsRolloverAccountPlanStartDate.

  • PyFundsRolloverAccountPlanEndDate string <date-time>

    When secondary rollover is configured, this will be the plan year end date for the target account for primary fund rollover. If secondary rollover is not configured/this value is not populated, then use PrimaryFundsRolloverAccountPlanEndDate.

  • SecondaryFundRolloverRule integer

    Based on the secondary fund rollover rules setup for the employer plan, this value indicates how much will rollover on the rollover date: 0 = All remaining fund, 1 = a % of remaining funds, 4 = a % of remining funds up to a set cap 8 = the lesser of the remaining funds or the set cap amount

  • SecondaryIndividualRolloverAmount number <double>

    After primary rollover a secondary rollover method is allowed. If the plan has Individual and Family Amounts, this is the secondary rollover amount for each family member.

  • SecondaryIndividualRolloverRate integer <int32>

    After primary rollover a secondary rollover method is allowed. If the plan has Individual and Family Amounts, this is the percentage of remaining funds for each family member individual amount that may be rolled over to the target account.

  • SdFundsRolloverAccountPlanStartDate string <date-time>

    The plan start date for the account to which funds will rollover through the secondary rollover method (target account plan start date). If this value is populated, then use this value and not the PrimaryFundsRolloverAccountPlanStartDate.

  • SdFundsRolloverAccountPlanEndDate string <date-time>

    The plan end date for the account to which funds will rollover through the secondary rollover method (target account plan end date). If this value is populated, then use this value and not the PrimaryFundsRolloverAccountEndStartDate.

  • SdIndividualRolloverAmount number <double>

    After primary rollover a secondary rollover method is allowed. If the plan has Individual and Family Amounts, this value is the percentage of remaining family amount funds that may be rolled over to the target account. If this amount is provided, then it should be used rather than SecondaryIndividualRolloverRate.

  • SdIndividualRolloverRate integer <int32>

    After primary rollover a secondary rollover method is allowed. If the plan has Individual and Family Amounts, this value is the percentage of remaining family amount funds that may be rolled over to the target account. If this amount is provided, then it should be used rather than SecondaryIndividualRolloverRate.

  • EmprPlanDeductmanagerEnabled boolean

    Flag to identify whether deductible manager is enabled at Plan level. 0 - Deductible manager is not enabled, 1 - Deductible manager enabled

  • Deductible number <double>

    Deductible Rules dependent field. This field provides the total deductible based on "Deductible Rules" configured for the plan. Deductible rules allow multiple levels of cost share. This amount can only be provided if last rule is 100% plan reimbursement.

  • DeductibleApplied number <double>

    Deductible Rules dependent field. The amount of the Deductible Rules deductible applied.

  • DeductibleRemaining number <double>

    Deductible Rules dependent field. Remaining deductible rules amount (Deductible - Deductible applied).

  • AccountStartDate string <date-time>

    This date is the account's start date - this date should be used as the participant's effective date for the account - dates of service prior to this date are not eligible for reimbursement.

  • AccountEndDate string <date-time>

    This will be the account's termination date if a termination date is populated; otherwise, this will be the plan end date. Dates of service after this date are not eligible for reimbursement.

  • CurrentDate string <date-time>

    Today's date. May be used to create a chart showing where today is in relation to the participant's account start and end dates.

  • SpendingLastDate string <date-time>

    This will be the date of the last day the participant can spend any money from this account - If an account has a grace period, this date is inclusive of the grace period. This date may be the earlier than plan end or grace if the participant terminated earlier.

  • SubmitClaimsLastDate string <date-time>

    This date is the latest date a claim with an eligible date of service can be provided. It is generally the plan end date + a period for late claim submission. If an employee terminated early, then this date will be the employee's termination date plus the employee run-out period set for the employer plan.

  • EligDte string <date-time>

    This date is the employee's eligibility date. It may be earlier than the account's effective date or could be null. This date is stored at the employee level.

  • AccountDisplayOptions integer

    Collection of account display options

  • AccountInfo array <object>

    Collection of account info

    • Status integer

      The Employee Account Status: 1 = New, 2 = Active, 3 = Temp Inactive, 4 = Permanently Inactive, 5 = Terminated

    • EmpeFlexAcctStatus integer

      The Employee Account Status: 1 = New, 2 = Active, 3 = Temp Inactive, 4 = Permanently Inactive, 5 = Terminated, 6 = Enrollment

    • DepFlexAcctStatus integer

      The Dependent Account Status: 1 = New, 2 = Active, 3 = Temp Inactive, 4 = Permanently Inactive, 5 = Terminated

    • DepStatus integer

      The Dependent Status: 1 = New, 2 = Active, 3 = Temp Inactive, 4 = Permanently Inactive, 5 = Terminated

    • FirstName string

      First name of employee or dependent, if IsDep = True.

    • Initial string

      Initials of employee or dependent, if IsDep = True.

    • LastName string

      Last name of employee or dependent, if IsDep = True.

    • IndividualAmount number <double>

      If the account is an embedded DTR or Individual/Family HRA, then this amount is the allocation provided to the employee or dependent.

    • AdditionalDeposits number <double>

      These deposits include amounts deposited to the account as an "other/special deposit" or due to fund rollover. This amount increases the amount available to spend without changing the Annual Election for prefunded plans or the Contributions YTD for Payroll funded account types.

    • Payments number <double>

      The amount spent by the employee. If this is an embedded DTR or Individual/Family HRA, then this amount is the individual amount spent for the employee or dependent

    • Balance number <double>

      For most accounts, this is the current balance available to spend for the account. This balance only displays if IsDep is false unless the plan is a DTR or HRX plan: If this is an embedded DTR or Individual / Family HRA, AND is DEP is true, then this is the Dependent Accounts individual amount balance. If this is an embedded DTR or Individual / Family HRA, AND is DEP is False, then this is the employee's individual amount balance.

    • IsDep boolean

      Flag to identify whether Dependent is available or not
      1 - Yes
      0 - No

    • FlexAcctKey integer <int32>

      Unique identifier for the flex account (this value will be the same for each dependent)

    • EmpeRelation integer

      0 = Unknown, 1 = Spouse or Common Law Spouse, 2 = Child, 3 = Domestic Partner, 4 = Other

  • AccountPayRollInfo object
    • PayrollCycle integer

      Indicates the payroll cycle for an account

    • EmployeePPPContribution number <double>

      Employee Pay Per Period Contribution amount that is set in the system for this account

    • EmployerPPPContributionsAmount number <double>

      Employer Pay Per Period Contribution amount that is set in the system for this account

    • ContributionsYTD number <double>

      Total Contributions Year to Date for an account (total of payroll deposits)

    • RemainingContributions number <double>

      Annual election minus contributions YTD

    • PlanStartDate string <date-time>

      The employer plan start date.

    • PlanEndDate string <date-time>

      The employer plan end date.

    • AutoDepositCalendarKey integer <int32>

      Unique identifier for auto deposit calendar

    • EmprAnnualElection number <double>

      Employer Annual election for the account

    • EmpeAnnualElection number <double>

      Employee Annual election for the account

  • AccountType string

    The account type code for the benefit account, such as FSA, HRA, FS2, HR2. Account types for HSA/VEBAs are specific to the HSA Custodian/Trust

  • IsHRA boolean

    Indicates whether the account is a 'full featured' HRA account. For HRA plans, is HRA indicates if the plan is a full feature HRA (i.e., HRX, HX*) If it is, then this account may also have Individual/Family balance details associated with it.

  • AccountTypeOptions integer <int64>

    For future use.

  • FundRolloverInfo array <object>

    A collect of data for fund rollover configuration

    • FundRolloverRule integer

      None = 0, AllFunds = 1, Cap = 2, Percentage = 4, CapAndPercentage = 8

    • PrimaryFundRolloverAmount number <double>

      The most that can rollover for this participant's account on the primary fund rollover date. For an Individual/Family amount HRX plan, this is the Family Amount, If the Primary Fund Rollover rule is set to 0, 1, or 4, then ignore this field. If set to 2, then this amount is the lesser of the account remaining balance or this amount will rollover. If set to 8, then this value workings in coordination with the Primary Fund Rollover Rate (Percent) see the PrimaryFundRolloverRate field description for how this option works.

    • PrimaryFundRolloverRate integer <int32>

      The Percentage amount for the rollover amount for the primary fund rollover. For an Individual/Family amount HRX plan, this is the Family Amount, If the Primary Fund Rollover rule is 4, then this percent of the participant's remaining balance on the fund rollover date will rollover. If the Primary fund rollover rule is 8 (Cap and Percentage), then this % of the remaining balance up to the PrimaryFundRollover Amount (i.e., cap) will rollover.

    • SecondaryFundRolloverAmount number <double>

      Secondary Fund Rollover runs AFTER primary fund rollover runs. This rollover process takes the remaining balance after primary fund rollover to determine how much to rollover. For an Individual/Family amount HRX plan, this is the Family Amount, Where are the Secondary Fund Rollover rules? The most that can rollover for this participant's account on the Secondary fund rollover date. If the Secondary Fund Rollover rule is set to 0, 1, or 4, then ignore this field. If set to 2, then this amount is the lesser of the account remaining balance or this amount will rollover. If set to 8, then this value workings in coordination with the Secondary Fund Rollover Rate (Percent) see the SecondaryFundRolloverRate field description for how this option works."

    • SecondaryFundRolloverRate integer <int32>

      The Percentage amount for the rollover amount for the secondary fund rollover. For an Individual/Family amount HRX plan, this is the Family Amount, If the Secondary Fund Rollover rule is 4, then this percent of the participant's remaining balance on the fund rollover date will rollover. If the Secondary fund rollover rule is 8 (Cap and Percentage), then this % of the remaining balance up to the SecondaryFundRollover Amount (i.e., cap) will rollover.

    • CoverageTierID string

      The coverage tier ID assigned to the last coverage period of the year the participant is aligned to. Example: "EMPLOYEE ONLY"

    • CoverageTierKey integer <int32>

      The system key for the coverage tier ID.

  • MccFlags integer <int64>

    A bit field used to indicate default MCC settings. Use PlanMccFlags to determine MCC settings that can be configured for this account. None = 0, Deductible = 1, Claims Crossover = 2, User defined flag 1= 4, User defined flag 2 = 8, User defined flag 3 = 16, User defined flag 4= 32, User defined flag 5= 64, User defined flag 6= 128, User defined flag 7= 256, User defined flag 8= 512, User defined flag 9= 1024, User defined flag 10= 2048, Deductible Use = 4096

  • PlanMccFlags integer <int64>

    A bit field used to indicate which plan level MCC settings are used by this account.None = 0, Deductible = 1, Claims Crossover = 2, User defined flag 1= 4, User defined flag 2 = 8, User defined flag 3 = 16, User defined flag 4= 32, User defined flag 5= 64, User defined flag 6= 128, User defined flag 7= 256, User defined flag 8= 512, User defined flag 9= 1024, User defined flag 10= 2048, Deductible Use = 4096

  • PlanExtOptions integer <int64>

    A bit field used to indicate online enrollment plan options. You may use these options to drive an online enrollment experience for your participants. None = 0, Eligible for Online Enrollment = 1, Allow Participant to Enter Annual Election = 2, Allow Participant to Enter Per Pay Period = 4, Allow Participant to Associate a Dependent to the Account = 8, Allow Participant to Add Broker ID = 16, Allow Participant to Choose Coverage Tier = 32, For HSAs, Allow Participant to Choose Product Partner Opt-in Status = 64, For HSAs, Allow Participant to Choose Product Partner Opt-in Status = 128, Allow Rolling Enrollment = 256, Allow Participant to Choose Claims Crossover Auto-Pay = 512, Medicare Primary Plan (this is from the Edit Plan screen, not the Online Enrollment Setup)= 1024, Auto Copy Active Employee Recurring Expenses = 2048, Auto Copy Employee Co-pays = 4096, This plan to pay providers if claims include a valid provider ID (this is from Edit Plan screen, not Online Enrollment Setup) = 8192, Participant default for auto pay (from Edit Plan screen, not Online Enrollment setup) = 16384, Allow enrolled participant to update per pay period election during open enrollment = 32768, Allow enrolled participants to update Coverage Tier during open enrollment dates = 65536, Allow Monthly Enrollment = 131072, Allow Mid-Year Enrollment = 262144, Future use only = 524288, Future use only = 1048576, Future use only = 2097152

  • InternalFlexAcctOptions integer <int32>

    Not recommended for client use. A bit field used to indicate what options are enabled for the account. None = 0, For Fixed Employer Funding, funding amount is available upon account creation= 1, Auto Link Dependents = 2, Override Perm Inactive Account = 4, Auto Pay Provider = 8, Linked DTR = 16, Future use = 32, Automatically Reinstate Card Suspension Activity = 64, Future use = 128

  • PlanDefaultAcctCrossover boolean

    Flag to identify whether claim crossover is enabled (i.e., can claims auto-pay from the account) at the plan level or not: 1 - claim crossover allowed, 0 - claim crossover not allowed

  • DPAccAllowManualClaims boolean

    Flag to identify if an HSA account may submit manual claims on WCP. Ignore for non-HSA accounts. 0 - manual claims not allowed, 1 - manual claims allowed

  • EnableAccountDormancy boolean

    Flag to identify whether dormancy enabled for the plan: 0 - Dormancy period is not enabled, 1 - Dormancy period enabled. Note: Dormancy is not a standard feature.

  • ShowCustomPlanDescriptionInCoveragePeriods boolean

    This field value indicates whether to display custom plan description in coverage period screens: 1- Display custom plan description, 0 - Hide custom plan description

  • CustomPlanDescription string

    This item is configured on the Employer Plan in WCA. This field will be blank if not set on the Employer Plan page. For VEBA/HSA account, if Custom description is not present on the plan page, then this field will display the description for the HSA Custodian (i.e., Product Partner Description).

  • IsAccountSuspended boolean

    Indicates if debit card activity is suspended for this account. 1 - debit card activity is suspended, 0 - debit card activity is not suspended

  • HsaAdvInitialAmt number <double>

    The annual election or prefunded amount designated for HSA Advance. It is the full amount available as an advance at the start of enrollment. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvUsedYtd number <double>

    The year-to-date amount which has been advanced to approve debit card purchases. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvRecoveredYtd number <double>

    The total year-to-date contributions used to offset amounts previously advanced (i.e., the participant used their advance and when payroll deposits are processed, the advance is offset / reduced. This amount is how much of their payroll deposits were used to 'pay back' the advanced amount). Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvOutstandingBal number <double>

    The amount advanced year-to-date which has not yet been recovered. (i.e., a participant used their advance and has not yet fully applied payroll deposits to that advance - this is the remaining advance to be 'paid back' by payroll deposits). HSA Advance Used - HSA Deposit Offsets = HSA Advance Outstanding Balance Amount. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvAvailBal number <double>

    Balance available in advance for immediate use by account holder - available on by using the debit card.

  • HsaAdvBeginDte string <date-time>

    Date when HSA advance is available for spending. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvEndDte string <date-time>

    Used to specify when employee no longer has access to HSA advance amount. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvDepositOffsetYtd number <double>

    The total year-to-date contributions deposited into the HSA cash balance that reduces the amount available for advance (as payroll deposits are received which increase a participant's HSA cash balance, the HSA Advance is reduced since the point of the Advance is to give participant's funds before contributions have been made). Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • TotalDisbursableBal number <double>

    Combined HSA cash balance and HSA advance available amount. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvAccessibilityFlag boolean

    Indicates if the accountholder currently has access to HSA Advance. It is set to false automatically if the accountholder is terminated or has an investment account balance. 1 - Hsa Advance accessible, 0 - Hsa Advance not accessible. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • HsaAdvNonAccessibilityReason integer <int32>

    This will be populated if HsaAdvAccessibilityFlag is 0. Provides the reason why the Advance is not available to the participant. None = 0, Advance Access Denied By Non-zero Investment Balance = 1, Advance Access Denied By Cardholder Account Status = 2, Advance Access Denied By Product Partner Acct Status = 4, Advance Access Denied By Cardholder Status = 8, Advance Access Denied By Plan Does Not Have Advance Enabled = 16, Advance Access Forcefully Denied = 32, Advance Access Denied As Advance Funding Setup Doesn't Exist = 64, Advance Access Denied Because Today's Date Not In Funding Period = 128, Advance AccessDenied By Funds Not Available (Available Balance < 0) = 256. Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • PriorYearHsaAdvInitialAmt number <double>

    For the prior year, the annual election or prefunded amount designated for HSA Advance. It is the full amount available as an advance at the start of enrollment.

  • PriorYearHsaAdvAvailBal number <double>

    HSA advance available balance from prior year. This is the prior year initial advance amount, minus contributions, HSA advance amount used, and ending transactions

  • PriorYearHsaAdvUsedYtd number <double>

    For the prior year, the year-to-date amount which has been advanced to approve debit card purchases.

  • PriorYearHsaAdvRecoveredYtd number <double>

    For the prior year, the total year-to-date contributions used to restore amounts previously advanced.

  • PriorYearHsaAdvOutstandingBal number <double>

    For the prior year, the amount advanced year-to-date which has not yet been recovered (i.e., paid back through payorll contributions).

  • PriorYearHsaAdvDepositOffsetYtd number <double>

    For the prior year, the total year-to-date contributions deposited into the HSA cash balance that reduces the amount available for advance.

  • FutureYearHsaAdvInitialAmt number <double>

    The total initial HSA Advance amount for the year/coverage period. This amount cannot exceed the IRS max contribution for the current tax year. Note: This amount does not affect the HSA cash balance., Note: Admin and Employer Plan must have HSA Advance feature enabled to setup HSA Advance for the participants.

  • RestrictParticipantClaimEntry boolean

    Identifies if the Participant is not allowed to enter a claim on the portal - as configured on the plan level.

  • ExtDeductibleStatus_2019_07 integer

    An integer indicating the status of the external. Deductible. Using this if using an API version greater than 10.1. Otherwise, use ExtDeductibleStatus. An integer indicating the grace period deductible status: 0 - No Deductible - This plan does not track whether a deductible is met or not., 1 - Deductible Not Met - the plan tracks a deductible, but the deductible has not been met. SCCs and MCCs are limited based upon plan setup., 2- Deductible Met - the deductible has been met (opens up eligible MCCs or SCCs for the participate - i.e., plan becomes 'full purpose'), 4 - No Deductible Limited - means the plan does not track a deductible and this account is a limited purpose account

  • HideDeductible boolean

    Flag to identify if the deductible status message should be presented to participants. This corresponds to "Hide external deductible prompt?" on the edit plan screen. This may be ignored if you are not displaying deductible status information on your UI. 1 - Hide deductible status message, 0 - Do not hide deductible status

  • PlanUsageDescription string

    If configured for the employer plan, this field includes Helpful description of plan usage to present to participants (corresponds to the "Plan Usage Summary for Mobile" field on the Edit Plan screen).

  • LinkFlexAccountKey integer <int32>

    A system generated key used to identify the account to which this account is linked.

  • IsLinkedDTR boolean

    For deductible tracking accounts (DT*, FD*), indicates if this account is linked to another plan: 1 - Linked to another plan, 0 - Not linked to another plan

  • IsQLE boolean

    Flag to identify whether Qualified life event feature is enabled for the account as configured on the plan. If true, then the account has coverage periods enabled. 1 - QLE enabled, 0 - QLE not enabled

  • EmpeCanSetDeductible boolean

    Flag to identify whether the employee can set external deductible status (met or not met) for account. (This setting is controlled at employer and employer plan level). 0 - participant cannot set external deductible status, 1 - participant can set external deductible status

  • ExtDeductibleStatus integer

    An integer indicating the status of the external deductible. Use this field if using version 10.1 or older; otherwise, use ExtDeductibleStatus_2019_07. No Deductible = 0, Deductible Not Met = 1, Deductible Met = 2

  • TransferAmountsAbove number <double>

    Used in conjunction with the MinAutoTransferAmount, this amount is the balance a participant wishes to maintain in their HSA. Any amounts above this amount can be automatically transferred to investments as soon as the MinAutoTransferAmount is met. Example: if theTransfer amounts above = 1000 and the MinAutoTransferAmount is $50, then the participant must have $1050 or more in order for any funds above $1000 to transfer to investments.

  • MinAutoTransferAmount number <double>

    For HSA accounts, this amount is the minimum amount that can be transferred through the auto-transfer to investments feature. For example, if the amount is 100.00, then a participant can only request to setup an auto-transfer of 100.00 or more.

  • DataPartnerAccountOptions integer <int32>

    Do not use. Indicates offerings available through the Product Partner - this information is not used by externally integrated systems and is used by Alegeus only.

  • ProductId string

    For an HSA or VEBA account, the Product ID is used to represent the custom program the participant is assigned to, as created by the HSA custodian. The product ID is tied to fee models, interest plans, and investment options used on the account.

  • HraType integer

    For an full featured HRA account type (HRX, HX1…HX9), this value indicates if it is an individual/family HRA (i.e., embedded) or a single fund HRA (i.e., umbrella). None = 0, Individual/Family Amt = 1, Single Fund Hra = 2

  • IsEmbedded boolean

    For a deductible account (DTR, DT*, and FD*), this field identifies the deductible type (specified when the plan was set up on the New Plan screen). 1 - Embedded, 0 - Not Embedded

  • PreauthBalance number <double>

    The amount of card authorizations + deposits on hold.

  • AvailBalance number <double>

    The available balance for the account - the amount before any card holds or deposit holds. For HSA Accounts, this is the "Current Balance".

  • AcctTypeClassCde integer

    An integer representing the account class the account belongs to FSA = 1, HRA = 2, HSA = 3,Deductible = 4, Other = 5, VEBA = 6, Transit = 7, Parking = 8, Retiree = 9, Dependent Care FSA = 10, LPFSA = 11, Payroll = 12, Premium = 13, Rollover = 14, Life Planning = 15, Lifestyle = 16, EE Care Card = 17, Connected Cash = 18, CMS OTC Medicare = 19, Medicare Advantage = 20, Parking Post Tax = 21, ICHRA Excepted Benefits = 22, Transit Post Tax Subsidy = 23, Wellness Incentives And Rewards = 24

  • AcctTypeClassDescription string

    The string description that corresponds to the AcctTypeClassCde (FSA, HRA, HSA, etc.)

  • HideDollarAmount boolean

    A plan level setting that controls the visibility of the contributions, coverage, and funding amounts for the participant. True - Hide dollar amount from participant. False - Display dollar amount to the participant.