Showing Record and Field IDs in Your Account
Records and fields are referenced in SuiteScript through their internal IDs. Internal IDs are unique identifiers that are associated to a record or field, and remains constant even if the record or field value is changed.
To configure your NetSuite account to display record and field IDs, see Show Internal IDs Preference.
If the Show Internal IDs preference is already checked, read the following sections for information about viewing internal IDs from within NetSuite:
Show Internal IDs Preference
Before you can see the record or field IDs in your NetSuite account, you must configure your user preference to display internal IDs.
To show internal NetSuite IDs:
-
Go to Home > Set Preferences.
-
On the General subtab, check the Show Internal IDs box.
-
Click Save.
For examples of how internal IDs are referenced in the SuiteScript API, see record.load(options) or search.load(options).
When writing SuiteScript, all internal IDs used must be in lowercase.
Finding Internal IDs of Records
In NetSuite, each record is assigned an internal ID when it is created. If the Show Internal IDs preference box is checked, an Internal ID column is shown when viewing record lists.
For example, to see the internal IDs of customer records, go to Lists > Relationships > Customers (Administrator). The internal ID of each record in the customer record list is found under the Internal ID column (see the following screenshot).
When the Show Internal IDs preference is cleared, or if the internal IDs do not appear on a particular page within NetSuite, you can see the record's internal ID by hovering over a link to that record. The internal ID is shown as a parameter in the URL in the browser status bar.
The following screenshot shows that if you hover over a link to the ABC Co. customer record, the internal record ID (1766) appears in the browser status bar.
You obtain the internal ID of a record type (for example, ‘salesorder’) by going to the SuiteScript Records Browser. For information about using the SuiteScript Records Browser, see Working with the SuiteScript Records Browser in the NetSuite Help Center.
Finding Internal IDs of Record Fields
Internal field IDs must be used when referring to a field using SuiteScript APIs. The following sections show the different ways to view a field’s internal ID:
Because not all fields are visible to NetSuite users, the SuiteScript Records Browser can be used to find the internal ID of any field.
Internal IDs for Standard and Custom Fields in Field Level Help Window
When the Show Internal IDs preference box is checked, you can view internal field IDs for both standard and custom fields by clicking the field label in the UI. The following screenshot shows the Field Level Help window that opens when you click a field label. In the example, the Company field label is clicked. The internal ID for the Company field is companyname, which appears in the bottom-right corner of the Field Level Help window.
When creating custom fields, you can specify your own field ID or you can accept the default ID assigned by NetSuite. To ensure that the field IDs make sense in the context of your business environment, you should define your own custom field IDs. For detailed information about creating custom fields and assigning custom field IDs, refer to Custom Fields.
Internal IDs for Custom Fields on List Pages
When the Show Internal IDs preference box is checked, internal IDs for each custom field are shown in the Internal ID column of a custom field page. For example, to see the internal IDs for custom CRM fields, go to Customization > Lists, Records, & Fields > CRM Fields (Administrator). The ID column appears in the list of custom fields as shown in the following screenshot.
