The company account your username is associated with on NetSuite.

string

""

Together with User and Password, this field is used to authenticate to NetSuite.

Indicating how aggregate columns should be treated.

string

"Ignore"

Aggregate columns are the columns that will appear on base tables which aggregate all of the data contained within child collections. Because these columns include all the data of a child collection, they can become very large. In some situations, such as writing the data to an offline database, it may be advisable to set AggregateColumnMode to either Ignore or List. The data in child tables can still be retrieved by setting IncludeChildTables to true. Setting AggregateColumnMode to List will still cause aggregate columns to be listed for use with inserts and updates.

 

As of version 2015.2, requests to NetSuite require an application ID or token-based authentication details.

string

""

This field is used to authenticate to NetSuite. These IDs are different from application IDs created in versions 2015.1 and older. You can find your applications in the NetSuite UI under Setup > Integration > Manage Integrations. An application ID is set by default, but can optionally be specified.

The authentication secret used to request and obtain the OAuth Access Token.

string

""

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

The type of authentication to use when connecting to NetSuite.

string

"Auto"

The authentication token used to request and obtain the OAuth Access Token.

string

""

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

string

""

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

A comma separated list of custom field permissions. Gives more control than IncludeCustomFieldColumns .

string

""

This property may be set in addition to or instead of IncludeCustomFieldColumns. If you want use a role for authentication where the permissions allow for some custom fields but not others, this property can be used to specify which custom fields metadata should be requested for by the NetSuite Adapter. If this property is left empty, IncludeCustomFieldColumns will determine if all custom field metadata or no custom field metadata is requested. Otherwise this property will override the behavior of IncludeCustomFieldColumns.

For example, to specify all of the custom field permissions for all available tables, set this to:

A password used to authenticate to a proxy-based firewall.

string

""

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the adapter uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy. Note that by default the adapter connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

 

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The user name to use to authenticate with a proxy-based firewall.

string

""

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A boolean indicating if child tables should be displayed.

bool

false

If this is set to true, tables will be displayed for all child lists of a given entity. For instance, the CashRefund table in the NetSuite development environment has a child list called ItemList. Therefore, a new table called CashRefund_ItemList will be displayed if this property is set to true. This can be useful for listing each item in the list in its own row.

A boolean indicating if you would like to include custom field columns.

bool

true

Setting this to true will cause custom fields to be displayed directly on tables as their own rows. However, it will cause lower performance when retrieving the table metadata information for the first time on an open connection. Table metadata is stored on the connection and cleared when the connection is closed.

A boolean indicating if you would like to use tables based on custom lists.

bool

false

Setting this to true will cause custom lists types to be included as their own tables. However, it will cause lower performance when retrieving the table metadata information for the first time on an open connection. Table metadata is stored on the connection and cleared when the connection is closed.

A boolean indicating if you would like to use tables based on custom record types.

bool

true

Setting this to true will cause custom record types to be included as their own tables. However, it will cause lower performance when retrieving the table metadata information for the first time on an open connection. Table metadata is stored on the connection and cleared when the connection is closed.

A comma separated list representing the columns to include when retrieving data from a field representing a record reference.

string

"InternalId, Name"

Many fields in NetSuite are references to other types of records. For instance, an Invoice might reference an Account and a Customer record. There are several pieces of data that can be returned by NetSuite when retrieving data from a record reference field. The available values are:

 

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

string

"OFF"

The following options are available:

A path to the directory that contains the schema files defining tables, views, and stored procedures.

string

""

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

Core modules to be included in the log file.

string

""

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

The maximum number of concurrent sessions available for use by the username specified in the connection.

string

"0"

As of version 2020.1, this value will be obtained automatically based on your AccountId and ApplicationId. Concurrent sessions as of NetSuite 2020.1 are only possible with token based authentication. User / password will always resolve to only a single session available.

NetSuite in general allows a maximum of 5 concurrent sessions, although a higher level may be purchased. Additional requests made that exceed the concurrent session limits of the account or integrated app being used to connect will result in a error. The NetSuite Adapter attempts to account for this automatically by witholding additional requests that would receive an error if it sees too many concurrent requests are already being made.

You can set the maximum number of concurrent sessions available if you your account has a higher amount available. However, if Version is set to 2020_1 or higher, this property will be ignored.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

int

-1

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

A path to a directory to download metadata files from NetSuite. Set this for best performance.

string

""

In order to avoid needless overhead, the adapter downloads a number of metadata files from the NetSuite API. If NetsuiteMetadataFolder is not specified then the Location will be used. Always set a value for NetsuiteMetadata for best performance.

The access token for connecting using OAuth.

string

""

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

The OAuth access token secret for connecting using OAuth.

string

""

The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.

The client Id assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

string

""

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The lifetime in seconds of the OAuth AccessToken.

string

""

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.

string

"%APPDATA%\\CData\\NetSuite Data Provider\\OAuthSettings.txt"

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the adapter saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\NetSuite Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

The Unix epoch timestamp in milliseconds when the current Access Token was created.

string

""

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

The verifier code returned from the OAuth authorization URL.

string

""

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the adapter exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

The other parameters necessary to connect to a data source, such as username and password, when applicable.

string

""

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

The number of results to return per page from NetSuite.

string

""

The pagesize can control the number of results requested from NetSuite on a given query. Setting a higher pagesize will cause more data to come back in a given request, but may take longer to execute. Setting a smaller pagesize is generally recommended to ensure timeout exceptions do not occur.

The password of the NetSuite user used to authenticate.

string

""

Together with User and AccountId, this field is used to authenticate to NetSuite.

The authentication type to use to authenticate to the ProxyServer proxy.

string

"BASIC"

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The adapter performs HTTP BASIC authentication.

DIGEST: The adapter performs HTTP DIGEST authentication.

NEGOTIATE: The adapter retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.

PROPRIETARY: The adapter does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see Firewall Type.

This indicates whether to use the system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.

bool

true

By default, the adapter uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see Proxy Server.

For other proxies, such as SOCKS or tunneling, see Firewall Type.

A semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .

string

""

The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the adapter will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

A password to be used to authenticate to the ProxyServer proxy.

string

""

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see Firewall Type.

By default, the adapter uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

string

"80"

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see Firewall Type.

The hostname or IP address of a proxy to route HTTP traffic through.

string

""

The hostname or IP address of a proxy to route HTTP traffic through. The adapter can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see Firewall Type.

By default, the adapter uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

string

"AUTO"

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

 

A user name to be used to authenticate to the ProxyServer proxy.

string

""

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

You can use this property to enforce read-only access to NetSuite from the provider.

bool

false

If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

Indicates if doubles should be reported as decimal.

bool

true

In the NetSuite API, all columns are reported as doubles. However, this can cause rounding issues when used in aggregation queries. It is generally expected that when monetary columns are used, they should be reported and stored as decimal. While we cannot change how the NetSuite API handles these columns, we can represent them in our tools as decimal so that their use in formulas like aggregations are not subject to these problems. For backwards compatibility on existing implementations, this property be set to false.

A boolean indicating if you would like to request memorized transactions when retrieving transactions from NetSuite.

bool

false

Memorized transactions in NetSuite are transactions that have been memorized for potentially being used again at a later time. They can be set up to recur on a regular basis or as a reminder to the user.

The RoleId is the InternalId of the role that will be used to log in to NetSuite. Leave empty to use the user's default role.

string

""

Together with User, Password, and AccountId this field is used to authenticate to NetSuite. If no RoleId is specified, the user's default role will be used. Otherwise, a RoleId may be obtained by logging into NetSuite, and navigating to the Setup -> Integration -> Web Services Preferences page. Here you can select a different Web Services Default Role as well as obtain the Id, displayed next to the specified role.

The type of schema to use.

string

"SuiteTalk"

The schemas available are SuiteTalk (to use SuiteTalk SOAP API and SuiteScript) and SuiteQL (to use REST API via SuiteQL).

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

The value in seconds until the timeout error is thrown, canceling the operation.

string

"300"

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition. If Timeout expires and the operation is not yet complete, the adapter throws an exception.

In NetSuite, operations can take a very long time to return if retrieving data from child tables or retrieving data from from a given table with AggregateColumnMode set to ListAndRetrieve. For instance, it is not unheard of for it to take in excess of 10 minutes to retrieve 1000 SalesOrders in a single request from NetSuite when AggregateColumnMode is set to ListAndRetrieve. Unfortunately, this is a limitation of the NetSuite Web Services with no known solution. If you need to work with aggregate columns or child tables, set Timeout to 0, set a small Pagesize, and select specific columns instead of everything.

A boolean indicating if you would like to use asynchronous services when inserting, updating, and deleting.

bool

false

NetSuite responses can be fairly slow, especially when inserting, updating, or deleting many records at a time. In these situations it is best to use asynchronous services to submit the data. Asynchronous services allow NetSuite to process the data while your application continues executing. The downside of using asynchronous services is that you will need to check the Job in NetSuite to see if NetSuite has finished processing the request and see if there were any issues.

A boolean indicating if you would like to use internal names for customizations.

bool

false

Typically the Label of a customization is shown when surfacing tables for custom records, and columns for custom field. This is done for ease of use so that things appear as they do in the NetSuite UI. However, it is technically not guaranteed to remain the same. If someone goes into NetSuite and modifies the label, it will cause the custom field or custom record to change name in our tool. Setting UseInternalNamesForCustomizations to false will instead cause the internal API names (which cannot be changed) to be surfaced for these tables and custom fields instead.

The user of the NetSuite account used to authenticate.

string

""

Together with AccountId and Password, this field is used to authenticate to NetSuite.

Your user timezone offset as defined in your NetSuite preferences under Home --> Preferences --> Time Zone. Ex: -8:00.

string

""

NetSuite returns dates offset based on your user timezone preferences. This applies only to Dates, and not to Datetimes, which always return the same way no matter your preferences. We attempt a best effort to automatically correct for this and return dates as they would appear in the NetSuite UI. However, this is not 100% perfect due to how a few time zones are offset by 24 hours or greater depending on daylight savings time. If your user preferences are set to +13:00, +12:00, or -12:00, this value must be specified to get dates to show up correctly. For other offsets it is not required but recommended for best accuracy.

Boolean determining if simple names should be used for tables and columns.

bool

false

NetSuite tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the adapter easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.

A boolean indicating if you would like to perform an upsert when an insert operation is used.

bool

false

Upserts can be used to potentially update an existing record when inserting. NetSuite handles this by using the ExternalId on a given record. If you perform an insert when the ExternalId you specify exists in NetSuite, it will instead update the corresponding record. Otherwise an insert will take place. Set this value to false to always insert new records regardless.

The version of the NetSuite API in usage. Defaults to 2017_1.

string

"2017_1"

In most cases the version should not need to be changed. However, if you modify the version, please make sure beforehand that the version specified exists as part of the NetSuite API. If an incorrect version is specified, the adapter will be unable to retrieve or update tables in NetSuite.

An optional override for the web service host such as webservices.na1.netsuite.com.

string

""

This is an override for the web services host if for some reason the host cannot be dynamically resolved. It intended as a last resort and should not normally need to be specified.

In most cases the web service host will be dynamically determined by using the NetSuite web service request that retrieves the correct web service host for your Account as well as the UseSandbox connection property. This will result in one extra request each time you create and establish a new connection. If you would like to avoid this extra request, you can instead set the WebServiceHost to override it. Note that specifying WebServiceHost will cause UseSandbox to be ignored.

The currently accepted web service hosts for NetSuite are the following: webservices.netsuite.com webservices.na1.netsuite.com webservices.sandbox.netsuite.com