@INTEREST

This function calculates the simple interest in balanceMbr at the rate specified by creditrateMbrConst if the value specified by balanceMbr is positive, or at the rate specified by borrowrateMbrConst if balanceMbr is negative. The interest is calculated for each time period specified by XrangeList.

Syntax

@INTEREST (balanceMbr, creditrateMbrConst, borrowrateMbrConst  [, XrangeList])

Parameters

balanceMbr

Single member specification representing the balance at the time the interest is calculated.

creditrateMbrConst

Single member specification, variable name, or numeric expression providing a constant value. The value must be a decimal number that corresponds to a percentage. The value represents the per-period interest rate.

borrowrateMbrConst

Single member specification, variable name, or numeric expression providing a constant value. The value must be a decimal number corresponding to a percentage value. The value represents the per-period interest rate.

XrangeList

Optional parameter specifying the time period over which the interest is calculated. If a range is not specified, Essbase uses the level 0 members from the dimension tagged as Time.

Can be a valid member name, a comma-delimited list of member names, cross dimensional members, or a return value from a member set function or range function (including @XRANGE).

For more information about rangeList and XrangeList, see Range List Parameters in the topic Range and Financial Functions.

Notes

Financial functions never return a value; rather, they calculate a series of values internally based on the range specified.

Example

The following example calculates the interest for Balance, using Credit Rate for positive balances and using Borrow Rate for negative balances. The results are placed in Interest Amount for each fiscal year.

"Interest Amount" = @INTEREST(Balance,"Credit Rate","Borrow Rate",
FY1998:FY2001,FY2002,FY2003);

This example produces the following report:

                FY1998  FY1999   FY2000  FY2001   FY2002   FY2003
                ======  ======   ======  ======   ======   ======                               
Balance        2000.00 3000.00 -1000.00 3000.00  9000.00 -6000.00
Credit Rate      0.065   0.065    0.065   0.065    0.065    0.065
Borrow Rate     0.1125  0.1125   0.1125  0.1125   0.1125   0.1125
Interest Amount 130.00  195.00  -112.50  195.00   585.00  -675.00

The following example assumes a Year dimension is added to Sample Basic. It calculates interest using a multidimensional range.

FIX ("100-10", "New York")
"Interest Amount" = @INTEREST (Balance, "Credit Rate", "Borrow Rate", @XRANGE("2011"->"Sep", "2012"->"Mar"));
ENDFIX

The above calculation is performed across the following multidimensional range specified by XrangeList:


2011->Sep
2011->Oct
2011->Nov
2011->Dec
2012->Jan
2012->Feb
2012->Mar