Fields in SOAP Web Services

NetSuite records contain standard body fields and custom fields. Standard fields are those that come with all NetSuite accounts. In SOAP web services, a record's standard body fields are its attributes, for example: Customer.email, SalesOrder.salesRep. Standard fields must be of one of the following logical types.

Type	Description
String	Corresponds to the xsd:string type in the XML Schema
Int	Corresponds to the xsd:int type in the XML Schema
Double	Corresponds to the xsd:double in the XML Schema
Boolean	Corresponds to the xsd:boolean type in the XML Schema and has valid values of true or false. If not explicitly set to either true or false, then set as false.
Datetime	Corresponds to the xsd:dateTime type in the XML Schema which conforms to the ISO 8601 standard.
RecordRef	Corresponds to the RecordRef type in the XML Schema. References an nsKey value for any other record in the system including system defined constants that are controlled by the system.
Enum	Corresponds to a specific type defined as an enum in the XSD that represents system constants that are also available in the UI.
WsEnum	Corresponds to a specific type defined as an enum in the XSD that represents system constants that are NOT available in the UI.
List	A List references a type that is a list and should be explicitly defined in the in the XML Schema as a type. A list can either be null (if it is an optional field), or it must contain at least one entry unless otherwise noted.

Custom fields are those that have been created by NetSuite users to customize their accounts. Custom fields can be added to an account using point-and-click customization tools. They can also be added through the SOAP web services add operation. Custom fields must be one of the types defined in Custom Field Types.

On records, custom fields are contained in the customFieldList property. For more details, see CustomFieldList.

Note:

If you are getting unusual results in your SOAP web services queries, it may be that a standard field has been customized.

Consider the following general guidelines when working with both standard and custom fields.

If a standard field is set as mandatory in a custom form, the “requiredness” of the field is honored in SOAP web services. If you do not provide value in your SOAP web services request for a field that is set as mandatory in a custom form, an error message is returned. For more information on NetSuite form types, see Custom Forms.
Customizations made to standard fields are honored in SOAP web services. For example, if a standard field is set as disabled, it is not settable through SOAP web services, either. If you try to set such a field through SOAP web services, an error message is returned.
If a standard field is set to NOT show in the UI, it is not settable through SOAP web services, either. If you try to set such a field through SOAP web services, an error message is returned.
Custom display only (inline) and disabled fields are not settable through SOAP web services because these are NOT settable through the UI. If you provide a value in your SOAP web services request for such a field, an error message is returned. For information on field display types, see Setting Display Options for Custom Fields.
The behavior of custom hidden fields varies depending on the endpoint being used. If you are using any endpoint since the 2011.2 endpoint (including 2011.2), the get operation does not return the value of custom hidden fields. If you are using an older endpoint, these values are gettable. By comparison, in the UI, these values cannot be seen.

If you are using the 2011.1 endpoint or earlier, the value of custom hidden fields is returned regardless of the setting of the ignoreReadOnlyFields preference.

Custom hidden fields cannot be set, either in the user interface or using SOAP web services, regardless of the endpoint.
Defaulted fields that are set to blank on a SOAP web services update will stay blank on update.
The bodyFieldsOnly request-level preference affects the way formulas on forms are processed. As a result, if the values of custom fields are calculated using formulas, the search might return incorrect results. If the calculated values of formulas are incorrect, set the bodyFieldsOnly preference to false to make sure the correct values are returned. For more information, see Request-Level Preferences.

Note:

If you are unfamiliar with NetSuite custom fields, you should see Custom Fields. This section describes the purpose and general characteristics of each custom field type, which will help you when working with the SOAP customization API (described in Customization).

Related Topics