MESCIUS.ActiveReports.Core.Data.VBFunctionLib Assembly / GrapeCity.Enterprise.Data.VisualBasicReplacement Namespace / Financial Class / Rate Method
Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 * 12 (or 48) payment periods.
Required. The payment to be made each period. Payments usually contain principal and interest that doesn't change over the life of the annuity.
Required. The present value, or value today, of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make.
Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed.
Optional. Object of type DueDate that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed.
Optional. The value you estimate is returned by Rate. If omitted, Guess is 0.1 (10 percent).

Rate Method
Returns a value specifying the interest rate per period for an annuity.
Syntax
'Declaration
 
Public Shared Function Rate( _
   ByVal NPer As Double, _
   ByVal Pmt As Double, _
   ByVal PV As Double, _
   Optional ByVal FV As Double, _
   Optional ByVal Due As DueDate, _
   Optional ByVal Guess As Double _
) As Double
 

Parameters

NPer
Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 * 12 (or 48) payment periods.
Pmt
Required. The payment to be made each period. Payments usually contain principal and interest that doesn't change over the life of the annuity.
PV
Required. The present value, or value today, of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make.
FV
Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed.
Due
Optional. Object of type DueDate that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed.
Guess
Optional. The value you estimate is returned by Rate. If omitted, Guess is 0.1 (10 percent).

Return Value

The interest rate per period for an annuity.
Exceptions
ExceptionDescription
NPer less than or equal to 0.
See Also