CustomerName Property

Customer's name.

Syntax

 customer.getCustomerName([callback])
 customer.setCustomerName( customerName, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCustomerName([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCustomerName([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The customer's name.

In Customer objects that are sub-customers or jobs the CustomerName will be different from the FullName. The FullName may be formed by combining CustomerName with the names of all ancestors, and separating with a colon: for example, "Parent Customer:Full Customer".

FullName is also available as a special field, and may be accessed via Config.

This property is required in Add operations only.

Data Type

String