AI Assistant

Administrative APIs | REST

Version:
Download Open API Specification

Add Default Benefit Plan

https://development.api.wealthcare.com/system/Services/Tpa/{tpaId}/DefaulBenefitPlan

This endpoint allows you to add a default benefit plan for a specific TPA (Third Party Administrator) identified by the tpaId. It is typically used when setting up new benefit plans or updating existing ones to ensure compliance with organizational policies and employee needs.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • accountTypeCode string

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

  • convenienceFeeAmount number <double>

    Convenience amount charged for each POS transaction Only used if employee is paying the fee.

  • convenienceFeePayor enum<string>

    Determines who is paying the convenience fee.

    Possible values: None Tpa Employer Employee
  • gracePeriodEndDate string <date-time>

    Plan's run out date.

  • spendingLimitPeriod enum<string>

    Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.

    Possible values: None Month Year Quarter
  • spendingDepositAmount number <double>

    Maximum amount to be deposited, during the spending Limit period.

  • spendingTransactionAmount number <double>

    Maximum amount to be withdrawn, during the spending limit period.

  • maxTransactionAmount number <double>

    Maximum amount to be exchanged per transaction.

  • maxTotalAmount number <double>

    Maximum amount spent per account under the plan.

  • planYearStartDate string <date-time>

    Plan's start date.

  • planYearEndDate string <date-time>

    Plan's end date.

  • iiasSettings enum<string>

    Indicates if IIAS will be used on the plan.

    Possible values: NotUsed Disabled HealthEligibleTotal Specific
  • iiasOptions enum<string>

    Indicates which IIAS options will be enabled.

    Possible values: None Rx Vision Dental
  • defaultDepositCalendarId string

    Default auto deposit calendar ID for the plan.

  • allowPartialManualTransaction boolean

    Determins if partial manual transactions will be allowed.

  • hidePlanFromParticipant boolean

    Determines if this plan will be hidden from the participants on WCM or WCP.

  • restrictClaimsProcessing boolean

    Determines if claims processing will be restricted.