Administrative APIs | REST

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

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

Unique identifier for the employee.

The requested API version

Update the deductible status for the grace period. 0 - No deductible 1 - Deductible not met 2 - Deductible met 4 - No deductible limited Note: Flagging the deductible as met during the prior year’s grace period also updates the deductible met status for the current year.

Must be populated when grace period deductible status is ‘2’ (deductible met). Date entered must be within the plan grace period dates Note: Flagging the deductible as met during the prior year’s grace period also updates the deductible met status for the current year.

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

Amount to be contributed by the employee automatically via the auto-deposit cycle. 0.00 is a valid amount.

Employee’s social security number. This field is used to identify the employee and is not changed within this method.

Required if this field is being used as the unique employee identifier. Either this field or SSN may be used for this purpose.

Amount to be contributed by the employer automatically via the auto-deposit cycle. 0.00 is a valid amount.

Unique identifier for the employer, generated when the employer was first set up. First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.

For prefunded plans this value is the annual election amount. For payroll funded plans that have an auto deposit schedule, this value should not be included. The system calculates this value automatically.

Indicates whether a prefunded amount was specified. True = Prefunded Amount specified in request False = Prefunded Amount was not specified in request

The plan ID of the account that the employee is assigned to.

Plan End Date the end date of the plan.

Plan Start Date the start date of the plan.

The auto deposit start date for this plan. Can be set for future start dates but not past. Note: If the flex account is setup for Auto Deposit, than this field is required. Otherwise, if a date is supplied, then the user receives a warning.

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.

YYYYMMDD. Date upon which the employee's account is no longer eligible for benefits. Date must be after employee Account Effective date.

Date the E-signature was received by the Administrator.

Valid for HSA accounts only. Returns the e-signature code. True or False

For Plans with Coverage Tiers enabled: If you do not provide a value for this field or if this field is not included on your template, then the Coverage Tier ID will default to the Coverage Tier specified as the default at the plan level. If a value is provided and it is a valid Coverage Tier ID within the Coverage Tier Type set for the plan, then the coverage tier is set for the participant's account

This amount indicates the maximum balance that is allowed for the Individual Amount within the participant's account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the Individual amount balance after funds have rolled into this account does not exceed the Fund Rollover Individual Balance Max specified. Only set for individual amount in an Individual/Family HRA account.

This amount indicates the maximum balance that is allowed in a Participant's account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the balance after funds have rolled into this account does not exceed the Fund Rollover Balance Max specified. For example, a participant’s balance is $600 in the target account and the Fund Rollover Balance Max is set to $1000. If the source fund has $750 of eligible funds to roll into this account, the rollover amount will be limited to $400 rather than rolling the full $750 so that the balance in the participant's account to which funds are being rolled is $1000. This amount is also used for the family amount in an Individual/Family HRA account.

If the value provided is: 0= No calendar. This participant will not be assigned to a payroll calendar and no corresponding auto-deposits are made. A valid Calendar ID = WCA assigns specified Calendar ID to the participant. Note: Calendar must be one allowed by the Employer as setup in the User Interface (UI) calendar employer filter section. Blank = Participant inherits the default calendar as specified for the plan. If the plan's Default Calendar ID is changed then this participant's Calendar ID is updated. Note: To have the employee account always use the plan default calendar, leave this field blank.

Date to begin fixed employer funding for the employee account. Only used if Fixed Employer Funding enabled for the plan and the funding is periodic (rather than upon account creation). If blank, and a funding calendar is setup, it will default to the greater of current date or plan year start date. If you need to allow for a catch up deposit set the date equal to the first deposit you wish to occur. WCA will update the date following each auto deposit to the deposit date + 1. If blank and a calendar is not setup, WCA defaults the value to funding the single deposit to the night of the account.

If plan is setup to allow claims cross over auto pay, this field specifies the default opt in value when assigning employees to benefit accounts. 0 = Opt Out (Default) 1 = Opt In Note 1: If not specified, then the employee will be assigned the plan default setting for Claims Crossover Opt-In Note 2: If the 'bypass the values sent in IC record file/employee account SOAP for new enrollments and updates' option is enabled on the admin options page in WCA, values for auto-reimbursement and autopay preferences are always ignored for new enrollment and updates.

0 = No Deductible 1 = Deductible Not Met (Default) 2 = Deductible Met Note: “No Deductible” can be used in conjunction with the WCA Deductible Manager feature. Use this to indicate the employee's deductible shouldn't be tracked by WCA. This will wipe out any deductible accumulations calculated by the participant and cannot be undone. Note 2: If using Deductible Manager, then only values of “0” or “1” can be specified. “1” would indicate to continue to allow WCA to track the deductible, while “0” would remove deductible accumulation.

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

This field is used when you want the employee to reenroll into a new account of the same Account Type Code, Plan ID, and Plan Start and End dates. The values to use are: False = (Default) Not to reenroll True = To Reenroll A new employee account will be created for the employee with a unique Account ID. The account effective dates must not overlap with the existing account.

Use this field to indicate the auto pay provider reimbursement setting on the employee account If not specified, and enrolling the participant into a plan using Auto Provider Pay, the employee will automatically inherit the default setting specified on the Benefit Plan. 0 = Pay Me (Default) 1 = Pay Provider

Employee annual election

Employer annual election

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.

The Product ID can only be specified for the employee account if the Product Partner allows Product IDs to be setup at the account level. If a Product ID is provided and the Product Partner does not allow product IDs to be set at account level, then an error should be provided Cannot set Product ID at account level for this account type.

Suspends debit card activity when there are ineligible/pending transactions 0 = False (Do not suspend debit card activity) 1 = True (Suspend debit card activity)

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

The subgroup ID you wish to assign to the account.