query.ReturnType

Note:

The content in this help topic pertains to SuiteScript 2.0.

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.0 documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds the string values for the formula return types supported with the N/query Module.

This enum is used to pass the formula return type argument to Query.createColumn(options), Component.createColumn(options), Query.createCondition(options), and Component.createCondition(options).

For more information about these return types, see Formula Fields.

For more information about formulas, see SuiteAnalytics Workbook Overview, SQL Expressions, and Search Formula Examples and Tips.

Module

N/query Module

Sibling Module Members

N/query Module Members

Since

2018.1

Values

Value

ANY

BOOLEAN

CLOBTEXT

CURRENCY

DATE

DATETIME

DURATION

FLOAT

INTEGER

KEY

PERCENT

RELATIONSHIP

STRING

UNKNOWN

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/query Module Script Samples.

            // Add additional code
...
var myTransactionQuery = query.create({ type: query.Type.TRANSACTION
}); var myFormulaColumn = myTransactionQuery.createColumn({ type: query.ReturnType.CURRENCY, formula: '{amount} * 125'
});
...
// Add additional code 

          

Related Topics

N/query Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices