NetSuite Banking Plug-in Refresh Interface Guide

Review Financial Institution Connectivity refresh methods, configuration access, and the implementation details Oracle's interface listing leaves...

·3 min read·15 views·NetSuite 2026.2·View Oracle Docs

The NetSuite Financial Institution Connectivity Plug-in reference lists refresh methods alongside configuration and transaction interfaces. It identifies configuration access and methods for account errors, request IDs, and refresh status, but does not establish a release date or provide the detailed contracts needed to implement those methods.

Which Refresh Methods Does the Reference List?

Two interface functions are the focus of this review: refreshData(context) and getRefreshRequestStatus(context). Oracle lists pluginConfiguration and getConfigurationFieldValue() for both, with different additional object functions for each.

Interface functionListed configuration objectListed object functions
refreshData(context)pluginConfigurationgetConfigurationFieldValue(), addAccountError(options), setRefreshRequestId(options)
getRefreshRequestStatus(context)pluginConfigurationgetConfigurationFieldValue(), returnRefreshRequestStatus(options)

Implementation boundary: The supplied excerpt does not define the options schemas, supported statuses, invocation timing, or error-handling behavior. Use this table to identify the relevant methods, not to infer payloads or execution order. Review their individual contracts before changing connector code.

How Does Configuration Access Fit In?

The pluginConfiguration interface object retrieves user-supplied configuration field values through getConfigurationFieldValue(). Oracle specifically directs custom plug-in authors to use this access mechanism for configuration_id.

The refresh rows list that same configuration object. However, the separate object's parent list names only the four non-refresh functions below. That difference in documentation is not enough to establish a runtime restriction.

Other interface functionAdditional listed members
getConfigurationIFrameUrl()configurationIFrameUrl
getAccounts()addAccount()
getTransactionData()accountRequestsJSON, addDataChunk(), returnAccountRequestsJSON()
getTransactionSources()addSourceList()

All four also list pluginConfiguration and getConfigurationFieldValue(). The configuration object's reference lists no child objects.

Where Does the Configuration URL Appear?

getConfigurationIFrameUrl(context) provides the financial-institution connection configuration UI. For most plug-in authors, this is a Suitelet URL. The URL appears on a format profile record's Connectivity Configuration subtab.

The function returns void; its context contains pluginConfiguration and configurationIFrameUrl. Oracle's example reads configuration_id and includes it in the URL assigned to configurationIFrameUrl:

javascript
1function getConfigurationIFrameUrl(context) {
2 var configurationId = context.pluginConfiguration.getConfigurationFieldValue({
3 fieldName: "configuration_id"
4 });
5 context.configurationIFrameUrl =
6 "/app/site/hosting/scriptlet.nl?script=1&deploy=1&configurationId=" + configurationId;
7}

Treat the script and deployment identifiers as example values, not deployment instructions. This example illustrates configuration access and URL assignment; it does not demonstrate refresh execution.

Who This Affects

  • Banking integration developers: Use the refresh inventory to identify which individual method contracts need review before implementation.
  • Administrators maintaining format profiles: The documented location for the connection configuration UI is the Connectivity Configuration subtab.
  • Connector support teams: Oracle lists a related error-handling topic, but this excerpt supplies no detailed account-error rules.

Key Takeaways

  • The refresh interface listing includes request-ID, account-error, and status-reporting methods.
  • pluginConfiguration provides access to user-supplied configuration values.
  • The configuration URL example does not establish refresh behavior.
  • The supplied reference does not identify a release-specific change.

Frequently Asked Questions (4)

Which methods should I review when implementing Financial Institution Connectivity refresh logic?
The reference lists `refreshData(context)` and `getRefreshRequestStatus(context)`. `refreshData` is associated with `addAccountError(options)` and `setRefreshRequestId(options)`, while status retrieval is associated with `returnRefreshRequestStatus(options)`. Review each method’s individual contract before changing connector code.
How does a refresh plug-in retrieve user-supplied configuration values such as `configuration_id`?
The refresh methods list the `pluginConfiguration` object and its `getConfigurationFieldValue()` method. Custom plug-in authors are directed to use this mechanism to retrieve `configuration_id`. The reference does not define the refresh methods’ payload schemas or execution behavior.
Where does the financial-institution connection configuration UI appear in NetSuite?
The UI provided by `getConfigurationIFrameUrl(context)` appears on a format profile record’s **Connectivity Configuration** subtab. For most plug-in authors, the URL is a Suitelet URL. The function returns `void` and assigns the URL through `context.configurationIFrameUrl`.
Does the configuration URL example show how to execute a refresh?
No. The example demonstrates retrieving `configuration_id` through `pluginConfiguration.getConfigurationFieldValue()` and assigning a URL to `configurationIFrameUrl`. Its script and deployment identifiers are example values, and it does not demonstrate refresh execution.

Weekly Update History (1)

Core Plug-insupdated

Updated Financial Institution Connectivity Plug-in Interface Definition to document importing multiple bank statement files using getTransactionSources(), addSourceList(), and sourceName.

View Oracle Docs
Source: Financial Institution Connectivity Plug-in Interface Definition — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in Banking

View all Banking articles →

Also from NetSuite 2026.2

View all NetSuite 2026.2 changes →