| java.lang.Object | |
| ↳ | org.mule.module.netsuite.NetSuiteCloudConnector |
Known Direct Subclasses
|
Known Indirect Subclasses
|
The NetSuite cloud connector facade, based on a NetSuiteClient
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | SUITETALK_LIVE_ADDRESS | ||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| client | The Netsuite client to use. | ||||||||||
| connectionId | The login email of both NetSuite UI and SuiteTalk | ||||||||||
| customKey | |||||||||||
| defaultEndpoint | Service endpoint
|
||||||||||
| logger | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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. | |||||||||||
Connection Management connect method
| |||||||||||
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. | |||||||||||
Connection Management disconnect method
| |||||||||||
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. | |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
The login email of both NetSuite UI and SuiteTalk
Service endpoint
Creates a new file record.
This Processor is similar to addRecord, but is customized for simplifying local content passing.
| folderId | The id of the folder record where to add this file |
|---|---|
| attributes | The additional file attributes |
| content | The content of the file record to add. It can be of type String, byte array, File or InputStream. If it is an input stream, this Processors also closes it. |
| fileName | The name of the remote file |
| preferences | Preferences for the request. |
| 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
| recordType | The type of record to add |
|---|---|
| records | The records with their attributes, as a string-object map |
| preferences | Preferences for the request. |
WriteResponse| 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:| recordType | The type of record to add |
|---|---|
| attributes | The record attributes, as a string-object map |
| preferences | Preferences of the request |
RecordRef or CustomRecordRef depending on the type of record that was added| 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:| records | The Records object |
|---|
WriteResponse| 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.
| recordType | The target record type. |
|---|---|
| recordsAttributes | A list of Map |
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| records | A list of BaseRefType that references the objects to be deleted. |
|---|---|
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| records | A list of RecordRef that references the objects to be deleted. |
|---|---|
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| records | A list of RecordRef that references the objects to be retrieved. |
|---|---|
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| records | A list of RecordRef that references the objects to be retrieved. |
|---|---|
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| initializeRecord | A list of RecordRef that references the objects to be retrieved. |
|---|---|
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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:
| recordType | The type of record to search |
|---|---|
| expression | 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. |
| bodyFieldsOnly | 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. |
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
| 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.
| recordType | The target record type. |
|---|---|
| recordsAttributes | A list of Map |
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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.
| recordType | The target record type. |
|---|---|
| recordsAttributes | A list of Map |
| preferences | Preferences for the request. |
AsyncStatusResult with the jobId that can be used to check the status and result.| 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:| source | An instance of RecordRef |
|---|---|
| destination | An instance of RecordRef |
| contact | An instance of RecordRef |
| role | An instance of RecordRef |
| preferences | Preferences for the request. |
WriteResponse| 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.
| newEmail | Value for the new email. |
|---|---|
| justThisAccount | Update email for just this account. |
Status.| 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.
| newPassword | New password value |
|---|---|
| justThisAccount | Apply change just to this account. |
Status.| 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:| jobId | The id of the job whose status to check. |
|---|---|
| preferences | Preferences for the request. |
| 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. |
Connection Management connect method
| The login email of both NetSuite UI and SuiteTalk | |
| password | The login password of both the NetSuite UI and SuiteTalk |
| endpoint | Service endpoint |
| account | SuiteTalk -NetSuite WebService - account id. It looks like TSTDRVXXXXXX |
| roleId | The id of the role used to login in SuiteTalk, which determines the Processor privileges |
| connectionTimeout | 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. |
| receiveTimeout | 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. |
| ConnectionException |
|---|
Deletes a record. Not all records can be deleted. Please consult NetSuite documentation
Example:| baseRef | An instance of BaseRefType. |
|---|---|
| preferences | Preferences for the request. |
| 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.
| records | The records with their attributes, as a string-object map |
|---|---|
| preferences | Preferences for the request. |
| 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:| recordRef | An instance of RecordRef |
|---|---|
| preferences | Preferences for the request. |
| 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.
| records | The records with their attributes, as a string-object map |
|---|---|
| preferences | Preferences for the request. |
| 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:| source | An instance of RecordRef |
|---|---|
| destination | An instance of RecordRef |
| preferences | Preferences for the request. |
| 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. |
Connection Management disconnect method
| ConnectionException | exception |
|---|---|
| Exception |
This is used to retrieve a record by providing the unique id that identifies that record.
Example:| baseRef | An instance of BaseRefType. |
|---|---|
| preferences | Preferences for the request. |
| 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:
| jobId | The id of the job |
|---|---|
| pageIndex | The page number the the async result |
| preferences | Preferences for the request. |
| 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:| period | References an existing period. |
|---|---|
| fromSubsidiary | References the receiving subsidiary. |
| toSubsidiary | References the originating subsidiary. |
| preferences | Preferences for the request. |
GetBudgetExchangeRateResult| 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:| period | References an existing period. |
|---|---|
| fromSubsidiary | References the receiving subsidiary. |
| toSubsidiary | References the originating subsidiary. |
| preferences | Preferences for the request. |
GetConsolidatedExchangeRateResult| 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.
| rateFilter | Filter the returned currency exchange rates using this filter. |
|---|---|
| preferences | Preferences for the request. |
| 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:| type | The target record type. |
|---|---|
| includeInactives | If inactive customizations should also be returned. |
| preferences | Preferences for the request. |
| 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.
| accountId | Netsuite account Id |
|---|
| 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:
| type | The type of the target deleted record to retrieve |
|---|---|
| whenExpression | A predicate-style date filtering expression |
| date1 | The first date to use |
| date2 | The second date to use |
| operator | The date operator |
| preferences | Preferences for the request. |
| 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:| record | An instance of RecordRef |
|---|---|
| ifModifiedSince | An optional modified since date. If set, only items with quantity available changes recorded as of the specified date are returned. |
| preferences | Preferences for the request. |
GetItemAvailabilityResult| 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:| references | List of BaseRef child classes. Check BaseRef for a list of child classes. |
|---|---|
| preferences | Preferences for the request. |
| 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. |
| key |
|---|
| Exception |
|---|
| Exception |
|---|
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.
| fields | Specify how you want your data grouped. |
|---|---|
| filters | Specify your filtering criteria. |
| pageIndex | Specify the page to be returned. |
| preferences | Preferences for the request. |
GetPostingTransactionSummaryResult containing the list of RecirdRef to the fields specified | 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:| recordRef | An instance of RecordRef |
|---|---|
| preferences | Preferences for the request. |
| 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
| type | The target record type |
|---|---|
| preferences | Preferences for the request. |
| 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:| type | The target record type |
|---|
| 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.
| page | For select values that span multiple pages, use this argument to specify which page to return in your response. |
|---|---|
| fieldDescriptor | 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. |
| preferences | Preferences for the request. |
GetSelectValueResult related to the request.| 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:| 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:
| record | An instance of InitializeRecord |
|---|---|
| preferences | Preferences for the request. |
| 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.
| initializeRecord | The list of InitializeRecord to initialize. |
|---|---|
| preferences | Preferences for the request. |
| 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.
| userAccount | Account |
|---|---|
| userPartnerId | This is the integration partner’s affiliate ID as provided to the partner by NetSuite. |
| authenticationToken | This is a string representing the encrypted token. |
| userEmail | |
| userPassword | Password |
| userRole | Role |
| 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.
| query | The query |
|---|---|
| bodyFieldsOnly | 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. |
| pageSize | Maximum amount of results per page |
SearchResult that matches the criteria.| 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.
| query | The query |
|---|---|
| bodyFieldsOnly | 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. |
| pagingConfiguration | Page size |
| 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.
To get the values of a saved search you need to specify an ADVANCED record type:| searchRecord | The search type. See SearchRecordTypeEnum. |
|---|---|
| criteria | A map that contains objects or maps describing the nested objects that define the SearchRecord object. |
| bodyFieldsOnly | 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. |
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
SearchResult that matches the criteria.| 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.
| pageIndex | An index that specifies which page in the search to return. |
|---|---|
| bodyFieldsOnly | 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. |
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
SearchResult with the results of the initial query in the specified page.| 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.
| searchId | The search result Id. |
|---|---|
| pageIndex | An index that specifies which page in the search to return. |
| bodyFieldsOnly | 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. |
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
SearchResult with the results of the initial query in the specified page.| 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.
| bodyFieldsOnly | 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. |
|---|---|
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
SearchResult corresponding to the next page of results.| 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: To make a search with multienum: Joined searchs: You can create multiple conditions using comas to separate the expressions: You can also use some functions as shown bellow:| searchRecord | The search type. See SearchRecordTypeEnum. |
|---|---|
| expression | The filtering expression Multiple filters can be combined using multiple predicates separated by commas. |
| bodyFieldsOnly | 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. |
| returnSearchColumns | Defaults to TRUE, meaning that only search columns will be returned in your search. |
| pageSize | Maximum amount of results per page |
SearchResult that matches the criteria.| 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. |
| defaultEndpoint |
|---|
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.
| partnerAccount | Partner Account |
|---|---|
| partnerId | Partner Id |
| authenticationToken | Token to use for authentication. |
| 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:| recordType | The target record type to update |
|---|---|
| customFieldType | The type of custom field |
| customFields | The custom fields as a map, where the key is the internalId |
| preferences | Preferences for the request. |
| 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:| eventId | The target event id |
|---|---|
| status | The new status to set |
| preferences | Preferences for the request. |
WriteResponse| 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:| inviteeStatusList | A list of the UpdateInviteeStatusReference items. |
|---|---|
| preferences | Preferences for the request. |
WriteResponse| 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.
| recordType | The type of record to add |
|---|---|
| records | The records with their attributes, as a string-object map |
| preferences | Preferences for the request. |
WriteResponse| 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:| recordType | The target record type to update |
|---|---|
| attributes | The record attributes, as a string-object map, including internalId or externalId attribute. |
| preferences | Preferences for the request. |
RecordRef or CustomRecordRef depending on the type of record that was added| 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.
| records | The records with their attributes. |
|---|---|
| preferences | Preferences for the request. |
WriteResponse| 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.
| recordType | The target record type to update |
|---|---|
| records | The record attributes, as a string-object map |
| preferences | Preferences for the request. |
| 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.
| recordType | The target record type to update |
|---|---|
| externalId | The target record id |
| attributes | The record attributes, as a string-object map |
| preferences | Preferences for the request. |
RecordRef or CustomRecordRef depending on the type of record that was added| 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. |
| recordType | |
|---|---|
| dynamicObject | |
| fieldModel | |
| customFields |