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.

## 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.

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 20 Feb 20 First day of month 1/01/2021 1/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 21 7 Sep 21 14 Sep 21 21 Sep 21 Chocolate 1,450 1,344 1,100 806 Fudge 754 887 1,003 1,012 Current week? CURRENTPERIODSTART() = START()

Disclaimer

We update Anapedia regularly to provide the most up-to-date instructions.