NetSuite - CData Cloud

Overview

CData Cloud offers access to NetSuite across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to NetSuite through CData Cloud.

CData Cloud allows you to standardize and configure connections to NetSuite as though it were any other OData endpoint, or standard SQL Server/MySQL database.

Key Features

Full SQL Support: NetSuite appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to NetSuite in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to NetSuite

Establishing a Connection shows how to authenticate to NetSuite and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from NetSuite through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to NetSuite by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to NetSuite

NetSuite currently offers two distinct APIs:

SuiteTalk is the older SOAP-based service we use to communicate with NetSuite. It has broad support for a lot of entities and full support for INSERT/UPDATE/DELETE. However, the tools offered for selecting data are fairly weak, which yields very poor performance during a SELECT. There is not a great way to join tables. Grouping and aggregating data is unavailable with this API, which means to support them they must be done entirely client side.
SuiteQL is the newer API. It offers a SQL-like method of communicating with the service, which allows for more rich JOIN support, as well as GROUP BY and aggregations. It also fully supports retrieving only the columns you want to select. This makes it much more performant than SuiteTalk for selecting data. However, it only supports selecting data.

To connect to NetSuite, you must:

Set Schema to specify the API you are using to connect.
If you are just retrieving data, we recommend you use SuiteQL. If you need to both retrieve and modify data, we recommend you use SuiteTalk.
Set the appropriate connection options for the API in use. (Be aware that each API has different available connection options, as described in Permission Configurations.)
Ensure that any connecting user has permissions on the specified AccountId to connect through NetSuite Web services. This property is required for both OAuth 1.0 (Token-Based Authentication) and OAuth 2.0. For details about required and optional permissions, see Permission Configurations.

To create or edit a role for Web services permissions:
1. Log into NetSuite.
2. If you need to create a new role, navigate to Setup > User/Roles > Manage Roles > New.
  If you need to modify an existing role, navigate to Setup > User/Roles > Manage Roles and select the role to be edited.
3. Click Permissions > Setup.
4. Add permissions for SOAP Web Services and REST Web Services.
5. Add other permissions that are needed for interacting with various entities and transactions. (See Permission Configurations.)
6. Under Setup, navigate to User/Roles > Manage Users. Select the user you just created or edited.
7. At the Access tab, add the newly-created role.
8. Save the new or changed user.

Authenticating to NetSuite

This section describes how to authenticate to NetSuite from earlier versions of SuiteTalk (which use Basic authentication), later versions of SuiteTalk, and all versions of Suite QL.

Suite Talk 2020.2 or Earlier

As of 2020.2, NetSuite no longer supports Basic (user/password) authentication. While the CData Cloud continues to support User/Password connections for Version set to values lower than 2020.2, we recommend that all customers migrate to the OAuth and Token Based Authentication mechanisms described below.

To continue using Basic authentication with an early version of SuiteTalk, set the AuthScheme to Basic to support user/password credentials. However, you must also manually specify a lower Version to use it.

To support either Token-Based or OAuth 2.0 authentication, set the AuthScheme to OAuth.

Suite Talk or Suite QL

NetSuite offers two forms of OAuth authentication:

Token Based Authentication (TBA) is essentially OAuth 1.0 with the OAuthAccessToken and OAuthAccessTokenSecret created within the NetSuite UI instead of at runtime. TBA is available for both SuiteTalk versions later than 2020.2, and SuiteQL.
OAuth 2.0 Authentication is only available for SuiteQL. To enforce OAuth 2.0 authentication, you can do one of the following:
- Set OAuthVersion explicitly to the API in use, or
- Set Schema to SuiteQL.

Note: Be aware that if you are using SuiteTalk, you will not be able to use OAuth 2.0 even if you configure the OAuthVersion to SuiteTalk. SuiteTalk does not support OAuth 2.0.

To support either Token-Based or OAuth 2.0 authentication, set the AuthScheme to OAuth.

Token Based Authentication (OAuth 1.0)

Token Based Authentication (TBA) is essentially OAuth 1.0. You can use TBA with either SuiteTalk or the SuiteQL Schema.

Token Based Authentication is performed by creating the OAuthClientId, OAuthClientSecret, OAuthAccessToken and OAuthAccessTokenSecret directly within the NetSuite UI by an administrator with permissions to do so.

To support the use of TBA, set the AuthScheme to Token and create tokens in the NetSuite UI, as described below.

Creating Tokens in the NetSuite UI

Many NetSuite admins prefer to create and assign a token directly in the NetSuite UI. Connecting via token enables users to bypass the normal steps for generating an OAuth Access Token. This provides the admin with more direct control over giving access. However, it also creates a need for them to take manual steps in the UI each time they need to create a new token.

Instead of creating and assigning a token directly in the NetSuite UI, follow this procedure:

In NetSuite, log in using an account with administrator privileges.
Navigate to Setup > Company > Enable Features > SuiteCloud > Manage Authentication.
Select Token-Based Authentication and TBA: Authorization Flow.
Save changes.
Navigate to Setup > Integration > Manage Integrations.
Create a new integration and select Token-Based Authentication.
When the integration is created, it displays the Consumer Key and Consumer Secret. These map directly to the OAuthClientId and OAuthClientSecret connection properties.
Record the values for Consumer Key and Consumer Secret.
To create a new token role or modify an existing role, navigate to Setup > User/Roles > Manage Roles.
Navigate to Permissions > Setup.
Assign the role User Access Token: Full, Access Token Management: Full, and Web Services: Full permissions.
To add the new token role to a user who is listed in Lists > Employees > Employees, select the employee, and then navigate to Access > Roles.
Navigate to Setup > User/Roles > Access Tokens and create a new access token.
For application name, specify the integration that was created earlier. Assign this to the same user and role that was created or updated in the previous steps.
After creating the access token, a Token Id and Token Secret are displayed. These map directly to the OAuthAccessToken and OAuthAccessTokenSecret. Write them down.

After the access token is created, it can be used to connect using the values obtained from the previous steps. Before you connect, specify at least the following connection properties:

AccountId = the account to connect to.
OAuthClientId = the Consumer Key displayed when the application was created.
OAuthClientSecret = the Consumer Secret displayed when the application was created.
OAuthAccessToken = the Token Id when the access token was created.
OAuthAccessTokenSecret = the Token Secret when the access token was created.

OAuth 2.0

NetSuite SuiteTalk supports OAuth 2.0 authentication. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth. Additionally, the AccountId is required to specify the account being connected to. If you want to authenticate via a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

The following subsections describe how to authenticate to NetSuite from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in NetSuite, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

The first time you connect to data, set the following connection parameters:
- AccountId = the account to connect to.
- InitiateOAuth = REFRESH.
- OAuthClientId = the client Id in your application settings.
- OAuthClientSecret = the client secret in your application settings.
- OAuthAccessToken = the access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation = the path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set the following connection properties:
- AccountId = the account to connect to.
- OAuthClientId = the Client Id in your application settings.
- OAuthClientSecret = the Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Concurrent Requests

NetSuite allows only a certain number of concurrent requests per account, which is configurable per integration connection. (The default is usually 5.) If another request is made when the maximum number of concurrent requests is already in use, the user may receive an "Only one request may be made against a session at a time" error.

The CData Cloud attempts to account for this situation by staggering additional requests so as not to exceed the concurrent request limit. However, if an account is being connected to from multiple machines or applications, it is not always possible to do this correctly.

CData Cloud

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for NetSuite

When integrating with NetSuite, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the NetSuite Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for NetSuite


Scope	Description
restlets	Access the RESTlets feature in the SuiteTalk schema. Required for read access.
rest_webservices	Access REST web services. Required for read and write access.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for NetSuite


Domain	Always Required	Description
<AccountId>.restlets.api.netsuite.com	FALSE	The subdomain used to access the SuiteQL API. Required when Schema is set to SuiteQL.
<AccountId>.suitetalk.api.netsuite.com	FALSE	The subdomain used to communicate with the SuiteTalk API. Required when Schema is set to SuiteTalk.
<AccountId>.app.netsuite.com	TRUE	The subdomain corresponding to your NetSuite account. The <Account> must match the value you set in AccountId.

CData Cloud

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used in NetSuite SuiteTalk when connecting to NetSuite via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:

set AuthScheme to OAuth,
get and set the OAuthAccessToken, and
set the necessary configuration parameters.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to NetSuite".)

However, you must create a custom OAuth application to connect to NetSuite via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

Procedure

Navigate to Setup > Integrations > Manage Integrations.
For OAuth 1.0 support (TBA), select both Token-Based Authentication and TBA: Authorization Flow
For OAuth 2.0 support, select Authorization Code Grant, Restlets, and Rest Web Services.
Set a Callback URL for your application:
- For Desktop, set the Callback URL to https://localhost:portnumber and set CallbackURL to match. You can specify any port available.
- For Web, set the Callback URL to a page on your website where you would like the user to be returned after the user grants permissions to your app.
- For Headless machines, set a Callback URL in the format https://localhost:portnumber. You can specify any port available.
Obtain the following connection properties:
- OAuthClientId (Desktop only) =the Consumer Key assigned when you registered your app.
- OAuthClientSecret = the Consumer Secret assigned when you registered your app.
- CallbackURL = the Redirect URI defined when you registered your app, such as https://localhost:33333. Note that this must be an exact match, including any trailing '/' characters.

CData Cloud

Permission Configurations

In NetSuite there are many permissions that may be used by the CData Cloud. Permissions may be configured for a role in NetSuite under Setup --> Users/Roles --> Manage Roles. This page contains two lists of permissions, first the most commonly required, and then other permissions for fuller support. Please be aware that it is not possible for us to provide an exhaustive list of permissions as NetSuite adds support for new entities and permissions with each version.

Most Commonly Required

Note: Most of the following permissions fall under the Permissions --> Setup section for a role.


Permission	Used For
Access Token Management	Allows users to create access tokens for Token Based Authentication.
Custom <type> Fields (VIEW)	Allows users to see custom fields of the given type. Used with IncludeCustomFieldColumns.
Custom Lists (VIEW)	Allows displaying metadata for custom list tables. Used with IncludeCustomListTables.
Custom Record Types (VIEW)	Allows displaying metadata for custom record tables. Used with IncludeCustomRecordTables.
Customer (VIEW)	This specific permission is under Permissions => Lists. It is used for testing the connection in RESTlets.
Deleted Records (VIEW)	Used for retrieving information on deleted records.
Log in Using Access Tokens	Allows the user to log in to REST / SOAP services with a token.
Log in Using OAuth 2.0 Access Tokens	Access REST web services and RESTlets using OAuth 2.0 access tokens.
REST Web Services	All REST requests including when Schema is set to SuiteQL, and support for RESTlets.
SOAP Web Services	All SOAP requests including when Schema is set to SuiteTalk (default), test connection, and some requests for custom fields.
SuiteAnalytics Workbook (VIEW)	Found under Permissions -> Reports. Required for SuiteQL access.
Other Custom Fields (VIEW)	Allows users to see custom fields of the "other" type. Used with IncludeCustomFieldColumns.
OAuth 2.0 Authorized Applications Management	Primarily for the Administrator role, enables the user to view or revoke any OAuth 2.0 authorized applications in the account.
User Access Token	Allows a user to have tokens created for them via ether Token Based Authentication or OAuth.

Other Permissions


Section	Permission	Used For (SuiteTalk Schema)	Used For (SuiteQL Schema)
Permissions => Custom Record	[Custom Record Name]	Access to the given custom record table	Access to the given custom record table
Permissions => Lists	Accounts	Access to the Account table	Access to the Account table
Permissions => Lists	Bins	Access to the Bin table	Access to the Bin table
Permissions => Lists	Calendar	Access to the CalendarEvent table along with the Events permission	Access to the CalendarEvent table along with the Events permission
Permissions => Lists	Cases	Access to the SupportCase table	Access to the SupportCase table
Permissions => Lists	Classes	Access to the Classification table	Access to the Classification table
Permissions => Lists	Contacts	Access to the Contact table	Access to the Contact table
Permissions => Lists	Currency	Access to the Currency table	Access to the Currency table
Permissions => Lists	Customers	Access to the Customer table	Access to the Customer table
Permissions => Lists	Departments	Access to the Department table	Access to the Department table
Permissions => Lists	Documents and Files	Access to the File and Folder tables	Access to the File table
Permissions => Lists	Employee Record	Access to the Employee tables	Access to the Employee table
Permissions => Lists	Events	Access to the CalendarEvent table along with the Calendars permission	Access to the CalendarEvent table along with the Calendars permission
Permissions => Lists	Items	Access to various Item tables such as DiscountItem, InventoryItem, NonInventoryItem, etc.	Access to the Item table
Permissions => Lists	Locations	Access to the Location table	Access to the Location table
Permissions => Lists	Phone Calls	Access to the PhoneCall table	Access to the PhoneCall table
Permissions => Lists	Project Tasks	Access to the ProjectTask table	Access to the ProjectTask table
Permissions => Lists	Subsidiaries	Access to the Subsidiary table	Access to the Subsidiary table
Permissions => Lists	Tasks	Access to the Task table	Access to the Task table
Permissions => Lists	Vendors	Access to the Vendor table	Access to the Vendor table
Permissions => Transactions	[Custom Transaction Name]	Access to retrieving data from the specific custom transaction via the special Transactions table	Access to retrieving data from the specific custom transaction type via the transaction table
Permissions => Transactions	Build Assemblies	Access to the AssemblyBuild table	Access the Build type from the Transaction table
Permissions => Transactions	CashSale	Access to the CashSale table	Access the CashSale type from the Transaction table
Permissions => Transactions	CashSaleRefund	Access to the CashRefund table	Access the CashRfnd type from the Transaction table
Permissions => Transactions	Charge	Access to the Charge table	Access the CardChrg type from the Transaction table
Permissions => Transactions	Check	Access to the Check table	Access the Check type from the Transaction table
Permissions => Transactions	Credit Memo	Access to the CreditMemo table	Access the Credit Memo type from the Transaction table
Permissions => Transactions	Deposit	Access to the Deposit table	Access the Deposit type from the Transaction table
Permissions => Transactions	Enter Vendor Credits	Access to the VendorCredit table	Access the VendorCredit type from the Transaction table
Permissions => Transactions	Fulfill Orders	Access to the ItemFulfillments table	Access the Item Fulfillment type from the Transaction table
Permissions => Transactions	Invoice	Access to the Invoice table	Access the Invoice type from the Transaction table
Permissions => Transactions	Item Receipt	Access to the ItemReceipt table	Access the ItemRcpt type from the Transaction table
Permissions => Transactions	Opportunity	Access to the Opportunity table	Access the Opportunity type from the Transaction table
Permissions => Transactions	Purchase Order	Access to the PurchaseOrder table	Access the PurchOrd type from the Transaction table
Permissions => Transactions	Sales Order	Access to the SalesOrder table	Access the SalesOrd type from the Transaction table
Permissions => Transactions	Transfer Order	Access to the TransferOrder table	Access the TrnfrOrd type from the Transaction table
Permissions => Transactions	Vendor Bill Approval	Access to the VendorCredit table	Access the VendorCredit type from the Transaction table
Permissions => Transactions	Vendor Return Authorization	Access to the VendorReturnAuthorization table	Access the Vendor Return Authorization type from the Transaction table
Permissions => Transactions	Work Order	Access to the WorkOrder table	Access the WorkOrd type from the Transaction table

CData Cloud

SuiteQL

The following feature was introduced on NetSuite in 2020.1. Your Version must be set to 2020.1 or higher to use it. In addition, you must enable the feature for it in NetSuite under Company -> Enable Features -> SuiteCloud -> REST Web Services.

The Cloud supports this connection by the Schema connection property. Simply set Schema to SuiteQL to access the service.

Differences between SuiteTalk and SuiteQL

SuiteQL offers an Oracle syntax to query data from NetSuite. The default service supported in SuiteTalk is instead designed using a number of SOAP requests to retrieve data in a format that is more closely associated with the saved searching in NetSuite. This means that SuiteQL can be used to handle much more complicated queries that SuiteTalk. For instance, joins, aggregations, group by, order by, and formulas can all be handled server side using SuiteQL. In contrast, SuiteTalk only supports some joins and predicates. In general, SuiteQL is a more powerful option for executing queries faster against NetSuite due to its more rich support for handling SQL.

Metadata Handling

Metadata in SuiteQL is handled in two ways: Custom Fields / Columns, and Native tables / column. Custom fields and columns contain a metadata service that can be used to retrieve data from. So when IncludeCustomFieldColumns and IncludeCustomRecordTables are set to true, this metadata may be retrieved automatically and accurately.

NetSuite does not contain an API method of returing metadata about native tables and columns. Therefore, native tables such as the account table must have their metadata hardcoded within the driver. Oddly, NetSuite will throw exceptions from the API indicating there was a problem with the submitted SuiteQL when your account or role do not have permissions to view a given table or column, even if it is defined within SuiteQL. To try and avoid these exceptions, we have added a RowScanDepth connection property. This defaults to 1000, which is one page worth of data. Leaving this enabled will ensure the listed columns for tables are available for you on your connection. However, SuiteQL does not return fields when they are null. So it is possible some fields will not show up that you require access to. You may disable this option by setting RowScanDepth to 0, but will need to account for potentially listing columns that SuiteQL will throw exceptions when you try to retrieve data from them.

Limitations of SuiteQL

As a releatively new feature in NetSuite and the CData Cloud in general, SuiteQL contains a number of limitations. These include:

No support for INSERT / Update / Delete. Only SELECT queries are supported.
Only OAuth / Token Based Authentication is supported. The SuiteQL REST API does not support user/password authentication.
Not all Oracle formulas are supported in SuiteQL.

Supported Formulas

The following lists the available formulas in SuiteQL as of version 2020.1.

ABS
ACOS
ADD_MONTHS
APPROX_COUNT_DISTINCT
ASCII
ASCIISTR
ASIN
ATAN
ATAN2
AVG
BFILENAME
BITAND
CEIL
CHARTOROWID
CHR
COALESCE
COMPOSE
CONCAT
CORR
CORR_K
CORR_S
COS
COSH
COUNT
COVAR_POP
COVAR_SAMP
CURRENT_DATE
CURRENT_TIMESTAMP
DECODE
DECOMPOSE
DENSE_RANK
EMPTY_BLOB
EMPTY_CLOB
EXP
EXPR
FLOOR
FROM_TZ
GREATEST
INITCAP
INSTR
LAST_DAY
LEAST
LENGTH
LENGTH2
LENGTH4
LENGTHB
LENGTHC
LN
LOCALTIMESTAMP
LOG
LOWER
LPAD
LTRIM
MAX
MEDIAN
MIN
MOD
MONTHS_BETWEEN
NANVL
NEW_TIME
NEXT_DAY
NLSSORT
NLS_INITCAP
NLS_LOWER
NLS_UPPER
NULLIF
NVL
NVL2
ORA_HASH
POWER
RANK
REGEXP_INSTR
REGEXP_REPLACE
REGEXP_SUBSTR
REMAINDER
REPLACE
ROUND
ROW_NUMBER
RPAD
RTRIM
SIGN
SIN
SINH
SOUNDEX
SQRT
SUBSTR
SUM
SYS_EXTRACT_UTC
TAN
TANH
TO_BINARY_DOUBLE
TO_BINARY_FLOAT
TO_CHAR
TO_CLOB
TO_DATE
TO_MULTI_BYTE
TO_NCHAR
TO_NCLOB
TO_NUMBER
TO_SINGLE_BYTE
TO_TIMESTAMP
TO_TIMESTAMP_TZ
TRANSLATE
TRUNC
TZ_OFFSET
UNISTR
UPPER
VSIZE
WIDTH_BUCKET

CData Cloud

SuiteTalk

SuiteTalk is the Schema that has been offered by the CData Cloud for many years. It supports full CRUD capabilities, access to custom records, fields, and lists. Saved searches are supported both the SOAP API (old method) and through RESTLets (newer method). Information in this section will cover unique features of the SuiteTalk Schema.

CData Cloud

Exposed Data

The CData Cloud dynamically obtains information about your NetSuite tables at runtime. The tables and columns that are exposed may be controlled by several connection properties. This section will discuss what connection properties may be used to control the listed tables and columns, and how to get the NetSuite data you are looking for. A further discussion about types of tables with examples of how to perform INSERTs and updates to each type can be found in Tables.

NetSuite Default Record Types

There are a number of default record types that come with NetSuite without any customization. These include entities such as Accounts, Customers, and Vendors. It also includes transactions such as SalesOrders, Invoices, and PurchaseOrders. Each of these default record types will be determined at runtime based on the Version connection property. A table will be exposed for every record type found this way.

Note that these default record tables are also frequently called parent tables when talking about child tables below.

Version

At least twice a year, NetSuite will release a new version. The new version often contains new default record types available to all users. In order to get the latest record types to be exposed as tables, set the Version connection property. The default is updated each major release to be in line with the latest from NetSuite.

Child Tables

Many of the default record types in NetSuite will contain collections of data. For instance, Customers can have several addresses. An Invoice can have several line items. These child collections are exposed in what are called Child Tables. For instance, Invoice_itemList would be considered the child table of the parent table Invoice.

Due to the number of child collections, turning them on will cause the total displayed table count to balloon significantly by several hundred. Child tables can be enabled by setting the IncludeChildTables connection property to true. It is false by default.

Child tables are not exposed beyond the first level. For instance, the Expense List on a Purchase Order contains a Linked Order List. There will not be a table exposed for the Linked Order List. Instead, an aggregate column would need to be used to retrieve this data as explained below.

Aggregate Columns

Child collections may also be exposed in a different way via the AggregateColumnMode connection property. Aggregate columns return collections of complex data such as a collection of addresses or line items. These values would not fit into a single column on their own and are thus aggregated together as XML values. Since most child collection information can be obtained easily and more readably by setting IncludeChildTables to true, aggregates are disabled by default.

Aggregates can be useful for exposing further collections on child tables. For instance, if you wanted to retrieve the Linked Order List from the Expense List on a Purchase Order. Set both IncludeChildTables to true and AggregateColumnMode to List. Those settings will cause the ExpenseList_linkedOrderList column to be displayed and return with data on the PurchaseOrder_expenseList table.

It is not recommended to set AggregateColumnMode to ListAndRetrieve except when trying very small samples, such as if you intend to perform INSERTs via an aggregate column and need to get a few samples of what the data looks like. Setting AggregateColumnMode to ListAndRetrieve will cause aggregate column data to be requested at all times on all tables. This will significantly slow down performance on parent tables such as Customers, PurchaseOrders, and Invoices due to NetSuite returning data much slower when this data is requested. When AggregateColumnMode is set to List, aggregate columns will always come back with data when retrieving data from child tables since NetSuite will already come back with the data at no additional performance penalty.

Custom Records

Custom records are exposed as full tables. Note that some types of records that are exposed in NetSuite by default are still considered custom records. We consider anything a custom record if it is available in NetSuite under Customization --> Lists, Records, & Fields --> Record Types. To control this setting, change the IncludeCustomRecordTables.

Custom Lists

Custom lists are not exposed by default. Custom lists in NetSuite are lists of information that may be selected for some types of custom fields. These do not typically contain data that is important since it rarely changes. However, these lists can be exposed as tables if needed by setting the IncludeCustomListTables connection property to true.

Custom Fields

Custom fields are exposed by default and will be displayed directly on the appropriate table. Custom fields are displayed for both parent tables such as Invoice and Customer, and also for child tables such as Invoice_itemList and Customer_addressbookList. Custom Field exposure may be controlled with the IncludeCustomFieldColumns connection property.

Reference Columns

Reference columns are columns that include a record reference. For instance, Invoice contains an Entity record reference. Record references always come back with multiple pieces of information such as an internalid, name, and potentially type and externalid. Due to the number of record reference columns in NetSuite, by default they only display with InternalId and Name. This can be modified by changing the IncludeReferenceColumns connection property.

Reports

Reports are not supported in the NetSuite API. This is a limitation of the API which means that reports are not available for us or other third party tools. NetSuite instead recommends customers make use of the PostingTransactionSummary for getting the sort of information that would appear on reports. The PostingTransactionSummary view can be used to access that information.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

Data Model

Using SuiteTalk API

See SuiteTalk Data Model for the available entities in the SuiteTalk API.

Using SuiteQL API

See SuiteQL Data Model for the available entities in the SuiteQL API.

CData Cloud

SuiteTalk Data Model

Overview

This section shows the available Tables and Views for the SuiteTalk Schema.

The CData Cloud models NetSuite entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained based on your NetSuite account.

Tables

Table definitions are dynamically retrieved. This section lists sample table definitions that are included in the NetSuite development environment.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

CData Cloud

Tables

The metadata for the tables in NetSuite are obtained during run time based on a number of predefined schemas from NetSuite and your unique NetSuite account information. Custom tables and custom fields will be listed and available to work with just like any other table. The Cloud offers several different types of tables, which have unique features. In this section you will find notes and examples for working with each type of table.

Entity Tables

Entity tables represent entities in NetSuite. These items exist on standard lists and these entities may show up in child lists or be referenced in transactions via their InternalId. Entity tables may contain aggregate columns. For instance, the Account table has a SubsidiaryListAggregate column. This column will contain an XML-formatted list of the subsidiaries associated with the account. These may be modified by updating the aggregate. For instance:

UPDATE Account SET SubsidiaryListAggregate = '<Account_subsidiaryList><Row><SubsidiaryList_InternalId>00001</SubsidiaryList_InternalId></Row><Row><SubsidiaryList_InternalId>00002</SubsidiaryList_InternalId></Row></Account_subsidiaryList>' WHERE InternalId = @AccountInternalId

A few examples of entity tables are:


Name	Description
Account	The NetSuite table Account.
Contact	The NetSuite table Contact.
Customer	The NetSuite table Customer.
Department	The NetSuite table Department.
DiscountItem	The NetSuite table DiscountItem.
Employee	The NetSuite table Employee.
InventoryItem	The NetSuite table InventoryItem.
NonInventoryPurchaseItem	The NetSuite table NonInventoryPurchaseItem.
Subsidiary	The NetSuite table Subsidiary.
Vendor	The NetSuite table Vendor.

Transaction Tables

Transaction tables represent transactions in NetSuite. These transactions will work operationally the same as entities. However, for some transactions you may be required to specify line items in order for the insert to work. These can be specified via the ItemListAggregate field, available on all lists where it is applicable. Set the AggregateColumnMode connection property to List for these columns to show up. For instance, the subsequent parameterized query inserts a CashRefund record that has two line items, shown below:

<CashRefund_itemList>
<Row>
  <itemlist_rate>2.00</itemlist_rate>
  <itemlist_taxcode_name>CA-ALAMEDA</itemlist_taxcode_name>    
  <itemlist_units_name></itemlist_item_units_name>    
  <itemlist_amount>2.0</itemlist_amount>    
  <itemlist_item_internalid>860</itemlist_item_internalid>    
  <itemlist_price_internalid>1</itemlist_price_internalid>    
  <itemlist_taxcode_internalid>-159</itemlist_taxcode_internalid>    
  <itemlist_description>Item Description</itemlist_description>    
  <itemlist_item_name>Backing</itemlist_item_name>    
  <itemlist_taxrate1>8.25%</itemlist_taxrate1>    
  <itemlist_price_name>Base Price</itemlist_price_name>    
  <itemlist_units_internalid></itemlist_units_internalid>    
  <itemlist_quantity>1.0</itemlist_quantity>    
  <itemlist_costestimate>0.0</itemlist_costestimate>  
</Row>  
<Row>    
  <itemlist_taxcode_name>-Not Taxable-</itemlist_taxcode_name>    
  <itemlist_units_name>Ea</itemlist_units_name>    
  <itemlist_amount>100.0</itemlist_amount>   
  <itemlist_item_internalid>704</itemlist_item_internalid>   
  <itemlist_price_internalid>-1</itemlist_price_internalid>   
  <itemlist_taxcode_internalid>-7</itemlist_taxcode_internalid>    
  <itemlist_description>Designer Seat / Back Cushions</itemlist_description>    
  <itemlist_item_name>Designer Seat Cushions</itemlist_item_name>    
  <itemlist_price_name>Custom</itemlist_price_name>    
  <itemlist_units_internalid>1</itemlist_units_internalid>    
  <itemlist_quantity>4.0</itemlist_quantity>   
  <itemlist_costestimate>100.0</itemlist_costestimate>  
  </Row>
</CashRefund_itemList>

INSERT INTO CashRefund (entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, itemListAggregate) VALUES (@EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, @ItemListAggregate)

A few examples of transaction tables are:


Name	Description
CashRefund	The NetSuite table CashRefund.
CreditMemo	The NetSuite table CreditMemo.
Estimate	The NetSuite table Estimate.
Invoice	The NetSuite table Invoice.
PurchaseOrder	The NetSuite table PurchaseOrder.
SalesOrder	The NetSuite table SalesOrder.
VendorBill	The NetSuite table VendorBill.
VendorCredit	The NetSuite table VendorCredit.
VendorPayment	The NetSuite table VendorPayment.
WorkOrder	The NetSuite table WorkOrder.

Child List Tables

For many tables, there are a number of lists that can exist as a part of a given entry on the table. We represent this data as an XML aggregate column directly on the table itself. These child lists can also be accessed as their own tables with each row representing a single entry on the list itself. To enable these child tables, set the IncludeChildTables connection property to true.

Child tables will always appear in the format ParentTableName_ChildListName. For instance, CashRefund_itemList. All child tables may be used to either modify the child list itself or insert/update the base entity or transaction. The only exception is that you cannot delete the base entity from the child table. Delete commands will instead be interpreted as a command to delete the specific row from the child list.

For inserting using a child table, a #TEMP table may be used to populate the structure that will eventually be passed to the parent as explained above. For example:

INSERT INTO CashRefund_itemList#TEMP (entity_internalId, itemlist_rate, itemlist_taxcode_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_taxrate1, itemlist_price_name, itemlist_quantity, itemlist_costestimate, itemlist_units_name, itemlist_units_internalid) VALUES (@EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, '2.00', 'CA-ALAMEDA', '2.0', '860', '1', '-159', 'xxxx', 'Backing', '8.25%', 'Base Price', '1.0', '0.0', '', '') 
INSERT INTO CashRefund_itemList#TEMP (entity_internalId, itemlist_taxcode_name, itemlist_units_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_price_name, itemlist_units_internalid, itemlist_quantity, itemlist_costestimate) VALUES (@CashRefundInternalId, @EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, '-Not Taxable-', 'Ea', '100.0', '704', '-1', '-7', 'Designer Seat / Back Cushions', 'Designer Seat Cushions', 'Custom', '1', '4.0', '100.0')
INSERT INTO CashRefund (entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, ItemListAggregate) VALUES (@EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, 'CashRefund_itemList#TEMP')

Alternatively, a complete parent and child record may be inserted using the child table. But only a single child record may be inserted using this method. For example, the following will create two separate CashRefund records, each with a single item:

INSERT INTO CashRefund_itemList (entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, itemlist_taxcode_name, itemlist_units_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_price_name, itemlist_units_internalid, itemlist_quantity, itemlist_costestimate) VALUES (@EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, '-Not Taxable-', 'Ea', '100.0', '704', '-1', '-7', 'Designer Seat / Back Cushions', 'Designer Seat Cushions', 'Custom', '1', '4.0', '100.0')
INSERT INTO CashRefund_itemList (entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, itemlist_taxcode_name, itemlist_units_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_price_name, itemlist_units_internalid, itemlist_quantity, itemlist_costestimate) VALUES (@EntityInternalId, @LocationInternalId, '2', '01/23/2012', @PostingPeriodInternalId, '-Not Taxable-', 'Ea', '101.0', '704', '-1', '-7', 'Designer Seat / Back Cushions', 'Designer Seat Cushions', 'Custom', '1', '4.0', '101.0')

To append additional rows to an existing entity, simply specify the InternalId of the entity in the INSERT statement. For instance:

INSERT INTO CashRefund_itemList (InternalId, entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, itemlist_rate, itemlist_taxcode_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_taxrate1, itemlist_price_name, itemlist_quantity, itemlist_costestimate, itemlist_units_name, itemlist_units_internalid) VALUES (@CashRefundInternalId, @EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, '2.00', 'CA-ALAMEDA', '2.0', '860', '1', '-159', 'xxxx', 'Backing', '8.25%', 'Base Price', '1.0', '0.0', '', '') 
INSERT INTO CashRefund_itemList (InternalId, entity_internalId, location_internalid, exchangerate, trandate, postingperiod_internalid, itemlist_taxcode_name, itemlist_units_name, itemlist_amount, itemlist_item_internalid, itemlist_price_internalid, itemlist_taxcode_internalid, itemlist_description, itemlist_item_name, itemlist_price_name, itemlist_units_internalid, itemlist_quantity, itemlist_costestimate) VALUES (@CashRefundInternalId, @EntityInternalId, @LocationInternalId, '1', '01/22/2012', @PostingPeriodInternalId, '-Not Taxable-', 'Ea', '100.0', '704', '-1', '-7', 'Designer Seat / Back Cushions', 'Designer Seat Cushions', 'Custom', '1', '4.0', '100.0')

Simple Tables

Most tables can be used with a WHERE clause when data is selected from them. However, a few tables do not have this ability in the NetSuite API and instead all items must be listed. These are simple tables that generally do not have much data to return.

The SupportEnhancedSQL feature, set by default, enables you to use a WHERE clause in queries against these tables. The following tables cannot be used in the WHERE clause without this feature:


Name	Description
BudgetCategory	The NetSuite table BudgetCategory.
CampaignAudience	The NetSuite table CampaignAudience.
CampaignCategory	The NetSuite table CampaignCategory.
CampaignChannel	The NetSuite table CampaignChannel.
CampaignFamily	The NetSuite table CampaignFamily.
CampaignOffer	The NetSuite table CampaignOffer.
CampaignSearchEngine	The NetSuite table CampaignSearchEngine.
CampaignSubscription	The NetSuite table CampaignSubscription.
CampaignVertical	The NetSuite table CampaignVertical.
CostCategory	The NetSuite table CostCategory.
Currency	The NetSuite table Currency.
LeadSource	The NetSuite table LeadSource.
SalesTaxItem	The NetSuite table SalesTaxItem.
State	The NetSuite table State.
SupportCaseIssue	The NetSuite table SupportCaseIssue.
SupportCaseOrigin	The NetSuite table SupportCaseOrigin.
SupportCasePriority	The NetSuite table SupportCasePriority.
SupportCaseStatus	The NetSuite table SupportCaseStatus.
SupportCaseType	The NetSuite table SupportCaseType.
TaxGroup	The NetSuite table TaxGroup.
TaxType	The NetSuite table TaxType.

Columns


Name	Type	ReadOnly	Description
InternalId [KEY]	String	True	The InternalId of the Customer.
AccessRole_ExternalId	String	False	The AccessRole_ExternalId of the Customer.
AccessRole_InternalId	String	False	The AccessRole_InternalId of the Customer.
AccessRole_Name	String	False	The AccessRole_Name of the Customer.
AccessRole_Type	String	False	The AccessRole_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
AccountNumber	String	False	The AccountNumber of the Customer.
AddressbookList_ReplaceAll	Boolean	False	The AddressbookList_ReplaceAll of the Customer.
Aging	Double	False	The Aging of the Customer.
AltEmail	String	False	The AltEmail of the Customer.
AltName	String	False	The AltName of the Customer.
AltPhone	String	False	The AltPhone of the Customer.
Balance	Double	False	The Balance of the Customer.
BillPay	Boolean	False	The BillPay of the Customer.
BuyingReason_ExternalId	String	False	The BuyingReason_ExternalId of the Customer.
BuyingReason_InternalId	String	False	The BuyingReason_InternalId of the Customer.
BuyingReason_Name	String	False	The BuyingReason_Name of the Customer.
BuyingReason_Type	String	False	The BuyingReason_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
BuyingTimeFrame_ExternalId	String	False	The BuyingTimeFrame_ExternalId of the Customer.
BuyingTimeFrame_InternalId	String	False	The BuyingTimeFrame_InternalId of the Customer.
BuyingTimeFrame_Name	String	False	The BuyingTimeFrame_Name of the Customer.
BuyingTimeFrame_Type	String	False	The BuyingTimeFrame_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
CampaignCategory_ExternalId	String	False	The CampaignCategory_ExternalId of the Customer.
CampaignCategory_InternalId	String	False	The CampaignCategory_InternalId of the Customer.
CampaignCategory_Name	String	False	The CampaignCategory_Name of the Customer.
CampaignCategory_Type	String	False	The CampaignCategory_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
Category_ExternalId	String	False	The Category_ExternalId of the Customer.
Category_InternalId	String	False	The Category_InternalId of the Customer.
Category_Name	String	False	The Category_Name of the Customer.
Category_Type	String	False	The Category_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
ClickStream	String	False	The ClickStream of the Customer.
Comments	String	False	The Comments of the Customer.
CompanyName	String	False	The CompanyName of the Customer.
ConsolAging	Double	False	The ConsolAging of the Customer.
ConsolBalance	Double	False	The ConsolBalance of the Customer.
ConsolDaysOverdue	Long	False	The ConsolDaysOverdue of the Customer.
ConsolDepositBalance	Double	False	The ConsolDepositBalance of the Customer.
ConsolOverdueBalance	Double	False	The ConsolOverdueBalance of the Customer.
ConsolUnbilledOrders	Double	False	The ConsolUnbilledOrders of the Customer.
ContactRolesList_ReplaceAll	Boolean	False	The ContactRolesList_ReplaceAll of the Customer.
ContribPct	String	False	The ContribPct of the Customer.
CreditCardsList_ReplaceAll	Boolean	False	The CreditCardsList_ReplaceAll of the Customer.
CreditHoldOverride	String	False	The CreditHoldOverride of the Customer. The allowed values are _auto, _on, _off.
CreditLimit	Double	False	The CreditLimit of the Customer.
Currency_ExternalId	String	False	The Currency_ExternalId of the Customer.
Currency_InternalId	String	False	The Currency_InternalId of the Customer.
Currency_Name	String	False	The Currency_Name of the Customer.
Currency_Type	String	False	The Currency_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
CurrencyList_ReplaceAll	Boolean	False	The CurrencyList_ReplaceAll of the Customer.
CustomForm_ExternalId	String	False	The CustomForm_ExternalId of the Customer.
CustomForm_InternalId	String	False	The CustomForm_InternalId of the Customer.
CustomForm_Name	String	False	The CustomForm_Name of the Customer.
CustomForm_Type	String	False	The CustomForm_Type of the Customer. The allowed values are account, accountingPeriod, appDefinition, appPackage, assemblyBuild, assemblyUnbuild, assemblyItem, bin, binTransfer, binWorksheet, budget, budgetCategory, calendarEvent, campaign, campaignAudience, campaignCategory, campaignChannel, campaignFamily, campaignOffer, campaignResponse, campaignSearchEngine, campaignSubscription, campaignVertical, cashRefund, cashSale, check, classification, contact, contactCategory, contactRole, costCategory, couponCode, creditMemo, crmCustomField, currency, currencyRate, customList, customRecord, customRecordCustomField, customRecordType, customer, customerCategory, customerDeposit, customerMessage, customerPayment, customerRefund, customerStatus, depositApplication, department, descriptionItem, discountItem, downloadItem, employee, entityCustomField, entityGroup, estimate, expenseCategory, expenseReport, file, folder, giftCertificate, giftCertificateItem, interCompanyJournalEntry, interCompanyTransferOrder, inventoryAdjustment, inventoryItem, inventoryNumber, inventoryTransfer, invoice, itemCustomField, itemDemandPlan, itemFulfillment, itemGroup, itemNumberCustomField, itemOptionCustomField, itemSupplyPlan, itemRevision, issue, job, jobStatus, jobType, itemReceipt, journalEntry, kitItem, leadSource, location, lotNumberedInventoryItem, lotNumberedAssemblyItem, markupItem, message, manufacturingCostTemplate, manufacturingOperationTask, manufacturingRouting, nexus, nonInventoryPurchaseItem, nonInventoryResaleItem, nonInventorySaleItem, note, noteType, opportunity, otherChargePurchaseItem, otherChargeResaleItem, otherChargeSaleItem, otherCustomField, otherNameCategory, partner, partnerCategory, paycheckJournal, paymentItem, paymentMethod, payrollItem, phoneCall, priceLevel, pricingGroup, projectTask, promotionCode, purchaseOrder, returnAuthorization, revRecSchedule, revRecTemplate, salesOrder, salesRole, salesTaxItem, serializedInventoryItem, serializedAssemblyItem, servicePurchaseItem, serviceResaleItem, serviceSaleItem, solution, siteCategory, state, subsidiary, subtotalItem, supportCase, supportCaseIssue, supportCaseOrigin, supportCasePriority, supportCaseStatus, supportCaseType, task, taxGroup, taxType, term, timeBill, topic, transferOrder, transactionBodyCustomField, transactionColumnCustomField, unitsType, vendor, vendorCategory, vendorBill, vendorCredit, vendorPayment, vendorReturnAuthorization, winLossReason, workOrder, workOrderIssue, workOrderCompletion, workOrderClose.
DateCreated	Datetime	False	The DateCreated of the Customer.
DaysOverdue	Long	False	The DaysOverdue o