Add Employer Logical Bank Account

https://api.wealthcare.com/system/Services/Employer/LogicalBankAccount/{tpaId}/{employerId}

Use this to add an Employer's logical bank account.

Path parameters

tpaId string Required

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

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

Request body

emailDaily boolean

Determines if there will be a daily email sent out.
nextCheckNumSpecified boolean

Determines if the next check number is specified.

reimbSchOverName1 string

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.

Min Length:	0
Max Length:	50

reimbSchOverName2 string

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.

Min Length:	0
Max Length:	50

bankAccountDisplayName string

Name associated with the logical bank account. Must be unique within the administrator Suggested format: Group ID prefix + Group ID + 3 digit sequence number starting with 001. For example, PFXGROUPID001.

Min Length:	0
Max Length:	50

convenienceFeesPaid boolean

Indicates if convenience fees are being paid on this employer account.
minBalanceReceiveAlert number <double>

The dollar amount that, if the account balance goes below, will result in a balance alert.
nextCheckNumber integer <int32>

Check number for reimbursement processing. Required if UseEmployerAccountCheckNumber is set to True.
physicalBankAccountName string

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

Email address of person selected to receive activity emails.
receiveAccountActivityViaEmail boolean

Indicates if daily account activity will be received via email.
typeOfClaimsAffected enum<string>

What type of claims should affect this account?

POS Manual All

Possible values: POS Manual All
planType string

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

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

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

Indicates if employer funding is enabled on this logical account.
fundingTemplateName string

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

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

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.
fundingNotificationCCAddress string

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.
fundingNotificationBCCAddress string

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.
fundingNotificationSubject string

This field defines the subject of the email sent to employer groups communicating debits and credits to the employer funding account.
processLogicalDeposits integer <int32>
1. – Never (default)
2. – Upon completion of funding schedule
3. – Upon funding clear date
New account:

If field is included in the import, account is set to the value entered. Defaults to 0 (never) 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 (never).

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

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

The tracking number is used to identify request. If this field is sent with a request, WCA will return this value in the response.
beginningDate string <date-time>

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.
employerFunding enum<string>

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

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

Possible values: None ClaimActivityFunding OnDemand HSA Payroll
hsaFundingOption enum<string>

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

Automated Settlement Nacha Files

Possible values: None AutomatedSettlement NachaFiles

checkFileExportTemplate string

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

Min Length:	0
Max Length:	50

checkPrintingTemplate string

This is the name of template used for Check Printing.

Min Length:	0
Max Length:	50

directDepositFileExportTemplate string

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

Min Length:	0
Max Length:	50

reimbursementSignature string

Reimbursement signature.

Min Length:	0
Max Length:	50

reimbursementComment string

Reimbursement comment text.

Min Length:	0
Max Length:	50

enableReminderCommunication boolean

Determines if reminder communications will go out.
reminderNotificationToEmail string

Email addresses that reminder notifications will be sent to.
reminderNotificationCCEmail string

Email addresses that reminder notifications will be CC'd on.
reminderNotificationBCCEmail string

Email addresses that reminder notifications will be BCC'd on.
reminderNotificationTemplateName string

Template name attached to the reminder notifications.
reminderNotificationSendDaysPrior integer <int32>

How many days in advance the reminder notifications should be sent.
fundingNotificationTemplate string

Funding notification template name.
fundingNotificationDaysPrior integer <int32>

How many days in advance funding notifications should be sent.

divisionName string

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.

Min Length:	0
Max Length:	50

billingGroup string

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.

Min Length:	0
Max Length:	150

accountSegmentId string

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.

Min Length:	0
Max Length:	15

enableEmployerHSAFundingManagement boolean

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

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).
suppressNACHA boolean

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.
fundNotClearedAlert boolean

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.
trackInvoiceDueDate boolean

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.
invoiceDueDays integer <int32>

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.

Response

TrackingNumber string
ErrorCode integer <int32>