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.

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

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

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

(YYYMMDD)Date that funds are available for services.

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

0 = Active 1 = Void a coverage period Note: When submitting '1' (void), coverage period start date and coverage period end date must be equal.

Date coverage period starts. Coverage period start date cannot be before another coverage period's end date. To add a coverage period: Send the coverage period start date and leave the coverage end date blank unless you know the end date of the coverage period. To indicate one day of coverage period: Send the coverage period start date and coverage period end date as the same date. Coverage status should be submitted as ‘0’ (active). To update a coverage's end date: Provide the coverage period start date and the coverage period end date, and WCA will update the end date of the coverage period. To 'terminate' a coverage period: Once the coverage period ends, provide the coverage period start date in addition to the coverage period end date. Coverage status should be submitted as '0' (active). Note: WCA considers the coverage period end date as an active date for claims. To change a coverage period start date: You must first void the coverage by sending a SetHealthCareCoveragePeriod request to set the coverage period start date equal to the coverage period end date and coverage period status submitted as '1' (void). Then submit a second SetHealthCareCoveragePeriod request with the new coverage start date.

Date coverage period ends. This field may be left blank if the coverage period has not ended for the employee. Coverage period end date is the last day for which the employee can have claim dates of service processed. For example, if coverage end date of 4/30 is provided, then claims with dates of service up to and including 4/30 are eligible under this coverage period.

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

Provide the subgroup ID coinciding with the employee's coverage period for this account type. The subgroup ID must match a subgroup ID setup for the group via the FQ record or through the user interface for this employer. This subgroup drives benefits during this coverage period if the plan has subgroup benefits configured. If subgroup

Provide the account segment ID coinciding with the employee's coverage period for this account type. The account segment ID must match an account segment ID setup for the group via the FV record or through the user interface for this employer. This account segment ID is used for reporting and transaction settlement. If segment is not provided, then no segment will be associated with the coverage period. If updating an existing coverage period that has a subgroup and the subgroup is blank, then no subgroup will be associated to the coverage period once updated. If segment is not provided on the import template, then no segment will be assigned to the coverage period even if one was assigned previously.

A 4-character code to indicate the type of change being made. No functionality is dependent upon this field as it is only for display purposes. It displays with the coverage period for customer service.

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.

The Individual Amount is the prefunded amount for employee or dependent’s HRA amount.

If fixed employer funding is enabled for the plan/subgroup, then this field will be ignored.