Name | Type | Cardinality | Label | Required | Help |
accessLevel |
CustomizationAccessLevel |
0..1 |
|
|
Set the default level of access for this field:
* 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. |
appliesToContact |
boolean |
0..1 |
|
|
Check this box to apply this field to your contact records. |
appliesToCustomer |
boolean |
0..1 |
|
|
Check this box to apply this custom field to your customer records. |
appliesToEmployee |
boolean |
0..1 |
|
|
Check this box to apply this custom field to your employee records. |
appliesToGroup |
boolean |
0..1 |
|
|
Check this box to apply this field to your group records. |
appliesToOtherName |
boolean |
0..1 |
|
|
Check this box to apply this custom field to your other name records. |
appliesToPartner |
boolean |
0..1 |
|
|
Check this box to apply this field to your partner records. |
appliesToPriceList |
boolean |
0..1 |
|
|
Check this box if you want this field to print on price lists. |
appliesToProject |
boolean |
0..1 |
|
|
Check this box to apply this custom field to your job records. |
appliesToStatement |
boolean |
0..1 |
|
|
Check this box if you want this field to print on customer statements. |
appliesToVendor |
boolean |
0..1 |
|
|
Check this box to apply this custom field to your vendor records. |
appliesToWebSite |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the registration form in your Web store.
When you check this box, the Customer:Job box is automatically checked.
Entity fields may not appear in your store without also appearing on your customer records. |
availableExternally |
boolean |
0..1 |
|
|
Check this box to make this custom field available on your external customer and partner forms. |
availableToSso |
boolean |
0..1 |
|
|
Check this box to make this field's values available as context data for SuiteSignOn integrations.
Once this box is checked, this field is listed on the User Identification subtab of the SuiteSignOn page.
For details about SuiteSignOn, see SuiteSignOnOverview. |
checkSpelling |
boolean |
0..1 |
|
|
Check this box to enable the spell check function for this field. |
customSegment |
RecordRef |
0..1 |
|
|
|
defaultChecked |
boolean |
0..1 |
|
|
|
defaultSelection |
RecordRef |
0..1 |
|
|
Enter a default value to appear in this custom field.
This value can still be changed if the field is not locked. |
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. |
deptAccessList |
CustomFieldDepartmentAccessList |
0..1 |
|
|
|
description |
string |
0..1 |
|
|
Enter a description of this field. |
displayHeight |
long |
0..1 |
|
|
|
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 |
|
|
Select a default option for this custom field. |
filterList |
EntityCustomFieldFilterList |
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 grayed out, ensure that Store Value is checked. If it is still grayed out, 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 entity 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 the field applies. |
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 the help topic Understanding Parent-Child Record Relationships. |
label |
string |
0..1 |
|
|
Enter a name for this custom entity field that is meaningful to your users. |
linkText |
string |
0..1 |
|
|
Enter the 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 |
|
|
|
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 |
|
|
|
searchDefault |
RecordRef |
0..1 |
|
|
Select a search with summary results, to be used to calculate a value for this custom field.
This kind of field displays a rollup value for a selected search results field; this value is dynamically calculated each time a form containing the summary search field is displayed. For example, you can display the total quantity of all line items on a transaction.
For more details, see Creating Custom Fields with Values Derived from Summary Search Results. |
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 entity field appear in the entity lists to which it is applied.
This box is not supported with Advanced Employee Permissions. To display custom fields on the Employees List page, you need to create a custom view that contains the custom fields. To do this, select Customize View from the Employees List page and manually add the custom fields. |
sourceFilterBy |
RecordRef |
0..1 |
|
|
When you are setting up filtering, select the field that you want to use to filter the list. |
sourceFrom |
RecordRef |
0..1 |
|
|
Choose the field that you want to source information from. The fields available are in the record selected in the Source List 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, if you are sourcing from a Phone Number field, you must choose Phone Number in the Type field. |
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. |
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. |
translationsList |
CustomFieldTranslationsList |
0..1 |
|
|
|