Financial Institution Connectivity Workflows

A Financial Institution Connectivity Plug-in is invoked when you configure a format profile record and during the bank data import process.

The following diagram shows the synchronous workflow for the format profile record:

getConfigurationIFrameUrl() and getAccounts() are interface functions of the Financial Institution Connectivity Plug-in interface, and they do the following:

getConfigurationIFrameUrl() – Retrieves a URL for configuring a connection to your financial institution. This function is invoked when you do one of the following:
- Create a new format profile and select a Financial Institution Connectivity Plug-in from the Connectivity Method dropdown list
- Edit an existing format profile that uses a Financial Institution Connectivity Plug-in
getAccounts() – Retrieves all available accounts from a financial institution, which enables you to link bank or credit card accounts to corresponding general ledger accounts in NetSuite. This function queries the status of the financial institution accounts, including the date or time since the last update.

Note:
getAccounts() is only invoked in a format profile with a profile type of Bank Reconciliation.

The following diagram shows the asynchronous workflow for the bank data import process:

getAccounts() and getTransactionData() are interface functions of the Financial Institution Connectivity Plug-in interface.

parseData() is an interface function of the Financial Institution Parser Plug-in interface, and parseBankStatement() is an interface function of the Bank Statement Parser Plug-in interface.

Note:

A Financial Institution Connectivity Plug-in works with a Financial Institution Parser Plug-in or Bank Statement Parser Plug-in. Therefore, a Financial Institution Connectivity Plug-in supports any format that has a Financial Institution Parser Plug-in or Bank Statement Parser Plug-in.

All three functions are invoked when a bank data import is initiated, and they do the following:

getAccounts() – Retrieves accounts from your financial institution, which appear on the Account Linking subtab on a Bank Reconciliation format profile record. This subtab is populated with information based on the financial institution accounts for which you have a configured connection. You can link your unlinked accounts to corresponding accounts in NetSuite.

Note:
For a successful import, you need at least one active linked account.
createAccountData() – Retrieves your financial data from your financial institution.

If your profile type is Bank Reconciliation, the following takes place:
- When the plug-in is invoked for the first time, NetSuite retrieves the last 60 calendar days of data, by default, or as requested in the accountRequestsJSON property. If required, you can modify the date range. For details, see accountRequestsJSON.
- Subsequently, NetSuite only retrieves new data created since the last successful import.
If your profile type is Corporate Card Expenses, at each scheduled import, NetSuite uses your credentials set in the Connectivity Configuration subtab to download charges from the corporate card company gateway. The amount of data retrieved and the method of retrieval depend on the configuration of the Financial Institution Connectivity Plug-in.
parseData() or parseBankStatement – Consumes the data retrieved by a Financial Institution Connectivity Plug-in and parses it into transactions. To use a connectivity plug-in, you need an existing or new implementation of the Financial Institution Parser Plug-in or Bank Statement Parser Plug-in. To develop these plug-ins, see Developing a Financial Institution Parser Plug-in and Developing a Bank Statement Parser Plug-in.

Related Topics