EntityName Property
An entity name to search for in a transaction.
Syntax
objsearch.getEntityName([callback]) objsearch.setEntityName( entityName, [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 getEntityName([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 setEntityName([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
An entity name to search for in a transaction. Limits the search to transactions associated with the entity specified by EntityName. For example, if searching for an Invoice EntityName would be the full name of a Customer.
Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityName field, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyName field.
Data Type
String