Show Internal IDs Preference for SuiteScript in NetSuite

Enabling the display of internal IDs in your NetSuite account allows users to reference specific records and fields more easily, particularly in SuiteScript. Knowing internal IDs aids API jobs and other scripting activities by ensuring accurate calls to data structures.

How to Enable Internal IDs

To see the internal IDs within your NetSuite environment, follow these steps:

1. Navigate to Home > Set Preferences.
2. In the General subtab, check the Show Internal IDs box.
3. Click Save.

By configuring this user preference, you make the internal IDs accessible, which is especially beneficial for developers and administrators working with SuiteScript.

Important Note

When using SuiteScript, ensure that all internal IDs are specified in lowercase. This requirement is essential for the correct functioning of scripts and data management processes.

For developers referencing internal IDs in the SuiteScript API, examples can be found in methods such as record.load(options) and search.load(options). These methods rely on internal IDs to load existing records and saved searches effectively.

Best Practices

• Always check your scripts for case sensitivity with internal IDs to prevent errors.
• Familiarize yourself with the internal ID format in different contexts, as it helps streamline API processing tasks.
• Make sure to update internal IDs appropriately after any record changes to maintain data integrity within your scripts.

Who This Affects

• Administrators: Need to ensure the setting is enabled for users requiring access to internal IDs.
• Developers: Frequently utilize internal IDs when scripting and managing records.

By enabling the internal ID visibility, you enhance your ability to interact with various aspects of the NetSuite platform, making it a vital step for efficient record management and development.