Records Catalog Fields Available for SuiteScript and Rest Query API

The Records Catalog is available for all users with the Records Catalog permission. To assign the Records Catalog permission, first select the role you want to allow access to the Records Catalog in Setup > Users/Roles > Manage Roles. On the role page, you can then add the permission to view the Records Catalog under Permission > Setup > Add (Records Catalog).

To open the Records Catalog go to Setup > Records Catalog or https://system.netsuite.com/app/recordscatalog/rcbrowser.nl.

An example of available fields in SuiteScript Analytic API for the Account Record Type.

1

Search fields - Search box for searching available fields using the field ID or its name.

2

Show Unavailable Fields Checkbox - Allows to show or hide fields and subrecords that are not available on the current user account.

3

Field ID - Field ID. To copy the field ID, click the Copy icon beside the field ID.

4

Name - Field name. To view field level help for a field, click the Information icon beside the field name.

5

Column Type - JavaScript data type of the field. If a field cannot be used as a column, but only for a join, N/A (Only for join) is shown.

6

Available/Unavailable Fields - Displays which fields are Available/Unavailable.

7

Feature – Displays information about feature that controls field corresponding line.

8

Permission - Displays permission that controls field corresponding line.

9

Join - Information about a possible join, such as record type name, record type script ID, and cardinality. Click the Information icon for more information about the join and other possible joins.

When you click SuiteScript and Rest Query API for a record type, you can see the fields available in the API, grouped by a record type (for example, Customer) or by its subrecords. For each field, the ID, name, column type, availability/unavailability, feature, permission, and join information are displayed.

Related Topics

SuiteScript and Rest Query API in Records Catalog
Records Catalog Joins Available for SuiteScript and Rest Query API

General Notices