Setting.value

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The value of the search parameter.

This property is set when you call search.createSetting(options). If you specify consolidationtype as the search parameter name (Setting.name), the following values are supported for this parameter:

ACCTTYPE
AVERAGE
CURRENT
HISTORICAL
NONE

If you specify includeperiodendtransactions as the search parameter name (Setting.name), the following values are supported for this parameter:

F
FALSE
T
TRUE

These values are not case sensitive.

Type

string

This property is read-only.

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/search Module

Since

2018.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/search Module Script Samples.

          //Add additional code 
...
var mySearch = search.create({
    type: 'transaction',
    columns: [ 'trandate', 'amount', 'entity' ],
    filters: [
        search.createFilter({
            name: 'internalid',
            operator: search.Operator.ANYOF,
            values: [13, 12356]
        })],
    settings: [
        search.createSetting({
            name: 'consolidationtype',
            value: 'NONE'
        })] 
});
...
//Add additional code

Syntax

Related Topics