NetSuite Connector synchronizes data and automates business processes between NetSuite and third party applications, either on-premise or in the cloud. The Connector makes use of the SuiteTalk WSDL to provide SOAP based integration in order to generate NetSuite business objects, make use of different authentication levels, and support error handling.
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
No |
Mule Version |
3.5.0 or higher |
Configs
SSO Login Authentication
<netsuite:config-sso-login-authentication>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
partnerId |
The partnerId agreed with NetSuite upon enabling SSO |
x |
||
partnerAccount |
NetSuite SuiteTalk WebService account id |
x |
||
companyId |
The companyId used when the SSO mapping was setup |
x |
||
userId |
The userId used when the SSO mapping was setup |
x |
||
keyFile |
The private key file used to encrypt the companyId and userId into an authentication token |
x |
||
applicationId |
The id related to the Integration record to be used. Integration records are set up on the NetSuite environment. |
x |
||
connectionTimeout |
Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. 0 specifies that the client will continue to attempt to open a connection indefinitely. |
|
||
receiveTimeout |
Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. 0 specifies that the client will wait indefinitely. |
|
||
proxyHost |
The hostname of the HTTP proxy e.g. localhost This field also requires the port to be set. |
|
||
proxyPort |
The port number of the HTTP proxy e.g. 3128. The port number must be specified if the hostname is also specified. |
|
||
proxyUsername |
The username which should be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
proxyPassword |
The password which would be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
endpoint |
Web Service (SOAP) endpoint |
|
||
restletEndpoint |
RESTlet endpoint |
|
||
separator |
Separator used to generate the keys required to provided a better support for custom fields/records. If the script Id of the customization that defines a custom field/record contains the separator default character, setup a new one and regenerate the metadata. |
__ |
|
Request Level Token Based Authentication
<netsuite:config-request-level-token-based-authentication>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
consumerKey |
The consumer key value for the token based authentication enabled integration record being used |
x |
||
consumerSecret |
The consumer secret value for the token based authentication enabled integration record being used |
x |
||
tokenId |
The token id representing the unique combination of a user and integration generated within the NetSuite environment |
x |
||
tokenSecret |
The respective token secret for the user/integration pair |
x |
||
account |
NetSuite SuiteTalk WebService account id. |
x |
||
connectionTimeout |
Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. 0 specifies that the client will continue to attempt to open a connection indefinitely. |
|
||
receiveTimeout |
Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. 0 specifies that the client will wait indefinitely. |
|
||
signatureAlgorithm |
SignatureAlgorithm |
The algorithm used to compute the SHA hash signature |
HMAC_SHA_1 |
|
proxyHost |
The hostname of the HTTP proxy e.g. localhost This field also requires the port to be set. |
|
||
proxyPort |
The port number of the HTTP proxy e.g. 3128. The port number must be specified if the hostname is also specified. |
|
||
proxyUsername |
The username which should be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
proxyPassword |
The password which would be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
endpoint |
Web Service (SOAP) endpoint |
|
||
restletEndpoint |
RESTlet endpoint |
|
||
separator |
Separator used to generate the keys required to provided a better support for custom fields/records. If the script Id of the customization that defines a custom field/record contains the separator default character, setup a new one and regenerate the metadata. |
__ |
|
Request Level Authentication
<netsuite:config-request-level-authentication>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
The login email of both NetSuite UI and SuiteTalk |
x |
|||
password |
The login password of both the NetSuite UI and SuiteTalk |
x |
||
account |
NetSuite SuiteTalk WebService account id |
x |
||
roleId |
The id of the role used to login in SuiteTalk, which determines the Processor privileges |
x |
||
applicationId |
The id related to the Integration record to be used. Integration records are set up on the NetSuite environment. |
x |
||
connectionTimeout |
Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. 0 specifies that the client will continue to attempt to open a connection indefinitely. |
|
||
receiveTimeout |
Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. 0 specifies that the client will wait indefinitely. |
|
||
proxyHost |
The hostname of the HTTP proxy e.g. localhost This field also requires the port to be set. |
|
||
proxyPort |
The port number of the HTTP proxy e.g. 3128. The port number must be specified if the hostname is also specified. |
|
||
proxyUsername |
The username which should be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
proxyPassword |
The password which would be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
endpoint |
Web Service (SOAP) endpoint |
|
||
restletEndpoint |
RESTlet endpoint |
|
||
separator |
Separator used to generate the keys required to provided a better support for custom fields/records. If the script Id of the customization that defines a custom field/record contains the separator default character, setup a new one and regenerate the metadata. |
__ |
|
Login Authentication
<netsuite:config-login-authentication>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
The login email of both NetSuite UI and SuiteTalk |
x |
|||
password |
The login password of both the NetSuite UI and SuiteTalk |
x |
||
account |
NetSuite SuiteTalk WebService account id |
x |
||
roleId |
The id of the role used to login in SuiteTalk, which determines the Processor privileges |
x |
||
applicationId |
The id related to the Integration record to be used. Integration records are set up on the NetSuite environment. |
x |
||
connectionTimeout |
Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. 0 specifies that the client will continue to attempt to open a connection indefinitely. |
|
||
receiveTimeout |
Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. 0 specifies that the client will wait indefinitely. |
|
||
proxyHost |
The hostname of the HTTP proxy e.g. localhost This field also requires the port to be set. |
|
||
proxyPort |
The port number of the HTTP proxy e.g. 3128. The port number must be specified if the hostname is also specified. |
|
||
proxyUsername |
The username which should be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
proxyPassword |
The password which would be supplied to the HTTP proxy on every request to NetSuite. This field is optional, since a user might want to pass through an unauthenticated HTTP proxy. |
|
||
endpoint |
Web Service (SOAP) endpoint |
|
||
restletEndpoint |
RESTlet endpoint |
|
||
separator |
Separator used to generate the keys required to provided a better support for custom fields/records. If the script Id of the customization that defines a custom field/record contains the separator default character, setup a new one and regenerate the metadata. |
__ |
|
Processors
Attach record
<netsuite:attach-record>
Defines a relationship between to records by attaching a source or contact record to another destination record. Not all record types are supported as source, destination or contact. Please consult NetSuite documentation.
XML Sample
<netsuite:attach-record config-ref="Netsuite" destination-ref="#[flowVars.destination]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
source |
RecordRef |
A RecordRef that references the source record. |
#[payload] |
|
destination |
RecordRef |
A RecordRef that references the destination record. |
x |
|
contact |
RecordRef |
A RecordRef that that references the contact record. |
|
|
role |
RecordRef |
A RecordRef that that references the user role. |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
WriteResponse |
A WriteResponse that contains details on the status of the operation and a reference to the attached record. |
Delete record
<netsuite:delete-record>
Deletes a record. Not all records can be deleted. Please consult NetSuite documentation.
XML Sample
<netsuite:delete-record config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordRef |
RecordRef |
A RecordRef that references the record to delete. |
#[payload] |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
WriteResponse |
A WriteResponse that contains details on the status of the operation and a reference to the deleted record. |
Delete
<netsuite:delete>
Deletes a record. Not all records can be deleted. Please consult NetSuite documentation.
XML Sample
<netsuite:delete config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
baseRef |
A BaseRefType that references the record to delete. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
WriteResponse |
A WriteResponse that contains details on the status of the operation and a reference to the deleted record. |
Detach record
<netsuite:detach-record>
Removes the relationship (attachment) between two records.
XML Sample
<netsuite:detach-record config-ref="Netsuite" destination-ref="#[flowVars.destination]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
source |
RecordRef |
A RecordRef that references the source record. |
#[payload] |
|
destination |
RecordRef |
A RecordRef that references the destination record. |
x |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
WriteResponse |
A DetachResponse that contains details on the status of the operation and a reference to the detached record. |
Get budget exchange rates
<netsuite:get-budget-exchange-rates>
Retrieves a list of budget exchange rates for a given period.
XML Sample
<netsuite:get-budget-exchange-rates config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
period |
RecordRef |
A RecordRef that references an existing period. |
#[payload] |
|
fromSubsidiary |
RecordRef |
A RecordRef that references the receiving subsidiary. |
|
|
toSubsidiary |
RecordRef |
A RecordRef that references the originating subsidiary. |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetBudgetExchangeRateResult |
A GetBudgetExchangeRateResult containing details of the status of the operation and the list of available exchange rates in a budget. |
Get customization ids
<netsuite:get-customization-ids>
Retrieves the IDs of all available custom objects of a specified type.
XML Sample
<netsuite:get-customization-ids config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
GetCustomizationType |
The target custom object type. |
x |
|
includeInactives |
boolean |
If false, no inactive custom objects are returned in the response. If true, both active and inactive custom objects are returned in the response. |
false |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetCustomizationIdResult |
A list of CustomizationRef. |
Get deleted records
<netsuite:get-deleted-records>
Retrieves a list of deleted records for the given record type and date period.
XML Sample
<netsuite:get-deleted-records config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
The type of the target deleted record to retrieve. |
x |
||
pageIndex |
The page number to retrieve. |
1 |
|
|
deletedDate |
SearchDateField |
A SearchDateField where you can define a predefined search date value, or a date period of your choice, together with the search date operator. |
#[payload] |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetDeletedResult |
A list of DeletedRecord that match the given date filtering expression. |
Get records
<netsuite:get-records>
Retrieves a list of all records of the specified type. Records that support the getAll operation are listed in the GetAllRecordType.
XML Sample
<netsuite:get-records config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
GetAllRecordType |
The target record type. |
x |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetAllResult |
A GetAllResult containing the status of the operation and a list of records. |
Get list
<netsuite:get-list>
Retrieves a list of one or more record by providing the unique ids that identify those records.
XML Sample
<netsuite:get-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
references |
A list of BaseRef objects that specify the ids of the records to be retrieved. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of ReadResponse containing the status of the operation and the record. |
Get
<netsuite:get>
Retrieves a record by providing the unique id that identifies that record.
XML Sample
<netsuite:get config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
baseRef |
A BaseRefType that references the record to fetch. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Get record
<netsuite:get-record>
DataSense enabled
Retrieves a record by providing the unique id that identifies that record.
XML Sample
<netsuite:get-record config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
The type of record to get. |
x |
||
internalId |
The internalId of the record to get. You can choose between this or externalId. |
|
||
externalId |
The externalId of the record to get. You can choose between this or internalId. |
|
||
preferences |
Preferences |
Preferences for the request. |
|
Get custom record
<netsuite:get-custom-record>
DataSense enabled
Retrieves a custom record by providing the unique id that identifies that record.
XML Sample
<netsuite:get-custom-record config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
The type of record to get. |
x |
||
internalId |
The internalId of the record to get. You can choose between this or externalId. |
#[payload] |
|
|
externalId |
The externalId of the record to get. You can choose between this or internalId. |
|
||
preferences |
Preferences |
Preferences for the request. |
|
Get item availability
<netsuite:get-item-availability>
Retrieves the inventory availability for a given item. If the Multi-Location Inventory feature is enabled, this Processor returns results for all locations. For locations that do not have any items available, only location IDs and names are listed in results.
XML Sample
<netsuite:get-item-availability config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
record |
RecordRef |
A RecordRef that references an existing item record in NetSuite. |
#[payload] |
|
ifModifiedSince |
If set, only items with quantity available changes recorded as of the specified date are returned. |
|
||
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetItemAvailabilityResult |
A GetItemAvailabilityResult with details on the status of the operation and the list of available items. |
Get saved search
<netsuite:get-saved-search>
Retrieves a list of existing saved search IDs on a per-record-type basis.
XML Sample
<netsuite:get-saved-search config-ref="Netsuite" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
type |
SearchRecordType |
The target record type. |
x |
Returns
| Return Java Type | Description |
|---|---|
GetSavedSearchResult |
An GetSavedSearchResult with details on the status of the operation, the total number of records for this search and the list of records that correspond to the specified IDs. |
Get server time
<netsuite:get-server-time>
Retrieves the NetSuite server time in GMT, regardless of the user's time zone, resulting in more accurate and reliable syncing of data than using using local client time. A user will use the time from server to determine if the record has changed since the last synchronization.
XML Sample
<netsuite:get-server-time config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Update invitee status
<netsuite:update-invitee-status>
Allows a user to respond to a NetSuite event.
XML Sample
<netsuite:update-invitee-status config-ref="Netsuite" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
eventId |
RecordRef |
The target event ID. |
#[payload] |
|
status |
The new status value to set. |
x |
||
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
WriteResponse |
A WriteResponse containing details on the status of the operation and a reference to the updated event record. |
Update invitee status list
<netsuite:update-invitee-status-list>
Allows a user to respond to one or more NetSuite events.
XML Sample
<netsuite:update-invitee-status-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
inviteeStatusList |
A list of the UpdateInviteeStatusReference items. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse, each of which contains details on the status of the operation and a reference to each event record. |
Add record objects
<netsuite:add-record-objects>
Adds one or more new instances of a record in NetSuite. If there are multiple records, they can either be of the same record type or different record types.
XML Sample
<netsuite:add-record-objects config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
The list of Record objects to persist. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each new record. |
Add record
<netsuite:add-record>
DataSense enabled
Adds a new instance of a record in NetSuite. The record attributes can either be the POJOs corresponding to the field or a map that represents it.
XML Sample
<netsuite:add-record config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The type of record to add. |
x |
||
attributes |
The record attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences of the request. |
|
Returns
| Return Java Type | Description |
|---|---|
BaseRef |
A RecordRef or CustomRecordRef depending on the type of |
Add list
<netsuite:add-list>
DataSense enabled
Adds one or more new instances of a record in NetSuite of the same type. The attributes that define each record can either be the POJOs corresponding to the field or a map that represents it.
XML Sample
<netsuite:add-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The type of record to add. |
x |
||
records |
The records with their attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each new record. |
Update list
<netsuite:update-list>
DataSense enabled
Updates one or more instances of a record type in NetSuite by providing new values for the fields to be updated for each record. The records to be updated are identified through the provided unique identifiers.
XML Sample
<netsuite:update-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The type of record to update. |
x |
||
records |
The fields of the records to be modified. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each updated record. |
Update records list
<netsuite:update-records-list>
Updates one or more instances of records in NetSuite which can be of multiple types. The records to be updated are identified through the provided unique identifiers. NOTE: This call cannot be used with Data Mapping or Data Sense, it was added to allow users to add a batch of records of any type in 1 call.
XML Sample
<netsuite:update-records-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
The records with their attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each updated record. |
Delete list
<netsuite:delete-list>
Deletes one or more existing instances of a certain record type in NetSuite.
XML Sample
<netsuite:delete-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of BaseRefType representing the records with their attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each deleted record. |
Delete records list
<netsuite:delete-records-list>
Deletes one or more existing instances of multiple record types in NetSuite.
XML Sample
<netsuite:delete-records-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of RecordRef to delete. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and a reference to each deleted record. |
Add file
<netsuite:add-file>
Creates a new file record. This operation is similar to addRecord, but is customized for simplifying local content passing.
XML Sample
<netsuite:add-file config-ref="Netsuite" content-ref="#[flowVars.content]" fileName="#[flowVars.fileName]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
RecordRef |
A RecordRef that represents the ID of the folder record where to add this file. |
#[payload] |
|
attributes |
The additional file attributes. |
|
||
content |
The content of the file record to add. It can be of type String, Byte Array, File or InputStream. |
x |
||
fileName |
the name of the remote file. |
x |
||
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
RecordRef |
A RecordRef containing the reference to the new file record. |
Update record
<netsuite:update-record>
DataSense enabled
Updates an existing record.The attributes can either be the POJOs corresponding to the field or a map that represents it.
XML Sample
<netsuite:update-record config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type to update. |
x |
||
attributes |
The record attributes, including internalId or externalId attribute. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
BaseRef |
A RecordRef or CustomRecordRef depending on the type of |
Upsert record
<netsuite:upsert-record>
DataSense enabled
Adds a new instance or to update an instance of a record in NetSuite. The upsert operation is similar to both the add and update operations, but upsert can be run without first determining whether a record exists in NetSuite. A record is identified by its external ID and its record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because external ID is mandatory for this operation, upsert is supported only for records that support the external ID field. Also, this operation prohibits the passing of internal ID values.
XML Sample
<netsuite:upsert-record config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type to update. |
x |
||
attributes |
The record attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
BaseRef |
A RecordRef or CustomRecordRef depending on the type of |
Upsert list
<netsuite:upsert-list>
DataSense enabled
Adds or updates one or more instances of a record type in NetSuite. The upsertList operation is similar to both the addList and updateList operations, but upsert can be run without first determining whether records exist in NetSuite. Records are identified by their external ID and their record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because external ID is mandatory for this operation, 'upsertList' is supported only for records that support the external ID field. Also, this operation prohibits the passing of internal ID values.
XML Sample
<netsuite:upsert-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type to update. |
x |
||
records |
The record attributes. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of WriteResponse containing details on the status of the operation and the references to the updated records. |
Check async status
<netsuite:check-async-status>
Checks whether a particular asynchronous job has finished processing or not.
XML Sample
<netsuite:check-async-status config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
jobId |
The ID of the job to check. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
The AsyncStatusResult for the given job. |
Async search
<netsuite:async-search>
DataSense enabled
An asynchronous request equivalent to #search(String, SearchRecord, boolean, boolean, PagingConfiguration). Searches for all records that match the given criteria, asynchronously. Note, due to the nature of the operation, this does not support paging meaning that only the first page of results would be returned. If no criteria is specified, all records of the given type are retrieved. In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID.
XML Sample
<netsuite:async-search config-ref="Netsuite" searchRecord="#[flowVars.searchRecord]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
searchRecord |
The search type. See SearchRecordTypeEnum. |
x |
||
criteria |
SearchRecord |
An instance of SearchRecord that defines the attributes that make up the search. |
#[payload] |
|
bodyFieldsOnly |
boolean |
Defaults to TRUE and indicates that the information in the body fields of the record are returned — significantly improving performance. Any fields in associated lists or sub-lists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. |
true |
|
returnSearchColumns |
boolean |
Defaults to TRUE, meaning that only search columns will be returned in your search. |
true |
|
pageSize |
Maximum amount of results per page. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Get async result
<netsuite:get-async-result>
Retrieves the results of an asynchronous web services submission (job) and can be used up to 20 times within a 30 day time period.
XML Sample
<netsuite:get-async-result config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
jobId |
The ID of the job. |
#[payload] |
|
|
pageIndex |
The page number of the asynchronous result. |
1 |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncResult |
A AsyncResult containing the details on the status of the job. |
Initialize
<netsuite:initialize>
Populates fields on transaction line items with values from a related record, in a similar way empty text boxes are pre-populated within the NetSuite UI.
XML Sample
<netsuite:initialize config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
record |
InitializeRecord |
An instance of InitializeRecord. |
#[payload] |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
ReadResponse |
A ReadResponse containing the results of the initialization request. |
Get posting transaction summary
<netsuite:get-posting-transaction-summary>
Retrieves a summary of the actual data in an account. Available filters/fields can be used to generate reports that are similar to what the user sees when running financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
XML Sample
<netsuite:get-posting-transaction-summary config-ref="Netsuite" filters-ref="#[flowVars.filters]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
fields |
PostingTransactionSummaryField |
Specify how you want your data grouped. |
#[payload] |
|
filters |
PostingTransactionSummaryFilter |
Specify your filtering criteria. |
x |
|
pageIndex |
Specify the page to be returned. |
1 |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetPostingTransactionSummaryResult |
A GetPostingTransactionSummaryResult containing details on the status of the operation and the list of available transactions filtered/grouped by the specified fields. |
Get select value
<netsuite:get-select-value>
Retrieves valid values for a given recordRef field where the referenced record type is not yet exposed in the Web services API or when the logged in role does not have access to the instances of the record type.
XML Sample
<netsuite:get-select-value config-ref="Netsuite" page="#[flowVars.page]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
page |
int |
For select values that span multiple pages, use this argument to specify which page to return in your response. |
x |
|
fieldDescriptor |
GetSelectValueFieldDescription |
Use to specify all characteristics of the field containing the select values. For example, depending on the field and the values you want returned, you will specify the names or internalIds for the record type, sublist, and field. You may also specify filtering criteria to refine the select options returned in the response. |
#[payload] |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetSelectValueResult |
The GetSelectValueResult related to the request. |
Get current rate
<netsuite:get-current-rate>
Retrieves the exchange rate between two currencies.
XML Sample
<netsuite:get-current-rate config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
rateFilter |
CurrencyRateFilter |
Filter the returned currency exchange rates using this filter. |
#[payload] |
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
GetCurrencyRateResult |
A GetCurrencyRateResult containing the status of the operation and the list of available currency rates for the given filters. |
Async add list
<netsuite:async-add-list>
DataSense enabled
An asynchronous request equivalent to #addList. The attributes can either be the POJOs corresponding to the field or a map that represents it. In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-add-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type. |
x |
||
recordsAttributes |
A list of attributes of the records that will be added. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Async update list
<netsuite:async-update-list>
DataSense enabled
An asynchronous request equivalent to #updateList(String, List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-update-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type. |
x |
||
recordsAttributes |
A list of Map |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
The result AsyncStatusResult with the jobId that can be used to check the status and result. |
Async upsert list
<netsuite:async-upsert-list>
DataSense enabled
An asynchronous request equivalent to #upsertList(String, List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-upsert-list config-ref="Netsuite" recordType="#[flowVars.recordType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
recordType |
The target record type. |
x |
||
recordsAttributes |
A list of attributes of the records that will be inserted or updated. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Async delete list records
<netsuite:async-delete-list-records>
An asynchronous request equivalent to #deleteRecordsList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-delete-list-records config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of RecordRef that references the objects to be deleted. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Async delete list
<netsuite:async-delete-list>
An asynchronous request equivalent to #deleteList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-delete-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of BaseRefType that references the objects to be deleted. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Async get list records
<netsuite:async-get-list-records>
An asynchronous request equivalent to #getList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-get-list-records config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of RecordRef that references the objects to be retrieved. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobId that can be used to check the status and result of the job. |
Async get list
<netsuite:async-get-list>
An asynchronous request equivalent to #getList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-get-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
A list of RecordRef that references the objects to be retrieved. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobID that can be used to check the status and result of the job. |
Async initialize list
<netsuite:async-initialize-list>
An asynchronous request equivalent to #initializeList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.
XML Sample
<netsuite:async-initialize-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
initializeRecord |
A list of InitializeRecord that references the objects to be initialized. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
AsyncStatusResult |
A AsyncStatusResult with the jobID that can be used to check the status and result of the job. |
Initialize list
<netsuite:initialize-list>
Emulates the UI workflow by pre-populating fields on transaction line items with values from a related record.
XML Sample
<netsuite:initialize-list config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
initializeRecord |
The list of InitializeRecord to initialize. |
#[payload] |
|
|
preferences |
Preferences |
Preferences for the request. |
|
Returns
| Return Java Type | Description |
|---|---|
A list of ReadResponse containing the results of each initialization request. |
Change email
<netsuite:change-email>
Changes the email address of the user account.
XML Sample
<netsuite:change-email config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
newEmail |
The new email. |
#[payload] |
|
|
justThisAccount |
Apply the change to the current account only. |
true |
|
Returns
| Return Java Type | Description |
|---|---|
SessionResponse |
A SessionResponse containing details on the status of the operation. |
Change password
<netsuite:change-password>
Changes the password of the user account.
XML Sample
<netsuite:change-password config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
newPassword |
The new password. |
#[payload] |
|
|
justThisAccount |
Apply the change to the current account only. |
true |
|
Returns
| Return Java Type | Description |
|---|---|
SessionResponse |
A SessionResponse containing details on the status of the operation. |
Get Data Center URLs
<netsuite:get-data-center-urls>
Retrieves the accessible data-center URLs for the accountId specified.
XML Sample
<netsuite:get-data-center-urls config-ref="Netsuite" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
accountId |
The NetSuite account ID. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
GetDataCenterUrlsResult |
A GetDataCenterUrlsResult containing the status of the request and the Data Center URLs. |
Map SSO
<netsuite:map-sso>
Automates the mapping between external applications credentials and NetSuite’s credentials for a user. This operation provides a mapping, not a login to NetSuite. This operation does NOT provide the ability to log in using a single sign-on token, cannot provide a partner with the inbound single sign-on feature, or aid with public/private key exchange. Use of this operation implies that the account already has inbound single sign-on set up and has access to the associated partner ID and encryption keys needed to generate the token.
XML Sample
<netsuite:map-sso config-ref="Netsuite" userAccount="#[flowVars.userAccount]" userPartnerId="#[flowVars.userPartnerId]" authenticationToken="#[flowVars.authenticationToken]" userEmail="#[flowVars.userEmail]" userPassword="#[flowVars.userPassword]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
userAccount |
The NetSuite account ID. |
x |
||
userPartnerId |
The integration partner’s affiliate ID as provided to the partner by NetSuite. |
x |
||
authenticationToken |
A string representing the encrypted token. |
x |
||
userEmail |
The user email. |
x |
||
userPassword |
The user password. |
x |
||
userRole |
RecordRef |
A RecordRef that represents the user role. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
SessionResponse |
A SessionResponse that includes the status and wsRoleList elements. The wsRoleList element contains a list of roles available for the user specified in the passport. |
Search
<netsuite:search>
Paged Operation
DataSense enabled
Executes a search on a specific record type based on a set of criteria. It supports pagination, so that large result sets can be retrieved in smaller sets. Searches can be of type Basic, Joined or Advanced. See SearchRecord for all the available searches.
XML Sample
<netsuite:search config-ref="Netsuite" searchRecord="#[flowVars.searchRecord]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
searchRecord |
The search type. See SearchRecordTypeEnum. |
x |
||
criteria |
SearchRecord |
An SearchRecord that defines the attributes that make up the search. |
#[payload] |
|
bodyFieldsOnly |
boolean |
Defaults to TRUE and indicates that the information in the body fields of the record are returned — significantly improving performance. Any fields in associated lists or sub-lists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. |
true |
|
returnSearchColumns |
boolean |
Defaults to TRUE, meaning that only search columns will be returned in your search. |
true |
|
pagingConfiguration |
PagingConfiguration |
The number of objects returned in each page. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,NetSuiteConnector> |
The results of the search criteria. |
Call RESTlet (GET)
<netsuite:call-restlet-get>
Calls a NetSuite RESTlet using the GET method.
XML Sample
<netsuite:call-restlet-get config-ref="Netsuite" script="546" deploy="1" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
script |
int |
The ID of the deployed script. |
x |
|
deploy |
int |
The deploy number corresponding to the script. |
x |
|
data |
The input data for the script. |
#[payload] |
|
Call RESTlet (DELETE)
<netsuite:call-restlet-delete>
Calls a NetSuite RESTlet using the DELETE method.
XML Sample
<netsuite:call-restlet-delete config-ref="Netsuite" script="546" deploy="1" />Call RESTlet (PUT)
<netsuite:call-restlet-put>
Calls a NetSuite RESTlet using the PUT method.
XML Sample
<netsuite:call-restlet-put config-ref="Netsuite" script="546" deploy="1" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
script |
int |
The ID of the deployed script. |
x |
|
deploy |
int |
The deploy number corresponding to the script. |
x |
|
data |
The input data for the script. |
#[payload] |
|
Call RESTlet (POST)
<netsuite:call-restlet-post>
Calls a NetSuite RESTlet using the POST method.
XML Sample
<netsuite:call-restlet-post config-ref="Netsuite" script="546" deploy="1" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
script |
int |
The ID of the deployed script. |
x |
|
deploy |
int |
The deploy number corresponding to the script. |
x |
|
data |
The input data for the script. |
#[payload] |
|