Name | Type | Cardinality | Label | Required | Help |
accessLevel |
CustomizationAccessLevel |
0..1 |
|
|
Set the level of access you want to given to this field by default:
* Edit – The field and its contents can be viewed and changed.
* View – The field can be seen, but its contents cannot be changed.
* None – The field cannot be seen, and its contents cannot be changed.
You can set the access level for specific roles, departments, and subsidiaries below. |
appliesToGroup |
boolean |
0..1 |
|
|
Check this box to apply this custom field to item group records. |
appliesToInventory |
boolean |
0..1 |
|
|
Check this box to apply this custom field to inventory item records. |
appliesToItemAssembly |
boolean |
0..1 |
|
|
Check this box to have your custom field appear on assembly/bill of materials records. |
appliesToKit |
boolean |
0..1 |
|
|
Check this box to apply this custom field to kit/package items. |
appliesToNonInventory |
boolean |
0..1 |
|
|
Check this box to apply this custom field to non-inventory item records. |
appliesToOtherCharge |
boolean |
0..1 |
|
|
Check this box to apply this custom field to other charge item records. |
appliesToPriceList |
boolean |
0..1 |
|
|
Check this box if you want this field included on printed price lists. |
appliesToService |
boolean |
0..1 |
|
|
Check this box to apply this custom field to service item records. |
availableToSso |
boolean |
0..1 |
|
|
|
checkSpelling |
boolean |
0..1 |
|
|
Check this box to enable the spell check function for this long text, rich text, text area, or free-form text field. Spell check is only available for non-column fields and cannot be used on sublists and online forms. |
customSegment |
RecordRef |
0..1 |
|
|
|
defaultChecked |
boolean |
0..1 |
|
|
If this custom field is a check box, check this box to have the field appear checked by default.
The field can still be unchecked if it is not locked. |
defaultSelection |
RecordRef |
0..1 |
|
|
Select a default option to appear automatically in your custom List/Record field. |
defaultValue |
string |
0..1 |
|
|
Enter a default value to appear in this custom field.
This value can still be changed if the field is not locked.
Note: If you are using a formula to define this value, the Store Value box must be cleared. |
deptAccessList |
CustomFieldDepartmentAccessList |
0..1 |
|
|
|
description |
string |
0..1 |
|
|
Enter a description of this field. |
displayHeight |
long |
0..1 |
|
|
Enter a height in number of lines for the custom field. The default is three lines. |
displayType |
CustomizationDisplayType |
0..1 |
|
|
Select the type of display you want this field to have:
* Normal - Can be edited. You can use this field with custom code calculations, defaulting and sourcing information.
* Disabled - Cannot be edited. You can use this field with custom code calculations, defaulting and sourcing information only. Any field with a display type of disabled that does not have default, sourced or custom code information will not display on forms.
Note: You cannot disable a mandatory field unless the field has a default value.
* Inline Text - For informational purposes only. The information in this field is the result of custom code calculation, defaulting or sourcing information only. Inline text field of the List/Record or Check Box type are not available for use with custom code. These fields are also not available for transaction column fields.
* Hidden - Cannot be seen on the record or transaction you apply it to. You can perform a search to display the value of this field. The information in this field is the result of custom code calculations and defaulting information. You must use custom code or set a default for this field. Note that you can also define a field as shown in its custom field definition, and then selectively hide it on a form-by-form basis.
In SuiteScript, only user event, scheduled, and Suitelet scripts can set the value of a custom field that has a display type of hidden.
Warning: Hiding a custom field is a display convenience only. This is not field level security. Hidden custom fields are embedded in the page output and viewable in the page source. |
displayWidth |
long |
0..1 |
|
|
Enter a width in columns for your custom field. |
dynamicDefault |
CustomizationDynamicDefault |
0..1 |
|
|
Dynamic default allows you to select from preset defaulting options specific to the kind of field you are creating. There are the following types of dynamic defaults:
* Current Date/Time: For Date fields, select this to have your custom field automatically filled with the current date or time. For example, you can add an information only date field to your sales orders. Setting the field to current date and time allows you to track when your sales reps are most productive.
* Current User: For Employee List/Record fields, select this to have the name of the employee entering the record or transaction automatically filled in this field. For example, if you have data entry employees as well as sales reps, you can add a field to your transactions to record who enters the transaction as well as the sales rep who made the sale.
* Current User's Supervisor: For Employee List/Record fields, select this to have the name of the supervisor selected on the employee record automatically filled in this field. For example, you can create a field for your task records that lists the Assignee’s supervisor. This can help your management team stay informed of the projects their teams are working on.
* Current User's Department: For Employee List/Record fields, select this to have the name of the department selected on the employee record automatically filled in this field.
* Current User's Location: For Employee List/Record fields, select this to have the name of the location selected on the employee record automatically filled in this field. |
filterList |
ItemCustomFieldFilterList |
0..1 |
|
|
|
globalSearch |
boolean |
0..1 |
|
|
Check this box to index this custom field for global search, so that this field's values are searched for matches to global search keywords, and records with matches are returned as global search results.
If this box is unavailable, ensure that Store Value is checked. If it is still unavailable, global search indexing is not supported for the selected data type. |
help |
string |
0..1 |
|
|
Enter a brief explanation of the kind of information you want entered in this field.
This help is available when the name of the field is clicked.
You can enter HTML in this field, but be sure to begin the code with <html> and end it with </html>. |
insertBefore |
RecordRef |
0..1 |
|
|
Select the placement of this field on transactions in relation to other custom fields.
This field lists custom item fields that have already been created.
Note: This only affects the placement of fields on standard forms and on the placement of newly created fields. To change the arrangement of fields on a custom form, you must edit the custom form. |
isFormula |
boolean |
0..1 |
|
|
If enabled, the Default Value is set as a formula field. Formula fields use NetSuite Tags and SQL Expressions to dynamically calculate values based on field data in the system. |
isMandatory |
boolean |
0..1 |
|
|
Check this box to require this field on the records where you applied the field. |
isParent |
boolean |
0..1 |
|
|
If you are creating a List/Record custom field, check this box to indicate that the record type selected is a parent record.
This field is used to create a parent-child relationship between two record types.
For more information, see Understanding Parent-Child Record Relationships. |
itemMatrix |
boolean |
0..1 |
|
|
Check this box to indicate that this field is an option for matrix items.
Checking this box automatically sets the Type field to Multiple Select and the Subtab field on the Display subtab to Matrix. Changing any of these settings clears the Matrix Option box. |
itemSubType |
ItemCustomFieldItemSubType |
0..1 |
|
|
Choose to apply this custom field to items available only for purchase, only for sale or both for purchase and sale.
Item subtypes only apply to non-inventory, service and other charge item records. |
label |
string |
0..1 |
|
|
Enter a name for this field that is meaningful to your users. |
linkText |
string |
0..1 |
|
|
If desired, enter text to display instead of a URL for hyperlink fields. Users will see this text instead of the URL. Clicking the text links to the URL. |
maxLength |
long |
0..1 |
|
|
Enter a maximum number of characters for free-form text and text area custom fields. |
maxValue |
double |
0..1 |
|
|
Enter a maximum value for decimal, integer number, and percent custom fields.
The maximum amounts for percent fields can be greater than 100. If you do not enter a maximum value for a percent field, the maximum is 100. |
minValue |
double |
0..1 |
|
|
Enter a minimum value for decimal, integer number, and percent custom fields.
The minimum amounts for percent fields can be less than zero. If you do not enter minimum value for a percent field, the minimum is 0. |
owner |
RecordRef |
0..1 |
|
|
Select the owner of this field. Only the owner can edit this record. |
parentSubtab |
RecordRef |
0..1 |
|
|
|
roleAccessList |
CustomFieldRoleAccessList |
0..1 |
|
|
|
searchCompareField |
RecordRef |
0..1 |
|
|
If you want values for this custom field to be based on summary search results, you can select a comparison field. The comparison field joins related records in cases where you want to put the custom field on a form for a record type that is different from the summary search record type.
This is only available for custom fields and data types that support summary search derived values. |
searchDefault |
RecordRef |
0..1 |
|
|
If you want values for this custom field to be based on search results, select the summary search. This is only available for custom fields and data types that support summary search derived values. |
searchLevel |
CustomizationSearchLevel |
0..1 |
|
|
Choose the level of access you want given by default to this field on reports and search.
* Edit – The field and its contents can be viewed and changed.
* Run – The field can be seen, but its contents cannot be changed.
* None – The field cannot be seen, and its contents cannot be changed.
You can set the access level for specific roles, departments, and subsidiaries below. |
selectRecordType |
RecordRef |
0..1 |
|
|
If you chose List/Record in the Type field, select a custom list or list of records to use with this field.
You must choose List/Record in the Type field before you can select a list. |
showInList |
boolean |
0..1 |
|
|
Check this box to have your custom item field appear in your items list. |
sourceFilterBy |
RecordRef |
0..1 |
|
|
Select the field to filter by. This field must be in the record type selected as the list/record. |
sourceFrom |
RecordRef |
0..1 |
|
|
Choose the name of the field you want to copy information from.
You must choose a source list before you can choose your source field.
The field you choose must match the type you chose in the Type field. For example, if you are sourcing from a Phone Number field, you must choose Phone Number in the Type field. |
sourceList |
RecordRef |
0..1 |
|
|
Choose the name of the list you want to copy information from.
You must choose a source list before you can choose your source field.
The field you choose must match the type you chose in the Type field. For example, you can source information from the vendor record that appears in the Preferred Vendor field on item records. |
storeValue |
boolean |
0..1 |
|
|
This field is checked by default, meaning that information entered is stored in the custom field.
Clear this box to indicate that any changes entered not be stored in the custom field. This enables you to look at data that is stored elsewhere. If you do not store the value, changes will be discarded, so you may want to make the field read-only.
If the custom field is used for criteria in duplicate detection, you cannot clear the Store Value box. |
subAccessList |
CustomFieldSubAccessList |
0..1 |
|
|
|
subtab |
RecordRef |
0..1 |
|
|
Choose the subtab you want this field to appear on.
You can create new subtabs for your records at Customization > Forms > Subtabs.
If you have checked the Matrix Option box, the subtab is automatically set to Matrix. |
translationsList |
CustomFieldTranslationsList |
0..1 |
|
|
|