Creating a Financial Institution Parser Plug-in Script File
You must implement each Financial Institution Parser Plug-in interface function in a Javascript file (with a .js extension). You can use the SuiteCloud IDE, another Javascript IDE, or a text editor to create the plug-in implementation script file.
This plug-in uses SuiteScript 2.0.
The following is a Financial Institution Parser Plug-in sample:
You should define a custom record to store your configuration for setting up a bank connection. You should then deploy a Suitelet to create a custom implementation of a UI to save and load the record. The Suitelet lets you implement a custom interface that enables you to give NetSuite access to your bank accounts.
When returning a URL to the deployed Suitelet (using the getConfigurationPageUrl method), do not hardcode the URL. Instead, use the standard resolveScript SuiteScript method to define the structure of the URL, which includes specifying the script ID, deployment ID, and parameters.
For information about Suitelets, see SuiteScript 2.x Suitelet Script Type. To build a UI in a Suitelet, see N/ui/serverWidget Module.
/**
* @NApiVersion 2.x
* @NScriptType fiParserPlugin
*/
define(['N/query', 'N/url'],
function (query, url)
{
// internal function used to load configuration for this plugin from a custom record
function loadConfiguration(configurationId)
{
var queryObj = query.create({
type: 'customrecord_sampleconfig',
columns: [{ fieldId: 'custrecord_memoprefix' }],
condition: {
fieldId: 'custrecord_configurationid',
operator: query.Operator.IS,
values: [configurationId]
}
});
return queryObj.run().results[0];
}
function getConfigurationPageUrl(context)
{
var configurationId = context.pluginConfiguration.getConfigurationFieldValue({fieldName: "configuration_id"});
context.configurationPageUrl = url.resolveScript({
scriptId: 'customscript_configuration_suitelet',
deploymentId: 'customdeploy_configuration_deployment',
params: {
configurationId: configurationId
}
});
}
function parseData(context)
{
var configurationId = context.pluginConfiguration.getConfigurationFieldValue({fieldName: "configuration_id"});
var configuration = loadConfiguration(configurationId)
var data = JSON.parse(context.inputData.getContents());
/*
Sample data:
{
"accounts": [
{
"accountId": "ACCOUNT1",
"employeeId": "EMPLOYEE1",
"cardHolder": "Card Holder",
"dataAsOfDate": "2020-07-01",
"openingBalance": 0.0,
"closingBalance": 100.0,
"currentBalance": 100.0,
"dueBalance": 100.0,
"transactions": [
{
"date": "2020-07-01",
"amount": 100.0,
"transactionTypeCode": "CHARGE",
"uniqueId": "TRN001",
"id": "CHK001",
"payee": "A Customer",
"currency": "US",
"memo": "Customer Credit",
"transactionStatus": "Posted",
"customerReferenceId": "CUST01",
"invoiceReferenceIds": ["101", "102"],
"billedTaxAmount": 10.0,
"localChargeAmount": 100.0,
"currencyExchangeRate": 1.0,
"expenseCode": "CC"
}
]
}
]
}
*/
for (var accountIndex = 0; accountIndex < data.accounts.length; accountIndex++) {
var account = data.accounts[accountIndex];
var accountData = context.createAccountData({
accountId: account.accountId,
employeeId: account.employeeId,
cardHolder: account.cardHolder,
dataAsOfDate: account.dataAsOfDate,
openingBalance: account.openingBalance,
closingBalance: account.closingBalance,
currentBalance: account.currentBalance,
dueBalance: account.dueBalance
});
for (var transactionIndex = 0; transactionIndex < account.transactions.length; transactionIndex++) {
var transaction = account.transactions[transactionIndex];
accountData.createNewTransaction({
date: transaction.date,
amount: transaction.amount,
transactionTypeCode: transaction.transactionTypeCode,
uniqueId: transaction.uniqueId,
id: transaction.id,
payee: transaction.payee,
currency: transaction.currency,
memo: configuration.custrecord_memoprefix + transaction.memo,
transactionStatus: transaction.transactionStatus,
customerReferenceId: transaction.customerReferenceId,
invoiceReferenceIds: transaction.invoiceReferenceIds,
billedTaxAmount: transaction.billedTaxAmount,
localChargeAmount: transaction.localChargeAmount,
currencyExchangeRate: transaction.currencyExchangeRate,
expenseCode: transaction.expenseCode
});
}
}
}
function getStandardTransactionCodes(context)
{
context.createNewStandardTransactionCode({
transactionCode: 'CHARGE',
transactionType: 'PAYMENT'
});
}
function getExpenseCodes(context)
{
context.createNewExpenseCode({
code: 'CC',
description: 'Customer Credit'
});
}
return {
getConfigurationPageUrl: getConfigurationPageUrl,
parseData: parseData,
getStandardTransactionCodes: getStandardTransactionCodes,
getExpenseCodes: getExpenseCodes
}
});
Guidelines for Creating a Plug-in Implementation Script File
Use the following guidelines when creating the plug-in implementation script file:
-
The plug-in script file can have any name, as long as it has a .js extension and contains an implementation of each of the interface functions.
-
You can include utility files with helper functions when you create the plug-in implementation.
-
Due to limitations with how strings are handled in NetSuite, you cannot use the JavaScript
casestatement in the plug-in implementation script file. -
The plug-in allows up to 1000 usage units.
-
If the character limit is exceeded in a field, NetSuite truncates the value.