EntityId Property

Limits the search to transactions associated with the entity specified by EntityId .

Syntax

 objsearch.getEntityId([callback])
 objsearch.setEntityId( entityId, [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 getEntityId([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 setEntityId([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

Limits the search to transactions associated with the entity specified by EntityId. Note that you may use EntityName OR EntityId to search, but you may not use both.

Only applicable to searches for transaction objects, with the following exceptions: BillToPay queries map this to the PayeeEntityId property, and ItemAssembliesCanBuild queries map this to the ItemInventoryAssemblyId property.

Data Type

String