This notice applies to accounts who use generally available REST records that contain enumerator fields.
As of NetSuite Release 2021.1, enumerator field values will be returned in a complex format in REST web services.
This change will go into effect when your account is upgraded to NetSuite Release 2021.1.
What is Changing?
The default behavior of the GET operation will change as of 2021.1.
Currently, the values of enumerator fields are returned in an enumeration-key format in REST web services, and only the internal ID of the enumerator field is used in the REST response.
As of 2021.1, both the internal ID and the UI label of enumerator fields will be returned by default.
It is recommended that you start using the new default format. To continue using the previous response format, you must use the simpleEnumFormat=true URL parameter in GET operations.
The POST, PATCH, and PUT operations will not be affected by this change, and you can specify enumerator field values in the REST request body in both formats.
The following example shows a REST response in the current format. Only the internal ID of the enumerator field is returned.
GET /record/v1/contact/81
{
...
"globalSubscriptionStatus": "2"
...
}
The following example shows a REST response in the new format. Both the internal ID and the UI label of the enumerator field are returned.
GET /record/v1/contact/81
{
"globalSubscriptionStatus": {
"id": "2",
"refName": "Soft Opt-Out"
}
}
The following example shows a request where the simpleEnumFormat query parameter is used to specify that the response should be returned in the current response format, instead of the new one.
GET /record/v1/contact/81?simpleEnumFormat=true
{
...
"globalSubscriptionStatus": "2"
...
}
Affected Record Types
The following table lists the generally available record types that contain enumerator fields and will be affected by the change.
Record type
Enumerator fields
Billing account
- cashSaleForm
- customForm
- frequency
- invoiceForm
Charge
- billingMode
- customForm
- stage
Contact
- customForm
- globalSubscriptionStatus
Email template
Journal entry
Price book
Price plan
Subscription
- advanceRenewalPeriodUnit
- billingSubscriptionStatus
- customForm
- defaultRenewalMethod
- frequency
Subscription line
- billingMode
- catalogType
- customForm
- revRecOption
- subscriptionLineStatus
- subscriptionLineType
Subscription plan
- advanceRenewalPeriodUnit
- customForm
- defaultRenewalMethod
- defaultRenewalTranType
Subsidiary
Usage
Required Actions
You must update your client application to handle enumerator field values that will be returned in the new default format.
If you cannot make changes to your client application and you want to continue using the current response format, you must use the simpleEnumFormat=true URL parameter in the REST request as shown in the example above.
If you require assistance or more information, please contact NetSuite Customer Support.