Administrative APIs | REST

Version:
Download Open API Specification

Get Flex Account Life Events

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

Returns a list of all qualifying life events for a specified 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.

  • ExtensionData object
  • TpaId string

    A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.

  • EmprId string

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • SocSecNum string

    Unique identifier for the employee.

  • PlanId string

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

    Min Length: 0
    Max Length: 18
  • AcctTypeCde string

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

  • PlanYrEndDte string <date-time>

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

  • PlanYrStartDte string <date-time>

    (YYYMMDD)Date that funds are available for services.

  • FlexAcctId string

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

  • array <object>
    • TpaId string

      A unique identifier for your administrator instance, generated by WCA when the instance was first set up.

    • EmprId string

      Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

    • SocSecNum string

      Unique identifier for the employee.

    • PlanId string

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

    • PlanYrEndDte string

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

    • PlanYrStartDte string

      (YYYMMDD)Date that funds are available for services.

    • AcctTypeCde string

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

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

    • LifeEventDte string

      (YYYYMMDD) - The life event date.

    • LifeEventCde string

      Life event type code associated with the employee account coverage period.

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

    • CoverageTierId string

      Coverage Tier designator (Ex.: Single, Family, etc.) for the employee account. ID of coverage tier to which this employee account is associated.

    • LifeEventCreatedBy string

      Returns the admin/user/function who created the coverage period.WCA Admin user