BankStatementParserOutput

Type	Interface output object
Description	Output object for parseBankStatement. When NetSuite requests the bank statement content, this object parses and sends the translated transaction data to NetSuite.
Methods	createNewAccountStatement addAccountStatement createNewTransaction addTransaction
Parent Object(s)	N/A
Child Object(s)	ParsedAccountStatement ParsedTransaction

createNewAccountStatement

Function Declaration	ParsedAccountStatement createNewAccountStatement()
Type	Object method
Description	Create a new ParsedAccountStatement object to enable the Bank Statement Parser Plug-in to set property values. This method does not persist a new account statement in NetSuite.
Returns	ParsedAccountStatement
Input Parameters	None
Parent object	BankStatementParserOutput

Example

                      var accountStatement = context.output.createNewAccountStatement();
            accountStatement.accountMappingKey = defaultAccountMappingKey;
            log.debug({
               title: 'Adding a new account statement',
               details: accountStatement
            }); 

        

addAccountStatement

Function Declaration	int addAccountStatement(ParsedAccountStatement parsedAccountStatement)
Type	Object method
Description	The plug-in calls this method to persist an account statement record in NetSuite, which enables the plug-in to later associate transactions to the account.
Returns	int – the record ID of the account statement.
Input Parameters	ParsedAccountStatement – the object containing information to create the account statement record.
Parent object	BankStatementParserOutput

Example

                      var accountStatementId = context.output.addAccountStatement({"parsedAccountStatement":accountStatement});
            log.debug({
               title: 'New account statement ID',
               details: accountStatementId
            }); 

        

createNewTransaction

Function Declaration	ParsedTransaction createNewTransaction()
Type	Object method
Description	Create a new object handler to enable the Bank Statement Parser Plug-in to set property values. This method does not persist a new transaction in NetSuite.
Returns	ParsedTransaction
Input Parameters	None
Parent object	BankStatementParserOutput

Example

                         var partsOfCSVLine = line.value.split(',');
               var transaction = context.output.createNewTransaction();
               transaction.accountStatementId = accountStatementId;
               var rawDate = partsOfCSVLine[0];
               transaction.date = rawDate.substring(6, 10) + '-' + rawDate.substring(0, 2) + '-' + rawDate.substring(3, 5);
               transaction.amount = partsOfCSVLine[4];
               transaction.transactionMappingKey = partsOfCSVLine[3];
               transaction.transactionNumber = partsOfCSVLine[2];
               transaction.payee = partsOfCSVLine[1];
               transaction.currency = "USD";
               transaction.memo = partsOfCSVLine[5];
               transaction.customerRawId = partsOfCSVLine[6];
               transaction.customerName = partsOfCSVLine[7];
               transaction.invoices = partsOfCSVLine[8].split(','); 

        

addTransaction

Function Declaration	void addTransaction(ParsedTransaction parsedTransaction)
Type	Object method
Description	The plug-in calls this method to persist the new transaction in NetSuite.
Returns	void
Input Parameters	ParsedTransaction – the new transaction to be persisted to NetSuite.
Parent object	BankStatementParserOutput

Example

                         context.output.addTransaction({"parsedTransaction":transaction});
               return true;
            }); 

        

ParsedAccountStatement

Type	Child Object
Description	Definition of a parsed account statement. createNewAccountStatement uses this object.
Methods	getAccountMappingKey setAccountMappingKey getStatementDate setStatementDate getOpeningBalance setOpeningBalance getClosingBalance setClosingBalance
Parent Object(s)	BankStatementParserOutput
Child Object(s)	N/A

getAccountMappingKey

Function Declaration	string getAccountMappingKey()
Type	Object method
Description	This method gets the account mapping key, to associate the parsed account statements with a selected NetSuite account.
Returns	string
Input Parameters	None
Parent object	ParsedAccountStatement

setAccountMappingKey

Function Declaration	void setAccountMappingKey(string accountMappingKey)
Type	Object method
Description	This method sets the account mapping key. The account mapping key must map to a valid NetSuite account ID. The mapping can be set up in the format profile or in the Online Banking Data Upload page. This is a required field.
Returns	void
Input Parameters	accountMappingKey – The value is used to map the account statements to a NetSuite account.
Parent object	ParsedAccountStatement

getStatementDate

Function Declaration	string getStatementDate()
Type	Object method
Description	This method gets the statement date.
Returns	string
Input Parameters	None
Parent object	ParsedAccountStatement

setStatementDate

Function Declaration	void setStatementDate(string statementDate)
Type	Object method
Description	This method sets the account statement date. When set, the following fields are populated from the most recent imported account statement containing a statement date: Bank Balance and Balance As Of on the Match Bank Data page Statement End Date and Ending Statement Balance on the Reconcile Account Statement page If no account statements contain a statement date, the following takes place: The Bank Balance and Balance As Of fields are not populated. The Statement End Date and Ending Statement Balance fields are populated with the current time, and the closing balance from the last reconciliation statement, respectively. Note: If you use a default parser to upload a file without an account statement date, NetSuite uses the most recent imported transaction date to set the statement date. This date may or may not correspond to the real account statement date. The date must be in the format YYYY-MM-DD. For example, "2018-05-28".
Returns	void
Input Parameters	statementDate – the statement date
Parent object	ParsedAccountStatement

getOpeningBalance

Function Declaration	string getOpeningBalance()
Type	Object method
Description	This method gets the opening balance for the statement.
Returns	string
Input Parameters	None
Parent object	ParsedAccountStatement

setOpeningBalance

Function Declaration	void setOpeningBalance(string openingBalance)
Type	Object method
Description	This method sets the opening balance for the statement.
Returns	void
Input Parameters	openingBalance
Parent object	ParsedAccountStatement

getClosingBalance

Function Declaration	string getClosingBalance()
Type	Object method
Description	This method gets the closing balance for the statement.
Returns	string
Input Parameters	None
Parent object	ParsedAccountStatement

setClosingBalance

Function Declaration	void setClosingBalance(string closingBalance)
Type	Object method
Description	This method sets the closing balance for the statement.
Returns	void
Input Parameters	closingBalance
Parent object	ParsedAccountStatement

ParsedTransaction

Type	Child Object
Description	Definition of a parsed transaction. createNewTransaction uses this object.
Methods	getAccountStatementId setAccountStatementId getDate setDate getAmount setAmount getTransactionMappingKey setTransactionMappingKey getTransactionNumber setTransactionNumber getPayee setPayee getCurrency setCurrency getMemo setMemo getUniqueId setUniqueId getSourceId setSourceId getTransactionStatus setTransactionStatus getCustomerRawId setCustomerRawId getCustomerName setCustomerName getInvoices setInvoices
Parent Object(s)	BankStatementParserOutput
Child Object(s)	N/A

getAccountStatementId

Function Declaration	int getAccountStatementId()
Type	Object method
Description	This method gets the account statement ID.
Returns	int
Input Parameters	None
Parent object	ParsedTransaction

setAccountStatementId

Function Declaration	void setAccountStatementId(integer accountStatementId)
Type	Object method
Description	This method sets the account statement ID, to which the transaction is associated. This record ID must belong to a valid account statement record, which NetSuite creates during the bank import process. This is a required field.
Returns	void
Input Parameters	accountStatementId – the record ID of the account statement.
Parent object	ParsedTransaction

getDate

Function Declaration	string getDate()
Type	Object method
Description	This method gets the date for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setDate

Function Declaration	void setDate(string date)
Type	Object method
Description	This method sets the date for the transaction. The date must be in the format YYYY-MM-DD. For example, "2018-05-28". This is a required field.
Returns	void
Input Parameters	date – the date for the transaction.
Parent object	ParsedTransaction

getAmount

Function Declaration	string getAmount()
Type	Object method
Description	This method gets the amount for the transaction. In bank and credit card statements, amounts must be provided in decimal formats only, with no commas. For example, “1 000 000.00”. Negative numbers must be represented with a minus (-) sign. For example, "-100".
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setAmount

Function Declaration	void setAmount(string amount)
Type	Object method
Description	This method sets the amount for the transaction. This is a required field.
Returns	void
Input Parameters	amount – the amount for the transaction.
Parent object	ParsedTransaction

getTransactionMappingKey

Function Declaration	string getTransactionMappingKey()
Type	Object method
Description	This method gets the transaction mapping key.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setTransactionMappingKey

Function Declaration	void setTransactionMappingKey(string transactionMappingKey)
Type	Object method
Description	This method sets the transaction mapping key. This transaction mapping key must map to a valid NetSuite transaction type. The mapping can be set up in the format profile or in getStandardTransactionCodes. This is a required field.
Returns	void
Input Parameters	transactionMappingKey – the mapping key.
Parent object	ParsedTransaction

getTransactionNumber

Function Declaration	string getTransactionNumber()
Type	Object method
Description	This method gets the transaction number.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setTransactionNumber

Function Declaration	void setTransactionNumber(string transactionNumber)
Type	Object method
Description	This method sets the transaction number.
Returns	void
Input Parameters	transactionNumber
Parent object	ParsedTransaction

getPayee

Function Declaration	string getPayee()
Type	Object method
Description	This method gets the payee for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setPayee

Function Declaration	void setPayee(string payee)
Type	Object method
Description	This method sets the payee for the transaction.
Returns	void
Input Parameters	payee
Parent object	ParsedTransaction

getCurrency

Function Declaration	string getCurrency()
Type	Object method
Description	This method gets the currency code for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setCurrency

Function Declaration	void setCurrency(string currency)
Type	Object method
Description	This method sets the currency code for the transaction. The currency must be one of the standard currency codes.
Returns	void
Input Parameters	currency – the currency code.
Parent object	ParsedTransaction

getMemo

Function Declaration	string getMemo()
Type	Object method
Description	This method gets the memo for the transaction, if applicable.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setMemo

Function Declaration	void setMemo(string memo)
Type	Object method
Description	This method sets the memo for the transaction, if applicable.
Returns	void
Input Parameters	memo
Parent object	ParsedTransaction

getUniqueId

Function Declaration	string getUniqueId()
Type	Object method
Description	This method gets the unique ID for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setUniqueId

Function Declaration	void setUniqueId(string uniqueId)
Type	Object method
Description	This method sets the unique ID for the transaction. The unique ID automatically prevents a transaction from getting imported into NetSuite as a duplicate. Note: If your transactions contain a unique ID, you should always use this method to ensure the removal of duplicates. This is the case for both manual file import and financial institution connectivity.
Returns	void
Input Parameters	uniqueId
Parent object	ParsedTransaction

getSourceId

Function Declaration	string getSourceId()
Type	Object method
Description	This method gets the source ID for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setSourceId

Function Declaration	void set SourceId(string sourceId)
Type	Object method
Description	This method sets the source ID for the transaction. Note: You should only use this method for OFX files. The source ID maps to a field that is only present in OFX files called FitId. This field is used in addition to others such as amount, date, and memo during the duplicate detection process. Alone, you cannot use this field to detect duplicate transactions in OFX files. To guarantee the automatic detection and removal of duplicates before they are imported, regardless of the file format, see setUniqueId.
Returns	void
Input Parameters	sourceId
Parent object	ParsedTransaction

getTransactionStatus

Function Declaration	string getTransactionStatus()
Type	Object method
Description	This method gets the transaction status.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setTransactionStatus

Function Declaration	void setTransactionStatus(string transactionStatus)
Type	Object method
Description	This method sets the transaction status.
Returns	void
Input Parameters	transactionStatus
Parent object	ParsedTransaction

getCustomerRawId

Function Declaration	string getCustomerRawId()
Type	Object method
Description	This method gets the customer ID for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setCustomerRawId

Function Declaration	void setCustomerRawId(string customerRawId)
Type	Object method
Description	This method sets the customer ID for the transaction.
Returns	void
Input Parameters	customerRawId
Parent object	ParsedTransaction

getCustomerName

Function Declaration	string getCustomerName()
Type	Object method
Description	This method gets the customer name for the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setCustomerName

Function Declaration	void setCustomerName(string customerName)
Type	Object method
Description	This method sets the customer name for the transaction.
Returns	void
Input Parameters	customerName
Parent object	ParsedTransaction

getInvoices

Function Declaration	string[] getInvoices()
Type	Object method
Description	This method gets the invoices associated with the transaction.
Returns	string
Input Parameters	None
Parent object	ParsedTransaction

setInvoices

Function Declaration	void setInvoices(string[] invoices)
Type	Object method
Description	This method sets the invoices associated with the transaction.
Returns	void
Input Parameters	invoices
Parent object	ParsedTransaction

Related Topics

parseBankStatement

BankStatementParserInput

General Notices