Connector Part | Description |
---|---|
Account | The NetSuite account id. Required for both types of authentication. |
Email | The NetSuite account email. Required for password-based authentication. |
Password | The NetSuite account password. Required for password-based authentication. |
ApplicationId | The NetSuite CRM application ID created by using the integration record. Required for password-based authentication. |
TokenId | The authentication token id, generated by a NetSuite user. Required for token-based authentication. |
TokenSecret | The authentication token secret, generated by a NetSuite user. Required for token-based authentication. |
ConsumerKey | The NetSuite consumer key from an integration record. Required for token-based authentication. |
ConsumerSecret | The NetSuite consumer secret from an integration record. Required for token-based authentication. |
Schema Selector | Shows a list of target tables from where you can select a table to define a schema. |
Property | Description |
---|---|
BatchResponse | Path of the batch response file, which provides detailed results for each object in a batch. These results are useful for the following: • Capturing system-generated object IDs for use in future updates. • Associating errors with objects for exception handling and error diagnosis. A batch response entry is generated for each top-level record. For example, when a Customer record is inserted with an Addressbooklist, only one entry appears in the batch response. For more information about Batch Response File, see Data File Formats. |
CustomizationLevel | Specifies the allowed level of NetSuite customizations. • Full (default): Use this option while using custom record types. Also, provides access to custom fields defined for the standard record types. • CustomFieldsOnly: Use this option while using custom fields defined for the standard record types. Custom fields are requested based on your requirements. You cannot access the custom record types. • None: Use this option when custom record types and custom fields are not defined for the standard record types. It improves performance since this option does not require generating API calls at startup. |
DisableMandatoryCustomFieldValidation | Enables or disables validation for the required custom fields. • Default (default): Default NetSuite setting is used. • TRUE: Data for a custom field is not required when submitting a web services request. • FALSE: An error is returned when data for a required custom field is not provided. |
DisableSystemNotesCustomFields | Enables or disables system-generated notes when you modify custom fields of a standard record. The system-generated notes are used in NetSuite to track changes to a record, including what action was taken, when the record was modified, and the user who is responsible for the change. If you turn off system-generated notes for custom fields, specific changes related to custom fields within the modified record are not recorded in NetSuite, although all changes for standard fields are logged as usual. • Default (default): Default NetSuite setting is used, which is TRUE. • TRUE: System-generated notes are enabled when importing data from custom fields. • FALSE: System-generated notes are disabled when importing data from custom fields. Note: When importing large records, you may consider disabling system notes to improve performance. For more information, see the disableSystemNotesForCustomFields property in the NetSuite documentation. |
FlushFrequency | Number of records buffered in the memory before being written to the target connector. Default value is 0 (all records are written at once). |
IgnoreReadOnlyFields | Specifies whether read-only fields are ignored. • Default (default): Default NetSuite setting is used. • TRUE: Read-only fields are ignored. • FALSE: Read-only fields are not ignored, and an error message is returned. |
NestedChildren | Sets the connector to retrieve records (parents) and their associated lists (children). • TRUE: Connector retrieves records (parents) and their associated lists (children). • FALSE (default): Connector retrieves records (parents) only. This can significantly improve performance. Note: This property is applicable only when the DataType property is set to Record. |
Role | Specifies the NetSuite Role ID. A role specifies the permissions required to access different parts of NetSuite. If Role ID is not provided, the connector uses the user's default role. For more information, see the NetSuite documentation. |
TreatWarningAsError | Controls whether warning messages generated by NetSuite are treated as errors and the request is rejected. • Default: Default NetSuite setting is used. • TRUE: Warning messages generated by NetSuite are treated as errors. • FALSE: Warning messages generated by NetSuite are not treated as errors. |
UpdateNulls | Controls whether empty or null values are sent to NetSuite. • TRUE: Null values are sent to the NetSuite server. Blank is not mapped and no value is sent to the server. Empty strings are mapped as “0”. • FALSE (default): Null values are not sent to the NetSuite server. Blank is not mapped and no value is sent to the server. Empty strings are mapped as “0”. Note: - This property is useful only if some default value is assigned to the column. Default values can be assigned from the Netsuite application. - The setting for this property affects only parent-level record types since child record types ignores the null values and empty strings. |
UseUILabel | When creating a custom field, you must specify a name (label). Also, the system automatically generates an ID. The UseUILabel option allows to display either label or custom ID for a custom field. The available options are: • FALSE (default): Displays custom IDs for custom fields. • TRUE: Displays labels for custom fields. |
Custom FieldType | NetSuite Display Name |
---|---|
Boolean | Check box |
Date | Date Date Time Time of Day |
Double | Decimal Number Currency Percent |
Long | Integer Number |
MultiSelect | Multiple Select |
Select | List/Record Image |
String | Document E-mail Address Free-Form Text Help HyperLink Inline HTML Long Text Phone Number Password Rich Text Text Area |
Example SQL | SQL Statement |
---|---|
Simple query with 'where' clause and field list | Select ExternalId, Title, Status, Message, CUSTEVENT4 from PhoneCall where Select ExternalId, Title, Status, Message, CUSTEVENT4 from PhoneCall where |
Search With Numeric Filter | Select Probability, LeadSource_InternalId, Status, Pro-jectedTotal from Opportunity where ProjectedTotal not-GreaterThanOrEqualTo 1396.70 |
Search with String Filter | Select Title, Status, Message from PhoneCall where Title doesNotStartWith 'TC24889' |
Search with Date Filter | Select Title, StartDate, EndDate, Status, NoEndDate from CalendarEvent where StartDate notOnOrBefore '2006-07-25' |
Simple Subquery | Select InternalId, (select (select Addr1 from 'Addressbook') from 'AddressbookList') from Customer |
Multiple 'and' Clauses | Select EntityId, FirstName, LastName, Email from Contact where EntityId contains 'John' and Email startsWith 'John' and LastName is 'Boy' |
Address-Contact Primary Joined Search | Select CompanyName, Email from Vendor where Email notEmpty '' and ContactPrimaryJoin(Title is 'Quality') |
Customer-SubCustomer Joined Search | Select EntityId, Email from Customer where Email notEmpty '' and SubCustomerJoin(EntityId contains 'subcust') |
Query Using a Single Quote in a Field Value | Select EntityId from Contact where Email is JohnO'Doe@company.com |
Query Using Double Quotes in a Field Value | Select EntityId from Contact where NickName is `John "the bomb"` |
Query Using a Backtick in a Field Value | Select EntityId from Contact where Height is "5`3" |
Operator Category | Operator |
---|---|
Date-Only Operators | after before on onOrAfter onOrBefore notAfter notBefore notOn notOnOrAfter notOnOrBefore notWithin within |
String-only Operators | contains doesNotContain doesNotStartWith is isNot startsWith |
Numeric-Only Operators | between equalTo greaterThan greaterThanOrEqualTo lessThan lessThanOrEqualTo notBetween notEqualTo notGreaterThan notGreaterThanOrEqualTo notLessThan notLessThanOrEqualTo |
ID/Select Field-Only Operators | anyof noneof |
Grammar | Query Statements |
---|---|
query | select field_list from table (where query_terms)? |
field_list | ('(' child_query ')' ',')* ('' (',' '(' child_query ')')) | (field (',' (field | '(' child_query ')'))*) |
child_query | select field_list from table |
Field | Label |
Table | label | string_literal | string_literal_2 | string_literal_3 |
query_terms | simple_term | joined_search (and (simple_term | joined_search)) |
*simple_term | label (operation | label)? value (',' value)* |
operation | '=' | '>' | '<' | '<>' | '>=' | '<=' |
Value | string_literal | decimal | macrodef |
joined_search | label '(" simple_term (and simple_term)* ')' |
Label | character (character | digit | "_")* |
character | ['A' - 'Z'] | ['a' - 'z'] |
Digit | ['0' - '9'] |
Select | 'SELECT' | 'Select' | 'select' |
From | 'FROM' | 'From' | 'from' |
And | 'AND' | 'And' | 'and' |
where | 'AND' | 'And' | 'and' |
string_literal | ''' ( (~[''','\\','\n','\r']) | ('\\' ( ['n','t','b','r','f','\\','\'','\''] | ['0'-'7'] ( ['0'-'7'] )? | ['0'-'3'] ['0'-'7'] ['0'-'7'] ) ) )* ''' |
string_literal_2 | "`" ( (~["`","\\","\n","\r"]) | ("\\" ( ["n","t","b","r","f","`","\\","\'","\""] | ["0"-"7"] ( ["0"-"7"] )? | ["0"-"3"] ["0"-"7"] ["0"-"7"] ) ) )* "`" |
string_literal_3 | "\"" ( (~["\"","\\","\n","\r"]) | ("\\" ( ["n","t","b","r","f","`","\\","\'","\""] | ["0"-"7"] ( ["0"-"7"] )? | ["0"-"3"] ["0"-"7"] ["0"-"7"] ) ) )* "\"" |
decimal | number ('.' number)? |
number | digit+ |
macrodef | '$(' ~[')']+ ')' |