Skip to main content

PV

Returns the present value of an investment: the total amount that a series of future payments is worth now.

Syntax

expression.PV(arg1, arg2, arg3, arg4, arg5);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRange | ApiName | numberThe interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
arg2RequiredApiRange | ApiName | numberThe total number of payment periods in an investment.
arg3RequiredApiRange | ApiName | numberThe payment made each period and cannot change over the life of the investment.
arg4OptionalApiRange | ApiName | numberThe future value, or a cash balance which will be attained after the last payment is made. If omitted, it is equal to 0.
arg5OptionalApiRange | ApiName | numberA logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

number

Example

let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.PV(0.1/12, 2*12, -500, 0));