Examples of Loading External Bank Accounts

An external bank account record holds the details of a bank account at a bank branch. Bank accounts are used by payment methods to make payments to a person.

Bank, Bank Branch, and External Bank Account are business objects whose details are stored in non-HCM tables. However, you can load them using HCM Data Loader. This topic describes aspects of the External Bank Account object that you must understand to load external bank accounts successfully.

Bank and Bank Branch

Before you can create an External Bank Account object, you must create both the bank and the bank branch where the bank account is held.

Note: When you create a bank or a bank branch using HCM Data Loader, they're created with the institution types of Bank and Bank Branch respectively. You can only maintain and reference banks and bank branches with these institution types. If you create the bank or the branch using any other method, the HCM Data Loader can't find them when you try creating a bank account later.

Loading External Bank Accounts

You supply external bank account data in the ExternalBankAccount.dat file for processing by HCM Data Loader. Multiple user keys are supported for referencing the external bank account. For details of these user keys, view the External Bank Account object on the Business Object Details page, using the View Business Objects task.

The External Bank Account Owner component identifies a person or third party to whom the account belongs. A bank account can be associated with multiple owners, of whom one must be the primary owner. Use the discriminator ExternalBankAccountOwner to load External Bank Account Owner components. Set the PrimaryFlag attribute of the relevant component to Y to identify the primary owner. Multiple user keys are supported for referencing the external bank account owner. For details of these user keys, view the External Bank Account Owner component on the Business Object Details page.

Note: You can't load external bank accounts for pending workers.

It is recommended that you use source keys to identify the external bank account and to reference the bank and bank branch the account is for. To support the various localization requirements there are a large number of user keys provided, supplying source keys removes that complexity.

This ExternalBankAccount.dat example uses source keys to identify the bank, bank branch, external bank account, and the external bank account owner.

METADATA|ExternalBankAccount|SourceSystemOwner|SourceSystemId|BankId(SourceSystemId)|BankBranchId(SourceSystemId)|CountryCode|CurrencyCode|AccountNumber|AccountName|AccountType
MERGE|ExternalBankAccount|VISION|12345678_CA|CA10001A|111111A|CA|CAD|12345678|J and P Smith|SAVINGS

METADATA|ExternalBankAccountOwner|SourceSystemOwner|SourceSystemId|ExternalBankAccountId(SourceSystemId)|PersonId(SourceSystemId)|PrimaryFlag
MERGE|ExternalBankAccountOwner|VISION|12345678_CA_121011|12345678_CA|SK121011|Y

This example ExternalBankAccount.dat file uses user keys to create an External Bank Account and associate it with two owners, one of whom is the primary owner.

METADATA|ExternalBankAccount|BankNumber|BankBranchNumber|CountryCode|AccountNumber|IBAN|AccountName|CurrencyCode
MERGE|ExternalBankAccount|100001A|111111A|CA|12345678|CA23 ANBK 3350 1234 5678 20|J and P Smith|USD
METADATA|ExternalBankAccountOwner|BankNumber|BankBranchNumber|CountryCode|AccountNumber|CurrencyCode|PersonNumber|PrimaryFlag
MERGE|ExternalBankAccountOwner|100001A|111111A|CA|12345678|USD|121011|Y
MERGE|ExternalBankAccountOwner|100001A|111111A|CA|12345678|USD|126231|N

Inactivating External Bank Accounts

You can delete an External Bank Account object, and recreate it if necessary, using HCM Data Loader. Alternatively, you can make the bank account inactive. This example ExternalBankAccount.dat file makes an external bank account inactive by including the InactiveFlag attribute and setting it to Y.

Note: When you inactivate a bank account, any updates to other attributes are ignored.

METADATA|ExternalBankAccount|BankNumber|BranchNumber|CountryCode|CurrencyCode|AccountNumber|InactiveFlag
MERGE|ExternalBankAccount|100001A|111111A|CA|USD|12345678|Y