The Records Catalog is a contextual reference tool that describes the NetSuite model structure and behavior. This tool supports users in developing integrations, adopting new features, and learning about the NetSuite model. Within the Records Catalog, you can find information about the record types and fields available for specific NetSuite channels. This dynamic NetSuite model reflects the customizations and features enabled or disabled in your account.
Developers, administrators, and system users need to clearly understand the NetSuite model to achieve a particular task in NetSuite. The Records Catalog provides information about the records that can be used with different technologies and provides general information such as record type name, record family, ID, and origin.
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 permission to view the Records Catalog under Permission > Setup > Add (Records Catalog).
In the available channels for a record type, you can find the SuiteScript and Rest Query API. The SuiteScript and Rest Query API includes data for creating constructed queries and SuiteQL queries using the SuiteScript N/query module.
SuiteQL provides advanced query capabilities you can use to access your NetSuite records and data, and it supports querying the analytics data source. SuiteQL is currently available using SuiteAnalytics Connect, the N/query module in SuiteScript, and SuiteTalk REST web services.
To open the Records Catalog go to Setup > Records Catalog or https://system.netsuite.com/app/recordscatalog/rcbrowser.nl.
The Records Catalog displays fields or joins available for the record type, field level help, and other information.
The list of record types provides available functions such as SuiteScript Analytic API. For more information about fields and joins available for SuiteScript Analytic API, see SuiteScript and Rest Query API in Records Catalog. .
| 1 | Record Type Filtering – Search box for searching record types using keywords. |
| 2 | Global Field Search – Search label or scriptId of a field within record type’s structure. |
| 3 | A-Z Index – Alphabetical index that allows you to jump to record types beginning with a specific letter. All is selected by default. |
| 4 | Record Types – List of available record types including the name and script ID for each. |
| 1 | Available channels – List of available channels, for example, APIs. |
| 2 | Record Type Name and script ID – The name and script ID of the record type. The script ID is the identifier of record types in all APIs. |
| 3 | Original Name – Original name of the record type, in case you changed the record type name. |
| 4 | Record Family – Record family to which the record belongs. Record family can be either CRM, Entity, Item, Transaction, or Other. |
| 5 | ID – Script ID. |
| 6 | Origin – Origin of the record, either System (provided by NetSuite) or Custom (additional record type created in this specific account). |