SOAP Web Services Standard Operations

The following operations are supported in SOAP web services. They are organized in alphabetical order:

Operation / API	Summary
add / addList	Use to add one or more records into the system. The system returns a NetSuite identifier (internalId) that is unique for each record created within a record type.
attach / detach	Use to attach or detach another record or file to/from another record.
changeEmail	Use to change the email address for the account.
changePassword	Use to change the password for the account.
checkAsyncStatus	Use to check the status of an asynchronous SOAP web services submission.
delete / deleteList	Use to delete one or more records in the system. The records to be deleted are identified by either the internal or external ID and the record type.
get / getList	Use to query the system for one or more records. You must provide either the internal or external ID and the record type for each query item.
getAccountGovernanceInfo	Use to retrieve the account concurrency limit and the unallocated concurrency limit.
getAll	Use to return a list of records that do not have a search interface.
getAsyncResult	Use to retrieve the results of an asynchronous SOAP web services submission.
getBudgetExchangeRate	Use to get and filter all data related to the Budget Exchange Rates table.
getConsolidatedExchangeRate	Use to get and filter all data related to the Consolidated Exchange Rates table. Important: The exposure of the consolidated exchange rate record prompted the removal of the getConsolidatedExchangeRate operation from the 2017.1 endpoint. You can still use the getConsolidatedExchangeRate operation on earlier endpoints. For more information about working with consolidated exchange rates on endpoints starting from 2017.1, see Consolidated Exchange Rate.
getCurrencyRate	Use to get currency exchange rates from the Currency Exchange Rate table.
getCustomizationId	Use to retrieve the internalIds, externalIds, and/or scriptIds of all custom objects of a specified type.
getDataCenterUrls	Use for dynamic discovery of the correct URL for SOAP web services requests. Important: All SOAP web services integrations must include logic to dynamically discover the correct URL. Important: As of the 2019.1 SOAP web services endpoint, you must use account-specific domains with SOAP web services. You can use the SOAP getDataCenterUrls operation to obtain the correct domain. Or, go to Setup > Company > Setup Tasks >Company Information in the NetSuite UI. Your domains are listed on the Company URLs subtab.
getDeleted	Use to retrieve a list of deleted records of a particular type during a specified period.
getIntegrationGovernanceInfo	Use to retrieve the concurrency limit for the specific integration and the limitType. With this information the integration can identify how many concurrent requests it can send.
getItemAvailability	Use to retrieve the inventory availability for a specific list of items.
getPostingTransactionSummary	Use to retrieve a summary of the actual data in an account.
getSavedSearch	Use to retrieve a list of existing saved searches for each record type. Specify the search record type to get a list of record references of the saved search.
getSelectValue	Use to retrieve valid values for a particular recordRef field where the referenced record type is not yet exposed in the SOAP web services API or when the logged in role does not have permission to the instances of the record type.
getServerTime	Use to get server time, resulting in more accurate and reliable sync'ing of data than using using local client time. The client will use the time from server to determine if the record has changed since the last synchronization.
initialize / initializeList	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.
mapSso	Warning: As of the NetSuite 2021.1 release, the mapSso operation is no longer available. This affects all endpoints, and even though the SOAP schema remains for older endpoints, the method is not working. For SOAP web services you must use token-based authentication instead. For more information, see Token-based Authentication (TBA).
search	Use to search for a set of records based on specific search criteria. This operation supports pagination, so that large result sets can be retrieved in smaller sets. For more information on how to control pagination, refer to SOAP Web Services Preferences.
searchMoreWithId	Use to retrieve search results for users who send requests to NetSuite by providing request-level credentials, rather than by invoking login.
ssoLogin	Warning: As of the NetSuite 2021.1 release, the ssoLogin operation is no longer available. This affects all endpoints, and even though the SOAP schema remains for older endpoints, the method is not working. For SOAP web services you must use token-based authentication instead. For more information, see Token-based Authentication (TBA).
update / updateList	Use 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 by either the internal or external ID and the record type.
updateInviteeStatus / updateInviteeStatusList	Allows event invitees to accept or decline NetSuite events. After invitees have responded to the event, the Event record is updated with their response.
upsert / upsertList	Use to add new records and update existing records in a single operation. Records are identified by external ID and 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.

Related Topics