Merge pull request #373 from agritheory/368-invoices-with-valid-payment-term-discounts-are-not-applied-in-check-run

368 invoices with valid payment term discounts are not applied in check run

Author: HKuz

CHANGELOG.md

@@ -302,7 +302,7 @@ Co-authored-by: agritheory <agritheory@users.noreply.github.com>
   ([#142](https://github.com/agritheory/check_run/pull/142),
   [`f07ad5a`](https://github.com/agritheory/check_run/commit/f07ad5a1c4a9b7e424ad534ec40731f26f6feb0c))
 
-- Only increment if check numer is numeric
+- Only increment if check number is numeric
   ([#139](https://github.com/agritheory/check_run/pull/139),
   [`079aa52`](https://github.com/agritheory/check_run/commit/079aa52bf013e13d3350848ef011b74b99b64bf1))
 

check_run/check_run/doctype/check_run/check_run.py

@@ -18,7 +18,7 @@
 from frappe.permissions import has_permission
 from frappe.query_builder.custom import ConstantColumn
 from frappe.query_builder.functions import Coalesce, NullIf, Sum
-from frappe.utils.data import flt, get_datetime, getdate, now, nowdate
+from frappe.utils.data import add_months, flt, get_datetime, get_last_day, getdate, now, nowdate
 from frappe.utils.file_manager import remove_all, save_file
 from frappe.utils.password import get_decrypted_password
 from frappe.utils.print_format import read_multi_pdf
@@ -59,6 +59,7 @@ def onload(self) -> None:
 		self.set_onload(
 			"is_approver_user", settings.approver_role in frappe.get_roles(frappe.session.user)
 		)
+		self.set_onload("payment_discount_account", getattr(settings, "payment_discount_account", None))
 
 	def validate(self) -> None:
 		gl_account = frappe.get_value("Bank Account", self.bank_account, "account")
@@ -350,6 +351,7 @@ def create_payment_entries(self, transactions: list[frappe._dict]) -> list[frapp
 						f"via {_group[0].mode_of_payment} {self.get_formatted('posting_date')}"
 					)
 
+				total_discount_amount = 0.0
 				for reference in group:
 					if not reference:
 						continue
@@ -360,6 +362,12 @@ def create_payment_entries(self, transactions: list[frappe._dict]) -> list[frapp
 					):
 						if frappe.get_value(reference.doctype, reference.name, "on_hold"):
 							frappe.db.set_value(reference.doctype, reference.name, "on_hold", 0)
+
+					discount_amount = 0.0
+					if reference.doctype == "Purchase Invoice" and reference.payment_term:
+						discount_amount, has_discount = calculate_payment_term_discount(reference, self.posting_date)
+						total_discount_amount += discount_amount
+
 					if reference.doctype == "Journal Entry":
 						reference_name = reference.ref_number
 					else:
@@ -381,11 +389,22 @@ def create_payment_entries(self, transactions: list[frappe._dict]) -> list[frapp
 					total_amount += reference.amount
 					reference.check_number = pe.reference_no
 					_references.append(reference)
-				pe.received_amount = total_amount
-				pe.base_received_amount = total_amount
-				pe.paid_amount = total_amount
-				pe.base_paid_amount = total_amount
-				pe.base_grand_total = total_amount
+				pe.received_amount = total_amount - total_discount_amount
+				pe.base_received_amount = total_amount - total_discount_amount
+				pe.paid_amount = total_amount - total_discount_amount
+				pe.base_paid_amount = total_amount - total_discount_amount
+				pe.base_grand_total = total_amount - total_discount_amount
+
+				if total_discount_amount > 0 and settings.payment_discount_account:
+					pe.append(
+						"deductions",
+						{
+							"account": settings.payment_discount_account,
+							"amount": -total_discount_amount,
+							"cost_center": frappe.get_value("Company", self.company, "cost_center"),
+						},
+					)
+
 				if not pe.get("references"):  # already paid or cancelled
 					continue
 				try:
@@ -552,6 +571,45 @@ def create_and_attach_positive_pay(self):
 		)
 
 
+def calculate_payment_term_discount(transaction, payment_date):
+	if not transaction.payment_term:
+		return 0.0, False
+
+	payment_term_doc = frappe.get_doc("Payment Term", transaction.payment_term)
+	if not payment_term_doc.discount or payment_term_doc.discount <= 0:
+		return 0.0, False
+
+	posting_date = (
+		getdate(transaction.posting_date)
+		if isinstance(transaction.posting_date, str)
+		else transaction.posting_date
+	)
+
+	if payment_term_doc.discount_validity_based_on == "Day(s) after invoice date":
+		discount_end_date = posting_date + datetime.timedelta(days=payment_term_doc.discount_validity)
+	elif payment_term_doc.discount_validity_based_on == "Day(s) after the end of the invoice month":
+		last_day_of_month = get_last_day(posting_date)
+		discount_end_date = last_day_of_month + datetime.timedelta(
+			days=payment_term_doc.discount_validity
+		)
+	elif payment_term_doc.discount_validity_based_on == "Month(s) after the end of the invoice month":
+		last_day_of_month = get_last_day(posting_date)
+		discount_end_date = get_last_day(
+			add_months(last_day_of_month, payment_term_doc.discount_validity)
+		)
+
+	if payment_date > discount_end_date:
+		return 0.0, False
+
+	discount_amount = 0.0
+	if payment_term_doc.discount_type == "Percentage":
+		discount_amount = transaction.amount * (payment_term_doc.discount / 100)
+	else:
+		discount_amount = min(payment_term_doc.discount, transaction.amount)
+
+	return discount_amount, True
+
+
 @frappe.whitelist()
 def check_for_draft_check_run(company: str, bank_account: str, payable_account: str) -> str:
 	existing = frappe.get_value(
@@ -766,7 +824,15 @@ def get_entries(doc: CheckRun | str) -> dict:
 
 	file_preview_allowed = False if len(transactions) > settings.file_preview_threshold else True
 
+	posting_date = getattr(doc, "posting_date", None)
 	for transaction in transactions:
+		if transaction.doctype == "Purchase Invoice" and transaction.payment_term and posting_date:
+			discount_amount, has_discount = calculate_payment_term_discount(transaction, posting_date)
+			transaction.discount_amount = transaction.amount - discount_amount if has_discount else 0.0
+			transaction.has_discount = has_discount
+		else:
+			transaction.has_discount = False
+
 		if file_preview_allowed:
 			doc_name = transaction.ref_number if transaction.ref_number else transaction.name
 			transaction.attachments = [
@@ -796,6 +862,14 @@ def get_entries(doc: CheckRun | str) -> dict:
 		if transaction.due_date and settings.show_due_date == "Show Days Past Due":
 			transaction.due_date = (getdate(nowdate()) - transaction.due_date).days
 
+	has_discounts = any(t.get("has_discount") for t in transactions)
+	if has_discounts and settings and not settings.payment_discount_account:
+		frappe.throw(
+			frappe._(
+				"Payment Discount Account is required in Check Run Settings when processing invoices with payment term discounts. Please configure the Payment Discount Account in Check Run Settings."
+			)
+		)
+
 	outstanding_transaction = []
 	if not isinstance(doc, CheckRun):
 		if db_doc:

check_run/check_run/doctype/check_run_settings/check_run_settings.json

@@ -11,6 +11,7 @@
 		"approver_role",
 		"column_break_3",
 		"pay_to_account",
+		"payment_discount_account",
 		"print_format",
 		"section_break_4",
 		"include_purchase_invoices",
@@ -26,7 +27,6 @@
 		"set_payment_entry_posting_date",
 		"show_due_date",
 		"number_of_invoices_per_voucher",
-		"secondary_print_format",
 		"file_preview_threshold",
 		"allow_stand_alone_debit_notes",
 		"default_modes_of_payment_section_section",
@@ -316,10 +316,16 @@
 			"fieldtype": "Select",
 			"label": "Show Due Date",
 			"options": "Show Due Date\nShow Days Past Due"
+		},
+		{
+			"fieldname": "payment_discount_account",
+			"fieldtype": "Link",
+			"label": "Payment Discount Account",
+			"options": "Account"
 		}
 	],
 	"links": [],
-	"modified": "2025-06-22 14:56:43.637709",
+	"modified": "2025-07-29 13:59:10.135620",
 	"modified_by": "Administrator",
 	"module": "Check Run",
 	"name": "Check Run Settings",
@@ -352,6 +358,7 @@
 		}
 	],
 	"quick_entry": 1,
+	"row_format": "Dynamic",
 	"sort_field": "modified",
 	"sort_order": "DESC",
 	"states": [],

check_run/public/js/check_run/CheckRun.vue

@@ -154,8 +154,11 @@
 							</select>
 							<span v-else>{{ transactions[item.name].mode_of_payment }}</span>
 						</td>
-						<td>{{ format_currency(item.amount, frm.pay_to_account_currency, 2) }}</td>
-						<td>{{ item.due_date }}</td>
+						<td v-if="item.has_discount">
+							{{ format_currency(item.discount_amount, frm.pay_to_account_currency, 2) }}
+						</td>
+						<td v-else>{{ format_currency(item.amount, frm.pay_to_account_currency, 2) }}</td>
+						<td>{{ datetime.str_to_user(item.due_date) }}</td>
 						<td v-if="item.on_hold && frm.settings.automatically_release_on_hold_invoices == 0">
 							<span style="font-weight: bold">On Hold</span>
 						</td>