Merge pull request #32424 from deepeshgarg007/loan_schedule_types
feat: Repayment schedule types for term loans
diff --git a/erpnext/loan_management/doctype/loan/loan.js b/erpnext/loan_management/doctype/loan/loan.js
index 38328e6..20e2b0b 100644
--- a/erpnext/loan_management/doctype/loan/loan.js
+++ b/erpnext/loan_management/doctype/loan/loan.js
@@ -61,6 +61,10 @@
},
refresh: function (frm) {
+ if (frm.doc.repayment_schedule_type == "Pro-rated calendar months") {
+ frm.set_df_property("repayment_start_date", "label", "Interest Calculation Start Date");
+ }
+
if (frm.doc.docstatus == 1) {
if (["Disbursed", "Partially Disbursed"].includes(frm.doc.status) && (!frm.doc.repay_from_salary)) {
frm.add_custom_button(__('Request Loan Closure'), function() {
@@ -103,6 +107,14 @@
frm.trigger("toggle_fields");
},
+ repayment_schedule_type: function(frm) {
+ if (frm.doc.repayment_schedule_type == "Pro-rated calendar months") {
+ frm.set_df_property("repayment_start_date", "label", "Interest Calculation Start Date");
+ } else {
+ frm.set_df_property("repayment_start_date", "label", "Repayment Start Date");
+ }
+ },
+
loan_type: function(frm) {
frm.toggle_reqd("repayment_method", frm.doc.is_term_loan);
frm.toggle_display("repayment_method", frm.doc.is_term_loan);
diff --git a/erpnext/loan_management/doctype/loan/loan.json b/erpnext/loan_management/doctype/loan/loan.json
index 47488f4..dc8b03e 100644
--- a/erpnext/loan_management/doctype/loan/loan.json
+++ b/erpnext/loan_management/doctype/loan/loan.json
@@ -18,6 +18,7 @@
"status",
"section_break_8",
"loan_type",
+ "repayment_schedule_type",
"loan_amount",
"rate_of_interest",
"is_secured_loan",
@@ -158,7 +159,8 @@
"depends_on": "is_term_loan",
"fieldname": "repayment_start_date",
"fieldtype": "Date",
- "label": "Repayment Start Date"
+ "label": "Repayment Start Date",
+ "mandatory_depends_on": "is_term_loan"
},
{
"fieldname": "column_break_11",
@@ -402,12 +404,20 @@
"fieldname": "is_npa",
"fieldtype": "Check",
"label": "Is NPA"
+ },
+ {
+ "depends_on": "is_term_loan",
+ "fetch_from": "loan_type.repayment_schedule_type",
+ "fieldname": "repayment_schedule_type",
+ "fieldtype": "Data",
+ "label": "Repayment Schedule Type",
+ "read_only": 1
}
],
"index_web_pages_for_search": 1,
"is_submittable": 1,
"links": [],
- "modified": "2022-07-12 11:50:31.957360",
+ "modified": "2022-09-30 10:36:47.902903",
"modified_by": "Administrator",
"module": "Loan Management",
"name": "Loan",
diff --git a/erpnext/loan_management/doctype/loan/loan.py b/erpnext/loan_management/doctype/loan/loan.py
index d84eef6..0c9c97f 100644
--- a/erpnext/loan_management/doctype/loan/loan.py
+++ b/erpnext/loan_management/doctype/loan/loan.py
@@ -7,7 +7,16 @@
import frappe
from frappe import _
-from frappe.utils import add_months, flt, get_last_day, getdate, now_datetime, nowdate
+from frappe.utils import (
+ add_days,
+ add_months,
+ date_diff,
+ flt,
+ get_last_day,
+ getdate,
+ now_datetime,
+ nowdate,
+)
import erpnext
from erpnext.accounts.doctype.journal_entry.journal_entry import get_payment_entry
@@ -107,30 +116,81 @@
if not self.repayment_start_date:
frappe.throw(_("Repayment Start Date is mandatory for term loans"))
+ schedule_type_details = frappe.db.get_value(
+ "Loan Type", self.loan_type, ["repayment_schedule_type", "repayment_date_on"], as_dict=1
+ )
+
self.repayment_schedule = []
payment_date = self.repayment_start_date
balance_amount = self.loan_amount
- while balance_amount > 0:
- interest_amount = flt(balance_amount * flt(self.rate_of_interest) / (12 * 100))
- principal_amount = self.monthly_repayment_amount - interest_amount
- balance_amount = flt(balance_amount + interest_amount - self.monthly_repayment_amount)
- if balance_amount < 0:
- principal_amount += balance_amount
- balance_amount = 0.0
- total_payment = principal_amount + interest_amount
- self.append(
- "repayment_schedule",
- {
- "payment_date": payment_date,
- "principal_amount": principal_amount,
- "interest_amount": interest_amount,
- "total_payment": total_payment,
- "balance_loan_amount": balance_amount,
- },
+ while balance_amount > 0:
+ interest_amount, principal_amount, balance_amount, total_payment = self.get_amounts(
+ payment_date,
+ balance_amount,
+ schedule_type_details.repayment_schedule_type,
+ schedule_type_details.repayment_date_on,
)
- next_payment_date = add_single_month(payment_date)
- payment_date = next_payment_date
+
+ if schedule_type_details.repayment_schedule_type == "Pro-rated calendar months":
+ next_payment_date = get_last_day(payment_date)
+ if schedule_type_details.repayment_date_on == "Start of the next month":
+ next_payment_date = add_days(next_payment_date, 1)
+
+ payment_date = next_payment_date
+
+ self.add_repayment_schedule_row(
+ payment_date, principal_amount, interest_amount, total_payment, balance_amount
+ )
+
+ if (
+ schedule_type_details.repayment_schedule_type == "Monthly as per repayment start date"
+ or schedule_type_details.repayment_date_on == "End of the current month"
+ ):
+ next_payment_date = add_single_month(payment_date)
+ payment_date = next_payment_date
+
+ def get_amounts(self, payment_date, balance_amount, schedule_type, repayment_date_on):
+ if schedule_type == "Monthly as per repayment start date":
+ days = 1
+ months = 12
+ else:
+ expected_payment_date = get_last_day(payment_date)
+ if repayment_date_on == "Start of the next month":
+ expected_payment_date = add_days(expected_payment_date, 1)
+
+ if expected_payment_date == payment_date:
+ # using 30 days for calculating interest for all full months
+ days = 30
+ months = 365
+ else:
+ days = date_diff(get_last_day(payment_date), payment_date)
+ months = 365
+
+ interest_amount = flt(balance_amount * flt(self.rate_of_interest) * days / (months * 100))
+ principal_amount = self.monthly_repayment_amount - interest_amount
+ balance_amount = flt(balance_amount + interest_amount - self.monthly_repayment_amount)
+ if balance_amount < 0:
+ principal_amount += balance_amount
+ balance_amount = 0.0
+
+ total_payment = principal_amount + interest_amount
+
+ return interest_amount, principal_amount, balance_amount, total_payment
+
+ def add_repayment_schedule_row(
+ self, payment_date, principal_amount, interest_amount, total_payment, balance_loan_amount
+ ):
+ self.append(
+ "repayment_schedule",
+ {
+ "payment_date": payment_date,
+ "principal_amount": principal_amount,
+ "interest_amount": interest_amount,
+ "total_payment": total_payment,
+ "balance_loan_amount": balance_loan_amount,
+ },
+ )
def set_repayment_period(self):
if self.repayment_method == "Repay Fixed Amount per Period":
diff --git a/erpnext/loan_management/doctype/loan/test_loan.py b/erpnext/loan_management/doctype/loan/test_loan.py
index da05c8e..388e65d 100644
--- a/erpnext/loan_management/doctype/loan/test_loan.py
+++ b/erpnext/loan_management/doctype/loan/test_loan.py
@@ -4,7 +4,16 @@
import unittest
import frappe
-from frappe.utils import add_days, add_months, add_to_date, date_diff, flt, get_datetime, nowdate
+from frappe.utils import (
+ add_days,
+ add_months,
+ add_to_date,
+ date_diff,
+ flt,
+ format_date,
+ get_datetime,
+ nowdate,
+)
from erpnext.loan_management.doctype.loan.loan import (
make_loan_write_off,
@@ -47,6 +56,51 @@
loan_account="Loan Account - _TC",
interest_income_account="Interest Income Account - _TC",
penalty_income_account="Penalty Income Account - _TC",
+ repayment_schedule_type="Monthly as per repayment start date",
+ )
+
+ create_loan_type(
+ "Term Loan Type 1",
+ 12000,
+ 7.5,
+ is_term_loan=1,
+ mode_of_payment="Cash",
+ disbursement_account="Disbursement Account - _TC",
+ payment_account="Payment Account - _TC",
+ loan_account="Loan Account - _TC",
+ interest_income_account="Interest Income Account - _TC",
+ penalty_income_account="Penalty Income Account - _TC",
+ repayment_schedule_type="Monthly as per repayment start date",
+ )
+
+ create_loan_type(
+ "Term Loan Type 2",
+ 12000,
+ 7.5,
+ is_term_loan=1,
+ mode_of_payment="Cash",
+ disbursement_account="Disbursement Account - _TC",
+ payment_account="Payment Account - _TC",
+ loan_account="Loan Account - _TC",
+ interest_income_account="Interest Income Account - _TC",
+ penalty_income_account="Penalty Income Account - _TC",
+ repayment_schedule_type="Pro-rated calendar months",
+ repayment_date_on="Start of the next month",
+ )
+
+ create_loan_type(
+ "Term Loan Type 3",
+ 12000,
+ 7.5,
+ is_term_loan=1,
+ mode_of_payment="Cash",
+ disbursement_account="Disbursement Account - _TC",
+ payment_account="Payment Account - _TC",
+ loan_account="Loan Account - _TC",
+ interest_income_account="Interest Income Account - _TC",
+ penalty_income_account="Penalty Income Account - _TC",
+ repayment_schedule_type="Pro-rated calendar months",
+ repayment_date_on="End of the current month",
)
create_loan_type(
@@ -62,6 +116,7 @@
"Loan Account - _TC",
"Interest Income Account - _TC",
"Penalty Income Account - _TC",
+ repayment_schedule_type="Monthly as per repayment start date",
)
create_loan_type(
@@ -902,6 +957,69 @@
amounts = calculate_amounts(loan.name, add_days(last_date, 5))
self.assertEqual(flt(amounts["pending_principal_amount"], 0), 0)
+ def test_term_loan_schedule_types(self):
+ loan = create_loan(
+ self.applicant1,
+ "Term Loan Type 1",
+ 12000,
+ "Repay Over Number of Periods",
+ 12,
+ repayment_start_date="2022-10-17",
+ )
+
+ # Check for first, second and last installment date
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[0].payment_date, "dd-MM-yyyy"), "17-10-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[1].payment_date, "dd-MM-yyyy"), "17-11-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[-1].payment_date, "dd-MM-yyyy"), "17-09-2023"
+ )
+
+ loan.loan_type = "Term Loan Type 2"
+ loan.save()
+
+ # Check for first, second and last installment date
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[0].payment_date, "dd-MM-yyyy"), "01-11-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[1].payment_date, "dd-MM-yyyy"), "01-12-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[-1].payment_date, "dd-MM-yyyy"), "01-10-2023"
+ )
+
+ loan.loan_type = "Term Loan Type 3"
+ loan.save()
+
+ # Check for first, second and last installment date
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[0].payment_date, "dd-MM-yyyy"), "31-10-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[1].payment_date, "dd-MM-yyyy"), "30-11-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[-1].payment_date, "dd-MM-yyyy"), "30-09-2023"
+ )
+
+ loan.repayment_method = "Repay Fixed Amount per Period"
+ loan.monthly_repayment_amount = 1042
+ loan.save()
+
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[0].payment_date, "dd-MM-yyyy"), "31-10-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[1].payment_date, "dd-MM-yyyy"), "30-11-2022"
+ )
+ self.assertEqual(
+ format_date(loan.get("repayment_schedule")[-1].payment_date, "dd-MM-yyyy"), "30-09-2023"
+ )
+
def create_loan_scenario_for_penalty(doc):
pledge = [{"loan_security": "Test Security 1", "qty": 4000.00}]
@@ -1033,6 +1151,8 @@
penalty_income_account=None,
repayment_method=None,
repayment_periods=None,
+ repayment_schedule_type=None,
+ repayment_date_on=None,
):
if not frappe.db.exists("Loan Type", loan_name):
@@ -1042,6 +1162,7 @@
"company": "_Test Company",
"loan_name": loan_name,
"is_term_loan": is_term_loan,
+ "repayment_schedule_type": "Monthly as per repayment start date",
"maximum_loan_amount": maximum_loan_amount,
"rate_of_interest": rate_of_interest,
"penalty_interest_rate": penalty_interest_rate,
@@ -1056,8 +1177,14 @@
"repayment_periods": repayment_periods,
"write_off_amount": 100,
}
- ).insert()
+ )
+ if loan_type.is_term_loan:
+ loan_type.repayment_schedule_type = repayment_schedule_type
+ if loan_type.repayment_schedule_type != "Monthly as per repayment start date":
+ loan_type.repayment_date_on = repayment_date_on
+
+ loan_type.insert()
loan_type.submit()
diff --git a/erpnext/loan_management/doctype/loan_type/loan_type.json b/erpnext/loan_management/doctype/loan_type/loan_type.json
index 00337e4..5cc9464 100644
--- a/erpnext/loan_management/doctype/loan_type/loan_type.json
+++ b/erpnext/loan_management/doctype/loan_type/loan_type.json
@@ -16,6 +16,8 @@
"company",
"is_term_loan",
"disabled",
+ "repayment_schedule_type",
+ "repayment_date_on",
"description",
"account_details_section",
"mode_of_payment",
@@ -157,12 +159,30 @@
"label": "Disbursement Account",
"options": "Account",
"reqd": 1
+ },
+ {
+ "depends_on": "is_term_loan",
+ "description": "The schedule type that will be used for generating the term loan schedules (will affect the payment date and monthly repayment amount)",
+ "fieldname": "repayment_schedule_type",
+ "fieldtype": "Select",
+ "label": "Repayment Schedule Type",
+ "mandatory_depends_on": "is_term_loan",
+ "options": "\nMonthly as per repayment start date\nPro-rated calendar months"
+ },
+ {
+ "depends_on": "eval:doc.repayment_schedule_type == \"Pro-rated calendar months\"",
+ "description": "Select whether the repayment date should be the end of the current month or start of the upcoming month",
+ "fieldname": "repayment_date_on",
+ "fieldtype": "Select",
+ "label": "Repayment Date On",
+ "mandatory_depends_on": "eval:doc.repayment_schedule_type == \"Pro-rated calendar months\"",
+ "options": "\nStart of the next month\nEnd of the current month"
}
],
"index_web_pages_for_search": 1,
"is_submittable": 1,
"links": [],
- "modified": "2022-01-25 16:23:57.009349",
+ "modified": "2022-10-22 17:43:03.954201",
"modified_by": "Administrator",
"module": "Loan Management",
"name": "Loan Type",
diff --git a/erpnext/patches.txt b/erpnext/patches.txt
index fc63f12..6a8c21f 100644
--- a/erpnext/patches.txt
+++ b/erpnext/patches.txt
@@ -315,4 +315,5 @@
erpnext.patches.v14_0.create_accounting_dimensions_in_subcontracting_doctypes
erpnext.patches.v14_0.fix_subcontracting_receipt_gl_entries
erpnext.patches.v14_0.migrate_remarks_from_gl_to_payment_ledger
+erpnext.patches.v13_0.update_schedule_type_in_loans
erpnext.patches.v14_0.create_accounting_dimensions_for_asset_capitalization
diff --git a/erpnext/patches/v13_0/update_schedule_type_in_loans.py b/erpnext/patches/v13_0/update_schedule_type_in_loans.py
new file mode 100644
index 0000000..e5b5f64
--- /dev/null
+++ b/erpnext/patches/v13_0/update_schedule_type_in_loans.py
@@ -0,0 +1,14 @@
+import frappe
+
+
+def execute():
+ loan = frappe.qb.DocType("Loan")
+ loan_type = frappe.qb.DocType("Loan Type")
+
+ frappe.qb.update(loan_type).set(
+ loan_type.repayment_schedule_type, "Monthly as per repayment start date"
+ ).where(loan_type.is_term_loan == 1).run()
+
+ frappe.qb.update(loan).set(
+ loan.repayment_schedule_type, "Monthly as per repayment start date"
+ ).where(loan.is_term_loan == 1).run()