SuiteTalk Web Services Integration
This release note was updated August 12, 2024.
NetSuite 2024.1 includes the following enhancements to web services features:
Removal of the REST Record Service (Beta) Feature
The REST Record Service beta feature has been removed from NetSuite. The feature is no longer available under Setup > Company > Enable Features > SuiteCloud.
With the removal of this beta feature, REST web services is generally available to use on production environments.
You can use REST web services with every generally available record listed in the REST API Browser and in REST Web Services Supported Records.
The record types not listed in the REST API browser are not available for use anymore.
Fully Supported Record Types for REST Web Services in 2024.1
The following table lists the record types that are fully supported as of 2024.1.
Record Type |
Notes |
---|---|
The record ID for an assembly build REST record is assemblyBuild. This record has one subrecord: component. |
|
The record ID for an assembly unbuild REST record is assemblyUnbuild. This record has one subrecord: component. |
|
The record ID for a billing revenue event REST record is BillingRevenueEvent. This record is available only when the Product Management and Subscription Billing features are enabled. |
|
The record ID for a BOM REST record is bom. You must enable the Advanced Bill of Materials feature before you can use this record through REST web services. |
|
The record ID for a BOM revision REST record is bomRevision. You must enable the Advanced Bill of Materials feature before you can use this record through REST web services. |
|
The record ID for a campaign REST record is campaign. You must enable the Marketing Automation feature before you can use this record through REST web services. |
|
The record ID for a campaign response REST record is campaignResponse. You must enable the Marketing Automation feature before you can use this record through REST web services. |
|
The record ID for a competitor REST record is competitor. You must set the Lists > Competitors permission before you can use this record through REST web services. |
|
The record ID for the coupon code REST record is couponcode. You must enable the SuitePromotions feature before you can use this record through REST web services. |
|
The record ID for the customer message REST record is customermessage. |
|
The record ID for the customer status REST record is customerstatus. |
|
The record ID for a fair value price REST record is fairvalueprice. This record is part of the Advanced Revenue Management (Revenue Allocation) feature. You must enable the Accounting Periods feature, Advanced Revenue Management (Essentials) feature, and Advanced Revenue Management (Revenue Allocation) feature to use advanced revenue management (revenue allocation). |
|
The record ID for an issue REST record is issue. |
|
The record ID for a manufacturing cost template REST record is manufacturingCostTemplate. You must enable the Manufacturing Routing and Work Center features before you can use this record through REST web services. |
|
The record ID for a manufacturing operation task REST record is manufacturingOperationTask. You must enable the Manufacturing Routing and Work Center features before you can use this record through REST web services. |
|
The record ID for a manufacturing routing REST record is manufacturingRouting. You must enable the Manufacturing Routing and Work Center features before you can use this record through REST web services. |
|
The record ID for a note type REST record is notetype. |
|
The record ID for the partner REST record is partner. You must enable the CRM feature before you can use this record through REST web services. |
|
The record ID for the paycheck REST record is paycheck. When accessed through REST, the paycheck record is read-only. |
|
The record ID for the promotion code REST record is promotioncode. You must enable the SuitePromotions feature before you can use this record through REST web services. |
|
The record ID for a revenue recognition schedule REST record is RevRecSchedule. All fields of the revenue recognition schedule record are read-only except for the name and recurrence fields. To modify these two fields, you must enable the Allow Users to Modify Revenue Recognition Schedule preference. |
|
The record ID for a revenue recognition template REST record is revrectemplate. All fields of the revenue recognition template record are read-only except for the name and recurrence fields. To modify these two fields, you must enable the Allow Users to Modify Revenue Recognition Schedule preference. |
|
The record ID for the sales role REST record is salesrole. You must enable the Team Selling feature before you can use this record through REST web services. |
|
The record ID for a support case REST record is supportcase. You must set the Lists > Case permission before you can use this record through REST web services. |
|
The record ID for a topic REST record is topic. You must enable the Knowledge Base feature and set the Lists > Knowledge Base permission before you can use this record through REST web services. |
|
The record ID for the website REST record is website. You must enable the Website feature to be able to use the website record. |
|
The record ID for a timesheet REST record is timesheet. This record is available only when the Time Tracking and Weekly Timesheets features are enabled. |
|
The record ID for a work order REST record is workOrder. You must enable the Work Orders feature to use this record. |
|
The record ID for a work order close REST record is workOrderClose. You must enable the Manufacturing Work In Process feature before you can use this record through REST web services. |
|
The record ID for a work order completion REST record is workOrderCompletion. You must enable the Manufacturing Work In Process feature before you can use this record through REST web services. |
|
The record ID for a work order issue REST record is workOrderIssue. You must enable the Manufacturing Work In Process feature before you can use this record through REST web services. |
For a list of every supported record, see REST Web Services Supported Records.
You can also see the list of supported records in the REST API browser. For more information about working with the browser, see The REST API Browser.
SOAP Web Services Version 2024.1
SOAP web services version 2024.1 is available. When your implementation is upgraded to 2024.1, the 2024.1 WSDL becomes available in your production account.
When SOAP web services version 2024.1 is available, version 2017.1 retired.
You do not need to upgrade your WSDL when the new version is generally available. NetSuite supports each endpoint for seven years. For information about the supported generally available versions, see Support for Existing WSDL Versions.
Araxis Merge Diff File for the 2024.1 Endpoint
The Araxis Merge diff file highlights the schema changes between the 2023.2 and 2024.1 endpoints.
About the Araxis Merge Diff File
NetSuite publishes an Araxis Merge diff file for every new endpoint. Depending on the scope of the release, changes described in the Araxis Merge diff file may include:
-
New record types
-
Elements (fields) that have been added, removed, or changed
-
New sublists (lists)
-
New joins
-
New search filters and search return columns
-
New platform operations
Using the Araxis Merge Diff File
The screenshots in this section are for illustrative purposes only. They do not reflect changes related to any specific endpoint.
The Araxis Merge diff file is generated using Araxis Merge. When you click the Araxis Merge diff file link (when it is available), a page appears that offers an overview of all schema changes.
The following screenshot shows how this summary page looks. In this example, the highlighted rows indicate that an XSD has been modified. The integers at the center indicate the number of changed lines in the file. To see the exact differences, click the report link in the column on the right or click the name of the file in either column.
![Araxis Merge summary page](img/AdditionalResources/Turing/ReleaseNotes/diffFileExample.png)
When you click any of these links, the Araxis Merge diff file shows a page with two columns. The previous version of the file is displayed on the left and the new version is displayed on the right. Changed elements are highlighted.
For example, the following screenshot shows an excerpt from the report on platform.commonTypes.xsd. Notice the addition of two values to the PermissionCode
enumeration: _accessPaymentAuditLog
and _advancedPDFHTMLTemplates
.
![Example showing differences between two files](img/AdditionalResources/Turing/ReleaseNotes/diffFileExample1.png)
The Araxis Merge diff file also shows changes to data types. The following screenshot is a snapshot of transactions.sales.xsd. Notice that the chargeType
element changed from an enumeration to a RecordRef.
![Example showing change to data type](img/AdditionalResources/Turing/ReleaseNotes/diffFileExample2.png)
2024.1 SOAP Schema Browser
The 2024.1 version of the SOAP Schema Browser is now available. You can find links to the SOAP Schema Browser in several places, including the following:
-
The help topic titled SOAP Schema Browser.
-
The reference page for each supported record in the SOAP Web Services Records Guide. The SuiteTalk SOAP Web Services Records Guide is available in the NetSuite Help Center and can be downloaded as a PDF from the User Guides topic.