Working with the SuiteScript Records Browser

To access the SuiteScript Records Browser, use the following link:

Go to the SuiteScript Records Browser

Important:

When writing SuiteScript, you must use the IDs listed in the NetSuite Help Center. Although you can access the IDs by viewing page source on a NetSuite record, there is no guarantee that all IDs in the source code are supported in SuiteScript. If you create a script that references an unsupported or undocumented ID, and the ID is later changed by NetSuite, your script may break.

Not every field that appears in the SuiteScript Records Browser can be set using SuiteScript. Some fields are read only. You must check the NetSuite UI to know whether a field can be set. In general, if you can set a field in the UI, you can set it using SuiteScript. If you cannot set a field in the UI, you cannot set it using SuiteScript. However, you can still get the field's value using SuiteScript.

The SuiteScript Records Browser provides a summary of all records, fields, sublists, search joins, search filters, search columns, and record transformations that are supported in SuiteScript. Information about elements is displayed as a series of tables.

To find SuiteScript-supported records and IDs:

Open the SuiteScript Records Browser.

Only records that officially support SuiteScript are listed in the SuiteScript Records Browser.
Click the record you want to reference in SuiteScript.

You will see all IDs currently supported for the record.

The following table provides examples of objects and methods that use each type of ID:

ID Type	Object Examples	Method Examples
Field IDs	serverWidget.Field record.Field record.Record currentRecord.CurrentRecord	Record.getField(options) CurrentRecord.getField(options) Record.setValue(options) CurrentRecord.setValue(options) record.submitFields(options) search.lookupFields(options)
Sublist and sublist field IDs	serverWidget.Sublist	Record.commitLine(options) CurrentRecord.commitLine(options) Record.getCurrentSublistValue(options) CurrentRecord.getCurrentSublistValue(options) Record.insertLine(options) CurrentRecord.insertLine(options) Record.setSublistValue(options)
Search join, filter, and column IDs	search.Search search.Filter search.Column search.Result search.ResultSet	search.create(options) search.load(options) search.createFilter(options) search.createColumn(options)
Transformation IDs	record.Record	record.transform(options)

ID Type

Object Examples

Method Examples

Field IDs

Sublist and sublist field IDs

serverWidget.Sublist

Search join, filter, and column IDs

Transformation IDs

record.Record

record.transform(options)

As you use the SuiteScript Records Browser, consider the following:

You can use the Records Browser online, or you can download it. For information about downloading the browser, see Downloading the SuiteScript Records Browser.
For information about governance applied to individual SuiteScript APIs, and about various SuiteScript script types, see SuiteScript Governance and Limits.
Only the Records Browser for the most recent release of NetSuite is supported. Older versions may still be accessible, but they are not supported.
Green highlighting indicates anything new in the current release.

For more details, see the following topics:

Related Topics