ConstantPrincipal

Updated 2024-02-16 15:01:41.797000

Syntax

SELECT * FROM [westclintech].[wct].[ConstantPrincipal](
  <@OutstandingAmount, float,>
 ,<@InterestBasis, nvarchar(4000),>
 ,<@InterestRate, float,>
 ,<@PrincipalPaymentFrequency, int,>
 ,<@InterestPaymentFrequency, int,>
 ,<@LastPrinPayAmount, float,>
 ,<@MaturityDate, datetime,>
 ,<@ReferenceDate, datetime,>
 ,<@PrevPrincipalPayDate, datetime,>
 ,<@PrevInterestPayDate, datetime,>
 ,<@StartDate, datetime,>
 ,<@FirstPrincipalPayDate, datetime,>
 ,<@FirstInterestPayDate, datetime,>
 ,<@PrincipalGracePeriodStartDate, datetime,>
 ,<@PrincipalGracePeriodEndDate, datetime,>
 ,<@InterestGracePeriodStartDate, datetime,>
 ,<@InterestGracePeriodEndDate, datetime,>)

Description

Use the table-valued function ConstantPrincipal to return the cash flow schedule for a loan with a fixed maturity date where the principal is reduced on a straight-line basis. ConstantPrincipal computes the periodic interest and principal amounts bring the loan balance to zero on the maturity date. ConstantPrincipal supports separate interest and principal repayment schedules.

The interest and principal payment periods are entered in ConstantPrincipal as the number of months between payments. For example, a loan with monthly payments of interest would have an interest frequency of 1. If principal is to be repaid every months, then it would have a principal payment frequency of 6.

ConstantPrincipal supports both an initial grace period and an additional grace period during the life of the loan, for principal and/or interest. All payments and their associated dates are calculated with respect to the reference date supplied to the function (which should not be confused with the start date). If an initial interest grace period is entered in ConstantPrincipal and it is greater than the reference date, then it becomes the first interest payment date and subsequent interest payments are calculated from that date forward. The same principal applies for principal payments.

If any payments would otherwise occur in the specified grace period, then that payment is moved to the end of the grace period and all remaining payments are calculated from the end of the grace period.

If no initial grace period is specified then the first payment date is calculated using the respective payment frequency. If the start date has been entered and the number of months between the start date and the reference date is less than the frequency, then the first payment date is calculated by adding the respective frequency (as a number of months) to the start date.

If no start date has been entered but a previous payment date has been entered and the number of months between the previous payment date and the reference date is less than the frequency, then the first payment date is calculated by adding the respective frequency (as a number of months) to the previous payment date.

If there is no start date and previous payment dates or the number of months between those dates and the reference date is greater than the frequency, then the first payment date is calculated by adding the resepctive frequency (as a number of months) to the reference date.

All payments in the resultant table are moved to the end of the month and interest is calculated using these end-of-month dates.

The interest rate is calculated as:

I=P\times\left[\left(\left(1+\frac{R\times{F}}{12}\right)^{12\slash{F}}\right)^T\right]-1

Where:

{"columns":[{"field":"column 1"},{"field":"column 2"},{"field":"column 3"}],"rows":[{"column 1":"I","column 2":"=","column 3":"InterestRate"},{"column 1":"R","column 2":"=","column 3":"@InterestRate"},{"column 1":"F","column 2":"=","column 3":"@Frequency"},{"column 1":"T","column 2":"=","column 3":"Time, in years, from the previous interest payment date to PaymentDate"}]}

In the case where there are one or more principal payments between interest payment dates, the interest payment amount is calculated using the outstanding principal balances during the interest payment period.

If the irregular period is longer than the regular period then the interest amount is broken out into the regular interest amount and a 'grace' interest amount.

Arguments

@InterestRate

the annual rate of interest for the loan. @InterestRate is an expression of type float or of a type that can be implicitly converted to float.

@PrevPrincipalPayDate

the last principal payment date prior to the reference date. @PrevPrincipalPayDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@PrincipalGracePeriodStartDate

the date on which the (interim) principal grace period commences. @PrincipalGracePeriodStartDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@InterestPaymentFrequency

the number of months in a regular interest payment. @InterestPaymentFrequency is an expression of type int or of a type that can be implicitly converted to int.

@OutstandingAmount

the principal amount of the loan. @OutstandingAmount is an expression of type float or of a type that can be implicitly converted to float.

@LastPrinPayAmount

the amount of the principal payment due on the maturity date. @LastPrinPayAmount is an expression of type float or of a type that can be implicitly converted to float.

@FirstInterestPayDate

the first interest payment date of the loan if other than a regular periodic payment. @FirstPayDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@MaturityDate

the maturity date of the loan. @MaturityDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@PrincipalPaymentFrequency

the number of months between principal payments. @PrincipalPaymentFrequency is an expression of type int or of a type that can be implicitly converted to int.

@InterestGracePeriodEndDate

the date on which the (interim) interest grace period concludes. @GracePeriodEndDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@PrincipalGracePeriodEndDate

the date on which the (interim) principal grace period concludes. @PrincipalGracePeriodEndDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@ReferenceDate

the starting date for the number of months with respect to all other dates. @ReferenceDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@StartDate

the start date of the loan. @StartDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@PrevInterestPayDate

the last interest payment date prior to the reference date. @PrevPrincipalPayDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@InterestGracePeriodStartDate

the date on which the (interim) interest grace period commences. @InterestGracePeriodStartDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@FirstPrincipalPayDate

the first principal payment date of the loan if other than a regular periodic payment. @FirstPayDate is an expression that returns a datetime or smalldatetime value, or a character string in date format.

@InterestBasis

the day count convention used to calculate the interest amount. @InterestBasis can be 30/360, Actual/360, Actual/365, or Actual/Actual. @InterestBasis is an expression of the character string data type category.

Return Type

table

{"columns": [{"field": "colName", "headerName": "Name", "header": "name"}, {"field": "colDatatype", "headerName": "Type", "header": "type"}, {"field": "colDesc", "headerName": "Description", "header": "description", "minWidth": 1000}], "rows": [{"id": "88edcc17-d6cb-42d3-b63f-f60c28c68f1e", "colName": "Period", "colDatatype": "int", "colDesc": "A reference number uniquely identifying a row in the resultant table."}, {"id": "ebfa897a-dfc9-4cb6-b1a3-d91d3a3befec", "colName": "PrincipalPayment", "colDatatype": "float", "colDesc": "The amount of the principal payment."}, {"id": "9aa2239d-cfff-4495-aa26-bda1123afa2f", "colName": "InterestPayment", "colDatatype": "float", "colDesc": "The amount of the regular interest payment."}, {"id": "42ed9fee-c45b-4332-8279-84706111c821", "colName": "CashFlow", "colDatatype": "float", "colDesc": "PrincipalPayment + InterestPayment + GraceInterest."}, {"id": "95238765-20b9-4625-9a65-27f54d0f9c7c", "colName": "OutstandingExposure", "colDatatype": "float", "colDesc": "When Period = 0 then @OutstandingAmount. For Period > 0 then OutstandingExposure(Period-1) + InterestPayment."}, {"id": "4ddf868a-4971-47a9-b392-1ac8583ba32e", "colName": "CapitalAmountInDebt", "colDatatype": "float", "colDesc": "When Period = 0, @OutstandingAmount. For Period > 0 then CapitalAmountInDebt(Period-1) \u2013 PrincipalPayment"}, {"id": "a20c88ad-74ba-4094-a380-b773cb7d8015", "colName": "TotalExposure", "colDatatype": "float", "colDesc": "When Period = 0, @OutstandingAmount. For Period > 0 then CapitalAmountInDebt(Period-1) + InterestPayment"}, {"id": "c6024003-fa47-4649-b420-8efddab7b7bd", "colName": "NumberOfMonth", "colDatatype": "int", "colDesc": "The number of months between the @ReferenceDate and the PaymentDate."}, {"id": "f4a45e98-4f54-4a25-81dc-3752956f6334", "colName": "PaymentDate", "colDatatype": "datetime", "colDesc": "The end-of-month date of the payment."}, {"id": "ba639cf4-5d55-42a9-9a47-a270680c53e8", "colName": "GraceInterest", "colDatatype": "float", "colDesc": "The amount of the grace interest"}, {"id": "f95da0dc-ab6a-416c-b270-a6ca0cf30c3d", "colName": "InterestRate", "colDatatype": "float", "colDesc": "The interest rate from the previous interest payment date to the PaymentDate."}]}

Remarks

The PaymentDate for all rows is generated as the last day of the month.

For Period = 0, PrincipalPayment, InterestPayment, CashFlow, NumberOfMonth, GraceInterest, and InterestRate are set to 0.

If @Frequency is NULL then @Frequency = 1.

If @InterestRate is NULL then @InterestRate = 0.

If @ReferenceDate is NULL then @ReferenceDate = GETDATE().

GraceInterest is only calculated on @FirstInterestPayDate and @InterestGracePeriodEndDate.

GraceInterest is only calculated if length of the grace interst periods is greater than @PaymentFrequency.

GraceInterest is the difference between the interest for the period from the previous interest payment to PaymentDate and interest that would have been calculated for a period with length equal to @PaymentFrequency.

CashFlow may not equal PaymentAmount on @FirstPayDate or @GracePeriodEndDate due to GraceInterest.

The last row returned will always be for the maturity date and may be shorter than a regular period depending on the combination of dates and @PaymentFrequency

Examples

This is a simple 5-year 100,000 loan with quarterly payments of principal and interest and an interest rate of 4.5%.

SELECT *

FROM wct.ConstantPrincipal(   100000,       --@OutstandingAmount

                              '30/360',     --@InterestBasis

                              .045,         --@InterestRate

                              3,            --@FreqPayPrincipal

                              3,            --@FreqPayInterest

                              10000.00,     --@LastPrinPayAmount

                              '2019-10-01', --@MaturityDate

                              '2014-10-01', --@ReferenceDate

                              NULL,         --@PrevPrincipalPayDate

                              NULL,         --@PrevInterestPayDate

                              NULL,         --@StartDate

                              NULL,         --@FirstPrincipalPayDate

                              NULL,         --@FirstInterestPayDate

                              NULL,         --@PrincipalGracePeriodStartDate

                              NULL,         --@PrincipalGracePeriodEndDate

                              NULL,         --@InterestGracePeriodStartDate

                              NULL          --@InterestGracePeriodEndDate

                          );