How to Find a Field's Internal ID

Note:

This topic applies to all versions of SuiteScript.

Internal field IDs must be used when calling a field from a SuiteScript API.

Tip:

To determine if Show Internal IDs is enabled , see Setting the Show Internal IDs Preference.

There are multiple ways to view a field’s internal ID:

Some fields are not displayed to users in NetSuite. Use the SuiteScript Records Browser to find internal IDs for those fields.

Internal IDs for Standard and Custom Fields in Field Level Help Window

With Show Internal IDs enabled, you can also view internal field IDs for both standard and custom fields, by clicking the field label in the UI. The figure below shows the Field Level Help window that opens when a field label is clicked, in this case, the Company label. The internal ID for the Company field is companyname, which appears in the bottom-right corner of the Field Level Help window.

Internal IDs for Standard and Custom Fields in Field Level Help Window section of the Configuring NetSuite for SuiteScript page
Note:

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, it is recommended that you define your own custom field IDs. For detailed information on creating custom fields and assigning custom field IDs, refer to Custom Fields in the NetSuite Help Center.

Internal IDs for Custom Fields on List Pages

When the Show Internal IDs preference is enabled, internal IDs for each custom field are displayed 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. The ID column appears in the list of custom fields, as shown in the figure.

Internal IDs for Custom Fields on List Pages section of the Configuring NetSuite for SuiteScript page

Related Topics

Showing Record and Field IDs in Your Account
How to Find a Record's Internal ID

General Notices