Employer Plan API | Administrative - SOAP

The Employer Plan Service provides employer plan functionalities such as reading, adding, updating, and deleting employers’ plan information.

Service Web Methods

The following is a list of methods that is provided by the Employer Plan Service.

AddEmployerPlan – Used to add an employer’s plan information.
DeleteEmployerPlan – Used to remove an employer’s plan.
UpdateEmployerPlan – Used to update an employer’s plan.
GetEmployerPlan – Used to retrieve an employer’s plan.
GetEmployerPlans – Used to retrieve all employers’ plans.
SetPlanPriority – Used to set plan priority for all plans associated with an employer.
GetPlanPriority – Used to get a list of plans in priority order.

Service Assumptions/Business Rules The Employer Plan Service makes the following assumptions as well as enforce the following business rules.

Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator.
Clients shall format SOAP messages in a Document/Literal format over HTTPS.
Clients shall have already created a valid user ID and password.
Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
If any method fails, the service returns a SOAP fault describing the problem.
Employer Plan Service is meant to be used only by non-split plan administrator.

AddEmployerPlan

This method is used to add an employer’s plan information.

History

The AddEmployerPlan methods are listed below:

Request Messages

AddEmployerPlanRequest_2026_07
AddEmployerPlanRequest_2024_03
AddEmployerPlanRequest_2023_10
AddEmployerPlanRequest_2023_03
AddEmployerPlanRequest_2021_11
AddEmployerPlanRequest_2021_02
AddEmployerPlanRequest_2020_02
AddEmployerPlanRequest_2019_10
AddEmployerPlanRequest_2019_03
AddEmployerPlanRequest_2018_02
AddEmployerPlanRequest_2012_10
AddEmployerPlanRequest_2012_06
AddEmployerPlanRequest_2011_04
AddEmployerPlanRequest_2010_10
AddEmployerPlanRequest_2010_04
AddEmployerPlanRequest_2009_04
AddEmployerPlanRequest_2008_07
AddEmployerPlanRequest_2007_12
AddEmployerPlanRequest_2006_05
AddEmployerPlan

Response Messages

AddEmployerPlanResponse_2026_07
AddEmployerPlanResponse

AddEmployerPlan Request/Response Messages

The AddEmployerPlan method requires the following request and response messages (input and output data).

The table below includes the following request messages:

AddEmployerPlanResponse_2026_07
AddEmployerPlanResponse_2023_03
AddEmployerPlanResponse_2021_11
AddEmployerPlanResponse_2021_02
AddEmployerPlanResponse_2020_02
AddEmployerPlanResponse_2019_06
AddEmployerPlanResponse_2019_03
AddEmployerPlanResponse_2018_02
AddEmployerPlanResponse_2012_10
AddEmployerPlanResponse_2012_06
AddEmployerPlanResponse_2011_04
AddEmployerPlanResponse_2010_10
AddEmployerPlanResponse_2010_04
AddEmployerPlanResponse_2009_04
AddEmployerPlanResponse_2008_07
AddEmployerPlanResponse_2007_12
AddEmployerPlanResponse_2006_05
AddEmployerPlanResponse

Request Body

TpaId String required

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

First Available Version: AddEmployerPlanRequest

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.

First Available Version:	AddEmployerPlanRequest
Max Length:	`12`

PlanId String required

Unique Identifier to distinguish this plan from others within the administrator.
Could be a combination of Plan ID, Account type, Effective Date and Expire Date.

First Available Version:	AddEmployerPlanRequest
Max Length:	`18`

AccountTypeCode String required

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

First Available Version: AddEmployerPlanRequest
PlanYearStartDate Date required

(YYYMMDD)Date that funds are available for services.

First Available Version: AddEmployerPlanRequest
PlanYearEndDate Date required

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

First Available Version: AddEmployerPlanRequest
GracePeriodEndDate Date required

Date the grace period ends for this account. After this date, a warning displays when transactions are applied to this account type. This field corresponds to the UI field: “Run Out Date”

First Available Version: AddEmployerPlanRequest
PlanYearExtendedEndDate Date

Date the extended period for this account type ends. After this date, a warning displays when POS transactions are applied to this account type. This field corresponds to the UI field: “Grace Period” or “IRS Grace Period/Extension Date”

First Available Version: AddEmployerPlanRequest

SpendingLimitPeriod Enumeration

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. Valid values are:
None
Month
Year
Carryover

First Available Version:	AddEmployerPlanRequest
Default Values:	`None`

SpendingDepositAmount Decimal

Maximum amount to be deposited, during the spending Limit period.
An error message is returned if the ‘carryover’ option is selected for spending limit period: Spending deposit amount cannot be set when spending limit period is set to carryover.

First Available Version: AddEmployerPlanRequest
SpendingTransactionAmount Decimal

Maximum amount to be withdrawn, during the spending limit period.
An error message is returned if the ‘carryover’ option is selected for spending limit period: Spending transaction amount cannot be set when spending limit period is set to carryover.

First Available Version: AddEmployerPlanRequest

AllowPartialManualTransaction Boolean

Specify if this account type allows partial payments of Manual Transactions
0 (false) - Pay what is left in account towards Manual Transactions
1 (true) - Deny Manual Transactions if the entire amount is not available.(Default)
(This applies to transactions submitted via EDI only)

First Available Version:	AddEmployerPlanRequest
Default Values:	`FALSE`

AutoDepositBypass Boolean

Corresponds to the Hold Account Funding UI option in WCA. Set this flag to True to discontinue any future scheduled auto deposits. Setting this flag to False enables auto deposits and catching up on any missed auto deposits, even those that occurred while this flag was set to True.

First Available Version:	AddEmployerPlanRequest
Default Values:	`FALSE`

ConvenienceFeePayor Enumeration

Who will pay the convenience fee. Valid values are:
None
Administrator
Employer
Employee
Note: "none" indicates that no fee is applied

First Available Version:	AddEmployerPlanRequest
Default Values:	`None`

ConvenienceFeeAmount Decimal

Convenience amount charged for each POS transaction. This field is only used if the employee is paying the fee.

First Available Version:	AddEmployerPlanRequest
Max Length:	`10`

MaxTransactionAmount Decimal

Maximum amount exchanged per transaction under the plan.

First Available Version:	AddEmployerPlanRequest
Max Length:	`10`

MaxTotalAmount Decimal

Maximum amount to be paid out over the Account Type’s date range.

First Available Version:	AddEmployerPlanRequest
Max Length:	`10`

DefaultPlanOptions Integer

Set this field if the administrator wishes to use the default plan functionality.
0 - None(Default)
1 - Plan
2 - MTC
This is a bit field, so a sum value should be sent if the administrator wishes to use the combination of defaults. Ex. if the administrator wants to create a Plan with Plan design defaults and MTC defaults, they have to set this field as 3 (1 + 2). See the bit field guide for more information.

First Available Version: AddEmployerPlanRequest

RolloverPlan Boolean

Determines if the plan will have a rollover.

First Available Version:	AddEmployerPlanRequest
Default Values:	`FALSE`

RolloverPlanAttributes Enumeration

If Plan Rollover is set to True and Plan Rollover Attributes has no value, WCA rolls over MTC codes and TPS settings. Valid Values are:
Merchant Type Codes
Plan Design Exceptions
Merchant Exceptions
Terminal Exceptions
Co-Pay Amounts for Auto-
All

First Available Version:	AddEmployerPlanRequest
Default Values:	`-1`

ProductPartnerAccountFee Integer

Allows the Product Partner to determine whether the monthly fee charged per participant is discounted or whether you receive a commission.
1=Commission to administrator, agency, or company
2=Discount to participant
Note: Leave blank if this plan is not a Product Partner HSA.

First Available Version:	AddEmployerPlanRequest_2006_05
Default Values:	`0`

ProductPartnerSetupFee Integer

Allows the Product Partner to determine whether the setup fee charged per participant is discounted or whether you receive a commission.
1=Commission to administrator, agency, or company
2=Discount to participant
Note: Leave blank if this plan is not a Product Partner HSA.

First Available Version:	AddEmployerPlanRequest_2006_05
Default Values:	`0`

ProductPartnerIssueCheckbooks Boolean

Determines whether a participant receives a checkbook.
0 = No
1 = Yes
Note: Leave blank if this plan is not a Product Partner HSA.

First Available Version:	AddEmployerPlanRequest_2006_05
Default Values:	`FALSE`

ProductPartnerEmployerId String

This is an additional employer identifier defined by the product partner, if requred by them, or may otherwise be defined by the administrator. Can be used to store employer tax ID or some other value associated with the employer.
Note 1: Leave blank if the plan is not an HSA.
Note 2: This field is required for HSA type plans. If the product partner employer ID is not provided, the record will fail.

First Available Version: AddEmployerPlanRequest_2006_05
ProductPartnerAdministratorId String

The value in this field links the administrator with the product partner. The product partner provides this ID for the administrator.
Note 1: Leave blank if the plan is not an HSA.
Note 2: This field is required for HSA type plans. If the administrator ID is not provided, the record will fail because the product partner relationship will not be found.

First Available Version: AddEmployerPlanRequest_2006_05
ProductPartnerProductId String

Unique identifier for the Product Partner.
Note 1: Leave blank if the plan is not an HSA.
Note 2: This field is required for HSA type Plans. If the Product Partner Employer ID is not provided, the record will fail

First Available Version: AddEmployerPlanRequest_2006_05

IiasSettings Enumeration

Indicates if and how IIAS is used for this plan. Valid options are:
0 = IIAS disabled (Default)
1 = IIAS Enabled for HET
2 = IIAS and Specific healthcare amount
4= IIAS Walgreens
8 = IIAS SIGIS
By making this selection to enable IIAS, Iyou are agreeing to the terms and conditions of the IIAS terms of use.

First Available Version:	AddEmployerPlanRequest_2007_12
Default Values:	`IIAS Disabled`

IiasOptions Enumeration

If IIAS Enabled = 0, then send IIAS Options = 0
If IIAS Enabled = 1, then 0 indicates HET
If IIAS Enabled = 2, then send the following IIAS Options value of 1 = RX
Note: The IIAS Options field is used by the administrator when not using HET. Rx and OTC are the only supported options at this time.
The options are:
0 = No, Healthcare Specific(Default)
1 = Rx

First Available Version:	AddEmployerPlanRequest_2007_12
Default Values:	`None`

CoverageTierT ypeId String

Maps to an administrator level coverage tier type (4 tier, 3 tier, etc.) as created by you via the User Interface (UI). This field is required if plan is enabled for coverage tiers (see Plan Options field). Only one coverage tier type ID can be assigned per plan. Leave field blank if not using coverage tiers.

First Available Version:	AddEmployerPlanRequest_2008_07
Max Length:	`10`

DefaultCoverageTierId String

Maps to a coverage tier (Single, Family, etc.). Required if plan is enabled for coverage tiers. Tier ID provided must be a valid coverage tier ID within the Coverage Tier Type specified.
Employee accounts are updated nightly to use the plan default coverage tier if none is defined when creating the employee account.
Leave field blank if not using coverage tiers.

First Available Version:	AddEmployerPlanRequest_2008_07
Max Length:	`10`

LifeEventCalculationMethods Enum

Field ignored unless Plan Options set to allow Life Event Management.
If Plan options is set to allow life event balance management, then valid values for this field are:
None
AnnualDisbursements
MaximumBenefits

First Available Version:	AddEmployerPlanRequest_2008_07
Default Values:	`None`

OtherDepositSubTypeIds String

Used for Special Deposits functionality. Specify the OtherDepositSubTypeIds to be used

First Available Version: AddEmployerPlanRequest_2008_07
ManualClaimPercentCoverage Integer

Percentage of claim amount that should be paid from the funds in the employee’s account attached to this plan.
Plan “Allow Partial Manual Transactions” must be set to “Yes” in order to utilize this feature.
Whole amounts >= 0 and = 0 and = 0 and = 0 and
Response Message: Request submitted successfully.
**GetPlanPriority**
This method is used to get a list of plans in priority order for
all plans associated with an employer
**History**
The GetPlanPriority methods are listed below:
Request
Messages
GetPlanPriorityRequest
Response Messages
GetPlanPriorityResponse
**GetPlanPriority Request/Response Messages**
The GetPlanPriority
method requires the following request and response messages (input and
output data).

The table below includes the following request messages:

GetPlanPriorityRequest

Request Body

TpaID String required

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

First Available Version: GetPlanPriorityRequest

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.

First Available Version:	GetPlanPriorityRequest
Max Length:	`12` GetPlanPriorityResponse

Response Body

String

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

First Available Version: String
String 12

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

First Available Version: String
String

Unique identifier to distinguish this plan from others within the administrator.

First Available Version: String
String

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

First Available Version: String
Date

First date of the plan year

First Available Version: Date
Date

Final date of the plan year

First Available Version: Date
Date

Date the grace period ends for accounts on this plan. After this date, a warning displays when transactions are applied to this account type. This field corresponds to the UI field: “Run Out Date”

First Available Version: Date
Date

Date the extended period for this account type ends. After this date, a warning displays when POS transactions are applied to this account type. This field corresponds to the UI field: “Grace Period” or “IRS Grace Period/Extension Date”

First Available Version: Date
Short

The number that corresponds to the priority of the plan (‘1’ being the highest priority, ‘2’ being the next priority, and so on).

First Available Version: Short
String

Unabbreviated description associated with the three-character account type code.

First Available Version: String

Employer Plan API | Administrative - SOAP

AddEmployerPlan

Request Body

Request Body

Response Body

AI Assistant Preview

AI Assistant ^Preview