The YEARVALUE function references another line item and returns the yearly time summary value for each time period within that year. The function replaces the period's individual value with the corresponding yearly summary.
For example, you can use the YEARVALUE function to identify sales across a year that are above average.
Syntax
YEARVALUE(Line item)
Arguments
| Argument | Data type | Description |
| Line item | Number, Boolean, date, time period, list, text | The line item to reference the yearly time summary value for. |
The YEARVALUE function returns a result of the same data type as the line item you reference.
Calculation engine functionality differences
In Polaris, you can't use the YEARVALUE function in a result line item with a time scale greater than the function.
The Classic Engine returns a value of 0 in this case.
Constraints
You can't use the YEARVALUE function in a model that has the Calendar Type set to Weeks: General.
Examples
Months with sales above the yearly average
In this example, an Income statement module has line items on rows and Time on columns:
- The Monthly sales and the Yearly sales line items have Number data types
- The Month above average for year line item has a Boolean data type
In Blueprint view, in the Summary column for Monthly sales, Time Summary is set to Average. The formula for the Yearly sales returns the yearly summary average for every month of the year. The formula for the Month above average for year returns a TRUE result for values that are above the average value for each month of the year.
| Jan 25 | Feb 25 | Mar 25 | Apr 25 | May 25 | Jun 25 | |
| Monthly sales | 660,338 | 123,665 | 988,541 | 200,456 | 200,456 | 200,336 |
Yearly salesYEARVALUE(Monthly sales) | 236,444 | 236,444 | 236,444 | 236,444 | 236,444 | 236,444 |
Month above average for yearMonthly sales > YEARVALUE(Monthly sales) |
