@INTEREST

The @INTEREST() 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 rangeList.

Syntax

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

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.

rangeList Optional. A valid member name, a comma-delimited list of member names, member set functions, and range functions from the dimension tagged as Time. If rangeList is not specified, Hyperion Essbase uses the level 0 members from the dimension tagged as Time.

Notes

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

Example

This 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",
FY1991:FY1994,FY1995,FY1996);

This example produces the following report:

                FY1991  FY1992   FY1993  FY1994   FY1995   FY1996
                ======  ======   ======  ======   ======   ======
				
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

See Also

@COMPOUND

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.
rangeList	Optional. A valid member name, a comma-delimited list of member names, member set functions, and range functions from the dimension tagged as Time. If rangeList is not specified, Hyperion Essbase uses the level 0 members from the dimension tagged as Time.