Exposing Internal IDs and Field IDs in NetSuite

TL;DR

This article explains how to expose internal IDs and field IDs in NetSuite, which are crucial for record identification and API interactions. Understanding these IDs can streamline development and integration tasks.

What Are Internal IDs and Field IDs?

Every record in NetSuite is assigned an internal ID, and similarly, each field has a designated field ID. These IDs serve as permanent identifiers for records and fields, often visible in the URL when viewing a record. They play a significant role in SuiteScript and SuiteTalk APIs, facilitating seamless data access and manipulation.

How to Enable Display of Internal IDs and Field IDs

To view internal IDs and field IDs in your NetSuite account, follow these steps:

1. Enable Client SuiteScript

To use SuiteScripts for exposing these IDs, ensure that Client SuiteScript is enabled:

1. Log in with an Administrator role and navigate to Setup > Company > Enable Features.
2. Click the SuiteCloud subtab.
3. Check the Client SuiteScript box.
4. Click Save.

2. Enable Show Internal IDs Preference

Next, you need to configure your preferences to display these IDs:

1. Click on the Home icon and select Set Preferences.
2. Under the General subtab, in the Defaults section, ensure the Show Internal IDs box is checked.
3. Click Save.
   After these settings are saved, field IDs can be viewed through the Field Level Help popup that appears when you click a field's label.

When performing a record search, the results will list the internal ID for each record in the corresponding column, making it easier to manage data.

Understanding Field ID Formats

Field IDs use specific formats based on the API being utilized:

• SuiteScript: Standard field IDs, primarily for SuiteScript usage, are in lowercase (e.g., itemid for Item Name/Number).
• SuiteTalk: When interacting with SuiteTalk, all field IDs are presented in camel case (e.g., itemId).

Schema Browser

To explore standard SuiteTalk field IDs and internal IDs of records, use the Schema and Records Browser. You can find valid field IDs for various entities by navigating through the browser:

1. Click on the Schema Browser tab for field IDs.
2. Click Records Browser for overall record IDs.
3. To locate a specific entity, select the corresponding initial from the alphabetical row, such as ‘I’ for inventory items.

Best Practices

• Check the Show Internal IDs preference regularly to streamline your API interactions.
• Familiarize yourself with the differences in ID formats to prevent errors during API calls, especially between SuiteScript and SuiteTalk.

Key Takeaways

• NetSuite records require internal IDs and fields have field IDs for accurate referencing.
• Enable Client SuiteScript and the Show Internal IDs preference to view IDs.
• Understand the formatting differences between SuiteScript and SuiteTalk field IDs.

Source: This article is based on Oracle's official NetSuite documentation.