Administrative APIs | REST

Version:
Download Open API Specification

Add Flex Account Life Event

https://api.wealthcare.com/system/Services/Employee/Account/FlexAccountLifeEvent/{tpaId}/{employerId}/{employeeId}

This is used to add a qualifying life event to an account.

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

  • employeeId string Required

    Unique identifier for the employee.

  • planId string

    Unique identifier that distinguishes this plan from all others you administer.

    Min Length: 0
    Max Length: 18
  • accountTypeCode string

    Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)

  • planYearEndDate string <date-time>

    (YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.

  • planYearStartDate string <date-time>

    (YYYMMDD)Date that funds are available for services.

  • annualElection number <double>

    Annual Election Amount/Goal Amount for the Life Event (new goal amount = full amount, not difference from old to new goal) Note: Since this is an amount field anything > 0 is valid value

  • lifeEventDate string <date-time>

    (YYYYMMDD) - Date of new life event

  • lifeEventCde string

    If an alpha numeric value (no greater then 4) is entered as a value, we will verify that the code exists. If Yes process accordingly. If No return an error. If the field is left blank, we will default to a blank value and process accordingly.

  • coverageStatus enum<string>

    0 = Active 1 = Suspended (no transactions permitted unless using an “override”).

    Possible values: None Suspended Delete
  • flexAcctId string

    A unique identifier for the employee's account, generated by WCA when the account was first set up.

  • individualAmount number <double>

    Annual election amount available for the employee to spend in the plan period for an individual/family HRA. It is ignored by prefunded & payroll plans. Note 1: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is for the employee, who can spend up to the family amount.

  • coverageTierId string

    The coverage tier ID provided must match a coverage tier ID set up for the employer group in WCA.

  • productId string

    The product partner product ID sets the service charge model and other attributes of the account. The product partner product ID provided must be a valid product ID as configured for the admin relationship ID assigned to the employee plan.

  • accountSegmentID string

    The account segment ID you wish to assign to the account.