The CURRENTPERIODSTART function returns the start date from a model's current period.

For example, you can use the CURRENTPERIODSTART function to ensure that a formula only applies to the current period in a financial year.

Syntax

CURRENTPERIODSTART()

Arguments

The CURRENTPERIODSTART function does not use any arguments.

This function returns a date result.

Syntax example

CURRENTPERIODSTART()

In this example, the formula returns the start date from the current period.

Additional information

You can set your model's Current Period in Time in the model settings bar.

Examples

In this example, the formula returns a TRUE result for the date that is set as the model's current period. 


Jan 20Feb 20
First day of month1/01/20211/02/2021

Current period?

CURRENTPERIODSTART() = START()


In this example, a Product Sales module has Time on columns, and line items on rows. The Current week? line item has a Boolean data type. The model calendar is set to Weeks: General.

The formula returns TRUE for the week that is set as the model's current period. 


31 Aug 217 Sep 2114 Sep 2121 Sep 21
Chocolate1,4501,3441,100806
Fudge7548871,0031,012

Current week?

CURRENTPERIODSTART() = START()