query.RelativeDateRange

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 query.RelativeDate object values for supported date ranges in relative dates. This enum is used to pass the values argument to Query.createCondition(options) and Component.createCondition(options). It is also used as the value of the RelativeDate.value property. Each value in this enum represents a date range. When Query.createCondition(options) or Component.createCondition(options) is called with a query.RelativeDate object as the values argument, this object is set as the value of the RelativeDate.value property. When creating a condition using Query.createCondition(options) or Component.createCondition(options), use the values in this enum (along with values in the query.Operator enum) to specify a range of dates relative to the current date. For example, to create a condition to match dates that occur before the current date, use the query.RelativeDateRange.TODAY enum value and the query.Operator.BEFORE enum value. To create a condition to match dates that occur after last year, use the query.RelativeDateRange.LAST_YEAR enum value and the query.Operator.AFTER enum value. For more information about relative dates, see Relative Dates in the N/query Module. The values in this enum might look similar to the values in the query.DateId enum, but each enum is used for a different purpose: Use query.DateId enum values to create a query.RelativeDate object using query.createRelativeDate(options). After you create this object, you can use it in query conditions that you create using Query.createCondition(options) or Component.createCondition(options). Use query.RelativeDateRange enum values directly in query conditions that you create using Query.createCondition(options) or Component.createCondition(options). Each value in the query.RelativeDateRange enum represents a date range, and you can use these values in the values parameter of Query.createCondition(options) or Component.createCondition(options).
Module	N/query Module
Sibling Module Members	N/query Module Members
Since	2019.1

Values

Value	RelativeDate.dateId Property
FISCAL_HALF_BEFORE_LAST	FHBL
FISCAL_HALF_BEFORE_LAST_TO_DATE	FHBLTD
FISCAL_QUARTER_BEFORE_LAST	FQBL
FISCAL_QUARTER_BEFORE_LAST_TO_DATE	FQBLTD
FISCAL_YEAR_BEFORE_LAST	FYBL
FISCAL_YEAR_BEFORE_LAST_TO_DATE	FYBLTD
FIVE_DAYS_AGO	DAGO5
FIVE_DAYS_FROM_NOW	DFN5
FOUR_DAYS_AGO	DAGO4
FOUR_DAYS_FROM_NOW	DFN4
FOUR_WEEKS_STARTING_THIS_WEEK	TWN3W
LAST_BUSINESS_WEEK	LBW
LAST_FISCAL_HALF	LFH
LAST_FISCAL_HALF_ONE_FISCAL_YEAR_AGO	LFHLFY
LAST_FISCAL_HALF_TO_DATE	LFHTD
LAST_FISCAL_QUARTER	LFQ
LAST_FISCAL_QUARTER_ONE_FISCAL_YEAR_AGO	LFQLFY
LAST_FISCAL_QUARTER_TO_DATE	LFQTD
LAST_FISCAL_QUARTER_TWO_FISCAL_YEARS_AGO	LFQFYBL
LAST_FISCAL_YEAR	LFY
LAST_FISCAL_YEAR_TO_DATE	LFYTD
LAST_MONTH	LM
LAST_MONTH_ONE_FISCAL_QUARTER_AGO	LMLFQ
LAST_MONTH_ONE_FISCAL_YEAR_AGO	LMLFY
LAST_MONTH_TO_DATE	LMTD
LAST_MONTH_TWO_FISCAL_QUARTERS_AGO	LMFQBL
LAST_MONTH_TWO_FISCAL_YEARS_AGO	LMFYBL
LAST_ROLLING_HALF	LRH
LAST_ROLLING_QUARTER	LRQ
LAST_ROLLING_YEAR	LRY
LAST_WEEK	LW
LAST_WEEK_TO_DATE	LWTD
LAST_YEAR	LY
LAST_YEAR_TO_DATE	LYTD
MONTH_AFTER_NEXT	MAN
MONTH_AFTER_NEXT_TO_DATE	MANTD
MONTH_BEFORE_LAST	MBL
MONTH_BEFORE_LAST_TO_DATE	MBLTD
NEXT_BUSINESS_WEEK	NBW
NEXT_FISCAL_HALF	NFH
NEXT_FISCAL_QUARTER	NFQ
NEXT_FISCAL_YEAR	NFY
NEXT_FOUR_WEEKS	N4W
NEXT_MONTH	NM
NEXT_ONE_HALF	NOH
NEXT_ONE_MONTH	NOM
NEXT_ONE_QUARTER	NOQ
NEXT_ONE_WEEK	NOW
NEXT_ONE_YEAR	NOY
NEXT_WEEK	NW
NINETY_DAYS_AGO	DAGO90
NINETY_DAYS_FROM_NOW	DFN90
ONE_YEAR_BEFORE_LAST	OYBL
PREVIOUS_FISCAL_QUARTERS_LAST_FISCAL_YEAR	PQLFY
PREVIOUS_FISCAL_QUARTERS_THIS_FISCAL_YEAR	PQTFY
PREVIOUS_MONTHS_LAST_FISCAL_HALF	PMLFH
PREVIOUS_MONTHS_LAST_FISCAL_QUARTER	PMLFQ
PREVIOUS_MONTHS_LAST_FISCAL_YEAR	PMLFY
PREVIOUS_MONTHS_SAME_FISCAL_HALF_LAST_FISCAL_YEAR	PMSFHLFY
PREVIOUS_MONTHS_SAME_FISCAL_QUARTER_LAST_FISCAL_YEAR	PMSFQLFY
PREVIOUS_MONTHS_THIS_FISCAL_HALF	PMTFH
PREVIOUS_MONTHS_THIS_FISCAL_QUARTER	PMTFQ
PREVIOUS_MONTHS_THIS_FISCAL_YEAR	PMTFY
PREVIOUS_ONE_DAY	OD
PREVIOUS_ONE_HALF	OH
PREVIOUS_ONE_MONTH	OM
PREVIOUS_ONE_QUARTER	OQ
PREVIOUS_ONE_WEEK	OW
PREVIOUS_ONE_YEAR	OY
PREVIOUS_ROLLING_HALF	PRH
PREVIOUS_ROLLING_QUARTER	PRQ
PREVIOUS_ROLLING_YEAR	PRY
SAME_DAY_FISCAL_QUARTER_BEFORE_LAST	SDFQBL
SAME_DAY_FISCAL_YEAR_BEFORE_LAST	SDFYBL
SAME_DAY_LAST_FISCAL_QUARTER	SDLFQ
SAME_DAY_LAST_FISCAL_YEAR	SDLFY
SAME_DAY_LAST_MONTH	SDLM
SAME_DAY_LAST_WEEK	SDLW
SAME_DAY_MONTH_BEFORE_LAST	SDMBL
SAME_DAY_WEEK_BEFORE_LAST	SDWBL
SAME_FISCAL_HALF_LAST_FISCAL_YEAR	SFHLFY
SAME_FISCAL_HALF_LAST_FISCAL_YEAR_TO_DATE	SFHLFYTD
SAME_FISCAL_QUARTER_FISCAL_YEAR_BEFORE_LAST	SFQFYBL
SAME_FISCAL_QUARTER_LAST_FISCAL_YEAR	SFQLFY
SAME_FISCAL_QUARTER_LAST_FISCAL_YEAR_TO_DATE	SFQLFYTD
SAME_MONTH_FISCAL_QUARTER_BEFORE_LAST	SMFQBL
SAME_MONTH_FISCAL_YEAR_BEFORE_LAST	SMFYBL
SAME_MONTH_LAST_FISCAL_QUARTER	SMLFQ
SAME_MONTH_LAST_FISCAL_QUARTER_TO_DATE	SMLFQTD
SAME_MONTH_LAST_FISCAL_YEAR	SMLFY
SAME_MONTH_LAST_FISCAL_YEAR_TO_DATE	SMLFYTD
SAME_WEEK_FISCAL_YEAR_BEFORE_LAST	SWFYBL
SAME_WEEK_LAST_FISCAL_YEAR	SWLFY
SIXTY_DAYS_AGO	DAGO60
SIXTY_DAYS_FROM_NOW	DFN60
TEN_DAYS_AGO	DAGO10
TEN_DAYS_FROM_NOW	DFN10
THIRTY_DAYS_AGO	DAGO30
THIRTY_DAYS_FROM_NOW	DFN30
THIS_BUSINESS_WEEK	TBW
THIS_FISCAL_HALF	TFH
THIS_FISCAL_HALF_TO_DATE	TFHTD
THIS_FISCAL_QUARTER	TFQ
THIS_FISCAL_QUARTER_TO_DATE	TFQTD
THIS_FISCAL_YEAR	TFY
THIS_FISCAL_YEAR_TO_DATE	TFYTD
THIS_MONTH	TM
THIS_MONTH_TO_DATE	TMTD
THIS_ROLLING_HALF	TRH
THIS_ROLLING_QUARTER	TRQ
THIS_ROLLING_YEAR	TRY
THIS_WEEK	TW
THIS_WEEK_TO_DATE	TWTD
THIS_YEAR	TY
THIS_YEAR_TO_DATE	TYTD
THREE_DAYS_AGO	DAGO3
THREE_DAYS_FROM_NOW	DFN3
THREE_FISCAL_QUARTERS_AGO	FQB
THREE_FISCAL_QUARTERS_AGO_TO_DATE	FQBTD
THREE_FISCAL_YEARS_AGO	FYB
THREE_FISCAL_YEARS_AGO_TO_DATE	FYBTD
THREE_MONTHS_AGO	MB
THREE_MONTHS_AGO_TO_DATE	MBTD
TODAY	TODAY
TODAY_TO_END_OF_THIS_MONTH	TODAYTTM
TOMORROW	TOMORROW
TWO_DAYS_AGO	DAGO2
TWO_DAYS_FROM_NOW	DFN2
WEEK_AFTER_NEXT	WAN
WEEK_AFTER_NEXT_TO_DATE	WANTD
WEEK_BEFORE_LAST	WBL
WEEK_BEFORE_LAST_TO_DATE	WBLTD
YESTERDAY	YESTERDAY

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
}); myTransactionQuery.condition = myTransactionQuery.createCondition({ fieldId: 'trandate', operator: query.Operator.BEFORE, values: query.RelativeDateRange.TODAY
});
...
// Add additional code 

          

Related Topics

N/query Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices