Entity Custom Field

Custom entity fields are fields that you can add to your entity records to gather information specific to your business needs. Entity custom fields can be added to existing and custom subtabs on the entry forms you use to enter entity records in your NetSuite account.

For information about working with these fields in the UI, see Creating Custom Entity Fields.

The entity custom field record is defined in the setupCustom (customization) XSD.

Supported Operations

The following operations can be used with entity custom field.

Note:

You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Field Definitions

The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s entity custom field reference page.

Note:

For information about using the SOAP Schema Browser, see SOAP Schema Browser.

Code Sample

The following sample adds a custom field to the customer record.

Java

           public void testAddCustomField() throws Exception { EntityCustomField ClubCard = new EntityCustomField(); ClubCard.setLabel("Club-Card"); ClubCard.setAppliesToCustomer(Boolean.TRUE); ClubCard.setDefaultChecked(Boolean.FALSE); ClubCard.setFieldType(CustomizationFieldType._checkBox); c.addRecord(ClubCard); }

SOAP Request

           <soapenv:Body> <add xmlns="urn:messages_2017_1.platform.webservices.netsuite.com"> <record xsi:type="ns6:EntityCustomField" xmlns:ns6="urn:customization_2017_1.setup.webservices.netsuite.com"> <ns6:fieldType xsi:type="ns7:CustomizationFieldType" xmlns:ns7="urn:types.customization_2017_1.setup.webservices.netsuite.com">_checkBox</ns6:fieldType> <ns6:label xsi:type="xsd:string">Club-Card</ns6:label> <ns6:defaultChecked xsi:type="xsd:boolean">false</ns6:defaultChecked> <ns6:appliesToCustomer xsi:type="xsd:boolean">true</ns6:appliesToCustomer> </record> </add> </soapenv:Body>

SOAP Response

           <soapenv:Body> <addResponse xmlns="urn:messages_2017_1.platform.webservices.netsuite.com"> <writeResponse> <platformCore:status isSuccess="true" xmlns:platformCore="urn:core_2017_1.platform.webservices.netsuite.com"/> <baseRef scriptId="custentity2" internalId="358" type="entityCustomField" xsi:type="platformCore:CustomizationRef" xmlns:platformCore="urn:core_2017_1.platform.webservices.netsuite.com"/> </writeResponse> </addResponse> </soapenv:Body>