Administrative APIs | REST

Optional, used only if the current logged on user is type Administrator.

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

Determines if the next check number is specified.

Optionally include the name of existing reimbursement schedule in WCA.

WCA overrides any current/future reimbursement schedules assigned at the employer level and uses the schedule that is set using this field for all transactions affecting this notional account.

Optionally include the name of existing reimbursement schedule in WCA.

WCA overrides any current/future reimbursement schedules assigned at the employer level and uses schedule that is set using this field for the specified plan.

Note: Override 2 can only be set if override 1 is also set, and no division, billing group or account segment has been selected for this notional account.

Display name associated with the logical bank account.

Indicates if convenience fees are being paid on this employer account.

The dollar amount that, if the account balance goes below, will result in a balance alert.

Check number for reimbursement processing.

Name of the ACH account to which the employer group is associated.

Email address of person selected to receive activity emails.

Indicates if daily account activity will be received via email.

What type of claims should affect this account?

POS Manual All

Type of benefit plan or account, such as FSA, DCA, or TRN.

Indicates if Employer Account specified check number will be used for reimbursement processing.

Indicates if this is a zero balance account. If true, POS claims are NOT authorized against the account.

Status of the Logical Account.

New Active TempInactive PermInactive PendingValidation ValidationRequired FixAccount

Should WCA Temp Inactivate an Employer, if the Logical Account balance drops below $0.00?

Leave empty unless changing BankAccountDisplayName.

Indicates if employer funding is enabled on this logical account.

This field should be used to name the Funding Template for employer funding.

This field should be used to name the Employer Funding Account used for employer funding.

This field is not required to utilize the Employer Funding feature.  The email address is used to communicate debit and credit information to the employer group.

This field is not required to utilize the Employer Funding feature.  The email address is used to communicate debit and credit information to the employer group via CC.

This field is not required to utilize the Employer Funding feature.  The email address is used to communicate debit and credit information to the employer group via BCC.

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.

Determines whether to process logical deposits upon completion of a Claims Based funding schedule.  Requires a Claim Activity Funding Template be assigned to the Logical Account.

This is name of the physical bank account used for Direct Deposit processing.

The tracking number is used to identify request.  If this field is sent with a request, WCA will return this value in the response.

The begin date field is used by administrators to indicate when payroll deposits should start funding HSA accounts using the automated HSA funded functionality in WCA. Deposits inserted prior to the begin date will not be used as funding deposits.

This field is required if ‘EnableEmployerFunding’ is set to True. Values:

None Claim Activity Funding (default) On-Demand HSA Payroll Funding Payroll Funding

This field is required if ‘EmployerFunding’ is set to HSA Payroll Funding. Values:

Automated Settlement Nacha Files

This is the name of template used for Check File Export.

This is the name of template used for Check Printing.

This is the name of template used for Direct Deposit File Export.

Signature on the reimbursement.

Comment on the reimbursement.

Determines if reminder communication will be enabled.

Indicates the email address that reminder notifications will be sent to.

Indicates the email address that reminder notifications will be CC'd on.

Indicates the email address that reminder notifications will be BCC'd on.

Reminder notification template name.

Determines how many days prior the reminder notification should go out.

This field should be used to name the Funding Template for employer funding.

Determines how many days prior the funding notification should go out.

Default/blank = All By specifying a division, WCA limits which transactions to associate with the notional account. Must be a valid division associated with the employer.

Default/blank = All

By specifying a billing group name, WCA limits which transactions to associate with the notional account. Must be a valid billing group associated with the employer.

Default/blank = All

By specifying an account segment ID, WCA limits which transactions to associate with the notional account. Must be a valid account segment ID associated with the employer.  If a billing group is specified, then the account segment ID must match an account segment within the billing group.

This option enables the employer-level HSA funding account, on the employer level. Values: 0 – Disabled (default) 1 – Enabled

New account:

If field is included in the import, account is set to the value entered.

Defaults to 0 (no), if no value is entered or field is not included. Update account:

If field is included in the import, account is set to the value entered.

If field is included but no value is entered, account is set to 0 (no).

If field is not included in the import, existing settings remain unchanged.

If admin-level invoicing option is not enabled, an error is returned.

If a communication template is not enabled, an error is returned.

Note: If ‘process logical deposits upon fund clear date’ is selected, this option is defaulted to 1 (yes).

0 – No (default) 1 – Yes

New account:

If field is included in the import, account is set to the value entered.

Defaults to 0 (no), if no value is entered or field is not included. Update account:

If field is included in the import, account is set to the value entered.

If field is included but no value is entered, account is set to 0 (no).

If field is not included in the import,existing settings remain unchanged.

‘Enable invoicing options’ must be set to ‘yes’ to enable this setting.  If not, an error is returned.

0 – No (default) 1 – Yes

New account:

If field is included in the import, account is set to the value entered.

Defaults to 0 (no), if no value is entered or field is not included. Update account:

If field is included in the import, account is set to the value entered.

If field is included but no value is entered, account is set to 0 (no).

If field is not included in the import, existing settings remain unchanged.

‘Enable invoicing options’ and ‘suppress NACHA’ both must be set to ‘yes’ to enable this setting.  If not, errors are returned.

0 – No (default) 1 – Yes

New account:

If field is included in the import, account is set to the value entered.

Defaults to 0 (no), if no value is entered or field is not included. Update account:

If field is included in the import, account is set to the value entered.

If field is included but no value is entered, account is set to 0 (no).

If field is not included in the import, existing settings remain unchanged.

‘Enable invoicing options’ must be set to ‘yes’ to enable this setting.  If not, an error is returned.

Specify number of days; 1 (default) through 5

New account:

If field is included in the import, account is set to the value entered.

Defaults to 1 if no value is entered or field is not included.

Update account:

If field is included in the import, account is set to the value entered. If field is included but no value is entered, account is set to 1. If field is not included in the import, existing settings remain unchanged.

‘Enable invoicing options’ and ‘track due date’ both must be set to ‘yes’ to enable this.