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, department, and subsidiaries below. |
availableToSso |
boolean |
0..1 |
|
|
|
bodyAssemblyBuild |
boolean |
0..1 |
|
|
Check this box to apply this custom field to assembly builds. |
bodyBom |
boolean |
0..1 |
|
|
Check this box to print this field on bills of materials. |
bodyBTegata |
boolean |
0..1 |
|
|
Check this box to apply this custom field to Tegata. |
bodyCustomerPayment |
boolean |
0..1 |
|
|
Check this box if you want to apply this field to customer payments. |
bodyDeposit |
boolean |
0..1 |
|
|
Check this box to apply this field to deposits. |
bodyExpenseReport |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of expense reports. |
bodyInventoryAdjustment |
boolean |
0..1 |
|
|
Check this box to apply this custom field to inventory adjustments. |
bodyItemFulfillment |
boolean |
0..1 |
|
|
Check this box to apply this custom field to item fulfillments. |
bodyItemFulfillmentOrder |
boolean |
0..1 |
|
|
Check this box to make this custom field always display the value from the Sales Order on Item Fulfillments, but not allow editing on the fulfillment.
Note: To enable this, the Sale and Item Fulfillment boxes must also be checked. |
bodyItemReceipt |
boolean |
0..1 |
|
|
Check this box to apply this custom field to item receipts. |
bodyItemReceiptOrder |
boolean |
0..1 |
|
|
Check this box to make this custom field always display the value from the Purchase Order on Item Receipts, but not allow editing on the receipt.
Note: To enable this, the Purchase and Item Receipt boxes must also be checked. |
bodyJournal |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of journal entries. |
bodyOpportunity |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of opportunities. |
bodyOtherTransaction |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the following other transaction types:
* Statement Charge
* Commission
* Partner Commission
* Bin Transfer
* Bin Put-away Worksheet
* Payroll Liability Check
* Payroll Adjustment
* Sales Tax Payment
* Tax Liability Check
* Currency Revaluation (Unrealized Gain/Loss)
* Inventory Distribution
* Transfer |
bodyPickingTicket |
boolean |
0..1 |
|
|
Check this box to include this body field on picking tickets. The information that appears in this field is sourced from the sales transaction.
You must also check the Sale box to have this field appear on sales transactions. |
bodyPrintFlag |
boolean |
0..1 |
|
|
Check this box to print this custom field on standard forms.
This field prints on the standard forms for the kind of transactions you have applied this field to. |
bodyPrintPackingSlip |
boolean |
0..1 |
|
|
Check this box to include this body field on packing slips.
The information that appears in this field is sourced from the sales transaction.
You must also check the Sales box for this field to appear on sales transactions. |
bodyPrintStatement |
boolean |
0..1 |
|
|
Check this box to have the information entered in this body field on sales transactions print on your statements as a column.
You must also check the Sale box to add this field to sales transactions. |
bodyPurchase |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of purchase transactions. |
bodySale |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of sales transactions. |
bodyStore |
boolean |
0..1 |
|
|
Check this box to display this custom field on the checkout page of your web store transactions.
When you check this box, the Sale box is automatically checked because transaction body fields that appear in your web store must also appear on your sales transactions. |
bodyTransferOrder |
boolean |
0..1 |
|
|
Check this box to apply this custom field to the body of item transfers. |
bodyVendorPayment |
boolean |
0..1 |
|
|
Check this box to apply this field to vendor payments. |
checkSpelling |
boolean |
0..1 |
|
|
Check this box to enable the spell check function for this field. |
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 |
|
|
This field defines the selection list to display in the custom field by default. The choices are limited to the list selected in the List/Record field when creating this custom 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. |
deptAccessList |
CustomFieldDepartmentAccessList |
0..1 |
|
|
|
description |
string |
0..1 |
|
|
Enter a description of this field. |
displayHeight |
long |
0..1 |
|
|
Enter a height for the custom field in number of lines. 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 can be viewed in the page source. |
displayWidth |
long |
0..1 |
|
|
Enter a width for your custom field in columns. |
dynamicDefault |
CustomizationDynamicDefault |
0..1 |
|
|
Sets the preset defaulting options specific to the kind of field you are creating. |
filterList |
TransactionBodyCustomFieldFilterList |
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 dimmed, 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 |
|
|
Defines where the field is placed on records. This field lists custom fields of the same type that have already been created.
You can also choose to have the custom field span the column at the top or bottom respectively. This is especially useful to add a text area field at the top or bottom of a tab or section which provides explanatory information.
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 transactions you applied the field to. |
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, click see the help topic Understanding Parent-Child Relationships. |
label |
string |
0..1 |
|
|
Enter a name for this 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 |
|
|
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 |
|
|
Select a Compare To field from the selected search to provide a comparison that links joined records.
You can use this field 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.
For example, if you want to put a custom entity field showing the result of a customer record summary search on an employee custom form, you could select an employee record field whose values could be matched to the values for the search’s Available Filter field. Search results field values for all records with matching values for the Compare To field and Available Filter field would be used to calculate the value of the summary search custom field. |
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, department, 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 body field appear in transaction lists.
The field only appears for the transaction types it is applied to. |
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 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.
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 in the Subtabs section of the custom record type. |
translationsList |
CustomFieldTranslationsList |
0..1 |
|
|
|