| Namespace | http://www.mulesoft.org/schema/mule/netsuite |
|---|---|
| Schema Location | http://www.mulesoft.org/schema/mule/netsuite/current/mule-netsuite.xsd (View Schema) |
| Schema Version | 3.0 |
| Minimum Mule Version | 3.5 |
The NetSuite cloud connector facade, based on a NetSuiteClient
| Configuration | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Configure an instance of this module
| |||||||||||
| Message Processors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new file record. | |||||||||||
Used to add one or more records into the system | |||||||||||
Creates a new record. | |||||||||||
Creates new records Example: | |||||||||||
An asynchronous requests equivalent to | |||||||||||
An asynchronous requests equivalent to #deleteList(Map | |||||||||||
An asynchronous requests equivalent to #deleteList(Map | |||||||||||
An asynchronous requests equivalent to #getList(Map | |||||||||||
An asynchronous requests equivalent to #getList(Map | |||||||||||
An asynchronous requests equivalent to #initializeRecord. | |||||||||||
Searches for all records that match the given filtering expression, asynchronously. | |||||||||||
An asynchronous requests equivalent to #updateRecord(Map | |||||||||||
An asynchronous requests equivalent to #upsertRecord(Map | |||||||||||
Attaches a source or contact record - that is, the attachment - to another destination one Not all record type are supported as source, destination or contact. | |||||||||||
Use to change the email address for the account. | |||||||||||
Use to change the password for the account. | |||||||||||
Answers the status of an asynchronous Web services submission. | |||||||||||
Deletes a record. | |||||||||||
Used to delete one or more records in the system. | |||||||||||
Deletes a record. | |||||||||||
Used to delete one or more records in the system. | |||||||||||
Detaches a source record - that is, the attachment - from a destination record. | |||||||||||
This is used to retrieve a record by providing the unique id that identifies that record. | |||||||||||
Answers the results of an asynchronous web services submission. | |||||||||||
Answers the list of budget exchange rates Example: | |||||||||||
Answers the list of consolidated exchange rates Example: | |||||||||||
Use this operation to get the exchange rate between two currencies based on a certain date. | |||||||||||
Answers the ids of available customizations for a given record type. | |||||||||||
Use for dynamic discovery of data-center-specific URLs for partner applications’ access to NetSuite.
| |||||||||||
Answers a list of deleted records of a given record type that match a given date expression. | |||||||||||
Answers the availability for a given record reference. | |||||||||||
This operation is used to retrieve a list of objects referenced in the list of BaseRef object. | |||||||||||
Use to retrieve a summary of the actual data in an account. | |||||||||||
This is used to retrieve a record by providing the unique id that identifies that record. | |||||||||||
This operation is used to retrieve a list of all records of the specified type. | |||||||||||
Retrieves a list of existing saved searches for the given record type. | |||||||||||
Use to retrieve 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 permission to the instances of the record type. | |||||||||||
Answers the server time, resulting in more accurate and reliable sync'ing of data than using using local client time. | |||||||||||
Populates fields on transaction line items with values from a related record, in a similar way empty text boxes are prepopulated within the Netsuite UI Example: | |||||||||||
Use to emulate the UI workflow by pre-populating fields on transaction line items with values from a related record. | |||||||||||
Use to automate the mapping between external applications credentials and NetSuite’s credentials for a user. | |||||||||||
Return a list of records, or columns matching the query provided. | |||||||||||
Return a list of records. | |||||||||||
The search operation is used to execute a search on a specific record type based on a set of criteria. | |||||||||||
The seachMore operation is used to retrieve more records after an initial search operation. | |||||||||||
The searchMoreWithId operation allows users to reference a specific search result set by its searchId, a parameter included in all search results. | |||||||||||
The searchNext operation is used to retrieve the next set of records after an initial search operation. | |||||||||||
The search operation is used to execute a search on a specific record type based on a set of criteria. | |||||||||||
Use to establish a single sign-on connection. | |||||||||||
Updates existing record's custom fields. | |||||||||||
Sets a new invitation status for a given event. | |||||||||||
Sets a new invitation status for a given event. | |||||||||||
Used to update one or more existing records in the system by providing new values for the fields to be updated for each record. | |||||||||||
Updates an existing record. | |||||||||||
Used to update one or more existing records in the system by providing a list of records. | |||||||||||
The upsertList operation is used to add or update one or more instances of a record type in NetSuite. | |||||||||||
The upsert operation is used to add a new instance or to update an instance of a record in NetSuite. | |||||||||||
To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:netsuite="http://www.mulesoft.org/schema/mule/netsuite"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/netsuite
http://www.mulesoft.org/schema/mule/netsuite/current/mule-netsuite.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.
Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.
| Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Type | Name | Default Value | Description | Java Type | MIME Type | Encoding | Optional. Give a name to this configuration so it can be later referenced. | ||||
| https://webservices.na1.netsuite.com/services/NetSuitePort_2013_2 | Optional. Service endpoint
|
||||||||||
This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.
Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.
The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:
<netsuite:connection-pooling-profile maxActive="10" maxIdle="10"
exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>
The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.
| Connection Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
| Optional. Specify which configuration to use. | |||||||||||
| The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Service endpoint | String | */* | UTF-8 | ||||||||
| SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:
With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.
A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.
<netsuite:config>
<reconnect count="5" frequency="1000"/>
</netsuite:config>
| Reconnect Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | |||||||||
| Optional. How often (in ms) to reconnect | |||||||||||
| Optional. How many reconnection attempts to make | |||||||||||
For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.
Creates a new file record.
This Processor is similar to addRecord, but is customized for simplifying local content passing.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The id of the folder record where to add this file | RecordRef | */* | |||||||||
| The content of the file record to add. It can be of type String, byte array, File or InputStream. If it is an input stream, this Processors also closes it. | Object | */* | |||||||||
| The name of the remote file | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| Optional. The additional file attributes | Map<String, Object> |
| Return Type | Description |
|---|---|
| RecordRef | the RecordRef of the new record |
| Payload Class | Description |
|---|---|
| IOException | if the content cannot be parsed to byte[] |
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
| InsufficientPermissionFault | This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |
Used to add one or more records into the system
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The type of record to add | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The records with their attributes, as a string-object map | List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | a list of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Creates a new record.
Example:INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The type of record to add | String | */* | UTF-8 | ||||||||
| Optional. Preferences of the request | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The record attributes, as a string-object map | Map<String, Object> |
| Return Type | Description |
|---|---|
| BaseRef | an instance of RecordRef or CustomRecordRef depending on the type of record that was added |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |
Creates new records
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| The Records object | List<? extends Record> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | List of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
An asynchronous requests equivalent to addRecord(String, Map.
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type. | RecordType | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of Map |
List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #deleteList(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of BaseRefType that references the objects to be deleted. |
List<BaseRefType> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #deleteList(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of RecordRef that references the objects to be deleted. |
List<RecordRef> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #getList(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of RecordRef that references the objects to be retrieved. |
List<BaseRefType> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #getList(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of RecordRef that references the objects to be retrieved. |
List<RecordRef> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #initializeRecord.
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of RecordRef that references the objects to be retrieved. |
List<InitializeRecord> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
Searches for all records that match the given filtering expression, asynchronously.
If no expression is specified, all records of the given type are retrieved
Filtering expressions support both basic and joined syntax, that is, using in the filters attributes of both the target entity and the target entity associations. Advanced search is not supported.
Search expressions are in the form operator(attribute, arguments...) for basic search, and operator(join.attribute, arguments...) for joined search, where operator is any of the string, long, double, and text operators supported by SuiteTalk - MultiSelect operators are not supported - plus the isTrue/isFalse boolean operators, and arguments are zero up to three operands that depend on the operator used.
Examples:
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The type of record to search | SearchRecordTypeEnum | */* | |||||||||
| Optional. The filtering expression, in the form operator(attribute, arguments...) for basic search, and operator(join.attribute, arguments...) for joined search, where operator is any of the string, long, double, and text operators supported by SuiteTalk - MultiSelect operators are not supported - plus the isTrue/isFalse boolean operators, and arguments are zero up to three operands that depend on the operator used. Multiple filters can be combined using multiple predicates separated by commas. | String | */* | UTF-8 | ||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| AsyncStatusResult | the AsyncStatusResult of the query |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
An asynchronous requests equivalent to #updateRecord(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type. | RecordType | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of Map |
List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
An asynchronous requests equivalent to #upsertRecord(Map
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 processed, 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type. | RecordType | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of Map |
List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| AsyncStatusResult | The result AsyncStatusResult with the jobId that can be used to check the status and result. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
Attaches a source or contact record - that is, the attachment - to another destination one
Not all record type are supported as source, destination or contact. Please consult NetSuite documentation.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
Optional. An instance of RecordRef |
RecordRef | */* | |||||||||
An instance of RecordRef |
RecordRef | */* | |||||||||
Optional. An instance of RecordRef |
RecordRef | */* | |||||||||
Optional. An instance of RecordRef |
RecordRef | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| WriteResponse | an instance of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use to change the email address for the account.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Value for the new email. | String | */* | UTF-8 | ||||||||
| true | Optional. Update email for just this account. | Boolean | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SessionResponse | The result of the operation. See Status. |
| Payload Class | Description |
|---|---|
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| InsufficientPermissionFault | InsufficientPermissionFault This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
Use to change the password for the account.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| New password value | String | */* | UTF-8 | ||||||||
| true | Optional. Apply change just to this account. | Boolean | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SessionResponse | The result of the operation. See Status. |
| Payload Class | Description |
|---|---|
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| InsufficientPermissionFault | InsufficientPermissionFault This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
Answers the status of an asynchronous Web services submission.
When a jobId is submitted, the status, percent complete, and estimated remaining duration are returned.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The id of the job whose status to check. | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| AsyncStatusResult | the AsyncStatusResult for the given job |
| Payload Class | Description |
|---|---|
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| AsyncFault | when error. |
Deletes a record. Not all records can be deleted. Please consult NetSuite documentation
Example:INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
An instance of BaseRefType. |
BaseRefType | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| WriteResponse | The result of the operation |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Used to delete one or more records in the system. The records to be deleted are identified through the provided unique identifiers.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| The records with their attributes, as a string-object map | List<BaseRefType> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | A list of Record references for the deleted records |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Deletes a record. Not all records can be deleted. Please consult NetSuite documentation
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
An instance of RecordRef |
RecordRef | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| WriteResponse | The result of the operation |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Used to delete one or more records in the system. The records to be deleted are identified through the provided unique identifiers.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| The records with their attributes, as a string-object map | List<RecordRef> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | A list of Record references for the deleted records |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Detaches a source record - that is, the attachment - from a destination record.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
An instance of RecordRef |
RecordRef | */* | |||||||||
An instance of RecordRef |
RecordRef | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| WriteResponse | DetachResponse object |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
This is used to retrieve a record by providing the unique id that identifies that record.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. An instance of BaseRefType. |
BaseRefType | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| Map<String, Object> | a Map that represents the Record you want to retrieve. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |
Answers the results of an asynchronous web services submission.
This Processor can be executed Processor up to 20 times within a 30 day time period to retrieve the results of an asynchronous job.
Example:
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The id of the job | String | */* | UTF-8 | ||||||||
| 1 | Optional. The page number the the async result | Integer | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| AsyncResult | An iterable with the Records found |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| AsyncFault | when error |
Answers the list of budget exchange rates
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| References an existing period. | RecordRef | */* | |||||||||
| Optional. References the receiving subsidiary. | RecordRef | */* | |||||||||
| Optional. References the originating subsidiary. | RecordRef | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetBudgetExchangeRateResult | An instance of GetBudgetExchangeRateResult |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Answers the list of consolidated exchange rates
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| References an existing period. | RecordRef | */* | |||||||||
| Optional. References the receiving subsidiary. | RecordRef | */* | |||||||||
| Optional. References the originating subsidiary. | RecordRef | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetConsolidatedExchangeRateResult | An instance of GetConsolidatedExchangeRateResult |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use this operation to get the exchange rate between two currencies based on a certain date.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Filter the returned currency exchange rates using this filter. | CurrencyRateFilter | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetCurrencyRateResult | The exchange rate. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
Answers the ids of available customizations for a given record type.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type. | GetCustomizationType | */* | |||||||||
| false | Optional. If inactive customizations should also be returned. | boolean | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetCustomizationIdResult | a list of CustomizationRef's |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use for dynamic discovery of data-center-specific URLs for partner applications’ access to NetSuite.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Netsuite account Id | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetDataCenterUrlsResult | Request The result containing the status and Data Center Urls. |
| Payload Class | Description |
|---|---|
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
Answers a list of deleted records of a given record type that match a given date expression.
This Processors accepts two different date expression passing styles: string oriented, and object oriented. If whenExpression is specified, it is parsed and used as date expression. Otherwise, a date expression is build from date1, date2 and operator parameters.
The first style is more appropriate when the date expression can be harcdoded, while the second style is better when client code already has date objects. However, predefined search values like thisWeek, tomorrow or today can only be used with the first, string oriented, style.
String oriented date expressions are in the form Processor( searchValue, arguments...), where Processor is any of the NetSuite supported date Processors, arguments are one or two operands for the given operator, and searchValue is some of the supported predefined search value as defined by NetSuite or any of the following expressions:
Supported predefined search values are:
Examples using both string and object oriented styles:
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The type of the target deleted record to retrieve | RecordTypeEnum | */* | |||||||||
| Optional. A predicate-style date filtering expression | String | */* | UTF-8 | ||||||||
| Optional. The first date to use | Date | */* | |||||||||
| Optional. The second date to use | Date | */* | |||||||||
| Optional. The date operator | SearchDateFieldOperatorEnum | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetDeletedResult | the list of DeletedRecord's that match the given date filtering expression |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Answers the availability for a given record reference.
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.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
An instance of RecordRef |
RecordRef | */* | |||||||||
| Optional. An optional modified since date. If set, only items with quantity available changes recorded as of the specified date are returned. | Date | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetItemAvailabilityResult | An instance of GetItemAvailabilityResult |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
This operation is used to retrieve a list of objects referenced in the list of BaseRef object.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
List of BaseRef child classes. Check BaseRef for a list of child classes. |
List<? extends BaseRef> |
| Return Type | Description |
|---|---|
| List<ReadResponse> | the list of Record's |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use to retrieve a summary of the actual data in an account.
The getPostingTransactionSummary operation allows you to retrieve a summary of the actual data that posted to the general ledger in an account. You can use available filters/fields to generate reports that are similar to what you see when you run financial reports such as a Trial Balance, Balance Sheet, or an Income Statement.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Specify how you want your data grouped. | PostingTransactionSummaryField | */* | |||||||||
| Specify your filtering criteria. | PostingTransactionSummaryFilter | */* | |||||||||
| 1 | Optional. Specify the page to be returned. | Integer | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetPostingTransactionSummaryResult | An instance of GetPostingTransactionSummaryResult containing the list of RecirdRef to the fields specified |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
This is used to retrieve a record by providing the unique id that identifies that record.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. An instance of RecordRef |
RecordRef | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| Map<String, Object> | a Map representing the Record. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |
This operation is used to retrieve a list of all records of the specified type. Records that support the getAll operation are listed in the GetAllRecordType
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type | GetAllRecordType | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetAllResult | the list of Record's |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Retrieves a list of existing saved searches for the given record type.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type | RecordType | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetSavedSearchResult | the list of RecordRedf's |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use to retrieve 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 permission to the instances of the record type.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| For select values that span multiple pages, use this argument to specify which page to return in your response. | int | */* | |||||||||
| #[payload] | Optional. 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. | GetSelectValueFieldDescription | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| GetSelectValueResult | The GetSelectValueResult related to the request. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
Answers the server time, resulting in more accurate and reliable sync'ing of data than using using local client time.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| Date | the server time, as a Date |
| Payload Class | Description |
|---|---|
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Populates fields on transaction line items with values from a related record, in a similar way empty text boxes are prepopulated within the Netsuite UI
Example:
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. An instance of InitializeRecord |
InitializeRecord | */* | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| ReadResponse | the initialized Record |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| IllegalAccessException | Unexpected error. |
| IllegalArgumentException | Invalid argument. |
Use to emulate the UI workflow by pre-populating fields on transaction line items with values from a related record. The initializeList operation can be used to run batch processes to retrieve initialized records.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The list of InitializeRecord to initialize. |
List<InitializeRecord> |
| Return Type | Description |
|---|---|
| List<ReadResponse> | A list containing the results of each initialize request. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
Use to automate the mapping between external applications credentials and NetSuite’s credentials for a user.
This operation provides mapping, not a login to NetSuite. This operation does NOT provide the ability to log in using a single sign-on token, cannot provisian 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Account | String | */* | UTF-8 | ||||||||
| This is the integration partner’s affiliate ID as provided to the partner by NetSuite. | String | */* | UTF-8 | ||||||||
| This is a string representing the encrypted token. | String | */* | UTF-8 | ||||||||
| String | */* | UTF-8 | |||||||||
| Password | String | */* | UTF-8 | ||||||||
| Role | RecordRef | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SessionResponse | Response which includes the status and wsRoleList elements. The wsRoleList element returns a list of roles available for the user specified in the passport. |
| Payload Class | Description |
|---|---|
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| InsufficientPermissionFault | InsufficientPermissionFault This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
Return a list of records, or columns matching the query provided. You can also use the #queryRecords( String,boolean,Integer) queryRecords if you want direct access to the records as Maps.
Take into account that netsuite Record models doesn't match the models they use for search, so user will probably want to write some of the query by hand.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The query | String | */* | UTF-8 | ||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult that matches the criteria. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Return a list of records. This should only be used when you want to retrieve all the columns.
Take into account that netsuite Record models doesn't match the models they use for search, so user will probably want to write some of the query by hand.
This operation can potentially return a large amount of records that might exceed memory capacity.
To prevent this from being a problem, the output of this operation is automatically paginated into an iterable collection of objects. Regardless of the page-size, the iterator will be pushing out registries one at a time and fetching next pages on demand. If you wish to take advantage of the pagination, you must process the output through elements that can handle collections, such as a ForEach scope or DataMapper. In this way, Mule will execute the entire set of registries one at a time, but processing only a batch at a time and thus keeping memory usage from going over limits.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The query | String | */* | UTF-8 | ||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| 100 | Specify the number of objects that will be returned in each iteration | int | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| Iterator < Map<String, Object> > | A collection: each index contains a list of objects, each object with its own set of properties. It is possible to process it in parts thanks to its pagination. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
The search operation is used to execute a search on a specific record type based on a set of criteria.
You can search by defining search filter fields on the record, joined fields on an associated record, search return columns, or joined search return columns from an associated record. The results of the search can be complete records, or a select set of fields specified through search return columns.
INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
The search type. See SearchRecordTypeEnum. |
SearchRecordTypeEnum | */* | |||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A map that contains objects or maps describing the nested objects that define the SearchRecord object. |
Map<String, Object> |
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult that matches the criteria. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
The seachMore operation is used to retrieve more records after an initial search operation.
The results returned in a searchMore operation reflect the records in the next segment as defined in the original search operation.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| An index that specifies which page in the search to return. | int | */* | |||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult with the results of the initial query in the specified page. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
The searchMoreWithId operation allows users to reference a specific search result set by its searchId, a parameter included in all search results.
As with searchMore, users must set the pageIndex value to specify which page in the search to return.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The search result Id. | String | */* | UTF-8 | ||||||||
| An index that specifies which page in the search to return. | int | */* | |||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult with the results of the initial query in the specified page. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
The searchNext operation is used to retrieve the next set of records after an initial search operation.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult corresponding to the next page of results. |
| Payload Class | Description |
|---|---|
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
The search operation is used to execute a search on a specific record type based on a set of criteria.
You can search by defining search filter fields on the record, joined fields on an associated record, search return columns, or joined search return columns from an associated record. The results of the search can be complete records, or a select set of fields specified through search return columns.
This method should be used with Search record types that are not BASIC, nor ADVANCED record Types This is a basic search:INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
The search type. See SearchRecordTypeEnum. |
SearchRecordTypeEnum | */* | |||||||||
| The filtering expression Multiple filters can be combined using multiple predicates separated by commas. | String | */* | UTF-8 | ||||||||
| true | Optional. 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 sublists are not returned. If the bodyFieldsOnly field is set to FALSE, all fields associated with the record are returned. | boolean | */* | ||||||||
| true | Optional. Defaults to TRUE, meaning that only search columns will be returned in your search. | boolean | */* | ||||||||
| Optional. Maximum amount of results per page | Integer | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SearchResult | A list of SearchResult that matches the criteria. |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Use to establish a single sign-on connection.
This operation allows for a partner application to login on behalf of the user in to NetSuite, without the user’s credentials ever going through partner servers.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Partner Account | String | */* | UTF-8 | ||||||||
| Partner Id | String | */* | UTF-8 | ||||||||
| Token to use for authentication. | String | */* | UTF-8 | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| SessionResponse | Response which includes the status and wsRoleList elements. The wsRoleList element returns a list of roles available for the user specified in the passport. |
| Payload Class | Description |
|---|---|
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| InsufficientPermissionFault | InsufficientPermissionFault This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
Updates existing record's custom fields.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type to update | RecordType | */* | |||||||||
| The type of custom field | CustomFieldRefTypeEnum | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| The custom fields as a map, where the key is the internalId | Map<String, Object> |
| Payload Class | Description |
|---|---|
| InvalidVersionFault | This fault is thrown in the event that the request message contains an unsupported version of the schema. |
| InsufficientPermissionFault | This fault is thrown when the client does not have the appropriate permissions to perform an action based on the role under which they are currently logged in. If the client (user) has more than one role, they may need to login again supplying a different role with more permissions. |
| InvalidAccountFault | This fault is thrown when the client attempts to login with an invalid account id. |
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Sets a new invitation status for a given event.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. The target event id | RecordRef | */* | ||||||||
| The new status to set | CalendarEventAttendeeResponseEnum | */* | |||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Return Type | Description |
|---|---|
| WriteResponse | An instance of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Sets a new invitation status for a given event.
Example:INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. A list of the UpdateInviteeStatusReference items. |
List<UpdateInviteeStatusReference> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | An instance of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Used to update one or more existing records in the system 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The type of record to add | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The records with their attributes, as a string-object map | List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | a list of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
Updates an existing record.
Example:INCLUDE_ERROR
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type to update | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The record attributes, as a string-object map, including internalId or externalId attribute. | Map<String, Object> |
| Return Type | Description |
|---|---|
| BaseRef | an instance of RecordRef or CustomRecordRef depending on the type of record that was added |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |
Used to update one or more existing records in the system by providing a list of records. 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| The records with their attributes. | List<? extends Record> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | a list of WriteResponse |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
The upsertList operation is used to add or update 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type to update | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The record attributes, as a string-object map | List<Map<String, Object>> |
| Return Type | Description |
|---|---|
| List<WriteResponse> | A list with the references to the upserted records |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
The upsert operation is used to add a new instance or to update an instance of a record in NetSuite.
It is similar to the upsertList operation, which allows users to add or update more than one record at a time. 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.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| The target record type to update | String | */* | UTF-8 | ||||||||
| The target record id | String | */* | UTF-8 | ||||||||
| Optional. Preferences for the request. | Preferences | */* | |||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. The login email of both NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. The login password of both the NetSuite UI and SuiteTalk | String | */* | UTF-8 | ||||||||
| Optional. Service endpoint | String | */* | UTF-8 | ||||||||
| Optional. SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX | String | */* | UTF-8 | ||||||||
| Optional. The id of the role used to login in SuiteTalk, which determines the Processor privileges | String | */* | UTF-8 | ||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will attempt to establish a connection before it times out. The default is 30000 (30 seconds). 0 specifies that the client will continue to attempt to open a connection indefinitely. | Long | */* | |||||||||
| Optional. Specifies the amount of time, in milliseconds, that the client will wait for a response before it times out. The default is 60000. 0 specifies that the client will wait indefinitely. | Long | */* | |||||||||
| Name | Default Value | Description | Java Type |
|---|---|---|---|
| #[payload] | Optional. The record attributes, as a string-object map | Map<String, Object> |
| Return Type | Description |
|---|---|
| BaseRef | an instance of RecordRef or CustomRecordRef depending on the type of record that was added |
| Payload Class | Description |
|---|---|
| ExceededRecordCountFault | This fault is thrown in the event the maximum number of records allowed for an operation has been exceeded. |
| InvalidCredentialsFault | This fault is thrown in the event of an invalid username (e-mail), password and/or role supplied in a login attempt. |
| UnexpectedErrorFault | This fault is thrown in the event of an occurrence of an unexpected exception. |
| ExceededRequestSizeFault | This fault is thrown if a request exceeds 10M. |
| ExceededRequestLimitFault | This fault is thrown if the allowed number of concurrent requests is exceeded. |
| ExceededUsageLimitFault | No description at documentation for this exception. |
| InvalidSessionFault | This fault is thrown when the client’s session has timed out or was terminated as the result of a second Web services client establishing another session. The fault message occurs on the first request attempted after the session is terminated/timed out. |
| NetSuiteGenericException | This fault is thrown when the request failed and it contains all the information related to the error. |