Financial Institution Parser Plug-ins as XML Definitions

Note:

Financial Institution Parser Plug-in objects in SuiteCloud Development Framework (SDF) only support SuiteScript 2.0. SuiteScript 2.1 is not supported.

You can create and manage a Financial Institution Parser Plug-in implementation in a SuiteCloud project and deploy it to a target NetSuite account. The Financial Institution Parser Plug-in interface enables you to create and upload your own parsers to parse financial data for different purposes. The plug-in interface lets you translate data received from a third party into data that can used in the bank reconciliation or expense report process.

This plug-in interface is intended to replace the Bank Statement Parser Plug-in interface, by providing a more general platform for parsing financial data. As of NetSuite 2020.2, you can parse and retrieve the following:

Bank and credit card data for matching and reconciliation – Automatically or manually import data from financial institutions into NetSuite for use in the downstream matching and reconciliation feature.
Corporate card charges for expense reporting – Automatically import data from corporate credit card vendors such as American Express into NetSuite for use in the downstream expense reporting feature.

For information about using Financial Institution Parser Plug-ins, see Financial Institution Parser Plug-in Interface Overview.

You can also import a Financial Institution Parser Plug-in implementation from a NetSuite account into a SuiteCloud project. For details about importing objects, see Account Component Imports to SuiteCloud Projects.

Customizing a plug-in implementation object from your SuiteCloud project is the equivalent of editing or making a new plug-in implementation from the NetSuite UI. For example, select Customization > Plug-ins > Plug-in Implementation > New from a NetSuite account.

To create a Financial Institution Parser Plug-in implementation in a SuiteCloud project, you must create a plug-in implementation script file. For details, see Create a Financial Institution Parser Plug-in Implementation Script File.

To run a Financial Institution Parser Plug-in, you must configure and save a format profile in the NetSuite account that uses the plug-in implementation. Invoking a Financial Institution Parser Plug-in is only possible in the NetSuite UI, since SDF does not support format profile records.

For details on running this plug-in, see Conditions for Running a Financial Institution Parser Plug-in. For information about format profile setup, see Creating Format Profiles for Bank Reconciliation.

Note:

If you have the administrator role, you can uninstall an SDF SuiteApp containing a Financial Institution Parser Plug-in implementation that is already used in a format profile. This is true even if the format profile has been used to import data. After you uninstall the SDF SuiteApp, NetSuite does the following:

Removes the plug-in reference from the format profile. The Transaction Parser field in the format profile is cleared.
Inactivates the format profile. To reactivate the format profile, you first need to select a new parser plug-in. See Modifying Format Profiles. If you no longer need the format profile, you should delete it. See Deleting a Format Profile.

Financial Institution Parser Plug-in implementations in SDF are represented with the fiparserplugin object. To define this object, see the following sections:

Create a Financial Institution Parser Plug-in Implementation Script File
Financial Institution Parser Plug-in Implementation Required Fields

Create a Financial Institution Parser Plug-in Implementation Script File

You need to have a Financial Institution Parser Plug-in implementation script either in the target account, or in the same SuiteCloud project as your XML object. For more information, see Creating a Financial Institution Parser Plug-in Script File and SuiteScript Files in SuiteCloud Projects.

Financial Institution Parser Plug-in Implementation Required Fields

The following table contains fields that are required for fiparserplugin objects. For a list of all available fields, see fiparserplugin.

Element	Type	Description
`name`	string	A user-friendly name for the Financial Institution Parser Plug-in implementation. The name is seen by administrators when they activate or deactivate the Financial Institution Parser Plug-in implementation. This field value can be up to 40 characters long.
`scriptfile`	filereference	The script file (`.js`) that contains the implementation for the Financial Institution Parser Plug-in. This field must reference a .js file.

Element

Type

Description

name

string

A user-friendly name for the Financial Institution Parser Plug-in implementation. The name is seen by administrators when they activate or deactivate the Financial Institution Parser Plug-in implementation.

This field value can be up to 40 characters long.

scriptfile

filereference

The script file (.js) that contains the implementation for the Financial Institution Parser Plug-in.

This field must reference a .js file.

Financial Institution Parser Plug-in Implementation Object Example

The following is an XML definition example of a Financial Institution Parser Plug-in implementation object in a SuiteCloud project.

The Financial Institution Parser Plug-in implementation object, customscript_fiprol, creates a new plug-in named Financial Institution Parser 1 that references the SuiteScript file connectionprofile1.js. This plug-in is in TESTING status and debugging messages are logged when the SuiteScript file is run. The owner of the object is notified whenever an error is thrown. The customscript_fiprol.js script is called when NetSuite receives a request to parse financial data.

Note:

Each fiparserplugin SDF custom object requires a scriptfile field reference to a SuiteScript file that implements interface functions. For more information, see Creating a Financial Institution Parser Plug-in Script File. This script file can be in the target account or in the same SuiteCloud project as your plug-in implementation object.

            <fiparserplugin scriptid="customscript_fipro1">
    <description></description>
    <isinactive>F</isinactive>
    <loglevel>DEBUG</loglevel>
    <name>Financial Institution Parser 1</name>
    <notifyadmins>F</notifyadmins>
    <notifyemails></notifyemails>
    <notifyowner>T</notifyowner>
    <notifyuser>F</notifyuser>
    <runasrole></runasrole>
    <scriptfile>[/SuiteApps/connectionprofile1.js]</scriptfile>
    <status>TESTING</status>
</fiparserplugin>

For more information about the fields in the preceding example, see fiparserplugin.

Create a Financial Institution Parser Plug-in Implementation Script File

Financial Institution Parser Plug-in Implementation Required Fields

Financial Institution Parser Plug-in Implementation Object Example

Related Topics