Financial Institution
The financial institution record enables you to save multiple format profiles, which store configuration details for manual or automatic import of financial institution data. You can configure imports of bank or credit card data for bank reconciliation, and corporate card charges for expense reporting.
For help working with this record in the UI, see Financial Institution Records.
The internal ID for this record is financialinstitution.
This record is available in NetSuite and NetSuite OneWorld accounts.
The script user must have the Financial Institution Records permission with full permissions.
In the UI, you create financial institution records on the Financial Institution page at Setup > Accounting > Financial Institution.
See the SuiteScript Records Browser for all internal IDs associated with this record.
For information about using the SuiteScript Records Browser, see Working with the SuiteScript Records Browser in the NetSuite Help Center.
For information about scripting with this record in SuiteScript, see the following help topics:
Supported Script Types
This record is scriptable in server SuiteScript. This record does not support client SuiteScript.
Supported Functions
This record is partially scriptable — it can be read, created, updated, deleted, and searched. It cannot be copied or transformed.
Usage Notes
The table on the Financial Institution page is not editable or scriptable. Clicking Add opens the Format Profile page.
Code Sample
The following sample shows how to create a financial institution record.
Instead of deploying a script, you can use a SuiteApp to automatically create a financial institution record and associated format profiles. You can use a NetSuite–owned SuiteApp, such as the Bank Feeds SuiteApp and the AMEX Corporate Card Integration SuiteApp. See Bank Feeds SuiteApp and American Express Integration for Expense Reporting.
Alternatively, if these SuiteApps do not meet your needs, you can build and deploy your own SuiteApps. To create SuiteApps from an integrated development environment (IDE) on your local computer, see SuiteCloud Development Framework.
You can also build SuiteApps using SuiteBundler, although this feature is no longer updated with new features. See SuiteBundler Overview.
For details about why to deploy your own script versus use a SuiteApp, see Capabilities of Using a Financial Institution Connectivity Plug-in.
// Create a financial institution record
var newFIRecord = record.create({
type: record.Type.FINANCIAL_INSTITUTION,
isDynamic: false,
defaultValues: null
}).setValue({
fieldId: 'financialinstitution',
value: 'New XYZ Bank'
}).setValue({
fieldId: 'description',
value: 'Description for XYZ Bank'
}).save();
// Load a financial institution record
var createdFIRecord = record.load({
type: record.Type.FINANCIAL_INSTITUTION,
id: 1,
isDynamic: false
});
// Get value of the description field
var description = createdFIRecord.getValue({
fieldId: 'description'
});
// Update the description field
createdFIRecord.setValue({
fieldId: 'description',
value: 'Edited Description for XYZ Bank'
});
var recId = createdFIRecord.save();