Custom Field Types

Custom fields are represented by the type CustomFieldRef, which is an abstract type. The table below contains a list of concrete custom field types that extend the CustomFieldRef type. Each type is followed by its corresponding type in the UI.

XML Schema Type

Custom Field Type in UI

LongCustomFieldRef

Integer

DoubleCustomFieldRef

Decimal Number

BooleanCustomFieldRef

Check Box

StringCustomFieldRef

Free-Form Text
Text Area
Phone Number
E-mail Address
Hyperlink
Rich Text

DateCustomFieldRef

Date
Time of Day

or Date/Time (both in one field)

SelectCustomFieldRef

List/Record
Document

MultiSelectCustomFieldRef

Multiple Select

CustomFieldRef

The CustomFieldRef type is an abstract type.

Field Name

XML Schema Type

Req

Notes

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

To locate the internal ID for a specific custom field in the UI, go to Customization > Lists, Records, & Fields > [Custom Field] (where [Custom Field] is the type of custom field such as CRM). The internal IDs for each custom field that has been created is listed in the ID column in the UI.

LongCustomFieldRef

The LongCustomFieldRef type extends the CustomFieldRef abstract type.

Field Name

XML Schema Type

Req

Notes

value

xsd:int

Y

 

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

DoubleCustomFieldRef

The DoubleCustomFieldRef type extends the CustomFieldRef abstract type.

Field Name

XML Schema Type

Req

Notes

value

xsd:double

Y

 

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

BooleanCustomFieldRef

The BooleanCustomFieldRef type extends the CustomFieldRef abstract type.

Field Name

XML Schema Type

Req

Notes

value

xsd:boolean

Y

 

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

StringCustomFieldRef

The StringCustomFieldRef type extends the CustomFieldRef abstract type.

Field Name

XML Schema Type

Req

Notes

value

xsd:string

Y

 

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

DateCustomFieldRef

The DateCustomFieldRef type extends the CustomFieldRef abstract type.

Field Name

XML Schema Type

Req

Notes

value

xsd:datetime

Y

 

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

SelectCustomFieldRef

The SelectCustomFieldRef type extends the CustomFieldRef abstract type. This references a single ListOrRecordRef and also requires an InternalId attribute to indicate the field name.

Field Name

XML Schema Type

Req

Notes

value

ListorRecordRef

Y

A single ListOrRecordRef.

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

MultiSelectCustomFieldRef

The MultiSelectCustomFieldRef type extends the CustomFieldRef abstract type. This references an array of ListOrRecordRef's and also requires an internalId attribute to indicate the field name.

Field Name

XML Schema Type

Req

Notes

value

ListorRecordRef[]

Y

An array of type RecordRef

internalId

xsd:string (attribute)

Y

References a unique instance of a custom field type.

CustomFieldList

Field Name

XML Schema Type

Req

Notes

value

customFieldRef []

Y

An array of type customFieldRef. The actual entries in the array will be of a concrete type that extends customFieldRef.

The following is an XML excerpt from a SOAP body that illustrates a custom field list that contains all the available custom field types.

SOAP Sample

          <listRel:customFieldList xmlns:platformCore="urn:core_2017_1.platform.webservices.netsuite.com">
 <platformCore:customField internalId="526" scriptId="custentity_exchange_rate" xsi:type="platformCore:DoubleCustomFieldRef">
   <platformCore:value>2.35</platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="524" scriptId="custentity_soft_skills" xsi:type="platformCore:MultiSelectCustomFieldRef">
   <platformCore:value internalId="1">
      <platformCore:name>Communication</platformCore:name>
   </platformCore:value>
   <platformCore:value internalId="5">
      <platformCore:name>Teamwork</platformCore:name>
   </platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="146" scriptId="custentity_checkbox" xsi:type="platformCore:BooleanCustomFieldRef">
   <platformCore:value>false</platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="525" scriptId="custentity_first_contact" xsi:type="platformCore:DateCustomFieldRef">
   <platformCore:value>2017-03-16T00:00:00.000-07:00</platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="324" scriptId="custentity_proficiency_level" xsi:type="platformCore:SelectCustomFieldRef">
   <platformCore:value internalId="2">
      <platformCore:name>Medium</platformCore:name>
   </platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="72" scriptId="custentity_franchiseeabn_on_customerrec" xsi:type="platformCore:StringCustomFieldRef">
   <platformCore:value>{‌partner.vatregnumber}</platformCore:value>
 </platformCore:customField>
 <platformCore:customField internalId="424" scriptId="custentity_test_score" xsi:type="platformCore:LongCustomFieldRef">
   <platformCore:value>25</platformCore:value>
 </platformCore:customField>
</listRel:customFieldList> 

        

Related Topics

General Notices