NetSuite Internal IDs and Field IDs

FarApp communicates with NetSuite using internal IDs and field IDs. For example, an order ID like SO12345 is the order ID you see in NetSuite but when you view the order, the internal ID (which is just an integer) will display in your URL. This is the internal ID. Likewise, a field like “Item Name/Number” has a field ID of itemId. There is no way for FarApp to communicate with NetSuite using the visible transaction numbers, entity IDs, or field labels you see in NetSuite.

Unfortunately if you change the field labels in NetSuite for NetSuite's standard fields, there's no way for FarApp to look up the field IDs it needs. So say for example you modify NetSuite's standard customer Category field (which has field ID category) to be named Class instead of Category, FarApp has no way of knowing that your Class field now represents field ID category. So you'll need to let us know what the field ID is and not the label.

Practically every record in NetSuite has an internal ID and every field in NetSuite has a field ID. These IDs are the permanent IDs associated with the records and fields and are often visible in the URL when viewing a record in NetSuite.

Exposing NetSuite Internal IDs and Field IDs

  1. As Administrator, go to Setup > Company > Enable Features > SuiteCloud and check the box for Client SuiteScript if it hasn’t already been checked.
  2. Go to Home > Set Preferences > General Tab > Set Defaults and check the box for Show Internal IDs if it hasn’t already been checked.

View field IDs: Click on the label of any form field to reveal the underlying field ID name for that element. You’ll see the field ID in the bottom right-hand corner of the pop-up when you click a label. For example, to find the field ID of your Class field in the example above, open up a customer record, click on the "CLASS" label, and you should see that the field ID is "category" at the bottom-right of the pop-up.

These field IDs are in NetSuite “SuiteScript” format which means that standard NetSuite field IDs (i.e. non-custom fields) will be all lowercase. FarApp communicates with NetSuite using “SuiteTalk” and not “SuiteScript”. In SuiteTalk, all field IDs are camel-case. For example, NetSuite’s Item Name/Number field ID is itemid in SuiteScript but itemId in SuiteTalk. You can find all the standard SuiteTalk field IDs for all NetSuite records here: https://system.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2016_1/schema/record/account.html. To find the valid field IDs for inventory items, click on "I" at the top of the schema browser (this will show all records starting with the letter "I"), then in the left-hand column, click on "InventoryItem". All the valid field IDs will be in the "Name" column in the main pane.

View internal IDs: After exposing NetSuite's internal IDs, lists will now show the internal IDs for each item. As you run searches and lists, the internal ID will automatically be shown in the results.

Comments