SOAP Web Services to REST Web Services Upgrade Guide

The NetSuite REST web services provide an integration channel that extends the capabilities of SuiteTalk. REST web services provide a REST-based interface for interacting with NetSuite.

REST web services provide a lightweight integration option, where no coding and script deployment is needed on the server side, and which is suitable for mobile devices.

REST web services also support strong authentication with OAuth 2.0 and TBA.

Note:

The preferred authentication method is OAuth 2.0.

Using the REST API, fewer calls may be required to accomplish a business flow. Therefore the overall performance may be better than with SOAP web services. REST web services also supports asynchronous request processing. The asynchronous execution of requests is useful for long-running requests. With asynchronous requests, you send a request to REST web services, where it is placed in a processing queue and handled asynchronously with other requests.

This guide provides you with the resources to help you upgrade your SOAP web services integration to REST web services. To start learning about REST web services in general, see the following topics:

The guide provides a side by side comparison of SOAP and REST operations, and provides information about how to perform actions in REST to get the same functionality as in SOAP.

The second part of the guide provides an overview of the record types available in SOAP and REST.

Comparison of SOAP Web Services and REST Web Services Operations

The following table maps SOAP operations to their REST equivalents. Click the links for detailed information about SOAP operations and their REST equivalents.

SOAP Operation	REST Operation	Notes
add	POST
addList	—	List operations are currently not supported in REST web services.
attach / detach	—	The attach / detach operation is currently not supported in REST web services. You can use SuiteScript to define or remove a relationship between two records. For more information, see record.attach(options) and record.detach(options).
changeEmail	—	Login through user credentials is not supported in REST web services.
changePassword	—	Login through user credentials is not supported in REST web services.
checkAsyncStatus	GET	You can use the async service to retrieve the status of a single async operation.
delete	DELETE
deleteList	—	List operations are currently not supported in REST web services.
get	GET
getAccountGovernanceInfo	governanceLimits
getAll	GET
getAsyncResult	—	You can use the async service to retrieve the result of a single async operation.
getBudgetExchangeRate	—	The budget exchange rate record is currently not available in REST web services. You can interact with the budget exchange rate record using SuiteScript. For details, see Budget Exchange Rate.
getCurrencyRate	GET	You can achieve the equivalent in REST by sending a GET request for a specific currency rate record.
getCustomizationId		In REST web services, you can return data about your customization objects by sending a request to the metadata catalog. For information, see Getting Metadata.
getDataCenterUrls	—	REST web services only use account-specific domains.
getDeleted	—	This functionality is not available in REST web services. You can retrieve information about deleted records by using the Deleted Record search type or a SuiteQL query. For information, see Searching for Deleted Records.
getIntegrationGovernanceInfo	governanceLimits
getItemAvailability		You can achieve the equivalent in REST by sending a GET request for a specific record.
getList	GET	You can retrieve a list of records of the same record type in REST.
getPostingTransactionSummary	—	You can search for financial reports and summaries in the UI. For information, see Financial Statements Overview.
getSavedSearch	—	Saved Search isn't supported in REST web services. REST web services supports SuiteAnalytics Datasets. For more information, see Working with SuiteAnalytics Datasets in REST Web Services.
getSelectValue	—	The getSelectValue operation is currently not supported in REST web services.
getServerTime	serverTime
initialize / initializeList		In REST web services, you can transform a record from one type into an another, using data from an existing records. This is the equivalent of the initialize SOAP operation. For more information, see Transforming Records.
search	GET
searchMoreWithId		In REST web services, you can use collection paging to move between pages of search results.
update	PATCH
updateList	—	List operations are currently not supported in REST web services.
updateInviteeStatus	PATCH	You can achieve the equivalent in REST by sending a PATCH request for a specific record.
updateInviteeStatusList	—	List operations are currently not supported in REST web services. You can update calendar events one by one. For information, see updateInviteeStatus.
upsert	PUT
upsertList	—	List operations are currently not supported in REST web services.

SOAP Operation

REST Operation

Notes

add

POST

addList

—

List operations are currently not supported in REST web services.

attach / detach

—

The attach / detach operation is currently not supported in REST web services. You can use SuiteScript to define or remove a relationship between two records. For more information, see record.attach(options) and record.detach(options).

changeEmail

—

changePassword

—

checkAsyncStatus

GET

You can use the async service to retrieve the status of a single async operation.

delete

DELETE

deleteList

—

List operations are currently not supported in REST web services.

get

GET

getAccountGovernanceInfo

governanceLimits

getAll

GET

getAsyncResult

—

You can use the async service to retrieve the result of a single async operation.

getBudgetExchangeRate

—

The budget exchange rate record is currently not available in REST web services. You can interact with the budget exchange rate record using SuiteScript. For details, see Budget Exchange Rate.

getCurrencyRate

GET

You can achieve the equivalent in REST by sending a GET request for a specific currency rate record.

getCustomizationId

In REST web services, you can return data about your customization objects by sending a request to the metadata catalog. For information, see Getting Metadata.

getDataCenterUrls

—

REST web services only use account-specific domains.

getDeleted

—

This functionality is not available in REST web services. You can retrieve information about deleted records by using the Deleted Record search type or a SuiteQL query. For information, see Searching for Deleted Records.

getIntegrationGovernanceInfo

governanceLimits

getItemAvailability

You can achieve the equivalent in REST by sending a GET request for a specific record.

getList

GET

You can retrieve a list of records of the same record type in REST.

getPostingTransactionSummary

—

You can search for financial reports and summaries in the UI. For information, see Financial Statements Overview.

getSavedSearch

—

Saved Search isn't supported in REST web services. REST web services supports SuiteAnalytics Datasets. For more information, see Working with SuiteAnalytics Datasets in REST Web Services.

getSelectValue

—

The getSelectValue operation is currently not supported in REST web services.

getServerTime

serverTime

initialize / initializeList

In REST web services, you can transform a record from one type into an another, using data from an existing records. This is the equivalent of the initialize SOAP operation. For more information, see Transforming Records.

GET

searchMoreWithId

In REST web services, you can use collection paging to move between pages of search results.

update

PATCH

updateList

—

List operations are currently not supported in REST web services.

updateInviteeStatus

PATCH

You can achieve the equivalent in REST by sending a PATCH request for a specific record.

updateInviteeStatusList

—

List operations are currently not supported in REST web services. You can update calendar events one by one. For information, see updateInviteeStatus.

upsert

PUT

upsertList

—

List operations are currently not supported in REST web services.

General Notices