Account Service API | Administrative - SOAP
The Account Service provides the clients with account data and functionality. Currently, the methods provided by this service are on an Employee level (accounts directly linked to an employee and their dependents.)
Important Note: In order to facilitate backward compatibility with all Web Services in use prior to June 4, 2005, either Employee (Dependent) Social Security Number (previously used as unique employee/dependent identifier) or Employee (Dependent) ID(new unique employee/dependent identifier) may be provided when required to uniquely identify an employee or depend ent. If both are provided, the Employee (Dependent) ID is used as the unique identifier.
Service Web Methods
- AddEmployeeAccount – used to add employee account information
- DeleteEmployeeAccount – used to remove employee account information
- GetDependentAccounts – returns a list of accounts for a given dependent along with the individual balance information for HRA and non HRA accounts
- GetEmployeeAccounts – returns a list of accounts for a given employee
- GetEmployeeHSAAccounts – returns a list of Health Savings Accounts for a given employee. (Documentation coming soon)
- RemoveDependentAccount – used to remove an account from a dependent
- SetDependentAccount – used to set an account to a dependent
- UpdateEmployeeAccount – used to update an employee's existing account
- AddFlexAccountLifeEvent – used to add employee flex account life event information to WCA
- DeleteFlexAccountLifeEvent – used to return a list of accounts for a given dependent within WCA
- GetFlexAccountCoveragePeriodList – used to get a list of all an employee’s flex account coverage periods given the employee's account information
- GetFlexAccountLifeEventList – used to get a list of all an employee’s flex account life events given the employee's account information
- UpdateFlexAccountLifeEvent – used to update an employee's existing flex account life event within WCA
- GetEmployeeHSAAccountDetails – used to get a list of all an employee's HSA account details given the employee's social security number, or card number, or the employee's ID
- EnrollHSAAccount – used to set enrollment status and account open dates for WealthCare HSAs (can only be utilized by partner users with profile access to edit HSA accounts)
Service Assumptions/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 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.
AddEmployeeAccount
This method is used to add employee account information.
History
The AddEmployeeAccount methods are listed below:
- AddEmployeeAccountRequest_2020_10
- AddEmployeeAccountRequest_2018_08
- AddEmployeeAccountRequest_2018_02
- AddEmployeeAccountRequest_2015_10
- AddEmployeeAccountRequest_2011_04
- AddEmployeeAccountRequest_2009_04
- AddEmployeeAccountRequest_2008_07
- AddEmployeeAccountRequest_2007_05
- AddEmployeeAccountRequest_2006_05
- AddEmployeeAccountRequest
-
AddEmployeeAccountResponse
AddEmployeeAccount Request/Response Messages
The AddEmployeeAccount method requires the following request and response messages (input and output data).
- AddEmployeeAccountRequest_2020_10
- AddEmployeeAccountRequest_2018_08
- AddEmployeeAccountRequest_2011_04
- AddEmployeeAccountRequest_2009_04
- AddEmployeeAccountRequest_2008_07
- AddEmployeeAccountRequest_2007_05
- AddEmployeeAccountRequest_2006_05
- AddEmployeeAccountRequest
MMC Account Level Settings
When the TPA option "Set default MCC Account Level setting to 'Yes'." is disabled (unchecked) and the plan is has associated MCC Account Settings, then all active MCC Account Setting will be set to 'No' by default.
When TPA option “Set default MCC Account Level setting to ‘Yes’.” is enabled (checked) and the plan is has associated MCC Account Settings, then all active MCC Account Setting will be set to Yes by default.
-
AccountTypeCode string requiredThree character abbreviation that indication that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: AddEmployeeAccountRequest -
EmployeeElection Decimal requiredAmount to be contributed by the employee automatically via the auto-deposit cycle. 0.00 is a valid amount.
First Available Version: AddEmployeeAccountRequest -
EmployeeSocialSecurityNumber string conditionally requiredEmployee's social secuirty number. This field is used to identify the employee and is not changed within this method.
First Available Version: AddEmployeeAccountRequest Max Length: 9 -
EmployeeId string conditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or the SSN may be used for this purpose.
First Available Version: AddEmployeeAccountRequest Max Length: 30 -
EmployerElection decimal requiredAmount to be contributed by the employer automatically via the auto-deposit cycle. 0.00 is a valid amount.
First Available Version: AddEmployeeAccountRequest -
EmployerId string requiredUnique 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: AddEmployeeAccountRequest Max Length: 12 -
OriginalPrefundedAmount decimalFor 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.
First Available Version: AddEmployeeAccountRequest -
PlanId string requiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: AddEmployeeAccountRequest Max Length: 18 -
PlanYearEndDate string (YYYYMMDD) requiredDate after which services are not eligible for payment unless there is an extension in the field.
First Available Version: AddEmployeeAccountRequest -
PlanYearStartDate string requiredDate that funds are available for services.
First Available Version: AddEmployeeAccountRequest Pattern: YYYYMMDD -
StartAutoDepositDate dateThe 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, then this field is required. Otherwise, if a date is supplied, then the user receives a warning.
First Available Version: AddEmployeeAccountRequest Default Value: 1 -
TpaId stringA unique identifier for your administrator instance, generated by WCA when the instance was first setup. If a value is not sent, the TPA ID from the user making the request will be used.
First Available Version: AddEmployeeAccountRequest -
ESignatureDate dateField is only valid when used with an HSA account and the
ESignatureCode
is True. This stores the e-signature date.First Available Version: AddEmployeeAccountRequest_2007_05 Default Value: 1 -
ESignatureCode booleanField is only valid when used with an HSA account and the
ESignatureDate
. Stores the value of the e-signature card.First Available Version: AddEmployeeAccountRequest_2007_05 Default Value: FALSE -
EligibilityDate stringDate upon which the employee is eligible to elect benefits.
First Available Version: AddEmployeeAccountRequest_2008_07 Pattern: YYYYMMDD Max Length: 8 -
TerminationDate stringDate upon which the employee's account is no longer eligibile for benefits. Date must be after employee account effective date.
First Available Version: AddEmployeeAccountRequest_2008_07 Pattern: YYYYMMDD Max Length: 8 -
ESignatureDate dateDate the E-signature was received by the administrator.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 10 Default Value: 1 -
ESignatureCode stringE-signature code.
First Available Version: AddEmployeeAccountRequest_2008_07 -
CoverageTierId stringFor plans with coverage tier 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 typeset for the plan, then the coverage tier is set for the participant's account.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 10 -
IndividualBalanceMax stringThis amount indicates the maximum balance that is allowed for the indidviaul 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.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 19 -
RolloverBalanceMax stringThis 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 $500 in the target account and the fund rollover balance max is set to $1,000. 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 $1,000. This amount is also used for the family amount in an indvidual/family HRA account.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 19 -
AutoDepositCalendarId stringIf 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 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.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 50 -
StartFixedEmployerFundingDate dateDate 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.
First Available Version: AddEmployeeAccountRequest_2008_07 Max Length: 8 Default Value: 1 -
ClaimsCrossoverOption shortIf 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, the the employee will be assigned the plan default setting for claims crossover opt-in.
Note 2: If the 'bypass the value 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.First Available Version: AddEmployeeAccountRequest_2009_04 -
Deductible short0 = No Deductible
1 = Deductible Not Met (Default)
2 = Deductible Met
Note 1: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.First Available Version: AddEmployeeAccountRequest_2009_04 Default Value: 1 -
FlexAcctId stringA unique identifier for the employee's account generated by WCA when the account was first setup.
First Available Version: AddEmployeeAccountRequest_2010_04 -
PrefundedAmtSpecified booleanIndicates whether a prefunded amount was specified.
True = Prefunded amount specified in request.
False = Prefunded amount was not specified in request.First Available Version: AddEmployeeAccountRequest_2010_04 Default Value: FALSE -
Reenroll booleanThis 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.First Available Version: AddEmployeeAccountRequest_2010_04 Default Value: FALSE -
AutoReimbursementSetting int16Use 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 providerFirst Available Version: AddEmployeeAccountRequest_2011_04 Default Value: 0 -
EmployeeAnnualElection decimalEmployee annual election
First Available Version: AddEmployeeAccountRequest_2015_10 Max Length: 19 -
EmployerAnnualElection decimalEmployer annual election
First Available Version: AddEmployeeAccountRequest_2015_10 Max Length: 19 -
EmployeeIndividualAmount decimalAnnual election amount available for the employee to spend in the plan period for an individaul/family HRA. It is ignored by prefunded & payroll plans.
Note: 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.First Available Version: AddEmployeeAccountRequest_2015_10 Max Length: 19 -
ProductID stringThe product ID can only be specified for the employee amount 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."
First Available Version: AddEmployeeAccountRequest_2016_02 Max Length: 20 Default Value: Null -
SuspendDebitCardActivity booleanSuspends debit card activity when there are ineligible/pending transactions.
0 = False (Do not suspend debit card activity)
1 = True (Suspend debit card activity)First Available Version: AddEmployeeAccountRequest_2016_02 Max Length: 1 -
Subgroup# stringThe subgroup ID you wish to assign to the account.
First Available Version: AddEmployeeAccountRequest_2018_08 Max Length: 15 -
AccountSegment stringThe account segment ID you wish to assign to the account.
First Available Version: AddEmployeeAccountRequest_2018_08 Max Length: 15 -
GracePeriodDeductibleStatus shortUpdate the deductible status for the grace period.
0 = No deductible
1 = Deductible not met
2 = Deductible met
4 = No deductible limited
Note: Flagging the dedutible as met during the prior year's grace period also updates the deductible met status for the current year.First Available Version: AddEmployeeAccountRequest_2020_10 Max Length: 1 Default Value: 0 -
GracePeriodDeductibleDate date conditionally requiredMust 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.First Available Version: AddEmployeeAccountRequest_2020_10 Max Length: 8 Default Value: Null
Response Body
No content
Example of an AddEmployeeAccount SOAP request body
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>xw1hgha3ess4ro45r55yr5ij</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<AddEmployeeAccount_2007_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2007/05/">
<addEmployeeAccountRequest_2007_05>
<AccountTypeCode>FSA</AccountTypeCode>
<EmployeeElection>200</EmployeeElection>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerElection>200</EmployerElection>
<EmployerId>EASE10</EmployerId>
<OriginalPrefundedAmount>200</OriginalPrefundedAmount>
<PlanId>EASFSA</PlanId>
<PlanYearEndDate>20041031</PlanYearEndDate>
<PlanYearStartDate>20031101</PlanYearStartDate>
<StartAutoDepositDate>2004-09-13</StartAutoDepositDate>
<AdministratorId>T00209</AdministratorId>
</addEmployeeAccountRequest_2007_05>
</AddEmployeeAccount_2007_05>
</soap:Body>
</soap:Envelope>
Example of an AddEmployeeAccount response body
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<AddEmployeeAccountResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2004/06/">
<AddEmployeeAccountResult />
</AddEmployeeAccountResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the AddEmployeeAccount method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for the Account service
proxy = new AccountServiceNameSpace.AccountService();
Create request message for method call (input parameters)
request = new AccountServiceNameSpace.AddEmployeeAccountRequest_2007_05();
// Set the input parameters
request.AccountTypeCode = _accountTypeCode.Text;
request.EmployeeElection = Convert.ToDecimal(_employeeElection.Text);
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerElection = Convert.ToDecimal(_employerElection.Text);
request.EmployerId = _employerId.Text;
request.OriginalPrefundedAmount =
Convert.ToDecimal(_originalPrefundedAmount.Text);
request.PlanId = _planId.Text;
planYearEndDate = Convert.ToDateTime(_planYearEndDate.Text);
planYearEndstring = planYearEndDate.Year.ToString();
planYearEndstring += (planYearEndDate.Month < 10) ? "0" +
planYearEndDate.Month.ToString()
: planYearEndDate.Month.ToString();
planYearEndstring += (planYearEndDate.Day < 10) ? "0" +
planYearEndDate.Day.ToString() :
planYearEndDate.Day.ToString();
request.PlanYearEndDate = planYearEndstring;
planYearStartDate = Convert.ToDateTime(_planYearStartDate.Text);
planYearStartstring = planYearStartDate.Year.ToString();
planYearStartstring += (planYearStartDate.Month < 10) ? "0" +
planYearStartDate.Month.ToString() :
planYearStartDate.Month.ToString();
planYearStartstring += (planYearStartDate.Day < 10) ? "0" +
planYearStartDate.Day.ToString() :
planYearStartDate.Day.ToString();
request.PlanYearStartDate = planYearStartstring;
request.StartAutoDepositDate = Convert.ToDateTime(_startAutoDepositDate.Text);
request.AdministratorId = _administratorId.Text;
// session IDreturned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call method
response = proxy.AddEmployeeAccount(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations}
DeleteEmployeeAccount
This method is used to remove employee account information.
History
The DeleteEmployeeAccount methods are listed below:
- DeleteEmployeeAccountRequest_2006_05
- DeleteEmployeeAccountRequest
- DeleteEmployeeAccountResponse
DeleteEmployeeAccount Request/Response Messages
DeleteEmployeeAccount
method requires the following request and response
messages (input a nd output data). The table below includes the following
request messages:
- DeleteEmployeeAccountRequest_2006_05
- DeleteEmployeeAccountRequest
-
AccountTypeCode string requiredFSA, DCA, etc.
First Available Version: DeleteEmployeeAccountRequest -
EmployeeSocialSecurityNumber string conditionally requiredEmployee's social security number. This field is used to identify the employee and is not changed within this method.
First Available Version: DeleteEmployeeAccountRequest Max Length: 9 -
EmployeeId string conditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or SSN may be used for this purpose.
First Available Version: DeleteEmployeeAccountRequest Max Length: 30 -
EmployerId string requiredFirst 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.
First Available Version: DeleteEmployeeAccountRequest Max Length: 12 -
PlanYearEndDate string requiredPlan end date as identified in Employer - Plan screen.
First Available Version: DeleteEmployeeAccountRequest Pattern: YYYYMMDD -
PlanYearStartDate string requiredPlan start date as identified in Employer - Plan screen.
First Available Version: DeleteEmployeeAccountRequest Pattern: YYYYMMDD -
TpaId stringUsed only if the current logged on user is type WCA.
First Available Version: DeleteEmployeeAccountRequest -
PlanId stringPlan ID
First Available Version: DeleteEmployeeAccountRequest_2006_05 -
FlexAcctId stringEmployee account ID. WealthCare Admin generates a unique flex account ID upon account creation. It is recommended to include this field to specify the plan you intend to delete, if the employee has multiple accounts with the same plan type.
First Available Version: DeleteEmployeeAccountRequest_2010_04
Response Body
No content
Example of a DeleteEmployeeAccount SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>xw1hgha3ess4ro45r55yr5ij</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<DeleteEmployeeAccount_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2006/05/"
<DeleteEmployeeAccountRequest_2006_05>
<AccountTypeCode>FSA</AccountTypeCode>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerId>EASE10</EmployerId>
<PlanYearEndDate>20041031</PlanYearEndDate>
<PlanYearStartDate>20031101</PlanYearStartDate>
<AdministratorId>T00209</AdministratorId>
</DeleteEmployeeAccountRequest_2006_05>
</DeleteEmployeeAccount_2006_05>
</soap:Body>
</soap:Envelope>
Example of a DeleteEmployeeAccount response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<DeleteEmployeeAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2004/06/">
<DeleteEmployeeAccountResult />
</DeleteEmployeeAccountResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the DeleteEmployeeAccount method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for account service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.DeleteEmployeeAccountRequest_2006_05()
// Set the input parameters
request.AccountTypeCode = _accountTypeCode.Text;
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerId = _employerId.Text;
planYearEndDate = Convert.ToDateTime(_planYearEndDate.Text);
planYearEndstring = planYearEndDate.Year.ToString();
planYearEndstring += (planYearEndDate.Month < 10) ? "0" +
planYearEndDate.Month.ToString() :
planYearEndDate.Month.ToString();
planYearEndstring += (planYearEndDate.Day < 10) ? "0" +
planYearEndDate.Day.ToString() :
planYearEndDate.Day.ToString();
request.PlanYearEndDate = planYearEndstring;
planYearStartDate = Convert.ToDateTime(_planYearStartDate.Text);
planYearStartstring = planYearStartDate.Year.ToString();
planYearStartstring += (planYearStartDate.Month < 10) ? "0" +
planYearStartDate.Month.ToString() :
planYearStartDate.Month.ToString();
planYearStartstring += (planYearStartDate.Day < 10) ? "0" +
planYearStartDate.Day.ToString() :
planYearStartDate.Day.ToString();
request.PlanYearStartDate = planYearStartstring;
request.AdministratorId = _administratorId.Text;
// session IDreturned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.DeleteEmployeeAccount(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
GetDependentAccounts
This method is used to return a list of accounts for a given dependent.
History
The GetDependentAccounts methods are listed below:
- MessagesGetDependentAccountsRequest_2011_10
- MessagesGetDependentAccountsRequest_2006_05
- GetDependentAccountsRequest
- GetDependentAccountsResponse_2008_07
- GetDependentAccountsResponse_2007_12
- GetDependentAccountsResponse_2006_12
- GetDependentAccountsResponse
-
DependentSocialSecurityNumber string conditionally requiredDependent's social security number.
First Available Version: GetDependentAccountsRequest Max Length: 9 -
DependentId string conditionally requiredRequired if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
First Available Version: GetDependentAccountsRequest Max Length: 30 -
EmployerId string requiredUnique 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: GetDependentAccountsRequest Max Length: 12 -
PlanYearListType enum requiredDefines what account years you wish to return.
First Available Version: GetDependentAccountsRequest Possible Values: ALL
Current
Previous
Future
-
AdministratorId stringA unique identifier for your administrator instance, generated by WCA when the instance was first setup. If a value is not sent, the TPA ID from the user making the request will be used.
First Available Version: GetDependentAccountsRequest -
VerboseMode booleanIf set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetDependentAccountsRequest Default Value: False -
PlanId stringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetDependentAccountsRequest_2006_05 -
EmployeeSocialSecurityNumber string conditionally requiredEmployee's social security number. Required if dependent IDs are not unique within an employer.
First Available Version: GetDependentAccountsRequest_2011_10 Max Length: 9 -
EmployeeID string conditionally requiredEmployee ID, a unique identifier for the employee. Required if dependent IDs are not unique within an employer.
First Available Version: GetDependentAccountsRequest_2011_10 Max Length: 30
-
AccountTypeCode stringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetDependentAccountsResponse -
DependentSocialSecurityNumber stringDependent's social security number.
First Available Version: GetDependentAccountsResponse -
DependentId stringDependent's unique WCA identifier.
First Available Version: GetDependentAccountsResponse -
EmployeeSocialSecurityNumber stringEmployee's social security number.
First Available Version: GetDependentAccountsResponse -
EmployeeId stringEmployee's unique WCA identifier.
First Available Version: GetDependentAccountsResponse -
EmployerId stringUnique 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: GetDependentAccountsResponse -
EndDate stringThe end date of the plan.
First Available Version: GetDependentAccountsResponse Pattern: YYYYMMDD -
Status enum<int>Activity status of the account.
1 = New
2 = Active
3 = Temporary Inactive
4 = Permanently Inactive
5 = TerminatedFirst Available Version: GetDependentAccountsResponse -
TpaId stringA unique identifier for your administrator instance, generated by WCA when the instance was first setup.
First Available Version: GetDependentAccountsResponse -
HraAccount booleanIf
True
account is an HRA account, ifFalse
account is not an HRA account.First Available Version: GetDependentAccountsResponse_2006_12 -
IndividualAmount decimalThe individual amount is the prefunded amount for employee or dependent's HRA amount.
First Available Version: GetDependentAccountsResponse_2006_12 -
IndividualAvailableAmount decimalAvailable balance is the disbursable balance plus the auth hold balance. If this account has multiple QLE coverage periods, this field will contain the current coverage period's balance.
Note: For full-featured HRAs--HRX, HX1 ...HX6--with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetDependentAccountsResponse_2006_12 -
IndividualDisbursableBalance decimalDisbursable balance = available balance minus auth hold balance.
If this account has multiple QLE coverage periods, this field will contain the current coverage period's balance.
Note: For full-featured HRAs--HRX, HX1 ...HX6--with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetDependentAccountsResponse_2006_12 -
IndividualPreAuthHold decimalAuth hold balance for single fund HRX and non-HRA accounts.
Note: For full-featured HRAs--HRX, HX1 ...HX6--with family and individual amounts or with individual amounts only, this balance is for the family.First Available Version: GetDependentAccountsResponse_2006_12 -
BalanceDue decimalThis field returns the aggregated total of ineligible card transactions by plan and year.
First Available Version: GetDependentAccountsResponse_2007_12 -
EligibilityDate stringDate upon which the employee is eligible to elect benefits.
First Available Version: GetDependentAccountsResponse_2008_07 Pattern: YYYYMMDD -
TerminationDate stringDate upon which the employee's account is no longer eligible for benefits. Date must be after employee account effective date.
First Available Version: GetDependentAccountsResponse_2008_07 Pattern: YYYYMMDD -
RolloverDepositsPtd stringDeposits made year to date into this account via fund rollover. For an individual/family HRA plan, this is the individual fund information. If a dependent ID is provided, then this is the dependent's indidvidual fund information.
First Available Version: GetDependentAccountsResponse_2008_07 -
FundRolloverStatusCode intDetermines current status of the process. For an individual/family HRA plan, this is the individual fund rollover status - If a dependent ID is provided, then this is the dependent's individual fund rollover status.
First Available Version: GetDependentAccountsResponse_2008_07 Possible Values: 0
= No Status
1
= Not Completed
2
= In Process
4
= Completed
8
= Partial
16
= Account Created
32
= Primary Transaction Calculated
64
= Primary Transaction Pending
128
= Primary Completed
256
= Secondary Transaction Calculated (future)
512
= Secondary Transaction Pending
1024
= Secondary Completed (future)
-
FundRolloverErrorCode intIf the FundRolloverStatusCode = 1 (Not Completed), then a value will exist in this field indicating the specific error.
For an individual/family HRA plan, this is the individual fund rollover error code - If a dependent ID is provided, then this is the dependent's individual fund rollover error code.First Available Version: GetDependentAccountsResponse_2008_07 -
FlexAcctId stringA unique identifier for the employee's account, generated by WCA when the account was first setup.
First Available Version: GetDependentAccountsResponse_2010_04 -
IsPlanLinked booleanReturns false if plan is not linked.
First Available Version: GetDependentAccountsResponse_2016_06 -
LinkedPlanYearStartDate stringReturns start date of linked plan.
First Available Version: GetDependentAccountsResponse_2016_06 -
LinkedPlanYearEndDate stringReturns end date of linked plan.
First Available Version: GetDependentAccountsResponse_2016_06 -
LinkedPlanId stringReturns plan ID of linked plan.
First Available Version: GetDependentAccountsResponse_2016_06 -
LinkedAccountTypeCode stringReturns account type for linked plan.
First Available Version: GetDependentAccountsResponse_2016_06
Example of a GetDependentAccounts SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>o3kaamaa2u4khf450irosiin</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetDependentAccounts_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2006/05/">
<GetDependentAccountsRequest_2006_05>
<DependentSocialSecurityNumber>122132876</DependentSocialSecurityNumbe r>
<EmployerId>EASE10</EmployerId>
<AdministratorId>T00209</AdministratorId>
</GetDependentAccountsRequest_2006_05>
</GetDependentAccounts_2006_05>
</soap:Body>
</soap:Envelope>
Example of a GetDependentAccounts response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<GetDependentAccountsResponse_2006_12
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2006/12/">
<GetDependentAccountsResult>
<GetDependentAccountsResponse_2006_12>
<AccountTypeCode>FSA</AccountTypeCode>
<DependentSocialSecurityNumber>122132876</DependentSocialSecurityNumber>
<DependentId>122132876</DependentId>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployeeId>Emp1</EmployeeId>
<EmployerId>EASE10</EmployerId>
<EndDate>20041031</EndDate>
<PlanId>EASFSA</PlanId>
<PlanTypeCode>HLTH</PlanTypeCode>
<StartDate>20031101</StartDate>
<Status xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</Status>
<AdministratorId>T00209</AdministratorId>
<HraAccount>true</HraAccount>
<IndividualAmount>500.00</ IndividualAmount>
<IndividualAvailableAmount>500.00</IndividualAvailableAmount>
< IndividualDisbursableBalance>500.00</IndividualDisbursableBalance>
< IndividualPreAuthHold >0.00</ IndividualPreAuthHold >
</GetDependentAccountsResponse_2006_12>
</GetDependentAccountsResult>
</GetDependentAccountsResponse_2006_12>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the GetDependentAccounts method.
try
{
_dataset.Tables["Accounts"].Clear();
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for Account service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.GetDependentAccountsRequest_2006_05();
// Set the input parameters
request.EmployerId = _employerId.Text;
request.DependentSocialSecurityNumber = _dependentSocialSecurityNumber.Text;
request.AdministratorId = _administratorId.Text;
request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
request.PlanYearListType =
(AccountServiceNameSpace.PlanYearList)_planYear.SelectedItem;
request.PlanYearListTypeSpecified = true;
// session IDreturned from logon method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
responses = proxy.GetDependentAccounts(request);
if(responses != null)
{
for(int i=0; i < responses.Length; i++)
{
_dataset.Tables["Accounts"].Rows.Add(new string[]
{
responses[i].AccountTypeCode,
responses[i].DependentSocialSecurityNumber,
responses[i].EmployeeSocialSecurityNumber,
responses[i].EmployerId, responses[i].EndDate,
responses[i].EndDate, responses[i].PlanId,
responses[i].StartDate,
responses[i].Status.ToString(),
responses[i].AdministratorId,
responses[i].HraAccount.ToString(),
responses[i].IndividualAmount.ToString(),
responses[i].IndividualAvailableAmount.ToString(),
responses[i].IndividualDisbursableBalance.ToString(),
responses[i].IndividualPreAuthHold.ToString()
});
}
}
accounts.CaptionText = _dataset.Tables["Accounts"].Rows.Count + " records found.";
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetEmployeeAccounts
This method is used to get a list of all an employee’s accounts given the employee’s social security number, or card number, or the employee’s ID.
History
The GetEmployeeAccounts methods are listed below:
- GetEmployeeAccountsRequest_2013_02
- GetEmployeeAccountsRequest_2010_04
- GetEmployeeAccountsRequest
- GetEmployeeAccountsResponse_2020_02
- GetEmployeeAccountsResponse_2019_10
- GetEmployeeAccountsResponse_2013_02
- GetEmployeeAccountsResponse_2009_04
- GetEmployeeAccountsResponse_2008_07
- GetEmployeeAccountsResponse_2007_12
- GetEmployeeAccountsResponse_2007_05
- GetEmployeeAccountsResponse_2006_05
- GetEmployeeAccountsResponse
GetEmployeeAccounts Request/Response Messages
- GetEmployeeAccountsRequest_2006_05
- GetEmployeeAccountsRequest
-
CardNumber string conditionally requiredProvide one of the following: card number, employee social security number, or employee ID. All are not required. If either or both of the employee identifier fields (SSN or ID) are provided in addition to the card number, the card number is used.
First Available Version: GetEmployeeAccountsRequest -
EmployeeSocialSecurityNumber string conditionally requiredRequired if this field is being used as the unique employee identifier and card number is not provided. Either ths field, CardNumber or EmployeeID may be used for this purpose.
First Available Version: GetEmployeeAccountsRequest -
EmployeeId string conditionally requiredRequired if this field is being used as the unique employee identifier and card number is not provided. Either this field, CardNumber, or EmployeeSocialSecurity number may be used for this purpose.
First Available Version: GetEmployeeAccountsRequest -
EmployerId string requiredUnique 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: GetEmployeeAccountsRequest Max Length: 12 -
PlanYearListType enumDefines what account years you wish to return.
First Available Version: GetEmployeeAccountsRequest Possible Values: ALL
Current
Previous
Future
Default Value: ALL
-
TpaId stringA unique identifier for your administrator instance, generated by WCA when the instance was first setup. If a value is not sent, the TPA ID from the user making the request will be used.
First Available Version: GetEmployeeAccountsRequest -
VerboseMode booleanIf set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetEmployeeAccountsRequest Default Value: False -
PlanId stringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetEmployeeAccountsRequest_2006_05 -
FlexAcctId stringA unique identifier for the employee's account, generated by WCA when the account was first setup.
First Available Version: GetEmployeeAccountsRequest_2009_04 -
CardProxy booleanFor security, the card proxy number is always returned in the response.
First Available Version: GetEmployeeAccountsRequest_2013_02 -
EnableAccountDormancy booleanPlan level setting to enable account dormancy.
First Available Version: GetEmployeeAccountsRequest_2013_02 Possible Values: False
- Not Enabled
True
- Enabled
Default Values: False
- GetEmployeeAccountsResponse_2020_02
- GetEmployeeAccountsResponse_2018_02
- GetEmployeeAccountsResponse_2013_02
- GetEmployeeAccountsResponse_2009_04
- GetEmployeeAccountsResponse_2008_07
- GetEmployeeAccountsResponse_2007_12
- GetEmployeeAccountsResponse_2007_05
- GetEmployeeAccountsResponse_2006_05
- GetEmployeeAccountsResponse
- AccountStatusEnumerationActivity status of the account. 1 = New
2 = Active
3 = Temporarily Inactive
4 = Permanently Inactive
5 = TerminatedFirst Available Version: GetEmployeeAccountsResponse - AccountTypeCodeStringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetEmployeeAccountsResponse - AvailableBalanceDecimalAvailable Balance is the Disbursable Balance plus the Auth Hold Balance.
If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.
Note: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetEmployeeAccountsResponse - CardNumberStringCard Proxy Number. Note: The Card Proxy number is returned in this field when either 0 or 1 is passed in the “CardProxy” field in the request. For security, the Card Proxy number is always returned in the response.
First Available Version: GetEmployeeAccountsResponse - DisbPtdDecimalReturns the disbursements paid to date.
First Available Version: GetEmployeeAccountsResponse - EmpeContribPtdDecimalYear to date total amount of employee deposits by the employee.
First Available Version: GetEmployeeAccountsResponse - EmployeeElectionDecimalAmount employee elected to deposit to the account each pay period.
First Available Version: GetEmployeeAccountsResponse - EmployeeSocialSecurityNumberStringEmployee Social Security Number
First Available Version: GetEmployeeAccountsResponse - EmployeeIdStringUnique identifier for the employee.
First Available Version: GetEmployeeAccountsResponse - EmployerElectionDecimalAmount the employer chose to deposit to the cardholder account each pay period.
First Available Version: GetEmployeeAccountsResponse - EmployerIdStringUnique 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: GetEmployeeAccountsResponse - EmprContribPtdDecimalYear to date total amount of employee deposits by the employer.
First Available Version: GetEmployeeAccountsResponse - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetEmployeeAccountsResponse - PlanYearEndDateString (YYYYMMDD)(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetEmployeeAccountsResponse - PlanYearStartDate String (YYYYMMDD)(YYYMMDD)Date that funds are available for services.
First Available Version: GetEmployeeAccountsResponse - PreauthBalDecimalTotal amount of all pre-auth transactions that currently do not have a matching force post for this employee
First Available Version: GetEmployeeAccountsResponse - PrefundedBooleanDisplays whether the account is Prefunded or Payroll based.
True = Prefunded Plan Type
False = Payroll Plan TypeFirst Available Version: GetEmployeeAccountsResponse - PrefundedAmtDecimalPrefunded Amount
First Available Version: GetEmployeeAccountsResponse - StartAutoDeposit DateStringAuto Deposit Start Date
First Available Version: GetEmployeeAccountsResponse - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetEmployeeAccountsResponse - ProducadministratorrtnerOptInStatusBooleanIndicates whether or not the employee is opted in for manual claim processing.
0 = Opt Out
1= Opt In
Note: This field will only populate if the account type is a Product Partner HSA account type.First Available Version: GetEmployeeAccountsResponse - ProducadministratorrtnerIdStringProduct Partner ID
First Available Version: GetEmployeeAccountsResponse_2006_05 - ProducadministratorrtnerErrorCodeIntegerProduct Partner code
First Available Version: GetEmployeeAccountsResponse_2006_05 - ProducadministratorrtnerAccountNumberStringProduct Partner Account Number
First Available Version: GetEmployeeAccountsResponse_2006_05 - ProducadministratorrtnerSigCardReceivedAccountOpenBooleanIf the signature card has been received, an account for an HSA plan can be opened.
0 = Not Received/ Account not open.
1 = Received/Account open.
Note: This field will only populate if the account type is a Product Partner HSA account type.First Available Version: GetEmployeeAccountsResponse_2006_05 - ProductPartnerLastUploadStatusIntegerSpecifies whether data was successfully copied from WealthCare Admin to the Product Partner system.
3 = Success
4 = Error re Validation; see Product Partner Error Code field.
5 = Unexpected Error
6 = Deactivated
Note: This field will only populate if the account type is a Product Partner has account type.First Available Version: GetEmployeeAccountsResponse_2006_05 - EmployeeLimitDecimalEmployee Limit
First Available Version: GetEmployeeAccountsResponse_2006_05 - FamilyDisbPtdDecimalFamilyDisbPtd
First Available Version: GetEmployeeAccountsResponse_2006_05 - FamilyAvailableBalanceDecimalFamily Available Balance
First Available Version: GetEmployeeAccountsResponse_2006_05 - FamilyPreauthBalDecimalFamily Preauth Balance
First Available Version: GetEmployeeAccountsResponse_2006_05 - ESignatureDateDate(YYYYMMDD) Date the E-Signature was received by the Administrator.
First Available Version: GetEmployeeAccountsResponse_2007_05 - ESignatureCodeBooleanValid for HSA accounts only. Returns the e-signature code. True or False
First Available Version: GetEmployeeAccountsResponse_2006_05 - BalanceDueDecimalThis field returns the aggregated total of Ineligible Card transactions by plan and year.
First Available Version: GetEmployeeAccountsResponse_2007_12 - DisbursableBalanceDecimalDisbursable Balance = Available Balance minus Auth Hold Balance.
If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.
Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetEmployeeAccountsResponse_2007_12 - FamilyDisbursableBalanceDecimalDisbursable Balance = Available Balance minus Auth Hold Balance.
If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.First Available Version: GetEmployeeAccountsResponse_2007_12 - CoverageTierIdStringCoverage Tier designator (Ex.: Single, Family, etc.) for the employee account.
ID of coverage tier to which this employee account is associated.First Available Version: GetEmployeeAccountsResponse_2008_07 - DeductiblePtdDecimalAmount of claims submitted YTD that were applied toward the deductible on this employee account (not paid out).
First Available Version: GetEmployeeAccountsResponse_2008_07 - DeductibleAmtDecimalDeductible amount.
First Available Version: GetEmployeeAccountsResponse_2008_07 - BalanceMaxDecimalThis amount is the maximum balance that an account may be increased to with a Fund Rollover Deposit. If the Fund Rollover deposit would otherwise bring the balance above this amount, then the amount of the Fund Rollover Deposit will be reduced.
For example, a participant’s balance is $600 in this 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.
Note: The Target Plan Balance Max only applies to fund rollover deposits.First Available Version: GetEmployeeAccountsResponse_2008_07 - IndividualBalanceMaxDecimalThis 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.First Available Version: GetEmployeeAccountsResponse_2008_07 - RolloverDepositPtdDecimalDeposits made Year to Date INTO this account via Fund Rollover. For an Individual/Family HRA plan, this is the Individual Fund information– If a Dependent ID is provided, then this is the Dependent’s individual Fund information.
First Available Version: GetEmployeeAccountsResponse_2008_07 - FamilyRolloverDepositsPtdDecimalIndividual/Family HRA plans only. Deposits made Year to Date INTO this account via Fund Rollover.
First Available Version: GetEmployeeAccountsResponse_2008_07 - FundRolloverStatusCodeIntegerDetermines current status of the process. For an Individual/Family HRA plan, this is the Individual Fund Rollover Status – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover
Status.
0 = No Status
1 = Not Completed
2 = In Process
4 = Completed
8 = Partial
16 = Account Created
32 = Primary Transaction Calculated
64 = Primary Transaction Pending
128 = Primary Completed
256 = Secondary Transaction Calculated (future)
512 = Secondary Transaction Pending (future)
1024 = Secondary Completed (future)First Available Version: GetEmployeeAccountsResponse_2008_07 - FamilyFundRolloverStatusCodeIntegerDetermines current status of process.
Applies only for Full Feature HRA (HRX
plans) family rollover status.
0 = No Status
1 = Not Completed
2 = In Process
4 = Completed
8 = Partial
16 = Account Created
32 = Primary Transaction Calculated
64 = Primary Transaction Pending
128 = Primary Completed
256 = Secondary Transaction Calculated (future)
512 = Secondary Transaction Pending (future)
1024 = Secondary Completed (future)First Available Version: GetEmployeeAccountsResponse_2008_07 - EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: GetEmployeeAccountsResponse_2008_07 - TerminationDateStringYYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
First Available Version: GetEmployeeAccountsResponse_2008_07 - AutoDepositCalendarIdStringID of calendar used with Auto Deposit cycle attached to the plan.
First Available Version: GetEmployeeAccountsResponse_2008_07 - StartFixedEmployerFundingDateStringDate 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).
First Available Version: GetEmployeeAccountsResponse_2008_07 - ClaimsCrossoverOptInShortplan 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: If not specified, then the employee will be assigned the plan default setting for Claims Crossover Opt-InFirst Available Version: GetEmployeeAccountsResponse_2009_04 - DeductibleShort0 = 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.First Available Version: GetEmployeeAccountsResponse_2009_04 - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetEmployeeAccountsResponse_2009_04 - AutoReimbursementSettingIntegerUse 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 ProviderFirst Available Version: GetEmployeeAccountsResponse_2011_04 - HSALedgerBalanceDecimalBalance at the start of the processing day (the balance after end of day processing is complete for the prior day). This value only applies to HSA accounts.
First Available Version: GetEmployeeAccountsResponse_2015_02 - Product IDStringThe 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.”First Available Version: GetEmployeeAccountsResponse_2016_02 - IsPlanLinkedBooleanReturns false if plan is not linked.
First Available Version: GetEmployeeAccountsResponse_2016_06 - LinkedPlanYearStartDateStringReturns start date of linked plan.
First Available Version: GetEmployeeAccountsResponse_2016_06 - LinkedPlanYearEndDateStringReturns end date of linked plan.
First Available Version: GetEmployeeAccountsResponse_2016_06 - LinkedPlanIdStringReturns plan ID of linked plan.
First Available Version: GetEmployeeAccountsResponse_2016_06 - LinkedAccountTypeCodeStringReturns account type of linked plan.
First Available Version: GetEmployeeAccountsResponse_2016_06 - SuspendDebitCardActivityBooleanSuspends debit card activity when there are ineligible/pending transactions.
First Available Version: GetEmployeeAccountsResponse_2018_02 - EnableAccountDormancyBoolean0 - not enabled (default) 1 – enabled
First Available Version: GetEmployeeAccountsResponse_2019_10 - CoverageContinuationStringReturns the coverage continuation type for the account, if applicable.
If participant is active, or coverage continuation is not enabled, then a blank value is returned.First Available Version: GetEmployeeAccountsResponse_2020_02 - AccountCreatedByStringReturns the admin/user/function who created the account.
WCA system
Admin usernameFirst Available Version: GetEmployeeAccountsResponse_2020_02 - AccountSegmentIdStringReturns the account segment ID for the participant account, if applicable
First Available Version: GetEmployeeAccountsResponse_2020_02 - SubgroupNameStringReturns the subgroup name for the participant account, if applicable
First Available Version: GetEmployeeAccountsResponse_2020_02
Example of a GetEmployeeAccounts SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>ceddfd55ibuicdanyb4fxq55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployeeAccounts_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2006/05/">
<GetEmployeeAccountsRequest_2006_05>
<EmployeeSocialSecurityNumber>999999999</EmployeeSocialSecurityNumber>
<EmployerId>XXXXXXXXX</EmployerId>
<PlanYearListType xmlns="http://www.medibank.com/MBIWebServices/Enums/">Current</PlanYearListType>
<AdministratorId>ADMINISTRATORXXX</AdministratorId>
<VerboseMode>false</VerboseMode>
</GetEmployeeAccountsRequest_2006_05>
</GetEmployeeAccounts_2006_05>
</soap:Body>
</soap:Envelope>
Example of a GetEmployeeAccounts response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<GetEmployeeAccountsResponse_2007_05
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2007/05/">
<GetEmployeeAccountsResult>
<GetEmployeeAccountsResponse_2007_05>
<AccountStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</AccountStatus>
<AccountTypeCode>ACO</AccountTypeCode>
<AvailableBalance>4343.0000</AvailableBalance>
<CardNumber>423883002000352</CardNumber>
<DisbPtd>0</DisbPtd>
<EmpeContribPtd>0</EmpeContribPtd>
<EmployeeElection>544.0000</EmployeeElection>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerElection>555.0000</EmployerElection>
<EmployerId>EASE10</EmployerId>
<EmprContribPtd>0</EmprContribPtd>
<PlanId>32332</PlanId>
<PlanYearEndDate>20051231</PlanYearEndDate>
<PlanYearStartDate>20050101</PlanYearStartDate>
<PreauthBal>0</PreauthBal>
<Prefunded>true</Prefunded>
<PrefundedAmt>4343.0000</PrefundedAmt>
<StartAutoDepositDate>20050115</StartAutoDepositDate>
<AdministratorId>T00209</AdministratorId>
<ProducadministratorrtnerOptInStatus>true</ProducadministratorrtnerOptInStatus>
<ProducadministratorrtnerId>XXXX</ProducadministratorrtnerId>
<ProducadministratorrtnerErrorCode>02</ProducadministratorrtnerErrorCode>
<ProducadministratorrtnerAccountNumber>XXXXXX</ProducadministratorrtnerAccountNumber>
<ProducadministratorrtnerSigCardReceivedAccountOpen>true</ProducadministratorrtnerSigC ardReceivedAccountOpen>
<ProducadministratorrtnerLastUploadStatus>0</ProducadministratorrtnerLastUploadStatus>
<EmployeeLimit>300.00</EmployeeLimit>
<FamilyDisbPtd>15.00</FamilyDisbPtd>
<FamilyAvailableBalance>500.00</FamilyAvailableBalance>
<FamilyPreauthBal>17.50</FamilyPreauthBal>
</GetEmployeeAccountsResponse_2007_05>
</GetEmployeeAccountsResult>
</GetEmployeeAccountsResponse_2007_05>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the GetEmployeeAccounts method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// Create proxy object for the account service
localhost.AccountService proxy = new localhost.AccountService();
// Create request message for method call (input parameters)
localhost.GetEmployeeAccountsRequest_2006_05 request = new
localhost.GetEmployeeAccountsRequest_2006_05();
// Declare reference variable for receiving the returned values,
// in this case the response will contain the account information.
localhost.GetEmployeeAccountsResponse_2006_05[] responses;
// Set the input parameters
request.EmployerId = "XXXXXXXXX";
request.EmployeeSocialSecurityNumber = "999999999";
request.AdministratorId = "ADMINISTRATORXXX";
// session IDreturned from login method
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
// Call the Get Employee Accounts method
responses = proxy.GetEmployeeAccounts(request);
if(responses != null)
{
for(int i=0; i < responses.Length; i++)
{
// perform needed operations
}
}
else
{
MessageBox.Show("Records not found");
RemoveDependentAccount
This method is used to remove an account from a dependent.
History
The RemoveDependentAccount methods are listed below:
- RemoveDependentAccountRequest_2006_05
- RemoveDependentAccountRequest
- RemoveDependentAccountResponse
RemoveDependentAccount Request/Response Messages
- RemoveDependentAccountRequest_2006_05
- RemoveDependentAccountRequest
- AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: RemoveDependentAccountRequest - DependentSocialSecurityNumberStringconditionally requiredDependent’s social security number.
First Available Version: RemoveDependentAccountRequest - DependentIdStringconditionally requiredRequired if this field is being used as the unique dependent identifier. Either this field or Dependent SSN may be used for this purpose.
First Available Version: RemoveDependentAccountRequest - EmployeeSocialSecurityNumberStringconditionally requiredEmployee’s social security number.
First Available Version: RemoveDependentAccountRequest - EmployeeIdStringconditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or Employee SSN may be used for this purpose.
First Available Version: RemoveDependentAccountRequest - EmployerIdStringrequiredUnique 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: RemoveDependentAccountRequest - PlanYearEndDateString (YYYYMMDD)required(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: RemoveDependentAccountRequest - PlanYearStartDateString (YYYYMMDD)required(YYYMMDD)Date that funds are available for services.
First Available Version: RemoveDependentAccountRequest - TpaIdStringA unique identifer 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.
First Available Version: RemoveDependentAccountReques - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: RemoveDependentAccountRequest_2006_05 - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: RemoveDependentAccountRequest_2011_04
Example of a RemoveDependentAccount SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>o3kaamaa2u4khf450irosiin</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<RemoveDependentAccount_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/R equest/2006/05/">
<RemoveDependentAccountRequest_2006_05>
<AccountTypeCode>DCA</AccountTypeCode>
<DependentSocialSecurityNumber>122132876</DependentSocialSecurityNumber>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerId>EASE10</EmployerId>
<PlanYearEndDate>20041031</PlanYearEndDate>
<PlanYearStartDate>20031101</PlanYearStartDate>
<AdministratorId>T00209</AdministratorId>
</RemoveDependentAccountRequest_2006_05>
</RemoveDependentAccount_2006_05 >
</soap:Body>
</soap:Envelope>
Example of a RemoveDependentAccount response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<RemoveDependentAccountResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2004/06/">
<RemoveDependentAccountResult />
</RemoveDependentAccountResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the RemoveDependentAccount method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for the Account service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.RemoveDependentAccountRequest_2006_05();
// Set the input parameters
request.AccountTypeCode = _accountTypeCode.Text;
request.DependentSocialSecurityNumber = _dependentSocialSecurityNumber.Text;
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerId = _employerId.Text;
planYearEndDate = Convert.ToDateTime(_planYearEndDate.Text);
planYearEndstring = planYearEndDate.Year.ToString();
planYearEndstring += (planYearEndDate.Month < 10) ? "0" +
planYearEndDate.Month.ToString() :
planYearEndDate.Month.ToString();
planYearEndstring += (planYe arEndDate.Day < 10) ? "0" +
planYearEndDate.Day.ToString() :
planYearEndDate.Day.ToString();
request.PlanYearEndDate = planYearEndstring;
planYearStartDate = Convert.ToDateTime(_planYearStartDate.Text);
planYearStartstring = planYearStartDate.Year.ToString();
planYearStartstring += (planYearStartDate.Month < 10) ? "0" + planYearStartDate.Month.ToString() : planYearStartDate.Month.ToString();
planYearStartstring += (planYearStartDate.Day < 10) ? "0" +
planYearStartDate.Day.ToString() :
planYearStartDate.Day.ToString();
request.PlanYearStartDate = planYearStartstring;
request.AdministratorId = _administratorId.Text;
// session IDreturned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.RemoveDependentAccount(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
SetDependentAccount
This method is used to set an account to a dependent for an employee that wishes their dependent to have access with their card.
Reenrolled Logic
- If the effective date, termination date, and Flex Account ID/Employee Account ID are not populated AND a non -PI account is found, then WCA will link the dependent to the first 'old' non -PI benefit account. Otherwise, WCA will return the error 'Flex account not found'.
- If an effective date and termination date are populated, then WCA will link the dependent to the respective benefit account within the effective and termination date range.
- If then Flex Account ID is populated, then WCA will link the dependent to the respective benefit account.
- If a Flex Account is not found, then WCA will return the error 'Benefit Account not found' (21010).
History
The SetDependentAccount methods are listed below:
- SetDependentAccountRequest_2010_04
- SetDependentAccountRequest_2008_07
- SetDependentAccountRequest_2006_05
- SetDependentAccountRequest
- SetDependentAccountResponse
SetDependentAccount Request/Response Messages
- SetDependentAccountRequest_2010_04
- SetDependentAccountRequest_2008_07
- SetDependentAccountRequest_2006_05
- SetDependentAccountRequest
- AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: SetDependentAccountRequest - DependentSocialSecurityNumberStringconditionally requiredDependent’s social security number.
First Available Version: SetDependentAccountRequest - DependentIdStringconditionally requiredRequired if this field is being used as the unique dependent identifier. Either this field or Dependent SSN may be used for this purpose.
First Available Version: SetDependentAccountRequest - EmployeeSocialSecurityNumberStringconditionally requiredEmployee’s social security number.
First Available Version: SetDependentAccountRequest - EmployeeIdStringconditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or Employee SSN may be used for this purpose.
First Available Version: SetDependentAccountRequest - EmployerIdStringrequiredUnique 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: SetDependentAccountRequest - PlanYearEndDateString (YYYYMMDD)required(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: SetDependentAccountRequest - PlanYearStartDateString (YYYYMMDD)required(YYYMMDD)Date that funds are available for services.
First Available Version: SetDependentAccountRequest - TpaIdStringA unique identifer 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.
First Available Version: SetDependentAccountRequest - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: SetDependentAccountRequest_2006_05 - EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: SetDependetAccountRequest_2008_08 - TerminationDateStringYYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
First Available Version: SetDependetAccountRequest_2008_08 - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: SetDependetAccountRequest_2011_04
Example of a SetDependentAccount SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>o3kaamaa2u4khf450irosiin</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<SetDependentAccount_2006_05
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2006/05/">
<SetDependentAccountRequest_2006_05>
<AccountTypeCode>DCA</AccountTypeCode>
<DependentSocialSecurityNumber>122132876</DependentSocialSecurityNumber>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerId>EASE10</EmployerId>
<PlanYearEndDate>20041031</PlanYearEndDate>
<PlanYearStartDate>20031101</PlanYearStartDate>
<AdministratorId>T00209</AdministratorId>
</SetDependentAccountRequest_2006_05>
</SetDependentAccount_2006_05>
</soap:Body>
</soap:Envelope>
Example of a SetDependentAccount response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<SetDependentAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2004/06/">
<SetDependentAccountResult />
</SetDependentAccountResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the SetDependentAccount method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for the account service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.SetDependentAccountRequest_2006_05();
// Set the input parameters
request.AccountTypeCode = _accountTypeCode.Text;
request.DependentSocialSecurityNumber = _dependentSocialSecurityNumber.Text;
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerId = _employerId.Text;
planYearEndDate = Convert.ToDateTime(_planYearEndDate.Text) ;
planYearEndstring = planYearEndDate.Year.ToString();
planYearEndstring += (planYearEndDate.Month < 10) ? "0" +
planYearEndDate.Month.ToString() :
planYearEndDate.Month.ToString();
planYearEndstring += (planYearEndDate.Day < 10) ? "0" +
planYearEndDate.Day.ToString() :
planYearEndDate.Day.ToString();
request.PlanYearEndDate = planYearEndstring;
planYearStartDate = Convert.ToDateTime(_planYearStartDate.Text);
planYearStartstring = planYearStartDate.Year.ToString();
planYearStartstring += (planYearStartDate.Month < 10) ? "0" +
planYearStartDate.Month.ToString() :
planYearStartDate.Month.ToString();
planYearStartstring += (planYearStartDate.Day < 10) ? "0" +
planYearStartDate.Day.ToString() :
planYearStartDate.Day.ToString();
request.PlanYearStartDate = planYearStartstring;
request.AdministratorId = _administratorId.Text;
// session IDreturned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.SetDependentAccount(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
UpdateEmployeeAccount
This method is used to update an employee’s existing account.
History
The UpdateEmployeeAccount methods are listed below:
- UpdateEmployeeAccountRequest_2022_02
- UpdateEmployeeAccountRequest_2020_10
- UpdateEmployeeAccountRequest_2018_02
- UpdateEmployeeAccountRequest_2015_10
- UpdateEmployeeAccountRequest_2011_04
- UpdateEmployeeAccountRequest_2010_04
- UpdateEmployeeAccountRequest_2009_04
- UpdateEmployeeAccountRequest_2008_07
- UpdateEmployeeAccountRequest_2006_05
- UpdateEmployeeAccountRequest
- UpdateEmployeeAccountResponse
UpdateEmployeeAccount Request/Response Messages
- UpdateEmployeeAccountRequest_2022_02
- UpdateEmployeeAccountRequest_2020_10
- UpdateEmployeeAccountRequest_2018_02
- UpdateEmployeeAccountRequest_2015_10
- UpdateEmployeeAccountRequest_2011_04
- UpdateEmployeeAccountRequest_2010_04
- UpdateEmployeeAccountRequest_2009_04
- UpdateEmployeeAccountRequest_2008_07
- UpdateEmployeeAccountRequest_2006_05
- UpdateEmployeeAccountRequest
- CardholderAccountStatusEnumerationrequiredActivity status of the account.
1 = New
2 = Active
3 = Temporarily Inactive
4 = Permanently Inactive
5 = TerminatedFirst Available Version: UpdateEmployeeAccountRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: UpdateEmployeeAccountRequest - EmployeeElectionDecimalrequiredAmount to be contributed by the employee automatically via the auto-deposit cycle. 0.00 is a valid amount.
First Available Version: UpdateEmployeeAccountRequest - EmployeeSocialSecurityNumberStringconditionally requiredEmployee’s social security number. This field is used to identify the employee and is not changed within this method.
First Available Version: UpdateEmployeeAccountRequest - EmployeeIdStringconditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or SSN may be used for this purpose.
First Available Version: UpdateEmployeeAccountRequest - EmployerElectionDecimalrequiredAmount to be contributed by the employer automatically via the auto-deposit cycle. 0.00 is a valid amount.
First Available Version: UpdateEmployeeAccountRequest - EmployerIdStringrequiredUnique 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: UpdateEmployeeAccountRequest - PlanYearEndDateString (YYYYMMDD)required(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: UpdateEmployeeAccountRequest - PlanYearStartDateString (YYYYMMDD)required(YYYMMDD)Date that funds are available for services.
First Available Version: UpdateEmployeeAccountRequest - StartAutoDepositDateDateThe 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.First Available Version: UpdateEmployeeAccountRequest Default Values: 1
- AdministratorIdStringA unique identifer 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.
First Available Version: UpdateEmployeeAccountRequest - EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: UpdateEmployeeAccountRequest_2006_05 - TerminationDateStringYYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
First Available Version: UpdateEmployeeAccountRequest_2006_05 - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: UpdateEmployeeAccountRequest_2006_05 - EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: UpdateEmployeeAccountRequest_2008_07 - TerminationDateStringYYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
First Available Version: UpdateEmployeeAccountRequest_2008_07 - EsignatureDateDateDate the E-signature was received by the Administrator.
First Available Version: UpdateEmployeeAccountRequest_2008_07 Default Values: 1
- EsignatureCodeStringEsignature code.
First Available Version: UpdateEmployeeAccountRequest_2008_07 - CoverageTierIdStringFor 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 accountFirst Available Version: UpdateEmployeeAccountRequest_2008_07 - IndividualBalanceMaxStringThis 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.First Available Version: UpdateEmployeeAccountRequest_2008_07 - RolloverBalanceMaxStringThis 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.First Available Version: UpdateEmployeeAccountRequest_2008_07 - AutoDepositCalendarIdStringIf 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.First Available Version: UpdateEmployeeAccountRequest_2008_07 - StartFixedEmployerFundingDateDateDate 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.First Available Version: UpdateEmployeeAccountRequest_2008_07 Default Values: 1
- ClaimsCrossoverOptionShortIf 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.First Available Version: UpdateEmployeeAccountRequest_2009_04 Default Values: 0
- DeductibleShort0 = 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.First Available Version: UpdateEmployeeAccountRequest_2009_04 Default Values: 0
- FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: UpdateEmployeeAccountRequest_2010_04 - ReenrollBooleanThis 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.First Available Version: UpdateEmployeeAccountRequest_2010_04 Default Values: FALSE
- AutoReimbursementSettingIntegerUse 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 ProviderFirst Available Version: UpdateEmployeeAccountRequest_2011_04 Default Values: 0
- EmployeeAnnualElectionDecimalEmployee annual election
First Available Version: UpdateEmployeeAccountRequest_2015_10 - EmployerAnnualElectionDecimalEmployer annual election
First Available Version: UpdateEmployeeAccountRequest_2015_10 - EmployeeIndividualAmountDecimalAnnual 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.First Available Version: UpdateEmployeeAccountRequest_2015_10 - Product IDStringThe 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.”First Available Version: UpdateEmployeeAccountRequest_2016_02 Default Values: Null
- SuspendDebitCardActivityBooleanSuspends debit card activity when there are ineligible/pending transactions 0 = False (Do not suspend debit card activity)
First Available Version: UpdateEmployeeAccountRequest_2018_02 - Subgroup#StringThe subgroup ID you wish to assign to the account.
First Available Version: UpdateEmployeeAccountRequest_2018_08 - AccountSegmentStringThe account segment ID you wish to assign to the account.
First Available Version: UpdateEmployeeAccountRequest_2018_08 - GracePeriodDeductibleStatusShortUpdate 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.First Available Version: UpdateEmployeeAccountRequest_2020_10 Default Values: 0
- GracePeriodDeductibleDateDateMust 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.First Available Version: UpdateEmployeeAccountRequest_2020_10 Default Values: Null
- OverridePrefundedAmountDecimalThis field sets the prefunded amount on the account directly, and regardless of the values of any other field in this request.
Note: This field is only for prefunded plan types and is ignored on payroll, HSA, and HRX/DTR plan types.First Available Version: UpdateEmployeeAccountRequest_2022_02
Response Body
No content
Example of a UpdateEmployeeAccount SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>o3kaamaa2u4khf450irosiin</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<UpdateEmployeeAccount_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2006/05/"><updateEmployeeAccountRequest_2006_05>
<UpdateEmployeeAccountRequest_2006_05>
<CardholderAccountStatus
xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</CardholderAccountStatus>
<AccountTypeCode>FSA</AccountTypeCode>
<EmployeeElection>200</EmployeeElection>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerElection>200</EmployerElection>
<EmployerId>EASE10</EmployerId>
<PlanYearEndDate>20041031</PlanYearEndDate>
<PlanYearStartDate>20031101</PlanYearStartDate>
<StartAutoDepositDate>2004-09-13</StartAutoDepositDate>
<AdministratorId>T00209</AdministratorId>
</UpdateEmployeeAccountRequest_2006_05>
</UpdateEmployeeAccount_2006_05>
</soap:Body>
</soap:Envelope>
Example of an UpdateEmployeeAccount response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<UpdateEmployeeAccountResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2004/06/">
<UpdateEmployeeAccountResult/>
</UpdateEmployeeAccountResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the UpdateEmployeeAccount method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
// Create proxy object for the account service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.UpdateEmployeeAccountRequest_2006_05();
// Set the input parameters
request.CardholderAccountStatus =
(AccountServiceNameSpace.AccountStatus)_accountStatus.SelectedItem;
request.AccountTypeCode = _accountTypeCode.Text;
request.EmployeeElection = Convert.ToDecimal(_employeeElection.Text);
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerElection = Convert.ToDecimal(_employerElection.Text);
request.EmployerId = _employerId.Text;
planYearEndDate = Convert.ToDateTime(_planYearEndDate.Text);
planYearEndstring = planYearEndDate.Year.ToString();
planYearEndstring += (planYearEndDate.Month < 10) ? "0" +
planYearEndDate.Month.ToString() :
planYearEndDate.Month.ToString();
planYearEndstring += (planYearEndDate.Day < 10) ? "0" +
planYearEndDate.Day.ToString() :
planYearEndDate.Day.ToString();
request.PlanYearEndDate = planYearEndstring;
planYearStartDate = Convert.ToDateTime(_planYearStartDate.Text);
planYearStartstring = planYearStartDate.Year.ToString();
planYearStartstring += (planYearStartDate.Month < 10) ? "0" +
planYearStartDate.Month.ToString() :
planYearStartDate.Month.ToString();
planYearStartstring += (planYearStartDate.Day < 10) ? "0" +
planYearStartDate.Day.ToString() :
planYearStartDate.Day.ToString();
request.PlanYearStartDate = planYearStartstring;
request.StartAutoDepositDate = Convert.ToDateTime(_startAutoDepositDate.Text);
request.AdministratorId = _administratorId.Text;
// session IDreturned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.UpdateEmployeeAccount(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
AddFlexAccountLifeEvent
This method is used to add employee flex account life event information to WCA.
History
The AddFlexAccountLifeEvent methods are listed below:
- AddFlexAccountLifeEventRequest
- AddFlexAccountLifeEventResponse
AddFlexAccountLifeEvent Request/Response Messages
- AddFlexAccountLifeEventRequest
- TPAIdStringrequiredA unique identifer 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.
First Available Version: AddFlexAccountLifeEventRequest - EmployerIdStringrequiredUnique 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: AddFlexAccountLifeEventRequest - PlanIdStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: AddFlexAccountLifeEventRequest - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: AddFlexAccountLifeEventRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: AddFlexAccountLifeEventRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: AddFlexAccountLifeEventRequest - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: AddFlexAccountLifeEventRequest - AnnualElectionDecimalrequiredAnnual 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 valueFirst Available Version: AddFlexAccountLifeEventRequest - LifeEventDateStringrequired(YYYYMMDD) - Date of new life event
First Available Version: AddFlexAccountLifeEventRequest - LifeEventCdeStringrequiredIf an alpha numeric value (no greater then 4) is entered as a value, we will verify that the code exists.
If Yes process accordingly.
If No return an error.
If the field is left blank, we will default to a blank value and process accordingly.First Available Version: AddFlexAccountLifeEventRequest - CoverageStatusEnum0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: AddFlexAccountLifeEventRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: AddFlexAccountLifeEventRequest - AccountSegmentStringThe account segment ID you wish to assign to the account.
First Available Version: AddFlexAccountLifeEventRequest_2018_08
Response Body
No Content
Example of an AddFlexAccountLifeEvent SOAP request message
<Request>
<![CDATA[<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBISessionHeader
xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>dx4evn55jretuf2c321ey145</MBISessionID>
</MBISessionHeader></soap:Header><soap:Body><AddFlexAccountLifeEventRequest xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2008/07/"><addFlexAccountLifeEve ntRequest>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<PlanId>FSA1</PlanId>
<EmployeeId>Emp0</EmployeeId>
<AccountTypeCode>FSA</AccountTypeCode>
<PlanYearStartDate>20080101</PlanYearStartDate>
<PlanYearEndDate>20081231</PlanYearEndDate>
<AnnualElection>100</AnnualElection>
<LifeEventDate>20080807</LifeEventDate>
<LifeEventCde>0010</LifeEventCde>
<CoverageStatus
xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</CoverageStatus></addFlexAccountLifeEventRequest></AddFlexAccountLifeEventRequest></soap:Body></soap:Envelope>]]>
</Request>
Example of an AddFlexAccountLifeEvent response message
[<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema - instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"><MessageId>b2b974ad-c024-4c10-87f3-
9c6e5bf45b65</MessageId></MBIMessageIdHeader><MBIWarningsHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"
/></soap:Header><soap:Body><AddFlexAccountLifeEventResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2008/07/"><AddFlexAccountLifeEventResult /></AddFlexAccountLifeEventResponse></soap:Body></soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the AddFlexAccountLifeEvent web method.
try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
//Create a response object to store the results
AccountServiceNameSpace.AddFlexAccountLifeEventResponse response;
// Create proxy object for the service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.AddFlexAccountLifeEventRequest ();
// Set the input parameters
Request.TpaId = _”T00481”;
request.EmployerId = “WWW2456”;
request.PlanId = “FSA1”; request.EmployeeId = “Emp0”;
request.AccountTypeCode = “FSA”;
request.PlanYearStartDate = “20080101”;
request.PlanYearEndDate = “20081231”;
request.AnnualElection = 5.00;
request.LifeEventDate = “20080808”;
request.LifeEventCde = “0010”;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.AddFlexAccountLifeEventRequest(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
AddFlexAccountLifeEvent1
This method is used to add employee flex account life event information to WCA, and allows Administrators to specify an Annual Election Amount of $0.00.
History
The AddFlexAccountLifeEvent methods are listed below:
- AddFlexAccountLifeEventRequest1
- AddFlexAccountLifeEventResponse1
AddFlexAccountLifeEvent1 Request/Response Messages
The AddFlexAccountLifeEvent1 method requires the following request and response messages (input and output data).
-
AddFlexAccountLifeEventRequest1
- TPAIdStringrequiredA unique identifer 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.
First Available Version: AddFlexAccountLifeEventRequest1 - EmployerIdStringrequiredUnique 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: AddFlexAccountLifeEventRequest1 - PlanIdStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: AddFlexAccountLifeEventRequest1 - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: AddFlexAccountLifeEventRequest1 - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: AddFlexAccountLifeEventRequest1 - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: AddFlexAccountLifeEventRequest1 - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: AddFlexAccountLifeEventRequest1 - AnnualElectionDecimalrequiredAnnual 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 valueFirst Available Version: AddFlexAccountLifeEventRequest1 - LifeEventDateStringrequired(YYYYMMDD) - Date of new life event
First Available Version: AddFlexAccountLifeEventRequest1 - LifeEventCdeStringrequiredIf an alpha numeric value (no greater then 4) is entered as a value, we will verify that the code exists.
If Yes process accordingly.
If No return an error.
If the field is left blank, we will default to a blank value and process accordingly.First Available Version: AddFlexAccountLifeEventRequest1 - CoverageStatisEnum0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: AddFlexAccountLifeEventRequest1 - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: AddFlexAccountLifeEventRequest1
Response Body:
No Content
UpdateFlexAccountLifeEvent
This method is used to update an employee’s existing flex account life event within WCA.
History
- UpdateFlexAccountLifeEventRequest
- UpdateFlexAccountLifeEventResponse
UpdateFlexAccountLifeEvent Request/Response Messages
- UpdateFlexAccountLifeEventRequest
- TPAIdStringrequiredA unique identifer 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.
First Available Version: UpdateFlexAccountLifeEventRequest - EmployerIdStringrequiredUnique 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: UpdateFlexAccountLifeEventRequest - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: UpdateFlexAccountLifeEventRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: UpdateFlexAccountLifeEventRequest - PlanIDStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: UpdateFlexAccountLifeEventRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: UpdateFlexAccountLifeEventRequest - AnnualElectionDecimalrequiredAnnual 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 valueFirst Available Version: UpdateFlexAccountLifeEventRequest - OldLifeEventDateStringrequired(YYYYMMDD) - Date of the life event that is being updated.
First Available Version: UpdateFlexAccountLifeEventRequest - NewLifeEventDateStringrequired(YYYYMMDD) - Date of new life event
First Available Version: UpdateFlexAccountLifeEventRequest - LifeEventCdeStringrequiredIf an alpha numeric value (no greater then 4) is entered as a value, we will verify that the code exists.
If Yes process accordingly.
If No return an error.
If the field is left blank, we will default to a blank value and process accordingly.First Available Version: UpdateFlexAccountLifeEventRequest - CoverageStatusEnumrequired0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: UpdateFlexAccountLifeEventRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: UpdateFlexAccountLifeEventRequest - AccountSegmentStringThe account segment ID you wish to assign to the account.
First Available Version: UpdateFlexAccountLifeEventRequest_2018_08
Response Body
No Content
Example of an UpdateFlexAccountLifeEvent SOAP request message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBISessionHeader
xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"><MBISessionID>dx4evn55jretuf2c321ey145</MBISessionID
></MBISessionHeader></soap:Header><soap:Body><UpdateFlexAccountLifeEventRequest
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2008/07/"><updateFlexAccountLifeE
ventRequest>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<PlanId>FSA1</PlanId>
<EmployeeId>Emp0</EmployeeId>
<AccountTypeCode>FSA</AccountTypeCode>
<PlanYearStartDate>20080101</PlanYearStartDate>
<PlanYearEndDate>20081231</PlanYearEndDate>
<AnnualElection>100</AnnualElection>
<LifeEventDate>20080807</LifeEventDate>
<LifeEventCde>0010</LifeEventCde>
<OldLifeEventDte>20080807</OldLifeEventDte>
<CoverageStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Suspended</CoverageStatus>
</updateFiexAccountlifeEventRequest><IUpdateFiexAccoll1tlteEventRequest></soap:Body></soap:Envelope>
Example of an UpdateFlexAccountLifeEvent response message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema -
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MessageId>37bc76d2-6fb3-48e1-b6ac-65a577811d7c</MessageId>
</MBIMessageIdHeader><MBIWarningsHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"
/></soap:Header><soap:Body><UpdateFlexAccountLifeEventResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2008/07/"><UpdateFlexAccountLif
eEventResult /></UpdateFlexAccountLifeEventResponse></soap:Body></soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the UpdateFlexAccountLifeEvent web method.
try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
//Create a response object to store the results
AccountServiceNameSpace.UpdateFlexAccountLifeEventResponse response;
// Create proxy object for the service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.UpdateFlexAccountLifeEventRequest ();
// Set the input parameters
Request.TpaId = _”T00481”;
request.EmployerId = “WWW2456”;
request.PlanId = “FSA1”;
request.EmployeeId = “Emp0”;
request.AccountTypeCode = “FSA”;
request.PlanYearStartDate = “20080101”;
request.PlanYearEndDate = “20081231”;
request.AnnualElection = 5.00;
request.LifeEventDate = “20080808”;
request.LifeEventCde = “0010”;
request.OldLifeEventDte = “20080808”;
request.CoverageStatus = AccountService.CoverageStatus.Suspended;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.UpdateFlexAccountLifeEventRequest(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
UpdateFlexAccountLifeEvent1
This method is used to update an employee’s existing flex account life event within WCA, and allows Administrators to specify an Annual Election Amount of $0.00.
History
The UpdateFlexAccountLifeEvent methods are listed below:
- UpdateFlexAccountLifeEventRequest1
- UpdateFlexAccountLifeEventResponse1
UpdateFlexAccountLifeEvent1 Request/Response Messages
- UpdateFlexAccountLifeEventRequest1
- TPAIdStringrequiredA unique identifer 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.
First Available Version: UpdateFlexAccountLifeEventRequest1 - EmployerIdStringrequiredUnique 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: UpdateFlexAccountLifeEventRequest1 - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: UpdateFlexAccountLifeEventRequest1 - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: UpdateFlexAccountLifeEventRequest1 - PlanIDStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: UpdateFlexAccountLifeEventRequest1 - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: UpdateFlexAccountLifeEventRequest1 - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: UpdateFlexAccountLifeEventRequest1 - AnnualElectionDecimalrequiredAnnual 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 valueFirst Available Version: UpdateFlexAccountLifeEventRequest1 - OldLifeEventDateStringrequired(YYYYMMDD) - Date of the life event that is being updated.
First Available Version: UpdateFlexAccountLifeEventRequest1 - NewLifeEventDateStringrequired(YYYYMMDD) - Date of new life event
First Available Version: UpdateFlexAccountLifeEventRequest1 - LifeEventCdeStringrequiredIf an alpha numeric value (no greater then 4) is entered as a value, we will verify that the code exists.
If Yes process accordingly.
If No return an error.
If the field is left blank, we will default to a blank value and process accordingly.First Available Version: UpdateFlexAccountLifeEventRequest1 - CoverageStatusEnumrequired0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: UpdateFlexAccountLifeEventRequest1 - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: UpdateFlexAccountLifeEventRequest1
Response Body
No Content
DeleteFlexAccountLifeEvent
This method is used to remove employee flex account life event information from WCA.
History
The DeleteFlexAccountLifeEvent methods are listed below:
- DeleteFlexAccountLifeEventRequest
- DeleteFlexAccountLifeEventResponse
DeleteFlexAccountLifeEvent Request/Response Messages
-
DeleteFlexAccountLifeEventRequest
- TPAIdStringrequiredA unique identifer 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.
First Available Version: DeleteFlexAccountLifeEventRequest - EmployerIdStringrequiredUnique 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: DeleteFlexAccountLifeEventRequest - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: DeleteFlexAccountLifeEventRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: DeleteFlexAccountLifeEventRequest - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: DeleteFlexAccountLifeEventRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: DeleteFlexAccountLifeEventRequest - PlanIdStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: DeleteFlexAccountLifeEventRequest - LifeEventDateStringrequired(YYYYMMDD) - Date of the life event to delete.
First Available Version: DeleteFlexAccountLifeEventRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: DeleteFlexAccountLifeEventRequest
Response Body
No Content
Example of an DeleteFlexAccountLifeEvent SOAP request message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBISessionHeader
xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"><MBISessionID>vxrelc45m2ulm2qjs3bdji55</MBISessionID
></MBISessionHeader></soap:Header><soap:Body><DeleteEmployeeAccount
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2008/07/"><deleteFlexAccountLifeE
ventRequest>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<EmployeeId>Emp0</EmployeeId>
<AccountTypeCode>FSA</AccountTypeCode>
<PlanYearEndDate>20081231</PlanYearEndDate>
<PlanYearStartDate>20080101</PlanYearStartDate>
<PlanId>FSA1</PlanId>
<LifeEventDate>20080807</LifeEventDate>
</deleteFlexAccountLifeEventRequest></DeleteEmployeeAccount></soap:Body></soap:Envelope>
Example of an DeleteFlexAccountLifeEvent response message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XM LSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MessageId>c9b315af-c73b-4dd4-a04c-b3f9970ee68f</MessageId></MBIMessageIdHeader>
<MBIWarningsHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"
/></soap:Header><soap:Body><DeleteFlexAccountLifeEventResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2008/07/"><DeleteFlexAccountLife
EventResult /></DeleteFlexAccountLifeEventResponse></soap:Body></soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the DeleteFlexAccountLifeEvent web method.
try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
//Create a response object to store the results
AccountServiceNameSpace.DeleteFlexAccountLifeEventResponse response;
// Create proxy object for the service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.DeleteFlexAccountLifeEventRequest ();
// Set the input parameters
Request.TpaId = _”T00481”;
request.EmployerId = “WWW2456”;
request.EmployeeId = “Emp0”;
request.AccountTypeCode = “FSA”;
request.PlanYearStartDate = “20080101”;
request.PlanYearEndDate = “20081231”;
request.PlanId = “FSA1”;
request.LifeEventDate = “20080808”;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.DeleteFlexAccountLifeEventRequest(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetFlexAccountLifeEventList
The GetFlexAccountLifeEventList method is used to get a list of the employee’s flex account life events.
History
The GetFlexAccountLifeEventList methods are listed below:
- GetFlexAccountLifeEventListRequest
- GetFlexAccountLifeEventListResponse _2020_02
- GetFlexAccountLifeEventListResponse
GetFlexAccountLifeEventList Request Messages
- GetFlexAccountLifeEventsRequest
- TPAIdStringrequiredA unique identifer 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.
First Available Version: GetFlexAccountLifeEventsRequest - EmployerIdStringrequiredUnique 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: GetFlexAccountLifeEventsRequest - PlanIdStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetFlexAccountLifeEventsRequest - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: GetFlexAccountLifeEventsRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetFlexAccountLifeEventsRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: GetFlexAccountLifeEventsRequest - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetFlexAccountLifeEventsRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetFlexAccountLifeEventsRequest
- GetFlexAccountLifeEventListResponse_2020_02
- GetFlexAccountLifeEventListResponse
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetFlexAccountLifeEventListResponse - EmployerIdStringUnique 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: GetFlexAccountLifeEventListResponse - EmployeeIdStringUnique identifier for the employee.
First Available Version: GetFlexAccountLifeEventListResponse - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetFlexAccountLifeEventListResponse - PlanYearEndDateString(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetFlexAccountLifeEventListResponse - PlanYearStartDateString(YYYMMDD)Date that funds are available for services.
First Available Version: GetFlexAccountLifeEventListResponse - AccountTypeCodeStringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetFlexAccountLifeEventListResponse - AnnualElectionDecimalAnnual 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 valueFirst Available Version: GetFlexAccountLifeEventListResponse - LifeEventDateString(YYYYMMDD) - The life event date.
First Available Version: GetFlexAccountLifeEventListResponse - LifeEventTypeStringLife event type code associated with the employee account coverage period.
First Available Version: GetFlexAccountLifeEventListResponse - CoverageStatusEnum0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: GetFlexAccountLifeEventListResponse - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetFlexAccountLifeEventListResponse - CoveragePeriodCreatedByStringReturns the admin/user/function who created the coverage period. Valid values are:
-WCA
-Admin userFirst Available Version: GetFlexAccountLifeEventListResponse _2020_02
Example of an GetFlexAccountLifeEventList SOAP request message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBISessionHeader
xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"><MBISessionID>zrjqy055uom1gc3bi43yll55</MBISessionID
></MBISessionHeader></soap:Header><soap:Body><GetFlexAccountLifeEventsRequest
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2008/07/"><getFlexAccountLifeEven
tsRequest>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<PlanId>FSA1</PlanId>
<EmployeeId>Emp1</EmployeeId>
<AccountTypeCode>FSA</AccountTypeCode>
<PlanYearStartDate>20080101</PlanYearStartDate>
<PlanYearEndDate>20081231</PlanYearEndDate>
</getFlexAccountLifeEventsRequest></GetFlexAccountLifeEventsRequest></soap:Body></soap:Envelope>
Example of an GetFlexAccountLifeEventList response message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MessageId>4d3a2186-c23c-4de6-baa4-094d6f8a61da</MessageId>
</MBIMessageIdHeader></soap:Header><soap:Body>
<GetFlexAccountLifeEventsResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2008/07/">
<GetFlexAccountLifeEventListResult>
<GetFlexAccountLifeEventsResponse>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<EmployeeId>Emp1</EmployeeId>
<PlanId>FSA1</PlanId>
<PlanYearEndDate>20081231</PlanYearEndDate>
<PlanYearStartDate>20080101</PlanYearStartDate>
<AccountTypeCode>FSA</AccountTypeCode>
<AnnualElection>400.0000</AnnualElection>
<LifeEventDate>20080807</LifeEventDate>
<LifeEventType>0001-Marital Status - Marriage</LifeEventType>
<CoverageStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</CoverageStatus>
</GetFlexAccountLifeEventsResponse></GetFlexAccountLifeEventListResult></GetFlexAccountLifeEventsResponse></soap:B
ody></soap:Envelope>
Example Client Code
try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
//Create a response object to store the results
AccountServiceNameSpace.GetFlexAccountLifeEventsResponse response;
// Create proxy object for the service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.GetFlexAccountLifeEventsRequest ();
// Set the input parameters
Request.TpaId = _”T00481”;
request.EmployerId = “WWW2456”;
request.PlanId = “FSA1”;
request.EmployeeId = “Emp0”;
request.AccountTypeCode = “FSA”;
request.PlanYearStartDate = “20080101”;
request.PlanYearEndDate = “20081231”;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.GetFlexAccountLifeEventsRequest(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetFlexAccountCoveragePeriodList
This method is used to get a list of all an employee’s flex account coverage periods given the employee’s account information.
History
- GetFlexAccountCoveragePeriodListRequest_2019_10
- GetFlexAccountCoveragePeriodListRequest
- GetFlexAccountCoveragePeriodListResponse_2020_02
- GetFlexAccountCoveragePeriodListResponse_2019_10
- GetFlexAccountCoveragePeriodListResponse
GetFlexAccountCoveragePeriodList Response Messages
- GetFlexAccountCoveragePeriodListRequest_2019_10
- GetFlexAccountCoveragePeriodListRequest
- TPAIdStringrequiredA unique identifer 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.
First Available Version: GetFlexAccountCoveragePeriodListRequest - EmployerIdStringrequiredUnique 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: GetFlexAccountCoveragePeriodListRequest - PlanIdStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetFlexAccountCoveragePeriodListRequest - EmployeeIdStringrequiredUnique identifier for the employee.
First Available Version: GetFlexAccountCoveragePeriodListRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetFlexAccountCoveragePeriodListRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: GetFlexAccountCoveragePeriodListRequest - PlanYearEndDateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetFlexAccountCoveragePeriodListRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetFlexAccountCoveragePeriodListRequest - SubgroupIDStringSubgroup ID assigned to the coverage period for this account type
First Available Version: GetFlexAccountCoveragePeriodListRequest_2019_10 Default Values: Empty
- GetFlexAccountCoveragePeriodListResponse_2020_02
- GetFlexAccountCoveragePeriodListResponse_2019_10
- GetFlexAccountCoveragePeriodListResponse
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetFlexAccountCoveragePeriodListResponse - EmployerIdStringUnique 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: GetFlexAccountCoveragePeriodListResponse - EmployeeIdStringEmployee ID, a unique identifer for the employee
First Available Version: GetFlexAccountCoveragePeriodListResponse - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetFlexAccountCoveragePeriodListResponse - PlanYearEndDateString(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetFlexAccountCoveragePeriodListResponse - PlanYearStartDateString(YYYMMDD)Date that funds are available for services.
First Available Version: GetFlexAccountCoveragePeriodListResponse - AccountTypeCodeStringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetFlexAccountCoveragePeriodListResponse - AnnualElectionDecimalAnnual 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 valueFirst Available Version: GetFlexAccountCoveragePeriodListResponse - AvailBalanceDecimalAvailable Balance is the Disbursable Balance plus the Auth Hold Balance.
If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.
Note: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetFlexAccountCoveragePeriodListResponse - CovPeriodStartDateString(YYYYMMDD) – Starting date for the coverage period.
First Available Version: GetFlexAccountCoveragePeriodListResponse - CovPeriodEndDteString(YYYYMMDD) – Ending date for the coverage period.
First Available Version: GetFlexAccountCoveragePeriodListResponse - DisbBalanceDecimalDisbursable Balance = Available Balance minus Auth Hold Balance.
If this account has multiple QLE Coverage Periods, this field will contain the current coverage period’s balance.
Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.First Available Version: GetFlexAccountCoveragePeriodListResponse - DisbPtdDecimalThe disbursable balance paid to date.
First Available Version: GetFlexAccountCoveragePeriodListResponse - PreauthPTDDecimalThe pre-authorization paid to date.
First Available Version: GetFlexAccountCoveragePeriodListResponse - LifeEventTypeStringLife event type code associated with the employee account coverage period.
First Available Version: GetFlexAccountCoveragePeriodListResponse - CoverageStatusEnum0 = Active
1 = Suspended (no transactions permitted unless using an “override”).First Available Version: GetFlexAccountCoveragePeriodListResponse - CoverageIdStringThis field is an ID assigned by WealthCare Admin to a coverage period within an Employee Account ID. Coverage IDs are only unique within an Account ID.
If this field is included on the template, this field will indicate the Coverage Period ID to which the balance provided is associated (Account IDs with multiple coverage IDs represent qualified life even coverage periods).
Field is always length of 10 with leading zeroes, such as “0000000001” The combination of Employee ID, Employee Account ID, Account Type Code, Plan Start Date, Plan End Date, Plan ID and Coverage ID creates a unique composite key for an employee coverage period.First Available Version: GetFlexAccountCoveragePeriodListResponse - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetFlexAccountCoveragePeriodListResponse - SubgroupIDStringSubgroup ID assigned to the coverage period for this account type
First Available Version: GetFlexAccountCoveragePeriodListResponse_2019_10 - CoveragePeriodCreatedByStringReturns the admin/user/function who created the coverage period.
-WCA
-Admin userFirst Available Version: GetFlexAccountCoveragePeriodListResponse_2020_02
Example of a GetFlexAccountCoveragePeriodList SOAP request message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><MBISessionHeader
xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/"><MBISessionID>4jdx5245anxlyz45wni1qhza</MBISessionID
></MBISessionHeader></soap:Header><soap:Body><GetFlexAccountCoveragePeriodListRequest
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Request/2008/07/">
<getFlexAccountCoveragePeriodListRequest>
<TpaId>T00481</TpaId>
<EmployerId>WWW27560</EmployerId>
<PlanId>FSA1</PlanId>
<EmployeeId>Emp1</EmployeeId>
<AccountTypeCode>FSA</AccountTypeCode>
<PlanYearStartDate>20080101</PlanYearStartDate>
<PlanYearEndDate>20081231</PlanYearEndDate>
</getFlexAccountCoveragePeriodListRequest></GetFlexAccountCoveragePeriodListRequest></soap:Body></soap:Envelope>
Example of an GetFlexAccountCoveragePeriodList response message
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xs i="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MessageId>515d0cfe-5684-4723-ab4a-8b790e8996b3</MessageId>
</MBIMessageIdHeader></soap:Header><soap:Body><GetFlexAccountCoveragePeriodListResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Account/Response/2008/07/"><GetFlexAccountCover
agePeriodListResult>
<GetFlexAccountCoveragePeriodListResponse>
<TpaId>T00481</TpaId><EmployerId>WWW27560</EmployerId><EmployeeId>Emp1</EmployeeId><PlanId>FSA1</PlanId><
PlanYearEndDate>20081231</PlanYearEndDate><PlanYearStartDate>20080101</PlanYearStartDate><AccountTypeCode>FS
A</AccountTypeCode><AnnualElection>5000.0000</AnnualElection><AvailBalance>4999.0000</AvailBalance><CovPeriodStar
tDte>20080101</CovPeriodStartDte><CovPeriodEndDte>20080806</CovPeriodEndDte><DisbBalance>4999.0000</DisbBalan
ce><DisbPtd>1.0000</DisbPtd><PreauthPTD>0.0000</PreauthPTD><LifeEventType>-</LifeEventType><CoverageStatus
xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</CoverageStatus></GetFlexAccountCoveragePeriodListRe
sponse><GetFlexAccountCoveragePeriodListResponse><TpaId>T00481</TpaId><EmployerId>WWW27560</EmployerId><Em
ployeeId>Emp1</EmployeeId><PlanId>FSA1</PlanId><PlanYearEndDate>20081231</PlanYearEndDate><PlanYearStartDate>
20080101</PlanYearStartDate><AccountTypeCode>FSA</AccountTypeCode><AnnualElection>400.0000</AnnualElection><A
vailBalance>399.0000</AvailBalance><CovPeriodStartDte>20080807</CovPeriodStartDte><CovPeriodEndDte>20081231</Co
vPeriodEndDte><DisbBalance>399.0000</DisbBalance><DisbPtd>0.0000</DisbPtd><PreauthPTD>0.0000</PreauthPTD><Life
EventType>0001-Marital Status - Marriage</LifeEventType><CoverageStatus
xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</CoverageStatus>
</GetFlexAccountCoveragePeriodListResponse></GetFlexAccountCoveragePeriodListResult></GetFlexAccountCoveragePerio
dListResponse></soap:Body></soap:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the GetFlexAccountCoveragePeriodList web method.
try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new AccountServiceNameSpace.MBISessionHeader();
//Create a response object to store the results
AccountServiceNameSpace.GetFlexAccountCoveragePeriodListResponse response;
// Create proxy object for the service
proxy = new AccountServiceNameSpace.AccountService();
// Create request message for method call (input parameters)
request = new AccountServiceNameSpace.GetFlexAccountCoveragePeriodListRequest();
// Set the input parameters
Request.TpaId = _”T00481”;
request.EmployerId = “WWW2456”;
request.PlanId = “FSA1”;
request.EmployeeId = “Emp0”;
request.AccountTypeCode = “FSA”;
request.PlanYearStartDate = “20080101”;
request.PlanYearEndDate = “20081231”;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.GetFlexAccountCoveragePeriodListRequest(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
GetEmployeeHSAAccountDetails
This method is used to get a list of all an employee’s HSA account details given the employee’s social security number, or card number, or the employee’s ID.
History
The GetEmployeeHSAAccountDetails methods are listed below:
- GetEmployeeHSAAccountDetailsRequest_2016_11
- GetEmployeeHSAAccountDetailsRequest_2015_02
- GetEmployeeHSAAccountDetailsResponse_2016_11
- GetEmployeeHSAAccountDetailsResponse_2015_02
GetEmployeeHSAAccountDetails Request/Response Messages
- GetEmployeeHSAAccountDetailsRequest
- CardProxyStringIf CardNumber is used for search criteria, this field indicates if the value in CardNumber is actually a card proxy number.
0 = CardNumber value is real card number
1 = CardNumber value is card proxy number
Note: For security, the Card Proxy number is always returned in the response.First Available Version: GetEmployeeHSAAccountDetailsRequest Default Values: 0
- CardNumberStringconditionally requiredProvide one of the following: card number, Employee Social Security Number, or Employee ID. All are not required. If either or both of the employee identifier fields (SSN or ID) are provided in addition to the card number, the card number is used.
First Available Version: GetEmployeeHSAAccountDetailsRequest - EmployeeIdStringconditionally requiredRequired if this field is being used as the unique employee identifier and card number is not provided. Either this field, CardNumber, or Employee SocialSecurity Number may be used for this purpose.
First Available Version: GetEmployeeHSAAccountDetailsRequest - EmployeeSocialSecurityNumberStringconditionally requiredRequired if this field is being used as the unique employee identifier and card number is not provided. Either this field, CardNumber or EmployeeID may be used for this purpose.
First Available Version: GetEmployeeHSAAccountDetailsRequest - EmployerIdStringrequiredUnique 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: GetEmployeeHSAAccountDetailsRequest - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetEmployeeHSAAccountDetailsRequest - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetEmployeeHSAAccountDetailsRequest - PlanYearListTypeEnumerationDefines what account years you wish to return. (ALL, Current, Previous, and Future)
First Available Version: GetEmployeeHSAAccountDetailsRequest Default Values: ALL
- TpaIdStringA unique identifer 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.
First Available Version: GetEmployeeHSAAccountDetailsRequest - VerboseModeBooleanIf set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetEmployeeHSAAccountDetailsRequest Default Values: FALSE
-
GetEmployeeHSAAccountDetailsResponse
- AccountStatusEnumerationActivity status of the account.
1 = New
2 = Active
3 = Temporarily Inactive
4 = Permanently Inactive
5 = TerminatedFirst Available Version: GetEmployeeHSAAccountDetailsResponse - AccountTypeCodeStringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetEmployeeHSAAccountDetailsResponse - AutoDepositCalendarIdStringID of calendar used with Auto Deposit cycle attached to the plan.
First Available Version: GetEmployeeHSAAccountDetailsResponse - Field NameIntegerUse 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
First Available Version: GetEmployeeHSAAccountDetailsResponse - AvailableBalanceDecimal1 - New
2 - Active
3 - TempInactive
4 - PermInactiveFirst Available Version: GetEmployeeHSAAccountDetailsResponse - ContributionsMadeThisYearDecimalTotal HSA contributions made this year
First Available Version: GetEmployeeHSAAccountDetailsResponse - ContributionsMadeThisYearEmployerDecimalTotal HSA contributions made this year by employer
First Available Version: GetEmployeeHSAAccountDetailsResponse - DateofDeath (MMDDYYYY)DateUse 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 ProviderFirst Available Version: GetEmployeeHSAAccountDetailsResponse - DisabilityDistributionDecimalDistribution amount for disability
First Available Version: GetEmployeeHSAAccountDetailsResponse - DisbPtdDecimalReturns the disbursements paid to date.
First Available Version: GetEmployeeHSAAccountDetailsResponse - DisbursableBalanceDecimalCard Proxy Number.
Note: The Card Proxy number is returned in this field when either 0 or 1 is passed in the “CardProxy” field in the request. For security, the Card Proxy number is always returned in the response.First Available Version: GetEmployeeHSAAccountDetailsResponse - DistributionOfExcessEarningsOnContributionsDecimalIf 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: If not specified, then the employee will be assigned the plan default setting for Claims Crossover Opt-InFirst Available Version: GetEmployeeHSAAccountDetailsResponse - EmployeeIdStringUnique identifier for the employee.
First Available Version: GetEmployeeHSAAccountDetailsResponse - Employee SocialSecurity NumberStringEmployee Social Security Number
First Available Version: GetEmployeeHSAAccountDetailsResponse - EmployerIdStringUnique 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: GetEmployeeHSAAccountDetailsResponse - FairMarketValueDecimalFair market value of HSA
First Available Version: GetEmployeeHSAAccountDetailsResponse - FixYeartoDateInterestDecimalYear to date interest adjustment
First Available Version: GetEmployeeHSAAccountDetailsResponse - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: GetEmployeeHSAAccountDetailsResponse - HSADateOfDeathFairMarketValueDate (MMDDYYYY)Fair market value of HSA at date of accountholder death
First Available Version: GetEmployeeHSAAccountDetailsResponse - HSALedgerBalanceDecimalBalance at the start of the processing day (the balance after end of day processing is complete for the prior day). This value only applies to HSA accounts.
First Available Version: GetEmployeeHSAAccountDetailsResponse - HsaCurrYrProcessingContrDecimalHSA Current Year Processing Contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - HsaCurrYrProcessingContrEmprDecimalHSA Current Year Processing Contributions Employer
First Available Version: GetEmployeeHSAAccountDetailsResponse - HsaPrevYrProcessingContrDecimalHSA Previous Year Processing Contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - HsaPrevYrProcessingContrEmprDecimalHSA Previous Year Processing Contributions Employer
First Available Version: GetEmployeeHSAAccountDetailsResponse - IDVerificationStatusStringID Verification Status
First Available Version: GetEmployeeHSAAccountDetailsResponse - IdvIdaFailureReasonStringID Verification Failure Reason
First Available Version: GetEmployeeHSAAccountDetailsResponse - IncidentFeeModelIdStringIncident Fee Model ID
First Available Version: GetEmployeeHSAAccountDetailsResponse - InterestAccruedAmtDecimalAmount of interest accrued in current year
First Available Version: GetEmployeeHSAAccountDetailsResponse - InterestPlanStringInterest Plan ID
First Available Version: GetEmployeeHSAAccountDetailsResponse - InterestRateDecimalInterest rate for HSA
First Available Version: GetEmployeeHSAAccountDetailsResponse - InvestmentFairMarketValueDecimalHSA Investment Fair Market Value
First Available Version: GetEmployeeHSAAccountDetailsResponse - LastInterestPaymentAmountDecimalLast Interest Payment Amount
First Available Version: GetEmployeeHSAAccountDetailsResponse - LastInterestPaymentDateDate (MMDDYYYY)Last Interest Payment Date
First Available Version: GetEmployeeHSAAccountDetailsResponse - MaintenanceFeeModelStringMaintenance Fee Model ID
First Available Version: GetEmployeeHSAAccountDetailsResponse - MiscFeeModelIdStringMiscellaneous Fee Model ID
First Available Version: GetEmployeeHSAAccountDetailsResponse - NextInterestPaymentDteDateDate of next interest payment
First Available Version: GetEmployeeHSAAccountDetailsResponse - NextStatementDateDate (MMDDYYYY)Date next statement will be issued
First Available Version: GetEmployeeHSAAccountDetailsResponse - NormalDistributionDecimalNormal distribution amount year to date
First Available Version: GetEmployeeHSAAccountDetailsResponse - OverdraftFeeThisPeriodDecimalOverdraft fees assessed this period
First Available Version: GetEmployeeHSAAccountDetailsResponse - OverdraftFeesYTDDecimalOverdraft fees assessed year to date
First Available Version: GetEmployeeHSAAccountDetailsResponse - PlanIdStringUnique identifier that distinguishes this plan from all others you administer.
First Available Version: GetEmployeeHSAAccountDetailsResponse - PlanYearEndDateString (YYYYMMDD)(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetEmployeeHSAAccountDetailsResponse - PlanYearStartDateString (YYYYMMDD)(YYYMMDD)Date that funds are available for services.
First Available Version: GetEmployeeHSAAccountDetailsResponse - PortfolioBalanceMarketValueDecimalInvestment portfolio balance market value
First Available Version: GetEmployeeHSAAccountDetailsResponse - PreauthBalDecimalTotal amount of all pre-auth transactions that currently do not have a matching force post for this employee
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearContributionsMadeDuringPriorYearEmployerDecimalTotal prior year contributions made by employer
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearContributionsReportableEmployerDecimalTotal prior year reportable contributions made by employer
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearDeathDistributionDecimalTotal prior year death distributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearDeathDistributionToNonSpouseDecimalTotal prior year death distributions to non-spouse
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearDisabilityDistributionDecimalTotal prior year disability distributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearDistributionOfEarningsOnExcessContributionsDecimalTotal prior year distribution of earnings on excess contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearDistributionofExcessContributionDecimalTotal prior year distribution of excess contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearFairMarketValueDecimalPrior year HSA fair market value
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearInvestmentFairMarketValueDecimalPrior year HSA investment fair market value
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearNormalDistributionDecimalTotal prior year normal distributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearProhibitedTransactionDistributionDecimalTotal prior year prohibited transaction distribution
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearRolloverContributionDecimalTotal prior year rollover contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearTotalContributionReportingDecimalPrior year total contribution reporting
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearTotalContributionsMadeDuringPriorYearDecimalTotal contributions made during prior year
First Available Version: GetEmployeeHSAAccountDetailsResponse - PriorYearTotalDistributionExcessContributionEarnDecimalTotal distributions on excess contributions made prior year
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerAccountCloseDateDate (MMDDYYYY)Date of HSA account closure
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerAccountNumberStringHSA Account Number
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerAccountOpenDateDate (MMDDYYYY)Date of HSA account opening
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerAccountUploadUpdateStatusStringProduct partner account upload update status
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerAcctStatusEnumerationReturns HSA account status
Active = 0,
Inactive = 1,
Pending = 2,
Dormant = 3,
ClosedAccount = 4,
FrozenPostNoTran = 5,
FrozenPostNoDebits = 6,
FrozenPostNoChecks = 7,
RejectedNeedInfo = 8,
RejectedNoUpdates = 9First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerErrorCodeIntegerProduct Partner Application Error Code
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerIdStringID associated with product partner
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerLastUploadStatusStringSpecifies whether data was successfully copied from WealthCare Admin to the Product Partner system.
3 = Success
4 = Error re Validation; see Product Partner Error Code field.
5 = Unexpected Error
6 = Deactivated
Note: This field will only populate if the account type is a Product Partner has account type.First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerNameStringProduct partner name
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerOptInStatusStringIndicates whether or not the employee is opted in for manual claim processing.
0 = Opt Out
1= Opt In
Note: This field will only populate if the account type is a Product Partner HSA account type.First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerProductIDStringBalance at the start of the processing day (the balance after end of day processing is complete for the prior day). This value only applies to HSA accounts.
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProductPartnerSigCardReceivedAccountOpenBooleanProduct Partner Signature Card Received – Indicates if account is open
First Available Version: GetEmployeeHSAAccountDetailsResponse - ProhibitedTransactionDistributionDecimalTotal prohibited transaction distributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - ReturnedItemFeesThisPeriodDecimalReturned item fees assessed this period
First Available Version: GetEmployeeHSAAccountDetailsResponse - ReturnedItemsFeesYTDDecimalReturned item fees assessed year to date
First Available Version: GetEmployeeHSAAccountDetailsResponse - RolloverContributionDecimalTotal rollover contributions
First Available Version: GetEmployeeHSAAccountDetailsResponse - StartAutoDeposit DateStringAuto Deposit Start Date
First Available Version: GetEmployeeHSAAccountDetailsResponse - TerminationDateStringYYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
First Available Version: GetEmployeeHSAAccountDetailsResponse - TotalContributionMadeNextYearDecimalTotal contributions made for future year
First Available Version: GetEmployeeHSAAccountDetailsResponse - TotalContributionReportingDecimalTotal contribution reporting
First Available Version: GetEmployeeHSAAccountDetailsResponse - TotalContributionReportingEmployerDecimalTotal employer contribution reporting
First Available Version: GetEmployeeHSAAccountDetailsResponse - TotalDistributionExcessContributionEarningsDecimalTotal distribution excess contribution earnings
First Available Version: GetEmployeeHSAAccountDetailsResponse - TotalPrevContributionMadeNextYearDecimalTotal previous contributions made for future year
First Available Version: GetEmployeeHSAAccountDetailsResponse - TpaIdStringAdministrator’s ID
First Available Version: GetEmployeeHSAAccountDetailsResponse - LastBalUpdateFromPPDateTimeLast Balance Update Received from Product Partner
Ex. 1900-01-01T00:00:00First Available Version: GetEmployeeHSAAccountDetailsResponse
Example of a GetEmployeeHSAAccountDetails SOAP request message
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers"
xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/Account/2010/04/V1"
xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Account/Request/2015/02/">
<soapenv:Header>
<mbiSessionHeader>
<mbi:MBISessionID>4jdx5245anzlyz45wni1qhza</mbi:MBISessionID>
</mbiSessionHeader>
</soapenv:Header>
<soapenv:Body>
<v1:GetEmployeeHSAAccountDetails>
<v1:request>
<ns:EmployeeId>123456789</ns:EmployeeId>
<ns:EmployerId>HSA1234</ns:EmployerId>
<ns:PlanYearListType>Current</ns:PlanYearListType>
</v1:request>
</v1:GetEmployeeHSAAccountDetails>
</soapenv:Body>
</soapenv:Envelope>
Example of a GetEmployeeHSAAccountDetails SOAP Response message
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="094afe0d-078d-4ad9-932e-3e24b1d0990a"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">c4b118b6-1a94-40b3-a9a5-
b729d1ab6b58</ActivityId>
<MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
<MessageId>urn:uuid:4cf6544b-7d5d-40e8-94bb-967f5bc3eefb</MessageId>
</MBIMessageIdHeader>
<mbiWarningsHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBIWarnings i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers"/>
</mbiWarningsHeader>
</s:Header>
<s:Body>
<GetEmployeeHSAAccountDetailsResponse
xmlns="http://bensoft.metavante.com/WebServices/Contracts/Account/2010/04/V1 ">
<GetEmployeeHSAAccountDetailsResult
xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Account/Response/2015/02/"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:GetEmployeeHSAAccountDetailsResponse i:type="b:GetEmploye eHSAAccountDetailsResponse_2016_11"
xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Account/Request/2016/11/">
<a:AccountStatus>Active</a:AccountStatus>
<a:AccountTypeCode>HSA</a:AccountTypeCode>
<a:AutoDepositCalendarId/>
<a:AutoReimbursementSetting>-1</a:AutoReimbursementSetting>
<a:AvailableBalance>0.0000</a:AvailableBalance>
<a:BalanceDue>0.0000</a:BalanceDue>
<a:CardNumber>1100109386121183</a:CardNumber>
<a:ClaimsCrossoverOptIn>-1</a:ClaimsCrossoverOptIn>
<a:ContributionMadeThisYear>0.00</a:ContributionMadeThisYear>
<a:ContributionMadethisYearEmployer>0.00</a:ContributionMadethisYearEmployer>
<a:DateofDeath/>
<a:DeathDistribution>0.00</a:DeathDistribution>
<a:DeathDistributionToNonSpouse>0.00</a:DeathDistributionToNonSpouse>
<a:DisabilityDistribution>0.00</a:DisabilityDistribution>
<a:DisbPtd>0.0000</a:DisbPtd>
<a:DisbursableBalance>0.0000</a:DisbursableBalance>
<a:DistributionOfExcessContribution>0.00</a:DistributionOfExcessContribution>
<a:DistributionOfExcessEarningsOnContributions>0.00</a:DistributionOfExcessEarningsOnContributions>
<a:ESignatureCode>False</a:ESignatureCode>
<a:ESignatureDate>1900-01-01T00:00:00</a:ESignatureDate>
<a:EligibilityDate>20160101</a:EligibilityDate>
<a:EmployeeId>abbygirl</a:EmployeeId>
<a:EmployeeSocialSecurityNumber>006690004</a:EmployeeSocialSecurityNumber>
<a:EmployerId>XXXX714001</a:EmployerId>
<a:FairMarketValue>0.00</a:FairMarketValue>
<a:FixYeartoDateInterest>0</a:FixYeartoDateInterest>
<a:FlexAcctId>0000000730</a:FlexAcctId>
<a:HSADateOfDeathFairMarketValue>0.00</a:HSADateOfDeathFairMarketValue>
<a:HSALedgerBalance>0.00</a:HSALedgerBalance>
<a:HsaCurrYrProcessingContr>0.00</a:HsaCurrYrProcessingContr>
<a:HsaCurrYrProcessingContrEmpr>0.00</a:HsaCurrYrProcessingContrEmpr>
<a:HsaPrevYrProcessingContr>0.00</a:HsaPrevYrProcessingContr>
<a:HsaPrevYrProcessingContrEmpr>0.00</a:HsaPrevYrProcessingContrEmpr>
<a:IDVerificationStatus>NoIdCheck</a:IDVerificationStatus>
<a:IdvIdaFailureReason>NoIdVperformed,NoIdVperformed</a:IdvIdaFailureReason>
<a:IncidentFeeModelId/>
<a:InterestAccruedAmt>0</a:InterestAccruedAmt>
<a:InterestPlan/>
<a:InterestRate>0</a:InterestRate>
<a:InvestmentFairMarketValue>0.00</a:InvestmentFairMarketValue>
<a:LastInterestPaymentAmount>0</a:LastInterestPaymentAmount>
<a:LastInterestPaymentDate/>
<a:MaintenanceFeeModel/>
<a:MiscFeeModelId/>
<a:NextInterestPaymentDte/>
<a:NextStatementDate/>
<a:NormalDistribution>0.00</a:NormalDistribution>
<a:OverdraftFeeThisPeriod>0.00</a:OverdraftFeeThisPeriod>
<a:OverdraftFeesYTD>0.00</a:OverdraftFeesYTD>
<a:PlanId>WE5</a:PlanId>
<a:PlanYearEndDate>20991231</a:PlanYearEndDate>
<a:PlanYearStartDate>20160101</a:PlanYearStartDate>
<a:PortfolioBalanceMarketValue>0.00</a:PortfolioBalanceMarketValue>
<a:PreauthBal>0.0000</a:PreauthBal>
<a:PriorYearContributionsMadeDuringPriorYearEmployer>0.00</a:PriorYearContributionsMadeDuringPriorYearEmployer>
<a:PriorYearContributionsReportableEmployer>0.00</a:PriorYearContributionsReportableEmployer>
<a:PriorYearDeathDistribution>0.00</a:PriorYearDeathDistribution>
<a:PriorYearDeathDistributionToNonSpouse>0.00</a:PriorYearDeathDistributionToNonSpouse>
<a:PriorYearDisabilityDistribution>0.00</a:PriorYearDisabilityDistribution>
<a:PriorYearDistributionOfEarningsOnExcessContributions>0.00</a:PriorYearDistributionOfEarningsOnExcessContributions>
<a:PriorYearDistributionofExcessContribution>0.00</a:PriorYearDistributionofExcessContribution>
<a:PriorYearFairMarketValue>0.00</a:PriorYearFairMarketValue>
<a:PriorYearInvestmentFairMarketValue>0.00</a:PriorYearInvestmentFairMarketValue>
<a:PriorYearNormalDistribution>0.00</a:PriorYearNormalDistribution>
<a:PriorYearProhibitedTransactionDistribution>0.00</a:PriorYearProhibitedTransactionDistribution>
<a:PriorYearRolloverContribution>0.00</a:PriorYearRolloverContribution>
<a:PriorYearTotalContributionReporting>0.00</a:PriorYearTotalContributionReporting>
<a:PriorYearTotalContributionsMadeDuringPriorYear>0.00</a:PriorYearTotalContributionsMadeDuringPriorYear>
<a:PriorYearTotalDistributionExcessContributionEarn>0.00</a:PriorYearTotalDistributionExcessContributionEarn>
<a:ProductPartnerAccountCloseDate/>
<a:ProductPartnerAccountNumber/>
<a:ProductPartnerAccountOpenDate/>
<a:ProductPartnerAccountUploadUpdateStatus/>
<a:ProductPartnerAcctStatus>Pending</a:ProductPartnerAcctStatus>
<a:ProductPartnerErrorCode/>
<a:ProductPartnerId>WE3</a:ProductPartnerId>
<a:ProductPartnerLastUploadStatus>DisclosureAcknowledgementRequired</a:ProductPartnerLastUploadStatus>
<a:ProductPartnerName>Will3</a:ProductPartnerName>
<a:ProductPartnerOptInStatus>false</a:ProductPartnerOptInStatus>
<a:ProductPartnerProductID>WE5</a:ProductPartnerProductID>
<a:ProductPartnerSigCardReceivedAccountOpen>false</a:ProductPartnerSigCardReceivedAccountOpen>
<a:ProhibitedTransactionDistribution>0.00</a:ProhibitedTransactionDistribution>
<a:ReturnedItemFeesThisPeriod>0.00</a:ReturnedItemFeesThisPeriod>
<a:ReturnedItemsFeesYTD>0.00</a:ReturnedItemsFeesYTD>
<a:RolloverContribution>0.00</a:RolloverContribution>
<a:StartAutoDepositDate>20160101</a:StartAutoDepositDate>
<a:TerminationDate></a:TerminationDate>
<a:TotalContributionMadeNextYear>0.00</a:TotalContributionMadeNextYear>
<a:TotalContributionReporting>0.00</a:TotalContributionReporting>
<a:TotalContributionReportingEmployer>0.00</a:TotalContributionReportingEmployer>
<a:TotalDistributionExcessContributionEarnings>0.00</a:TotalDistributionExcessContributionEarnings>
<a:TotalPrevContributionMadeNextYear>0.00</a:TotalPrevContributionMadeNextYear>
<a:TpaId>T02171</a:TpaId>
<a:TrustModelNum/>
<a:UncollectedFees>0.00</a:UncollectedFees>
<b:LastBalUpdateFromPP>1900-01-01T00:00:00</b:LastBalUpdateFromPP>
</GetEmployeeHSAAccountDetailsResult>
</GetEmployeeHSAAccountDetailsResponse>
</s:Body>
</s:Envelope>
Example Client Code
The following is an example of the client code (using a .NET proxy class for the service) used when calling the GetEmployeeHSAAccountDetails method.
try
{
// Create the session SOAP header in order to pass the Account Service
// the client’s current session id.
localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
// Create proxy object for the account service
localhost.AccountService proxy = new localhost.AccountService();
// Create request message for method call (input parameters)
localhost.GetEmployeeHSAAccountDetailsRequest request = new
localhost.GetEmployeeHSAAccountDetailsRequest();
// Declare reference variable for receiving the returned values,
// in this case the response will contain the account information.
localhost.GetEmployeeHSAAccountDetailsResponse[] responses;
// Set the input parameters
request.EmployerId = "XXXXXXXXX";
request.EmployeeID = "999999999";
request.PlanYearListType = "Current";
// session IDreturned from login method
sh.MBISessionID = _sessionID;
proxy.MBISessionHeaderValue = sh;
// Call the Get Employee HSA Account Details method
responses = proxy.GetEmployeeHSAAccountDetails(request);
if(responses != null)
{
for(int i=0; i < responses.Length; i++)
{
// perform needed operations
}
}
else
{
MessageBox.Show("Records not found");
}
}
SetHealthCareCoveragePeriod
This method is used to add coverage periods (similar to the healthcare coverage period (FF) EDI record type).
- Effective date
- Termination date
- Coverage tier
- Subgroup
- Account segment ID
- Product partner product ID
Note: If subgroups and/or life event management are NOT enabled, the fields listed above are not ignored and values provided using UpdateEmployeeAccount are populated.
History
The SetHealthCareCoveragePeriod methods are listed below:
- SetHealthCareCoveragePeriod
Response Messages
SetHealthCareCoveragePeriod Request/Response Messages
The SetHealthCareCoveragePeriod method requires the following request and response messages (input and output data).
- SetHealthCareCoveragePeriodRequest
- TPAIDStringrequiredA unique identifer 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.
First Available Version: SetHealthCareCoveragePeriodRequest - EmployerIDStringrequiredUnique 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: SetHealthCareCoveragePeriodRequest - PlanIDStringrequiredUnique identifier that distinguishes this plan from all others you administer.
First Available Version: SetHealthCareCoveragePeriodRequest - EmployeeIDStringrequiredUnique identifier assigned to the employee.
First Available Version: SetHealthCareCoveragePeriodRequest - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: SetHealthCareCoveragePeriodRequest - AccountIDStringconditionally requiredAccount ID assigned by WCA to a re-enrolled account. Note: Only used when reenrollment feature is used.
First Available Version: SetHealthCareCoveragePeriodRequest - PlanStartDateDaterequiredMust match exactly what is provided on the employer plan import.
First Available Version: SetHealthCareCoveragePeriodRequest - PlanEndDateDaterequiredMust match exactly what is provided on the employer plan import.
First Available Version: SetHealthCareCoveragePeriodRequest - CoveragePeriodStatusEnumeration0 = Active
1 = Void a coverage period
Note: When submitting ‘1’ (void), coverage period start date and coverage period end date must be equal.First Available Version: SetHealthCareCoveragePeriodRequest - CoveragePeriodStartDateDaterequiredDate 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.
Coverage period start date cannot be before another coverage period's end date.First Available Version: SetHealthCareCoveragePeriodRequest - CoveragePeriodEndDateDateDate 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.
First Available Version: SetHealthCareCoveragePeriodRequest - CoverageTierIDStringThe coverage tier ID provided must match a coverage tier ID set up for the employer group in WCA.
First Available Version: SetHealthCareCoveragePeriodRequest - SubgroupIDStringProvide 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 # is not provided, then no subgroup is associated with the coverage period. If updating an existing coverage period with a subgroup associated and the subgroup is blank, then no subgroup will be associated to the coverage period once updated.
First Available Version: SetHealthCareCoveragePeriodRequest - AccountSegmentIDStringProvide 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.
First Available Version: SetHealthCareCoveragePeriodRequest - LifeEventCodeNumericA 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.
First Available Version: SetHealthCareCoveragePeriodRequest - ProductPartnerProductIDStringThe 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.
First Available Version: SetHealthCareCoveragePeriodRequest - AnnualElectionFamilyAmountCurrencyIf fixed employer funding is enabled for the plan/subgroup, then this field will be ignored.
First Available Version: SetHealthCareCoveragePeriodRequest - IndividualAmountCurrencyA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: SetHealthCareCoveragePeriodRequest - RecordTrackingNumberStringThe record tracking number is used to identify line numbers within an import record. If this field is sent during import, WCA will return these values in the result file.
First Available Version: SetHealthCareCoveragePeriodRequest - TrackingNumberStringThis value is stored in WCA and can be used for research purposes.
First Available Version: SetHealthCareCoveragePeriodRequest
EnrollHSAAccount
In an effort to increase the number of HSA-related tasks which can be automated, product partner users can now set enrollment status and account open dates for WealthCare HSAs via a new web service method: EnrollHSAAccount. This web service can only be utilized by partner users with profile access to edit HSA accounts.
This method allows partner users to specify an 'enrollment action' and 'product partner account open date' and follows existing logic on the edit benefit account page in WCA.
History
- EnrollHSAAccount
Response Messages
EnrollHSAAccount request/response messages
- EnrollHSAAccount
- ProductPartnerIdAlphanumericrequiredProduct ID
First Available Version: EnrollHSAAccount - TpaIdAlphanumericrequiredA unique identifer 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.
First Available Version: EnrollHSAAccount - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: EnrollHSAAccount - EmployeeIdAlphanumericrequiredUnique identifier assigned to the employee.
First Available Version: EnrollHSAAccount - EmployerIdAlphanumericrequiredUnique 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: EnrollHSAAccount - PlanIdAlphanumericUnique identifier that distinguishes this plan from all others you administer.
First Available Version: EnrollHSAAccount - PlanStartdateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: EnrollHSAAccount - PlanEnddateStringrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: EnrollHSAAccount - EmployeeSocialSecurityNumberStringrequiredEmployee social security number
First Available Version: EnrollHSAAccount - FlexAcctIdStringA unique identifer for the employee's account, generated by WCA when the account was first set up.
First Available Version: EnrollHSAAccount - EnrollmentActionEnumeration0 – None
8 - Application Approved Manually
10 – Application Denied No Reapply
11 – Application Denied Reapply Allowed
13 – Awaiting Additional InformationFirst Available Version: EnrollHSAAccount - ProductPartnerAccountOpenDateString(YYYYMMDD)Product partner account open date
First Available Version: EnrollHSAAccount