NetSuiteConnector (Mule NetSuite Connector 7.4.3 API)

java.lang.Object
- org.mule.module.netsuite.NetSuiteConnector

```
@MetaDataScope(value=DefaultMetaData.class)
 @Connector(name="netsuite",
           friendlyName="NetSuite",
           schemaVersion="3.0",
           minMuleVersion="3.5")
 @ReconnectOn(exceptions=InvalidSessionFault.class)
 @RequiresEnterpriseLicense(allowEval=true)
public class NetSuiteConnector
extends Object
```
NetSuite Connector synchronizes data and automates business processes between NetSuite and third party applications, either on-premise or in the cloud. The Connector makes use of the SuiteTalk WSDL to provide SOAP based integration in order to generate NetSuite business objects, make use of different authentication levels, and support error handling.

Author:

MuleSoft

Constructor Summary

Constructors
Constructor and Description

NetSuiteConnector()

Constructors
Constructor and Description
`NetSuiteConnector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordRef`	`addFile(RecordRef folderId, Map<String,Object> attributes, Object content, String fileName, Preferences preferences)` Creates a new file record.
`List<WriteResponse>`	`addList(String recordType, List<Map<String,Object>> records, Preferences preferences)` Adds one or more records into the system.
`BaseRef`	`addRecord(String recordType, Map<String,Object> attributes, Preferences preferences)` Creates a new record.
`List<WriteResponse>`	`addRecordObjects(List<? extends Record> records)` Creates new records.
`AsyncStatusResult`	`asyncAddList(String recordType, List<Map<String,Object>> recordsAttributes, Preferences preferences)` An asynchronous request equivalent to `addList(java.lang.String, java.util.List<java.util.Map<java.lang.String, java.lang.Object>>, com.netsuite.webservices.platform.messages.Preferences)`.
`AsyncStatusResult`	`asyncDeleteList(List<BaseRefType> records, Preferences preferences)` An asynchronous request equivalent to `deleteList(List, Preferences)`.
`AsyncStatusResult`	`asyncDeleteListRecords(List<RecordRef> records, Preferences preferences)` An asynchronous request equivalent to `deleteRecordsList(List, Preferences)`.
`AsyncStatusResult`	`asyncGetList(List<BaseRefType> records, Preferences preferences)` An asynchronous request equivalent to `getList(List, Preferences)`.
`AsyncStatusResult`	`asyncGetListRecords(List<RecordRef> records, Preferences preferences)` An asynchronous request equivalent to `getList(List, Preferences)`.
`AsyncStatusResult`	`asyncInitializeList(List<InitializeRecord> initializeRecord, Preferences preferences)` An asynchronous request equivalent to `initializeList(List, Preferences)`.
`AsyncStatusResult`	`asyncSearch(String searchRecord, SearchRecord criteria, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)` An asynchronous request equivalent to `search(String, SearchRecord, boolean, boolean, PagingConfiguration)`.
`AsyncStatusResult`	`asyncUpdateList(String recordType, List<Map<String,Object>> recordsAttributes, Preferences preferences)` An asynchronous request equivalent to `updateList(String, List, Preferences)`.
`AsyncStatusResult`	`asyncUpsertList(String recordType, List<Map<String,Object>> recordsAttributes, Preferences preferences)` An asynchronous request equivalent to `upsertList(String, List, Preferences)`.
`WriteResponse`	`attachRecord(RecordRef source, RecordRef destination, RecordRef contact, RecordRef role, Preferences preferences)` Attaches a source or contact record - that is, the attachment - to another destination one.
`void`	`callRestletDelete(int script, int deploy, Map<String,Object> data)` Calls a NetSuite RESTlet using the DELETE method.
`List<Map<String,Object>>`	`callRestletGet(int script, int deploy, Map<String,Object> data)` Calls a NetSuite RESTlet using the GET method.
`List<Map<String,Object>>`	`callRestletPost(int script, int deploy, Map<String,Object> data)` Calls a NetSuite RESTlet using the POST method.
`List<Map<String,Object>>`	`callRestletPut(int script, int deploy, Map<String,Object> data)` Calls a NetSuite RESTlet using the PUT method.
`SessionResponse`	`changeEmail(String newEmail, Boolean justThisAccount)` Changes the email address of the account.
`SessionResponse`	`changePassword(String newPassword, Boolean justThisAccount)` Changes the password of the account.
`AsyncStatusResult`	`checkAsyncStatus(String jobId, Preferences preferences)` Checks whether a particular asynchronous job has finished processing or not.
`WriteResponse`	`delete(BaseRefType baseRef, Preferences preferences)` Deletes a record.
`List<WriteResponse>`	`deleteList(List<BaseRefType> records, Preferences preferences)` Deletes one or more records in the system.
`WriteResponse`	`deleteRecord(RecordRef recordRef, Preferences preferences)` Deletes a record.
`List<WriteResponse>`	`deleteRecordsList(List<RecordRef> records, Preferences preferences)` Deletes one or more records in the system.
`WriteResponse`	`detachRecord(RecordRef source, RecordRef destination, Preferences preferences)` Detaches a source record - that is, the attachment - from a destination record.
`Map<String,Object>`	`get(BaseRefType baseRef, Preferences preferences)` Retrieves a record by providing the unique id that identifies that record.
`AsyncResult`	`getAsyncResult(String jobId, Integer pageIndex, Preferences preferences)` This operation returns the result of a job given that it has finished processing.
`GetBudgetExchangeRateResult`	`getBudgetExchangeRates(RecordRef period, RecordRef fromSubsidiary, RecordRef toSubsidiary, Preferences preferences)` Retrieves a list of budget exchange rates for a give period.
`AbstractConfig`	`getConfig()`
`GetConsolidatedExchangeRateResult`	`getConsolidatedExchangeRates(RecordRef period, RecordRef fromSubsidiary, RecordRef toSubsidiary, Preferences preferences)` Retrieves a list of consolidated exchange rates for a given period.
`GetCurrencyRateResult`	`getCurrentRate(CurrencyRateFilter rateFilter, Preferences preferences)` Retrieves the exchange rate between two currencies.
`GetCustomizationIdResult`	`getCustomizationIds(GetCustomizationType type, boolean includeInactives, Preferences preferences)` Retrieves the IDs of available customizations for a given customization type.
`Map<String,Object>`	`getCustomRecord(String type, String internalId, String externalId, Preferences preferences)` Retrieves a custom record by providing the unique id that identifies that record.
`GetDataCenterUrlsResult`	`getDataCenterUrls(String accountId)` Retrieves the accessible data-center URLs for the accountId specified.
`GetDeletedResult`	`getDeletedRecords(RecordTypeEnum type, Integer pageIndex, SearchDateField deletedDate, Preferences preferences)` Retrieves a list of deleted records for the given record type and date period.
`GetItemAvailabilityResult`	`getItemAvailability(RecordRef record, Date ifModifiedSince, Preferences preferences)` Retrieves the availability for a given item record reference.
`List<ReadResponse>`	`getList(List<? extends BaseRef> references, Preferences preferences)` Retrieves a list of objects referenced in the list of BaseRef object.
`GetPostingTransactionSummaryResult`	`getPostingTransactionSummary(PostingTransactionSummaryField fields, PostingTransactionSummaryFilter filters, Integer pageIndex, Preferences preferences)` Retrieves a summary of the actual data in an Account.
`Map<String,Object>`	`getRecord(String type, String internalId, String externalId, Preferences preferences)` Retrieves a record by providing the unique id that identifies that record.
`GetAllResult`	`getRecords(GetAllRecordType type, Preferences preferences)` Retrieves a list of all records of the specified type.
`GetSavedSearchResult`	`getSavedSearch(SearchRecordType type)` Retrieves a list of existing saved searches for the given record type.
`GetSelectValueResult`	`getSelectValue(int page, GetSelectValueFieldDescription fieldDescriptor, Preferences preferences)` Retrieves valid values for a given recordRef field where the referenced record type is not yet exposed in the Web services API or when the logged in role does not have access to the instances of the record type.
`Date`	`getServerTime()` Returns the server time.
`void`	`init()`
`ReadResponse`	`initialize(InitializeRecord record, Preferences preferences)` Populates fields on transaction line items with values from a related record, in a similar way empty text boxes are pre-populated within the NetSuite UI.
`List<ReadResponse>`	`initializeList(List<InitializeRecord> initializeRecord, Preferences preferences)` Emulates the UI workflow by pre-populating fields on transaction line items with values from a related record.
`SessionResponse`	`mapSso(String userAccount, String userPartnerId, String authenticationToken, String userEmail, String userPassword, RecordRef userRole)` Automates the mapping between external applications credentials and NetSuite’s credentials for a user.
`protected void`	`registerTransformers()`
`org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,NetSuiteConnector>`	`search(String searchRecord, SearchRecord criteria, boolean bodyFieldsOnly, boolean returnSearchColumns, org.mule.streaming.PagingConfiguration pagingConfiguration)` Executes a search on a specific record type based on a set of criteria.
`void`	`setConfig(AbstractConfig config)`
`void`	`setRegistry(org.mule.api.registry.MuleRegistry registry)`
`WriteResponse`	`updateInviteeStatus(RecordRef eventId, CalendarEventAttendeeResponseEnum status, Preferences preferences)` Sets a new invitation status for a given event.
`List<WriteResponse>`	`updateInviteeStatusList(List<UpdateInviteeStatusReference> inviteeStatusList, Preferences preferences)` Sets multiple new invitation status for a given event.
`List<WriteResponse>`	`updateList(String recordType, List<Map<String,Object>> records, Preferences preferences)` Updates one or more existing records in the system by providing new values for the fields to be updated for each record.
`BaseRef`	`updateRecord(String recordType, Map<String,Object> attributes, Preferences preferences)` Updates an existing record.The attributes can either be the POJOs corresponding to the field or a map that represents it.
`List<WriteResponse>`	`updateRecordsList(List<? extends Record> records, Preferences preferences)` Updates one or more existing records in the system by providing a list of records.
`List<WriteResponse>`	`upsertList(String recordType, List<Map<String,Object>> records, Preferences preferences)` Adds or updates one or more instances of a record type in NetSuite.
`BaseRef`	`upsertRecord(String recordType, Map<String,Object> attributes, Preferences preferences)` Adds a new instance or to update an instance of a record in NetSuite.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- NetSuiteConnector
```
public NetSuiteConnector()
```

Method Detail

attachRecord

@Processor
public WriteResponse attachRecord(@RefOnly @Default(value="#[payload]")
                                             RecordRef source,
                                             @RefOnly
                                             RecordRef destination,
                                             @RefOnly @Optional
                                             RecordRef contact,
                                             @RefOnly @Optional
                                             RecordRef role,
                                             @Placement(group="Request Preferences") @RefOnly @Optional
                                             Preferences preferences)
                                      throws NetSuiteException

Attaches a source or contact record - that is, the attachment - to another destination one. Not all record types are supported as source, destination or contact. Please consult NetSuite documentation.

Parameters:: 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.
Returns:: An instance of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

deleteRecord

@Processor
public WriteResponse deleteRecord(@RefOnly @Default(value="#[payload]")
                                             RecordRef recordRef,
                                             @Placement(group="Request Preferences") @RefOnly @Optional
                                             Preferences preferences)
                                      throws NetSuiteException

Deletes a record. Not all records can be deleted. Please consult NetSuite documentation.

Parameters:: recordRef - An instance of RecordRef.; preferences - Preferences for the request.
Returns:: The result of the operation.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

delete

@Processor
public WriteResponse delete(@RefOnly @Default(value="#[payload]")
                                       BaseRefType baseRef,
                                       @Placement(group="Request Preferences") @RefOnly @Optional
                                       Preferences preferences)
                                throws NetSuiteException

Deletes a record. Not all records can be deleted. Please consult NetSuite documentation.

Parameters:: baseRef - An instance of BaseRefType.; preferences - Preferences for the request.
Returns:: An instance of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

detachRecord

@Processor
public WriteResponse detachRecord(@RefOnly @Default(value="#[payload]")
                                             RecordRef source,
                                             @RefOnly
                                             RecordRef destination,
                                             @Placement(group="Request Preferences") @RefOnly @Optional
                                             Preferences preferences)
                                      throws NetSuiteException

Detaches a source record - that is, the attachment - from a destination record.

Parameters:: source - An instance of RecordRef.; destination - An instance of RecordRef.; preferences - Preferences for the request.
Returns:: A DetachResponse object.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getBudgetExchangeRates

@Processor
public GetBudgetExchangeRateResult getBudgetExchangeRates(@RefOnly @Default(value="#[payload]")
                                                                     RecordRef period,
                                                                     @RefOnly @Optional
                                                                     RecordRef fromSubsidiary,
                                                                     @RefOnly @Optional
                                                                     RecordRef toSubsidiary,
                                                                     @Placement(group="Request Preferences") @RefOnly @Optional
                                                                     Preferences preferences)
                                                              throws NetSuiteException

Retrieves a list of budget exchange rates for a give period.

Parameters:: period - References an existing period.; fromSubsidiary - References the receiving subsidiary.; toSubsidiary - References the originating subsidiary.; preferences - Preferences for the request.
Returns:: An instance of GetBudgetExchangeRateResult.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getConsolidatedExchangeRates

@Processor
public GetConsolidatedExchangeRateResult getConsolidatedExchangeRates(@RefOnly @Default(value="#[payload]")
                                                                                 RecordRef period,
                                                                                 @RefOnly @Optional
                                                                                 RecordRef fromSubsidiary,
                                                                                 @RefOnly @Optional
                                                                                 RecordRef toSubsidiary,
                                                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                                                 Preferences preferences)
                                                                          throws NetSuiteException

Retrieves a list of consolidated exchange rates for a given period.

Parameters:: period - References an existing period.; fromSubsidiary - References the receiving subsidiary.; toSubsidiary - References the originating subsidiary.; preferences - Preferences for the request.
Returns:: An instance of GetConsolidatedExchangeRateResult.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getCustomizationIds

@Processor
public GetCustomizationIdResult getCustomizationIds(GetCustomizationType type,
                                                               @Default(value="false")
                                                               boolean includeInactives,
                                                               @Placement(group="Request Preferences") @RefOnly @Optional
                                                               Preferences preferences)
                                                        throws NetSuiteException

Retrieves the IDs of available customizations for a given customization type.

Parameters:: type - The target record type.; includeInactives - If inactive customizations should also be returned.; preferences - Preferences for the request.
Returns:: A list of CustomizationRef.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getDeletedRecords

@Processor
public GetDeletedResult getDeletedRecords(RecordTypeEnum type,
                                                     @Default(value="1")
                                                     Integer pageIndex,
                                                     @RefOnly @Default(value="#[payload]")
                                                     SearchDateField deletedDate,
                                                     @Placement(group="Request Preferences") @RefOnly @Optional
                                                     Preferences preferences)
                                              throws NetSuiteException

Retrieves a list of deleted records for the given record type and date period.

Parameters:: type - The type of the target deleted record to retrieve.; pageIndex - The page number to retrieve.; deletedDate - A SearchDateField where you can define a predefined search date value, or a date period of your choice, together with the search date operator.; preferences - Preferences for the request.
Returns:: A list of DeletedRecord that match the given date filtering expression.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getRecords
```
@Processor
public GetAllResult getRecords(GetAllRecordType type,
                                          @Placement(group="Request Preferences") @RefOnly @Optional
                                          Preferences preferences)
                                   throws NetSuiteException
```
Retrieves a list of all records of the specified type. Records that support the getAll operation are listed in the GetAllRecordType.

Parameters:

type - The target record type.

preferences - Preferences for the request.

Returns:

The list of Records.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getList

@Processor
public List<ReadResponse> getList(@RefOnly @Default(value="#[payload]")
                                             List<? extends BaseRef> references,
                                             @Placement(group="Request Preferences") @RefOnly @Optional
                                             Preferences preferences)
                                      throws NetSuiteException

Retrieves a list of objects referenced in the list of BaseRef object.

Parameters:: references - List of BaseRef child classes. Check BaseRef for a list of child classes.; preferences - Preferences for the request.
Returns:: The list of Records.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

get
```
@Processor
public Map<String,Object> get(@RefOnly @Default(value="#[payload]")
                                         BaseRefType baseRef,
                                         @Placement(group="Request Preferences") @RefOnly @Optional
                                         Preferences preferences)
                                  throws NetSuiteException
```
Retrieves a record by providing the unique id that identifies that record.

Parameters:

baseRef - An instance of BaseRefType.

preferences - Preferences for the request.

Returns:

A map that represents the Record you want to retrieve.

Throws:

NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getRecord

@MetaDataScope(value=RecordMetaData.class)
 @Processor
public Map<String,Object> getRecord(@MetaDataKeyParam(affects=OUTPUT)
                                                                                           String type,
                                                                                           @Optional
                                                                                           String internalId,
                                                                                           @Optional
                                                                                           String externalId,
                                                                                           @Placement(group="Request Preferences") @RefOnly @Optional
                                                                                           Preferences preferences)
                                                                                    throws NetSuiteException

Retrieves a record by providing the unique id that identifies that record.

Parameters:: type - The type of record to get.; internalId - The internalId of the record to get. You can choose between this or externalId.; externalId - The externalId of the record to get. You can choose between this or internalId.; preferences - Preferences for the request.
Returns:: A map representing the Record.
Throws:: NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getCustomRecord

@MetaDataScope(value=CustomRecordMetaData.class)
 @Processor
public Map<String,Object> getCustomRecord(@MetaDataKeyParam(affects=OUTPUT)
                                                                                                       String type,
                                                                                                       @Default(value="#[payload]")
                                                                                                       String internalId,
                                                                                                       @Optional
                                                                                                       String externalId,
                                                                                                       @Placement(group="Request Preferences") @RefOnly @Optional
                                                                                                       Preferences preferences)
                                                                                                throws NetSuiteException

Retrieves a custom record by providing the unique id that identifies that record.

Parameters:: type - The type of record to get.; internalId - The internalId of the record to get. You can choose between this or externalId.; externalId - The externalId of the record to get. You can choose between this or internalId.; preferences - Preferences for the request.
Returns:: A map representing the Record.
Throws:: NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getItemAvailability

@Processor
public GetItemAvailabilityResult getItemAvailability(@RefOnly @Default(value="#[payload]")
                                                                RecordRef record,
                                                                @Optional
                                                                Date ifModifiedSince,
                                                                @Placement(group="Request Preferences") @RefOnly @Optional
                                                                Preferences preferences)
                                                         throws NetSuiteException

Retrieves the availability for a given item 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.

Parameters:: 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.
Returns:: An instance of GetItemAvailabilityResult.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getSavedSearch
```
@Processor
public GetSavedSearchResult getSavedSearch(SearchRecordType type)
                                               throws NetSuiteException
```
Retrieves a list of existing saved searches for the given record type.

Parameters:

type - The target record type.

Returns:

A list of RecordRefs corresponding to the available saved searches.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

getServerTime
```
@Processor
public Date getServerTime()
                              throws NetSuiteException
```
Returns the server time.

Returns:

The server time, as a Date.

Throws:

NetSuiteException - This could be one of the following: InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

updateInviteeStatus

@Processor
public WriteResponse updateInviteeStatus(@RefOnly @Default(value="#[payload]")
                                                    RecordRef eventId,
                                                    CalendarEventAttendeeResponseEnum status,
                                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                                    Preferences preferences)
                                             throws NetSuiteException

Sets a new invitation status for a given event.

Parameters:: eventId - The target event ID.; status - The new status value to set.; preferences - Preferences for the request.
Returns:: An instance of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

updateInviteeStatusList

@Processor
public List<WriteResponse> updateInviteeStatusList(@RefOnly @Default(value="#[payload]")
                                                              List<UpdateInviteeStatusReference> inviteeStatusList,
                                                              @Placement(group="Request Preferences") @RefOnly @Optional
                                                              Preferences preferences)
                                                       throws NetSuiteException

Sets multiple new invitation status for a given event.

Parameters:: inviteeStatusList - A list of the UpdateInviteeStatusReference items.; preferences - Preferences for the request.
Returns:: An instance of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

addRecordObjects
```
@Processor
public List<WriteResponse> addRecordObjects(@RefOnly @Default(value="#[payload]")
                                                       List<? extends Record> records)
                                                throws NetSuiteException
```
Creates new records.

Parameters:

records - A list of Record objects.

Returns:

List of WriteResponse.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

addRecord
```
@Processor
public BaseRef addRecord(@MetaDataKeyParam
                                    String recordType,
                                    @Placement(group="Record attributes") @RefOnly @Default(value="#[payload]")
                                    Map<String,Object> attributes,
                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                    Preferences preferences)
                             throws NetSuiteException
```
Creates a new record. The attributes can either be the POJOs corresponding to the field or a map that represents it.

Parameters:

recordType - The type of record to add.

attributes - The record attributes.

preferences - Preferences of the request.

Returns:

An instance of RecordRef or CustomRecordRef depending on the type of record that was added.

Throws:

NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

addList

@Processor
public List<WriteResponse> addList(@MetaDataKeyParam
                                              String recordType,
                                              @RefOnly @Default(value="#[payload]")
                                              List<Map<String,Object>> records,
                                              @Placement(group="Request Preferences") @RefOnly @Optional
                                              Preferences preferences)
                                       throws NetSuiteException

Adds one or more records into the system. The attributes that define each record can either be the POJOs corresponding to the field or a map that represents it.

Parameters:: recordType - The type of record to add.; records - The records with their attributes.; preferences - Preferences for the request.
Returns:: A list of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

updateList

@Processor
public List<WriteResponse> updateList(@MetaDataKeyParam
                                                 String recordType,
                                                 @RefOnly @Default(value="#[payload]")
                                                 List<Map<String,Object>> records,
                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                 Preferences preferences)
                                          throws NetSuiteException

Updates 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.

Parameters:: recordType - The type of record to add.; records - The records with their attributes.; preferences - Preferences for the request.
Returns:: A list of WriteResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

updateRecordsList
```
@Processor
public List<WriteResponse> updateRecordsList(@RefOnly @Default(value="#[payload]")
                                                        List<? extends Record> records,
                                                        @Placement(group="Request Preferences") @RefOnly @Optional
                                                        Preferences preferences)
                                                 throws NetSuiteException
```
Updates 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.

Parameters:

records - The records with their attributes.

preferences - Preferences for the request.

Returns:

A list of WriteResponse.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

deleteList

@Processor
public List<WriteResponse> deleteList(@RefOnly @Default(value="#[payload]")
                                                 List<BaseRefType> records,
                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                 Preferences preferences)
                                          throws NetSuiteException

Deletes one or more records in the system.

Parameters:: records - The records with their attributes.; preferences - Preferences for the request.
Returns:: A list of record references for the deleted records.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

deleteRecordsList

@Processor
public List<WriteResponse> deleteRecordsList(@RefOnly @Default(value="#[payload]")
                                                        List<RecordRef> records,
                                                        @Placement(group="Request Preferences") @RefOnly @Optional
                                                        Preferences preferences)
                                                 throws NetSuiteException

Deletes one or more records in the system.

Parameters:: records - A list of RecordRef to delete.; preferences - Preferences for the request.
Returns:: A list of record references for the deleted records.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

addFile

@Processor
public RecordRef addFile(@RefOnly @Default(value="#[payload]")
                                    RecordRef folderId,
                                    @Placement(group="Additional file attributes") @RefOnly @Optional
                                    Map<String,Object> attributes,
                                    @RefOnly
                                    Object content,
                                    String fileName,
                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                    Preferences preferences)
                             throws IOException,
                                    NetSuiteException

Creates a new file record. This Processor is similar to addRecord, but is customized for simplifying local content passing.

Parameters:: 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.; fileName - the name of the remote file.; folderId - the id of the folder record where to add this file.; preferences - Preferences for the request.
Returns:: The RecordRef of the new record.
Throws:: IOException - If the content cannot be parsed to byte[].; NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

updateRecord
```
@Processor
public BaseRef updateRecord(@MetaDataKeyParam
                                       String recordType,
                                       @Placement(group="Record attributes") @RefOnly @Default(value="#[payload]")
                                       Map<String,Object> attributes,
                                       @Placement(group="Request Preferences") @RefOnly @Optional
                                       Preferences preferences)
                                throws NetSuiteException
```
Updates an existing record.The attributes can either be the POJOs corresponding to the field or a map that represents it.

Parameters:

recordType - The target record type to update.

attributes - The record attributes, including internalId or externalId attribute.

preferences - Preferences for the request.

Returns:

An instance of RecordRef or CustomRecordRef depending on the type of record that was added.

Throws:

NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

upsertRecord
```
@Processor
public BaseRef upsertRecord(@MetaDataKeyParam
                                       String recordType,
                                       @Placement(group="Record attributes") @RefOnly @Default(value="#[payload]")
                                       Map<String,Object> attributes,
                                       @Placement(group="Request Preferences") @RefOnly @Optional
                                       Preferences preferences)
                                throws NetSuiteException
```
Adds a new instance or to update an instance of a record in NetSuite. The upsert operation is similar to both the add and update operations, but upsert can be run without first determining whether a record exists in NetSuite. A record is identified by its external ID and its record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because external ID is mandatory for this operation, upsert is supported only for records that support the external ID field. Also, this operation prohibits the passing of internal ID values.

Parameters:

recordType - The target record type to update.

attributes - The record attributes.

preferences - Preferences for the request.

Returns:

An instance of RecordRef or CustomRecordRef depending on the type of record that was added.

Throws:

NetSuiteException - This is thrown when the request returned an unsuccessful status. This could also be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

upsertList
```
@Processor
public List<WriteResponse> upsertList(@MetaDataKeyParam
                                                 String recordType,
                                                 @RefOnly @Default(value="#[payload]")
                                                 List<Map<String,Object>> records,
                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                 Preferences preferences)
                                          throws NetSuiteException
```
Adds or updates one or more instances of a record type in NetSuite. The upsertList operation is similar to both the addList and updateList operations, but upsert can be run without first determining whether records exist in NetSuite. Records are identified by their external ID and their record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because external ID is mandatory for this operation, 'upsertList' is supported only for records that support the external ID field. Also, this operation prohibits the passing of internal ID values.

Parameters:

recordType - The target record type to update.

records - The record attributes.

preferences - Preferences for the request.

Returns:

A list with the references to the upserted records.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault

checkAsyncStatus

@Processor
public AsyncStatusResult checkAsyncStatus(@Default(value="#[payload]")
                                                     String jobId,
                                                     @Placement(group="Request Preferences") @RefOnly @Optional
                                                     Preferences preferences)
                                              throws NetSuiteException

Checks whether a particular asynchronous job has finished processing or not.

Parameters:: jobId - The ID of the job to check.; preferences - Preferences for the request.
Returns:: The AsyncStatusResult for the given job.
Throws:: NetSuiteException - This could be one of the following: InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestLimitFault , InvalidSessionFault , AsyncFault

asyncSearch
```
@MetaDataScope(value=SearchMetaData.class)
 @Processor
public AsyncStatusResult asyncSearch(@MetaDataKeyParam(affects=INPUT)
                                                                                            String searchRecord,
                                                                                            @RefOnly @Default(value="#[payload]")
                                                                                            SearchRecord criteria,
                                                                                            @Placement(group="Search preferences") @Default(value="true")
                                                                                            boolean bodyFieldsOnly,
                                                                                            @Placement(group="Search preferences") @Default(value="true")
                                                                                            boolean returnSearchColumns,
                                                                                            @Placement(group="Search preferences") @Optional
                                                                                            Integer pageSize)
                                                                                     throws NetSuiteException
```
An asynchronous request equivalent to search(String, SearchRecord, boolean, boolean, PagingConfiguration). Searches for all records that match the given criteria, asynchronously. Note, due to the nature of the operation, this does not support paging meaning that only the first page of results would be returned. If no criteria is specified, all records of the given type are retrieved. In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID.

Parameters:

searchRecord - The search type. See SearchRecordTypeEnum.

criteria - An instance of SearchRecord that defines the attributes that make up the search.

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.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , InvalidSessionFault

getAsyncResult

@Processor
public AsyncResult getAsyncResult(@Default(value="#[payload]")
                                             String jobId,
                                             @Default(value="1")
                                             Integer pageIndex,
                                             @Placement(group="Request Preferences") @RefOnly @Optional
                                             Preferences preferences)
                                      throws NetSuiteException

This operation returns the result of a job given that it has finished processing.

Parameters:: jobId - The ID of the job.; pageIndex - The page number of the asynchronous result.; preferences - Preferences for the request.
Returns:: An iterable with the Records found.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault , AsyncFault

initialize
```
@Processor
public ReadResponse initialize(@RefOnly @Default(value="#[payload]")
                                          InitializeRecord record,
                                          @Placement(group="Request Preferences") @RefOnly @Optional
                                          Preferences preferences)
                                   throws NetSuiteException
```
Populates fields on transaction line items with values from a related record, in a similar way empty text boxes are pre-populated within the NetSuite UI.

Parameters:

record - An instance of InitializeRecord.

preferences - Preferences for the request.

Returns:

The initialized Record.

Throws:

NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault ,

getPostingTransactionSummary

@Processor
public GetPostingTransactionSummaryResult getPostingTransactionSummary(@RefOnly @Default(value="#[payload]")
                                                                                  PostingTransactionSummaryField fields,
                                                                                  @RefOnly
                                                                                  PostingTransactionSummaryFilter filters,
                                                                                  @Default(value="1")
                                                                                  Integer pageIndex,
                                                                                  @Placement(group="Request Preferences") @RefOnly @Optional
                                                                                  Preferences preferences)
                                                                           throws NetSuiteException

Retrieves a summary of the actual data in an Account. The getPostingTransactionSummary operation allows you to retrieve a summary of the actual data 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.

Parameters:: 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.
Returns:: An instance of GetPostingTransactionSummaryResult containing the list of RecirdRef to the fields specified
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault , AsyncFault

getSelectValue
```
@Processor
public GetSelectValueResult getSelectValue(int page,
                                                      @RefOnly @Default(value="#[payload]")
                                                      GetSelectValueFieldDescription fieldDescriptor,
                                                      @Placement(group="Request Preferences") @RefOnly @Optional
                                                      Preferences preferences)
                                               throws NetSuiteException
```
Retrieves valid values for a given recordRef field where the referenced record type is not yet exposed in the Web services API or when the logged in role does not have access to the instances of the record type.

Parameters:

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.

Returns:

The GetSelectValueResult related to the request.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededUsageLimitFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

getCurrentRate

@Processor
public GetCurrencyRateResult getCurrentRate(@RefOnly @Default(value="#[payload]")
                                                       CurrencyRateFilter rateFilter,
                                                       @Placement(group="Request Preferences") @RefOnly @Optional
                                                       Preferences preferences)
                                                throws NetSuiteException

Retrieves the exchange rate between two currencies.

Parameters:: rateFilter - Filter the returned currency exchange rates using this filter.; preferences - Preferences for the request.
Returns:: The exchange rate.
Throws:: NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededUsageLimitFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncAddList
```
@Processor
public AsyncStatusResult asyncAddList(@MetaDataKeyParam
                                                 String recordType,
                                                 @RefOnly @Default(value="#[payload]")
                                                 List<Map<String,Object>> recordsAttributes,
                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                 Preferences preferences)
                                          throws NetSuiteException
```
An asynchronous request equivalent to addList(java.lang.String, java.util.List<java.util.Map<java.lang.String, java.lang.Object>>, com.netsuite.webservices.platform.messages.Preferences). The attributes can either be the POJOs corresponding to the field or a map that represents it. In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

recordType - The target record type.

recordsAttributes - A list of Map containing the attributes of the records that will be added.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncUpdateList
```
@Processor
public AsyncStatusResult asyncUpdateList(@MetaDataKeyParam
                                                    String recordType,
                                                    @RefOnly @Default(value="#[payload]")
                                                    List<Map<String,Object>> recordsAttributes,
                                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                                    Preferences preferences)
                                             throws NetSuiteException
```
An asynchronous request equivalent to updateList(String, List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

recordType - The target record type.

recordsAttributes - A list of Map containing the attributes of the records that will be updated.

preferences - Preferences for the request.

Returns:

The result AsyncStatusResult with the jobId that can be used to check the status and result.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncUpsertList
```
@Processor
public AsyncStatusResult asyncUpsertList(@MetaDataKeyParam
                                                    String recordType,
                                                    @RefOnly @Default(value="#[payload]")
                                                    List<Map<String,Object>> recordsAttributes,
                                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                                    Preferences preferences)
                                             throws NetSuiteException
```
An asynchronous request equivalent to upsertList(String, List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

recordType - The target record type.

recordsAttributes - A list of Map containing the attributes of the records that will be inserted or updated.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncDeleteListRecords
```
@Processor
public AsyncStatusResult asyncDeleteListRecords(@RefOnly @Default(value="#[payload]")
                                                           List<RecordRef> records,
                                                           @Placement(group="Request Preferences") @RefOnly @Optional
                                                           Preferences preferences)
                                                    throws NetSuiteException
```
An asynchronous request equivalent to deleteRecordsList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

records - A list of RecordRef that references the objects to be deleted.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncDeleteList
```
@Processor
public AsyncStatusResult asyncDeleteList(@RefOnly @Default(value="#[payload]")
                                                    List<BaseRefType> records,
                                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                                    Preferences preferences)
                                             throws NetSuiteException
```
An asynchronous request equivalent to deleteList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

records - A list of BaseRefType that references the objects to be deleted.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncGetListRecords
```
@Processor
public AsyncStatusResult asyncGetListRecords(@RefOnly @Default(value="#[payload]")
                                                        List<RecordRef> records,
                                                        @Placement(group="Request Preferences") @RefOnly @Optional
                                                        Preferences preferences)
                                                 throws NetSuiteException
```
An asynchronous request equivalent to getList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

records - A list of RecordRef that references the objects to be retrieved.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncGetList
```
@Processor
public AsyncStatusResult asyncGetList(@RefOnly @Default(value="#[payload]")
                                                 List<BaseRefType> records,
                                                 @Placement(group="Request Preferences") @RefOnly @Optional
                                                 Preferences preferences)
                                          throws NetSuiteException
```
An asynchronous request equivalent to getList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

records - A list of RecordRef that references the objects to be retrieved.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

asyncInitializeList
```
@Processor
public AsyncStatusResult asyncInitializeList(@RefOnly @Default(value="#[payload]")
                                                        List<InitializeRecord> initializeRecord,
                                                        @Placement(group="Request Preferences") @RefOnly @Optional
                                                        Preferences preferences)
                                                 throws NetSuiteException
```
An asynchronous request equivalent to initializeList(List, Preferences). In asynchronous requests, your client application sends a request to the SuiteTalk Platform where it is placed in a processing queue and handled asynchronously with other requests. Note that all available jobs for each polling period will be processed contiguously. There is no enforced waiting period for a job that is available. Once a job is initiated, a job ID is returned in the Web services response. Your client application can then check on the status and result of the request by referencing the job ID. NOTE: Asynchronous request JobIDs are valid for 30 days.

Parameters:

initializeRecord - A list of InitializeRecord that references the objects to be initialized.

preferences - Preferences for the request.

Returns:

An AsyncStatusResult with the jobId that can be used to check the status and result of the job.

Throws:

NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededUsageLimitFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

initializeList

@Processor
public List<ReadResponse> initializeList(@RefOnly @Default(value="#[payload]")
                                                    List<InitializeRecord> initializeRecord,
                                                    @Placement(group="Request Preferences") @RefOnly @Optional
                                                    Preferences preferences)
                                             throws NetSuiteException

Emulates the UI workflow by pre-populating fields on transaction line items with values from a related record.

Parameters:: initializeRecord - The list of InitializeRecord to initialize.; preferences - Preferences for the request.
Returns:: A list containing the results of each initialize request.
Throws:: NetSuiteException - This could be one of the following: InvalidSessionFault , ExceededUsageLimitFault , ExceededRequestLimitFault , ExceededRequestSizeFault , UnexpectedErrorFault , InvalidCredentialsFault , ExceededRecordCountFault

changeEmail
```
@Processor
public SessionResponse changeEmail(@Default(value="#[payload]")
                                              String newEmail,
                                              @Default(value="true")
                                              Boolean justThisAccount)
                                       throws NetSuiteException
```
Changes the email address of the account.

Parameters:

newEmail - Value for the new email.

justThisAccount - Update email for the current account only.

Returns:

An instance of SessionResponse .

Throws:

NetSuiteException - This exception is thrown when this operation is used with SSO Login Authentication. This could also be one of the following: ExceededRequestLimitFault , UnexpectedErrorFault , InvalidCredentialsFault , InvalidAccountFault , InsufficientPermissionFault , InvalidVersionFault , ExceededRecordCountFault

changePassword

@Processor
public SessionResponse changePassword(@Default(value="#[payload]")
                                                 String newPassword,
                                                 @Default(value="true")
                                                 Boolean justThisAccount)
                                          throws NetSuiteException

Changes the password of the account.

Parameters:: newPassword - New password value.; justThisAccount - Apply change just to this account.
Returns:: An instance of SessionResponse.
Throws:: NetSuiteException - This could be one of the following: ExceededRequestLimitFault , UnexpectedErrorFault , InvalidCredentialsFault , InvalidAccountFault , InsufficientPermissionFault , InvalidVersionFault , ExceededRecordCountFault

getDataCenterUrls

@Processor(friendlyName="Get Data Center URLs")
public GetDataCenterUrlsResult getDataCenterUrls(@Default(value="#[payload]")
                                                                                                 String accountId)
                                                                                          throws NetSuiteException

Retrieves the accessible data-center URLs for the accountId specified.

Parameters:: accountId - NetSuite account Id.
Returns:: Request The result containing the status and Data Center URLs.
Throws:: NetSuiteException - This could be one of the following: UnexpectedErrorFault , ExceededRequestSizeFault

mapSso
```
@Processor(friendlyName="Map SSO")
public SessionResponse mapSso(String userAccount,
                                                                 String userPartnerId,
                                                                 String authenticationToken,
                                                                 String userEmail,
                                                                 String userPassword,
                                                                 @RefOnly @Default(value="#[payload]")
                                                                 RecordRef userRole)
                                                          throws NetSuiteException
```
Automates the mapping between external applications credentials and NetSuite’s credentials for a user. This operation provides a mapping, not a login to NetSuite. This operation does NOT provide the ability to log in using a single sign-on token, cannot provide a partner with the inbound single sign-on feature, or aid with public/private key exchange. Use of this operation implies that the account already has inbound single sign-on set up and has access to the associated partner ID and encryption keys needed to generate the token.

Parameters:

userAccount - Account.

userPartnerId - The integration partner’s affiliate ID as provided to the partner by NetSuite.

authenticationToken - A string representing the encrypted token.

userEmail - Email.

userPassword - Password.

userRole - Role.

Returns:

Response which includes the status and wsRoleList elements. The wsRoleList element returns a list of roles available for the user specified in the passport.

Throws:

NetSuiteException - This could be one of the following: ExceededRequestLimitFault , UnexpectedErrorFault , InvalidCredentialsFault , InvalidAccountFault , InsufficientPermissionFault , InvalidVersionFault ,

search

@MetaDataScope(value=SearchMetaData.class)
 @Processor
 @Paged
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,NetSuiteConnector> search(@MetaDataKeyParam(affects=INPUT)
                                                                                                                                                                  String searchRecord,
                                                                                                                                                                  @RefOnly @Default(value="#[payload]")
                                                                                                                                                                  SearchRecord criteria,
                                                                                                                                                                  @Placement(group="Search preferences") @Default(value="true")
                                                                                                                                                                  boolean bodyFieldsOnly,
                                                                                                                                                                  @Placement(group="Search preferences") @Default(value="true")
                                                                                                                                                                  boolean returnSearchColumns,
                                                                                                                                                                  @RefOnly
                                                                                                                                                                  org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                                                                           throws NetSuiteException

Executes a search on a specific record type based on a set of criteria. This processor has been enhanced with a paging mechanism. Searches can be Basic, Advanced or Join searches. See SearchRecord for all the available searches.

Parameters:: searchRecord - The search type. See SearchRecordTypeEnum.; criteria - An instance of SearchRecord that defines the attributes that make up the search.; 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 sub-lists 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.; pagingConfiguration - The number of objects returned in each page.
Returns:: A list of maps representing the results of the search criteria.
Throws:: NetSuiteException - This could be one of the following: ExceededRecordCountFault , InvalidCredentialsFault , UnexpectedErrorFault , ExceededRequestSizeFault , ExceededRequestLimitFault , ExceededUsageLimitFault , InvalidSessionFault , AsyncFault

callRestletGet

@Processor(friendlyName="Call RESTlet (GET)")
public List<Map<String,Object>> callRestletGet(int script,
                                                                                             int deploy,
                                                                                             @RefOnly @Default(value="#[payload]")
                                                                                             Map<String,Object> data)

Calls a NetSuite RESTlet using the GET method.

Parameters:: script - The ID of the deployed script.; deploy - The deploy number corresponding to the script.; data - The input data for the script.
Returns:: A List containing the output of the script deployed as a RESTlet.
Throws:: NetSuiteException - If the call cannot be performed.

callRestletDelete

@Processor(friendlyName="Call RESTlet (DELETE)")
public void callRestletDelete(int script,
                                                                               int deploy,
                                                                               @RefOnly @Default(value="#[payload]")
                                                                               Map<String,Object> data)

Calls a NetSuite RESTlet using the DELETE method.

Parameters:: script - The ID of the deployed script.; deploy - The deploy number corresponding to the script.; data - The input data for the script.
Throws:: NetSuiteException - If the call cannot be performed.

callRestletPut

@Processor(friendlyName="Call RESTlet (PUT)")
public List<Map<String,Object>> callRestletPut(int script,
                                                                                             int deploy,
                                                                                             @RefOnly @Default(value="#[payload]")
                                                                                             Map<String,Object> data)

Calls a NetSuite RESTlet using the PUT method.

Parameters:: script - The ID of the deployed script.; deploy - The deploy number corresponding to the script.; data - The input data for the script.
Returns:: A List containing the output of the script deployed as a RESTlet.
Throws:: NetSuiteException - If the call cannot be performed.

callRestletPost

@Processor(friendlyName="Call RESTlet (POST)")
public List<Map<String,Object>> callRestletPost(int script,
                                                                                               int deploy,
                                                                                               @RefOnly @Default(value="#[payload]")
                                                                                               Map<String,Object> data)

Calls a NetSuite RESTlet using the POST method.

Parameters:: script - The ID of the deployed script.; deploy - The deploy number corresponding to the script.; data - The input data for the script.
Returns:: A List containing the output of the script deployed as a RESTlet.
Throws:: NetSuiteException - If the call cannot be performed.

setRegistry

public void setRegistry(org.mule.api.registry.MuleRegistry registry)

setConfig

public void setConfig(AbstractConfig config)

getConfig
```
public AbstractConfig getConfig()
```

registerTransformers
```
protected void registerTransformers()
```

init
```
@Start
public void init()
```

Class NetSuiteConnector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetSuiteConnector

Method Detail

attachRecord

deleteRecord

delete

detachRecord

getBudgetExchangeRates

getConsolidatedExchangeRates

getCustomizationIds

getDeletedRecords

getRecords

getList

get

getRecord

getCustomRecord

getItemAvailability

getSavedSearch

getServerTime

updateInviteeStatus

updateInviteeStatusList

addRecordObjects

addRecord

addList

updateList

updateRecordsList

deleteList

deleteRecordsList

addFile

updateRecord

upsertRecord

upsertList

checkAsyncStatus

asyncSearch

getAsyncResult

initialize

getPostingTransactionSummary

getSelectValue

getCurrentRate

asyncAddList

asyncUpdateList

asyncUpsertList

asyncDeleteListRecords

asyncDeleteList

asyncGetListRecords

asyncGetList

asyncInitializeList

initializeList

changeEmail

changePassword

getDataCenterUrls

mapSso