blob: 0c554f2374002f9acab79290d2edebc229aa03dc [file] [log] [blame]
Anand Doshi885e0742015-03-03 14:55:30 +05301# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
Rushabh Mehtae67d1fb2013-08-05 14:59:54 +05302# License: GNU General Public License v3. See license.txt
Nabin Hait2df4d542013-01-29 11:34:39 +05303
Chillar Anand915b3432021-09-02 16:44:59 +05304
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08005import json
Chillar Anand915b3432021-09-02 16:44:59 +05306
7import frappe
ruthra kumar81cd7872023-04-27 09:46:54 +05308from frappe import _, bold, qb, throw
Chillar Anand915b3432021-09-02 16:44:59 +05309from frappe.model.workflow import get_workflow_name, is_transition_condition_satisfied
Gursheen Anand74619262023-06-02 17:13:51 +053010from frappe.query_builder.custom import ConstantColumn
Gursheen Anand4ee16372023-06-08 13:15:23 +053011from frappe.query_builder.functions import Abs, Sum
Chillar Anand915b3432021-09-02 16:44:59 +053012from frappe.utils import (
13 add_days,
14 add_months,
15 cint,
ruthra kumar0cdd6432023-10-11 14:42:23 +053016 comma_and,
Chillar Anand915b3432021-09-02 16:44:59 +053017 flt,
18 fmt_money,
19 formatdate,
20 get_last_day,
21 get_link_to_form,
22 getdate,
23 nowdate,
GangaManojd24cfff2021-10-28 20:06:48 +053024 today,
Chillar Anand915b3432021-09-02 16:44:59 +053025)
Chillar Anand915b3432021-09-02 16:44:59 +053026
27import erpnext
28from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import (
29 get_accounting_dimensions,
30)
31from erpnext.accounts.doctype.pricing_rule.utils import (
32 apply_pricing_rule_for_free_items,
33 apply_pricing_rule_on_transaction,
34 get_applied_pricing_rules,
35)
Deepesh Garg492ea3b2023-08-08 11:39:44 +053036from erpnext.accounts.general_ledger import get_round_off_account_and_cost_center
Chillar Anand915b3432021-09-02 16:44:59 +053037from erpnext.accounts.party import (
38 get_party_account,
39 get_party_account_currency,
Deepesh Garga7f15a02021-12-12 21:09:11 +053040 get_party_gle_currency,
Chillar Anand915b3432021-09-02 16:44:59 +053041 validate_party_frozen_disabled,
42)
ruthra kumar1ea1bfe2023-07-26 16:19:38 +053043from erpnext.accounts.utils import (
44 create_gain_loss_journal,
45 get_account_currency,
46 get_fiscal_years,
47 validate_fiscal_year,
48)
Chillar Anand915b3432021-09-02 16:44:59 +053049from erpnext.buying.utils import update_last_purchase_rate
50from erpnext.controllers.print_settings import (
51 set_print_templates_for_item_table,
52 set_print_templates_for_taxes,
53)
54from erpnext.controllers.sales_and_purchase_return import validate_return
55from erpnext.exceptions import InvalidCurrency
56from erpnext.setup.utils import get_exchange_rate
Ankush Menat10583eb2022-06-17 12:13:27 +053057from erpnext.stock.doctype.item.item import get_uom_conv_factor
Marica3dee5272020-06-23 10:33:47 +053058from erpnext.stock.doctype.packed_item.packed_item import make_packing_list
Chillar Anand915b3432021-09-02 16:44:59 +053059from erpnext.stock.get_item_details import (
60 _get_item_tax_template,
61 get_conversion_factor,
62 get_item_details,
63 get_item_tax_map,
64 get_item_warehouse,
65)
Sagar Vora4205f562023-07-24 18:37:36 +053066from erpnext.utilities.regional import temporary_flag
Chillar Anand915b3432021-09-02 16:44:59 +053067from erpnext.utilities.transaction_base import TransactionBase
68
Nabin Hait1d218422015-07-17 15:19:02 +053069
Ankush Menat494bd9e2022-03-28 18:52:46 +053070class AccountMissingError(frappe.ValidationError):
71 pass
marination53b1a9a2020-11-03 15:45:25 +053072
Ankush Menat494bd9e2022-03-28 18:52:46 +053073
Maricab9f5a1c2023-11-27 09:05:22 +053074class InvalidQtyError(frappe.ValidationError):
75 pass
76
77
Ankush Menat494bd9e2022-03-28 18:52:46 +053078force_item_fields = (
79 "item_group",
80 "brand",
81 "stock_uom",
82 "is_fixed_asset",
83 "item_tax_rate",
84 "pricing_rules",
85 "weight_per_unit",
86 "weight_uom",
87 "total_weight",
88)
89
Doridel Cahanap6f06cc22018-05-17 16:28:58 +080090
Nabin Haitbf495c92013-01-30 12:49:08 +053091class AccountsController(TransactionBase):
Nabin Hait7eba1a32017-10-02 15:59:27 +053092 def __init__(self, *args, **kwargs):
93 super(AccountsController, self).__init__(*args, **kwargs)
Anand Doshi979326b2015-09-11 16:22:37 +053094
prssanna71e5b602020-10-29 14:19:34 +053095 def get_print_settings(self):
96 print_setting_fields = []
Ankush Menat494bd9e2022-03-28 18:52:46 +053097 items_field = self.meta.get_field("items")
prssanna71e5b602020-10-29 14:19:34 +053098
Ankush Menat494bd9e2022-03-28 18:52:46 +053099 if items_field and items_field.fieldtype == "Table":
100 print_setting_fields += ["compact_item_print", "print_uom_after_quantity"]
prssanna71e5b602020-10-29 14:19:34 +0530101
Ankush Menat494bd9e2022-03-28 18:52:46 +0530102 taxes_field = self.meta.get_field("taxes")
103 if taxes_field and taxes_field.fieldtype == "Table":
104 print_setting_fields += ["print_taxes_with_zero_amount"]
prssanna71e5b602020-10-29 14:19:34 +0530105
106 return print_setting_fields
107
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530108 @property
109 def company_currency(self):
110 if not hasattr(self, "__company_currency"):
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530111 self.__company_currency = erpnext.get_company_currency(self.company)
Anand Doshi979326b2015-09-11 16:22:37 +0530112
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530113 return self.__company_currency
Anand Doshi979326b2015-09-11 16:22:37 +0530114
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530115 def onload(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530116 self.set_onload(
117 "make_payment_via_journal_entry",
118 frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"),
119 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530120
tundee52bb822017-09-25 09:02:23 +0100121 if self.is_new():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530122 relevant_docs = (
123 "Quotation",
124 "Purchase Order",
125 "Sales Order",
126 "Purchase Invoice",
127 "Sales Invoice",
128 )
tundee52bb822017-09-25 09:02:23 +0100129 if self.doctype in relevant_docs:
130 self.set_payment_schedule()
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530131
rohitwaghchauref09e2132024-01-04 14:58:02 +0530132 def remove_bundle_for_non_stock_invoices(self):
133 has_sabb = False
134 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.update_stock:
135 for item in self.get("items"):
136 if item.serial_and_batch_bundle:
137 item.serial_and_batch_bundle = None
138 has_sabb = True
139
140 if has_sabb:
141 self.remove_serial_and_batch_bundle()
142
tundebabzyad08d4c2018-05-16 07:01:41 +0100143 def ensure_supplier_is_not_blocked(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530144 is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier"
145 is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"]
tundebabzyad08d4c2018-05-16 07:01:41 +0100146 supplier = None
147 supplier_name = None
148
149 if is_buying_invoice or is_supplier_payment:
150 supplier_name = self.supplier if is_buying_invoice else self.party
Ankush Menat494bd9e2022-03-28 18:52:46 +0530151 supplier = frappe.get_doc("Supplier", supplier_name)
tundebabzyad08d4c2018-05-16 07:01:41 +0100152
153 if supplier and supplier_name and supplier.on_hold:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530154 if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or (
155 is_supplier_payment and supplier.hold_type in ["All", "Payments"]
156 ):
tundebabzyad08d4c2018-05-16 07:01:41 +0100157 if not supplier.release_date or getdate(nowdate()) <= supplier.release_date:
158 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530159 _("{0} is blocked so this transaction cannot proceed").format(supplier_name),
160 raise_exception=1,
161 )
tundebabzyad08d4c2018-05-16 07:01:41 +0100162
Saurabh6f753182013-03-20 12:55:28 +0530163 def validate(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530164 if not self.get("is_return") and not self.get("is_debit_note"):
Deepesh Gargd301d262019-07-31 15:58:19 +0530165 self.validate_qty_is_not_zero()
166
nabinhait23cce732014-07-03 12:25:06 +0530167 if self.get("_action") and self._action != "update_after_submit":
Nabin Hait704a4532014-06-05 16:55:31 +0530168 self.set_missing_values(for_validate=True)
tunde62af5c52017-09-22 15:16:38 +0100169
rohitwaghchauref09e2132024-01-04 14:58:02 +0530170 if self.get("_action") == "submit":
171 self.remove_bundle_for_non_stock_invoices()
172
tundebabzyad08d4c2018-05-16 07:01:41 +0100173 self.ensure_supplier_is_not_blocked()
174
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530175 self.validate_date_with_fiscal_year()
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530176 self.validate_party_accounts()
177
Deepesh Gargb4be2922021-01-28 13:09:56 +0530178 self.validate_inter_company_reference()
179
Ankush Menat3714e362022-05-16 18:09:14 +0530180 self.disable_pricing_rule_on_internal_transfer()
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530181 self.disable_tax_included_prices_for_internal_transfer()
Deepesh Gargb4be2922021-01-28 13:09:56 +0530182 self.set_incoming_rate()
Deepesh Garg25889702023-12-12 15:18:54 +0530183 self.init_internal_values()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530184
Anand Doshi3543f302013-05-24 19:25:01 +0530185 if self.meta.get_field("currency"):
Anand Doshi923d41d2013-05-28 17:23:36 +0530186 self.calculate_taxes_and_totals()
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530187
Nabin Hait1d218422015-07-17 15:19:02 +0530188 if not self.meta.get_field("is_return") or not self.is_return:
189 self.validate_value("base_grand_total", ">=", 0)
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530190
Nabin Hait3cf67a42015-07-24 13:26:36 +0530191 validate_return(self)
Anand Doshid2946502014-04-08 20:10:03 +0530192
tunde62af5c52017-09-22 15:16:38 +0100193 self.validate_all_documents_schedule()
Anand Doshid2946502014-04-08 20:10:03 +0530194
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530195 if self.meta.get_field("taxes_and_charges"):
196 self.validate_enabled_taxes_and_charges()
Nabin Haita2426fc2018-01-15 17:45:46 +0530197 self.validate_tax_account_company()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530198
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +0530199 self.validate_party()
Nabin Hait895029d2015-08-20 14:55:39 +0530200 self.validate_currency()
Deepesh Garg80c85dd2021-08-12 15:39:07 +0530201 self.validate_party_account_currency()
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530202
Ankush Menat494bd9e2022-03-28 18:52:46 +0530203 if self.doctype in ["Purchase Invoice", "Sales Invoice"]:
ruthra kumar0cdd6432023-10-11 14:42:23 +0530204 if invalid_advances := [
205 x for x in self.advances if not x.reference_type or not x.reference_name
206 ]:
207 frappe.throw(
208 _(
209 "Rows: {0} in {1} section are Invalid. Reference Name should point to a valid Payment Entry or Journal Entry."
210 ).format(
211 frappe.bold(comma_and([x.idx for x in invalid_advances])), frappe.bold(_("Advance Payments"))
212 )
213 )
214
Ankush Menat494bd9e2022-03-28 18:52:46 +0530215 pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid"
Nabin Hait4a994d42019-04-25 17:47:26 +0530216 if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)):
Nabin Hait041a5c22018-08-01 18:07:39 +0530217 self.set_advances()
218
Saqiba20999c2021-07-12 14:33:23 +0530219 self.set_advance_gain_or_loss()
220
Nabin Hait041a5c22018-08-01 18:07:39 +0530221 if self.is_return:
222 self.validate_qty()
Nabin Haitacdd5082019-12-04 15:30:01 +0530223 else:
224 self.validate_deferred_start_and_end_date()
rohitwaghchaure70489252018-06-11 12:02:14 +0530225
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530226 self.validate_deferred_income_expense_account()
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530227 self.set_inter_company_account()
228
Ankush Menat494bd9e2022-03-28 18:52:46 +0530229 if self.doctype == "Purchase Invoice":
Deepesh Garg7f06c8c2021-11-26 10:27:57 +0530230 self.calculate_paid_amount()
231 # apply tax withholding only if checked and applicable
232 self.set_tax_withholding()
233
Dany Robert9bc59522023-08-26 18:14:40 +0530234 with temporary_flag("company", self.company):
235 validate_regional(self)
236 validate_einvoice_fields(self)
Saqib Ansaric5782b02022-01-27 20:09:56 +0530237
Deepesh Gargb741ae12022-12-02 17:14:06 +0530238 if self.doctype != "Material Request" and not self.ignore_pricing_rule:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530239 apply_pricing_rule_on_transaction(self)
Gauravf1e28e02019-02-13 16:46:24 +0530240
RitvikSardana03f0abf2023-09-19 13:08:17 +0530241 self.set_total_in_words()
Deepesh Garg3b4b2272023-12-29 08:25:38 +0530242 self.set_default_letter_head()
243
244 def set_default_letter_head(self):
245 if hasattr(self, "letter_head") and not self.letter_head:
246 self.letter_head = frappe.db.get_value("Company", self.company, "default_letter_head")
RitvikSardana03f0abf2023-09-19 13:08:17 +0530247
Deepesh Garg25889702023-12-12 15:18:54 +0530248 def init_internal_values(self):
249 # init all the internal values as 0 on sa
250 if self.docstatus.is_draft():
251 # TODO: Add all such pending values here
252 fields = ["billed_amt", "delivered_qty"]
253 for item in self.get("items"):
254 for field in fields:
255 if hasattr(item, field):
256 item.set(field, 0)
257
Saqib Ansaric5782b02022-01-27 20:09:56 +0530258 def before_cancel(self):
259 validate_einvoice_fields(self)
260
ruthra kumar42df0d32023-08-28 17:36:12 +0530261 def _remove_references_in_unreconcile(self):
ruthra kumar9a1588f2023-08-30 20:50:16 +0530262 upe = frappe.qb.DocType("Unreconcile Payment Entries")
ruthra kumar42df0d32023-08-28 17:36:12 +0530263 rows = (
264 frappe.qb.from_(upe)
265 .select(upe.name, upe.parent)
266 .where((upe.reference_doctype == self.doctype) & (upe.reference_name == self.name))
267 .run(as_dict=True)
268 )
269
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530270 if rows:
271 references_map = frappe._dict()
272 for x in rows:
273 references_map.setdefault(x.parent, []).append(x.name)
ruthra kumar42df0d32023-08-28 17:36:12 +0530274
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530275 for doc, rows in references_map.items():
ruthra kumar74f9e342023-11-21 16:51:06 +0530276 unreconcile_doc = frappe.get_doc("Unreconcile Payment", doc)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530277 for row in rows:
278 unreconcile_doc.remove(unreconcile_doc.get("allocations", {"name": row})[0])
ruthra kumar42df0d32023-08-28 17:36:12 +0530279
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530280 unreconcile_doc.flags.ignore_validate_update_after_submit = True
281 unreconcile_doc.flags.ignore_links = True
282 unreconcile_doc.save(ignore_permissions=True)
283
284 # delete docs upon parent doc deletion
ruthra kumar74f9e342023-11-21 16:51:06 +0530285 unreconcile_docs = frappe.db.get_all("Unreconcile Payment", filters={"voucher_no": self.name})
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530286 for x in unreconcile_docs:
ruthra kumar74f9e342023-11-21 16:51:06 +0530287 _doc = frappe.get_doc("Unreconcile Payment", x.name)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530288 if _doc.docstatus == 1:
289 _doc.cancel()
290 _doc.delete()
ruthra kumar42df0d32023-08-28 17:36:12 +0530291
ruthra kumared7f67b2023-09-26 14:23:21 +0530292 def _remove_references_in_repost_doctypes(self):
293 repost_doctypes = ["Repost Payment Ledger Items", "Repost Accounting Ledger Items"]
ruthra kumarc722f282023-02-19 12:09:10 +0530294
ruthra kumared7f67b2023-09-26 14:23:21 +0530295 for _doctype in repost_doctypes:
296 dt = frappe.qb.DocType(_doctype)
297 rows = (
298 frappe.qb.from_(dt)
299 .select(dt.name, dt.parent, dt.parenttype)
300 .where((dt.voucher_type == self.doctype) & (dt.voucher_no == self.name))
301 .run(as_dict=True)
302 )
303
304 if rows:
305 references_map = frappe._dict()
306 for x in rows:
307 references_map.setdefault((x.parenttype, x.parent), []).append(x.name)
308
309 for doc, rows in references_map.items():
310 repost_doc = frappe.get_doc(doc[0], doc[1])
311
312 for row in rows:
313 if _doctype == "Repost Payment Ledger Items":
314 repost_doc.remove(repost_doc.get("repost_vouchers", {"name": row})[0])
315 else:
316 repost_doc.remove(repost_doc.get("vouchers", {"name": row})[0])
317
318 repost_doc.flags.ignore_validate_update_after_submit = True
319 repost_doc.flags.ignore_links = True
320 repost_doc.save(ignore_permissions=True)
321
322 def on_trash(self):
323 self._remove_references_in_repost_doctypes()
ruthra kumar42df0d32023-08-28 17:36:12 +0530324 self._remove_references_in_unreconcile()
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530325 self.remove_serial_and_batch_bundle()
ruthra kumarfbdfb812023-08-28 16:27:29 +0530326
Saqib8e556772021-01-28 12:26:45 +0530327 # delete sl and gl entries on deletion of transaction
Ankush Menat494bd9e2022-03-28 18:52:46 +0530328 if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"):
ruthra kumar70313df2022-09-08 18:53:30 +0530329 ple = frappe.qb.DocType("Payment Ledger Entry")
330 frappe.qb.from_(ple).delete().where(
331 (ple.voucher_type == self.doctype) & (ple.voucher_no == self.name)
332 ).run()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530333 frappe.db.sql(
334 "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)
335 )
336 frappe.db.sql(
337 "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s",
338 (self.doctype, self.name),
339 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530340
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530341 def remove_serial_and_batch_bundle(self):
342 bundles = frappe.get_all(
343 "Serial and Batch Bundle",
344 filters={"voucher_type": self.doctype, "voucher_no": self.name, "docstatus": ("!=", 1)},
345 )
346
347 for bundle in bundles:
348 frappe.delete_doc("Serial and Batch Bundle", bundle.name)
349
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530350 def validate_deferred_income_expense_account(self):
351 field_map = {
352 "Sales Invoice": "deferred_revenue_account",
353 "Purchase Invoice": "deferred_expense_account",
354 }
355
356 for item in self.get("items"):
357 if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"):
358 if not item.get(field_map.get(self.doctype)):
Daizy Modi4efc9472022-11-07 09:21:03 +0530359 default_deferred_account = frappe.get_cached_value(
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530360 "Company", self.company, "default_" + field_map.get(self.doctype)
361 )
362 if not default_deferred_account:
363 frappe.throw(
364 _(
365 "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master"
366 ).format(item.idx)
367 )
368 else:
369 item.set(field_map.get(self.doctype), default_deferred_account)
370
Deepesh Gargfa152212022-11-28 19:22:35 +0530371 def validate_auto_repeat_subscription_dates(self):
Deepesh Garg6a47fb62022-11-28 22:47:44 +0530372 if (
373 self.get("from_date")
374 and self.get("to_date")
375 and getdate(self.from_date) > getdate(self.to_date)
376 ):
Deepesh Gargfa152212022-11-28 19:22:35 +0530377 frappe.throw(_("To Date cannot be before From Date"), title=_("Invalid Auto Repeat Date"))
378
Nabin Haitacdd5082019-12-04 15:30:01 +0530379 def validate_deferred_start_and_end_date(self):
380 for d in self.items:
381 if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"):
382 if not (d.service_start_date and d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530383 frappe.throw(
384 _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)
385 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530386 elif getdate(d.service_start_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530387 frappe.throw(
388 _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)
389 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530390 elif getdate(self.posting_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530391 frappe.throw(
392 _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)
393 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530394
tunde62af5c52017-09-22 15:16:38 +0100395 def validate_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530396 self.validate_payment_schedule_dates()
397 self.set_due_date()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530398 self.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530399 if not self.get("ignore_default_payment_terms_template"):
Deepesh Garg5c758942023-04-16 17:11:24 +0530400 self.validate_payment_schedule_amount()
Deepesh Gargbd709f82021-08-23 19:05:52 +0530401 self.validate_due_date()
tunde62af5c52017-09-22 15:16:38 +0100402 self.validate_advance_entries()
403
404 def validate_non_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530405 self.set_payment_schedule()
Nabin Hait2f9f4f92017-12-20 12:24:59 +0530406 self.validate_payment_schedule_dates()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530407 self.validate_payment_schedule_amount()
tunde62af5c52017-09-22 15:16:38 +0100408
409 def validate_all_documents_schedule(self):
410 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.is_return:
411 self.validate_invoice_documents_schedule()
412 elif self.doctype in ("Quotation", "Purchase Order", "Sales Order"):
413 self.validate_non_invoice_documents_schedule()
414
prssanna71e5b602020-10-29 14:19:34 +0530415 def before_print(self, settings=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530416 if self.doctype in [
417 "Purchase Order",
418 "Sales Order",
419 "Sales Invoice",
420 "Purchase Invoice",
421 "Supplier Quotation",
422 "Purchase Receipt",
423 "Delivery Note",
424 "Quotation",
425 ]:
KanchanChauhan49a50fe2016-11-18 13:57:53 +0530426 if self.get("group_same_items"):
427 self.group_similar_items()
428
Zarrar5be6d192018-11-08 12:16:26 +0530429 df = self.meta.get_field("discount_amount")
430 if self.get("discount_amount") and hasattr(self, "taxes") and not len(self.taxes):
431 df.set("print_hide", 0)
432 self.discount_amount = -self.discount_amount
433 else:
434 df.set("print_hide", 1)
435
prssanna71e5b602020-10-29 14:19:34 +0530436 set_print_templates_for_item_table(self, settings)
437 set_print_templates_for_taxes(self, settings)
438
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530439 def calculate_paid_amount(self):
Saurabh43520f92016-03-21 18:32:48 +0530440 if hasattr(self, "is_pos") or hasattr(self, "is_paid"):
441 is_paid = self.get("is_pos") or self.get("is_paid")
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530442
443 if is_paid:
444 if not self.cash_bank_account:
445 # show message that the amount is not paid
Ankush Menat494bd9e2022-03-28 18:52:46 +0530446 frappe.throw(
447 _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")
448 )
Marica23d7b092019-09-25 17:17:36 +0530449
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530450 if cint(self.is_return) and self.grand_total > self.paid_amount:
451 self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount"))
452
453 elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0:
454 self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount"))
455
Ankush Menat494bd9e2022-03-28 18:52:46 +0530456 self.base_paid_amount = flt(
457 self.paid_amount * self.conversion_rate, self.precision("base_paid_amount")
458 )
Saurabh43520f92016-03-21 18:32:48 +0530459
Anand Doshiabc10032013-06-14 17:44:03 +0530460 def set_missing_values(self, for_validate=False):
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530461 if frappe.flags.in_test:
tunde62af5c52017-09-22 15:16:38 +0100462 for fieldname in ["posting_date", "transaction_date"]:
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530463 if self.meta.get_field(fieldname) and not self.get(fieldname):
464 self.set(fieldname, today())
465 break
Anand Doshid2946502014-04-08 20:10:03 +0530466
Nabin Hait3237c752015-02-17 11:11:11 +0530467 def calculate_taxes_and_totals(self):
Nabin Haitfe81da22015-02-18 12:23:18 +0530468 from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals
Ankush Menat494bd9e2022-03-28 18:52:46 +0530469
Nabin Haitfe81da22015-02-18 12:23:18 +0530470 calculate_taxes_and_totals(self)
Nabin Hait3237c752015-02-17 11:11:11 +0530471
Raffael Meyere10ab162021-11-30 13:24:18 +0100472 if self.doctype in (
Ankush Menat494bd9e2022-03-28 18:52:46 +0530473 "Sales Order",
474 "Delivery Note",
475 "Sales Invoice",
476 "POS Invoice",
Raffael Meyere10ab162021-11-30 13:24:18 +0100477 ):
Nabin Hait3237c752015-02-17 11:11:11 +0530478 self.calculate_commission()
479 self.calculate_contribution()
480
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530481 def validate_date_with_fiscal_year(self):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +0800482 if self.meta.get_field("fiscal_year"):
Rohan Bansal1e3a3b22021-05-26 15:18:10 +0530483 date_field = None
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530484 if self.meta.get_field("posting_date"):
485 date_field = "posting_date"
486 elif self.meta.get_field("transaction_date"):
487 date_field = "transaction_date"
Anand Doshid2946502014-04-08 20:10:03 +0530488
Rushabh Mehtaf2227d02014-03-31 23:37:40 +0530489 if date_field and self.get(date_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530490 validate_fiscal_year(
491 self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self
492 )
Anand Doshid2946502014-04-08 20:10:03 +0530493
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530494 def validate_party_accounts(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530495 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530496 return
497
Ankush Menat494bd9e2022-03-28 18:52:46 +0530498 if self.doctype == "Sales Invoice":
499 party_account_field = "debit_to"
500 item_field = "income_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530501 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530502 party_account_field = "credit_to"
503 item_field = "expense_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530504
Ankush Menat494bd9e2022-03-28 18:52:46 +0530505 for item in self.get("items"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530506 if item.get(item_field) == self.get(party_account_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530507 frappe.throw(
508 _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(
509 item.idx,
510 frappe.bold(frappe.unscrub(item_field)),
511 item.get(item_field),
512 frappe.bold(frappe.unscrub(party_account_field)),
513 self.get(party_account_field),
514 )
515 )
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530516
Deepesh Gargb4be2922021-01-28 13:09:56 +0530517 def validate_inter_company_reference(self):
Rohit Waghchaure38aaba52023-05-13 13:00:05 +0530518 if self.get("is_return"):
519 return
520
Rohit Waghchaureb4a102d2022-09-06 16:22:00 +0530521 if self.doctype not in ("Purchase Invoice", "Purchase Receipt"):
Deepesh Gargb4be2922021-01-28 13:09:56 +0530522 return
523
524 if self.is_internal_transfer():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530525 if not (
526 self.get("inter_company_reference")
527 or self.get("inter_company_invoice_reference")
528 or self.get("inter_company_order_reference")
Deepesh Garg906ad102023-01-15 17:32:57 +0530529 ) and not self.get("is_return"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530530 msg = _("Internal Sale or Delivery Reference missing.")
Deepesh Gargb4be2922021-01-28 13:09:56 +0530531 msg += _("Please create purchase from internal sale or delivery document itself")
532 frappe.throw(msg, title=_("Internal Sales Reference Missing"))
533
Rohit Waghchaure19911b42023-04-21 16:49:48 +0530534 label = "Delivery Note Item" if self.doctype == "Purchase Receipt" else "Sales Invoice Item"
535
536 field = frappe.scrub(label)
537
538 for row in self.get("items"):
539 if not row.get(field):
540 msg = f"At Row {row.idx}: The field {bold(label)} is mandatory for internal transfer"
541 frappe.throw(_(msg), title=_("Internal Transfer Reference Missing"))
542
Ankush Menat3714e362022-05-16 18:09:14 +0530543 def disable_pricing_rule_on_internal_transfer(self):
544 if not self.get("ignore_pricing_rule") and self.is_internal_transfer():
545 self.ignore_pricing_rule = 1
546 frappe.msgprint(
547 _("Disabled pricing rules since this {} is an internal transfer").format(self.doctype),
548 alert=1,
549 )
550
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530551 def disable_tax_included_prices_for_internal_transfer(self):
552 if self.is_internal_transfer():
553 tax_updated = False
554 for tax in self.get("taxes"):
555 if tax.get("included_in_print_rate"):
556 tax.included_in_print_rate = 0
557 tax_updated = True
558
559 if tax_updated:
560 frappe.msgprint(
561 _("Disabled tax included prices since this {} is an internal transfer").format(self.doctype),
562 alert=1,
563 )
564
Nabin Haite9daefe2014-08-27 16:46:33 +0530565 def validate_due_date(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530566 if self.get("is_pos"):
567 return
rohitwaghchaureea943c62018-07-06 12:28:58 +0530568
Nabin Haite9daefe2014-08-27 16:46:33 +0530569 from erpnext.accounts.party import validate_due_date
Ankush Menat494bd9e2022-03-28 18:52:46 +0530570
Nabin Haite9daefe2014-08-27 16:46:33 +0530571 if self.doctype == "Sales Invoice":
Nabin Hait04d244a2015-07-22 17:47:49 +0530572 if not self.due_date:
573 frappe.throw(_("Due Date is mandatory"))
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530574
Ankush Menat494bd9e2022-03-28 18:52:46 +0530575 validate_due_date(
576 self.posting_date,
577 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530578 self.payment_terms_template,
579 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530580 elif self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530581 validate_due_date(
582 self.bill_date or self.posting_date,
583 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530584 self.bill_date,
585 self.payment_terms_template,
586 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530587
Nabin Hait096d3632013-10-17 17:01:14 +0530588 def set_price_list_currency(self, buying_or_selling):
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530589 if self.meta.get_field("posting_date"):
Nabin Hait288a18e2016-12-08 15:36:23 +0530590 transaction_date = self.posting_date
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530591 else:
Nabin Hait288a18e2016-12-08 15:36:23 +0530592 transaction_date = self.transaction_date
Rushabh Mehta66958302017-01-16 16:57:53 +0530593
Rushabh Mehta4a404e92013-08-09 18:11:35 +0530594 if self.meta.get_field("currency"):
Nabin Hait7a75e102013-09-17 10:21:20 +0530595 # price list part
Shreya3f778522018-05-15 16:59:20 +0530596 if buying_or_selling.lower() == "selling":
597 fieldname = "selling_price_list"
598 args = "for_selling"
599 else:
600 fieldname = "buying_price_list"
601 args = "for_buying"
602
Anand Doshif78d1ae2014-03-28 13:55:00 +0530603 if self.meta.get_field(fieldname) and self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530604 self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency")
Anand Doshid2946502014-04-08 20:10:03 +0530605
Nabin Hait6e439a52015-08-28 19:24:22 +0530606 if self.price_list_currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530607 self.plc_conversion_rate = 1.0
Nabin Hait11f41952013-09-24 14:36:55 +0530608
Anand Doshif78d1ae2014-03-28 13:55:00 +0530609 elif not self.plc_conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530610 self.plc_conversion_rate = get_exchange_rate(
611 self.price_list_currency, self.company_currency, transaction_date, args
612 )
Anand Doshid2946502014-04-08 20:10:03 +0530613
Nabin Hait7a75e102013-09-17 10:21:20 +0530614 # currency
Anand Doshif78d1ae2014-03-28 13:55:00 +0530615 if not self.currency:
616 self.currency = self.price_list_currency
617 self.conversion_rate = self.plc_conversion_rate
Nabin Hait6e439a52015-08-28 19:24:22 +0530618 elif self.currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530619 self.conversion_rate = 1.0
620 elif not self.conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530621 self.conversion_rate = get_exchange_rate(
622 self.currency, self.company_currency, transaction_date, args
623 )
Nabin Hait7a75e102013-09-17 10:21:20 +0530624
ruthra kumar08315522023-10-03 09:53:41 +0530625 if (
626 self.currency
627 and buying_or_selling == "Buying"
628 and frappe.db.get_single_value("Buying Settings", "use_transaction_date_exchange_rate")
629 and self.doctype == "Purchase Invoice"
630 ):
631 self.use_transaction_date_exchange_rate = True
632 self.conversion_rate = get_exchange_rate(
633 self.currency, self.company_currency, transaction_date, args
634 )
635
Nabin Haitcccc45e2016-10-05 17:15:43 +0530636 def set_missing_item_details(self, for_validate=False):
Anand Doshi3543f302013-05-24 19:25:01 +0530637 """set missing item values"""
Nabin Haitf37d43d2017-07-18 12:14:42 +0530638 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530639
Nabin Haitdd38a262014-12-26 13:15:21 +0530640 if hasattr(self, "items"):
Nabin Hait444f9562014-06-20 15:59:49 +0530641 parent_dict = {}
Pratik Vyasf7daab72014-04-10 17:53:30 +0530642 for fieldname in self.meta.get_valid_columns():
643 parent_dict[fieldname] = self.get(fieldname)
644
mbauskara52472c2016-03-05 15:10:25 +0530645 if self.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
646 document_type = "{} Item".format(self.doctype)
mbauskarc97becb2016-01-18 16:28:21 +0530647 parent_dict.update({"document_type": document_type})
648
Nabin Hait34c551d2019-07-03 10:34:31 +0530649 # party_name field used for customer in quotation
Ankush Menat494bd9e2022-03-28 18:52:46 +0530650 if (
651 self.doctype == "Quotation"
652 and self.quotation_to == "Customer"
653 and parent_dict.get("party_name")
654 ):
Nabin Hait34c551d2019-07-03 10:34:31 +0530655 parent_dict.update({"customer": parent_dict.get("party_name")})
656
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530657 self.pricing_rules = []
Deepesh Garg4c61ee32023-04-02 09:35:27 +0530658
Nabin Haitdd38a262014-12-26 13:15:21 +0530659 for item in self.get("items"):
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530660 if item.get("item_code"):
Nabin Hait444f9562014-06-20 15:59:49 +0530661 args = parent_dict.copy()
662 args.update(item.as_dict())
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530663
Nabin Hait34d28222016-01-19 15:45:49 +0530664 args["doctype"] = self.doctype
665 args["name"] = self.name
Smit Vorab206b052023-11-23 15:10:47 +0530666 args["child_doctype"] = item.doctype
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530667 args["child_docname"] = item.name
Ankush Menat494bd9e2022-03-28 18:52:46 +0530668 args["ignore_pricing_rule"] = (
669 self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0
670 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530671
Nabin Haite2f054c2015-03-09 14:54:37 +0530672 if not args.get("transaction_date"):
673 args["transaction_date"] = args.get("posting_date")
Anand Doshi2b2b6392015-03-20 14:18:09 +0530674
675 if self.get("is_subcontracted"):
676 args["is_subcontracted"] = self.is_subcontracted
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530677
Deepesh Garga7051cb2023-04-14 09:59:42 +0530678 ret = get_item_details(args, self, for_validate=True, overwrite_warehouse=False)
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530679
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530680 for fieldname, value in ret.items():
Anand Doshi602e8252015-11-16 19:05:46 +0530681 if item.meta.get_field(fieldname) and value is not None:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530682 if item.get(fieldname) is None or fieldname in force_item_fields:
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530683 item.set(fieldname, value)
Anand Doshid2946502014-04-08 20:10:03 +0530684
Ankush Menat494bd9e2022-03-28 18:52:46 +0530685 elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname):
Anand Doshi602e8252015-11-16 19:05:46 +0530686 item.set(fieldname, value)
687
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530688 elif fieldname == "serial_no":
Alchez9155e402018-07-09 16:57:42 +0530689 # Ensure that serial numbers are matched against Stock UOM
690 item_conversion_factor = item.get("conversion_factor") or 1.0
691 item_qty = abs(item.get("qty")) * item_conversion_factor
Alchez8f2a0f32018-07-06 14:36:52 +0530692
Ankush Menat494bd9e2022-03-28 18:52:46 +0530693 if item_qty != len(get_serial_nos(item.get("serial_no"))):
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530694 item.set(fieldname, value)
Nabin Haita74468b2014-12-30 18:33:52 +0530695
Saqib Ansariab36b272022-02-09 10:10:17 +0530696 elif (
697 ret.get("pricing_rule_removed")
698 and value is not None
699 and fieldname
700 in [
701 "discount_percentage",
702 "discount_amount",
703 "rate",
704 "margin_rate_or_amount",
705 "margin_type",
706 "remove_free_item",
707 ]
708 ):
Saqib Ansarib8c41e32022-01-20 13:06:08 +0530709 # reset pricing rule fields if pricing_rule_removed
710 item.set(fieldname, value)
711
Ankush Menat494bd9e2022-03-28 18:52:46 +0530712 if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field(
713 "is_fixed_asset"
714 ):
715 item.set("is_fixed_asset", ret.get("is_fixed_asset", 0))
Rohit Waghchauref6f503a2018-12-19 15:06:44 +0530716
Deepesh Garga60c3082021-05-11 16:38:33 +0530717 # Double check for cost center
718 # Items add via promotional scheme may not have cost center set
Ankush Menat494bd9e2022-03-28 18:52:46 +0530719 if hasattr(item, "cost_center") and not item.get("cost_center"):
720 item.set(
721 "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company)
722 )
Deepesh Garga60c3082021-05-11 16:38:33 +0530723
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530724 if ret.get("pricing_rules"):
725 self.apply_pricing_rule_on_items(item, ret)
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530726 self.set_pricing_rule_details(item, ret)
Ankush Menat10583eb2022-06-17 12:13:27 +0530727 else:
728 # Transactions line item without item code
729
730 uom = item.get("uom")
731 stock_uom = item.get("stock_uom")
732 if bool(uom) != bool(stock_uom): # xor
733 item.stock_uom = item.uom = uom or stock_uom
734
Deepesh Garg61751832022-12-29 10:41:36 +0530735 # UOM cannot be zero so substitute as 1
736 item.conversion_factor = (
737 get_uom_conv_factor(item.get("uom"), item.get("stock_uom"))
738 or item.get("conversion_factor")
739 or 1
740 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530741
Nabin Hait14aa9c52016-04-18 15:54:01 +0530742 if self.doctype == "Purchase Invoice":
Nabin Haitcccc45e2016-10-05 17:15:43 +0530743 self.set_expense_account(for_validate)
Nabin Haita3dd72a2014-05-28 12:49:20 +0530744
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530745 def apply_pricing_rule_on_items(self, item, pricing_rule_args):
746 if not pricing_rule_args.get("validate_applied_rule", 0):
747 # if user changed the discount percentage then set user's discount percentage ?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530748 if pricing_rule_args.get("price_or_product_discount") == "Price":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530749 item.set("pricing_rules", pricing_rule_args.get("pricing_rules"))
Rohit Waghchauref5bd3fa2022-09-16 15:23:10 +0530750 if pricing_rule_args.get("apply_rule_on_other_items"):
751 other_items = json.loads(pricing_rule_args.get("apply_rule_on_other_items"))
752 if other_items and item.item_code not in other_items:
753 return
754
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530755 item.set("discount_percentage", pricing_rule_args.get("discount_percentage"))
756 item.set("discount_amount", pricing_rule_args.get("discount_amount"))
757 if pricing_rule_args.get("pricing_rule_for") == "Rate":
758 item.set("price_list_rate", pricing_rule_args.get("price_list_rate"))
759
760 if item.get("price_list_rate"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530761 item.rate = flt(
762 item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)),
763 item.precision("rate"),
764 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530765
Ankush Menat494bd9e2022-03-28 18:52:46 +0530766 if item.get("discount_amount"):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530767 item.rate = item.price_list_rate - item.discount_amount
768
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530769 if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"):
770 item.rate = pricing_rule_args.get("rate")
771
Ankush Menat494bd9e2022-03-28 18:52:46 +0530772 elif pricing_rule_args.get("free_item_data"):
773 apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data"))
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530774
775 elif pricing_rule_args.get("validate_applied_rule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530776 for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530777 pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530778 for field in ["discount_percentage", "discount_amount", "rate"]:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530779 if item.get(field) < pricing_rule_doc.get(field):
780 title = get_link_to_form("Pricing Rule", pricing_rule)
781
Ankush Menat494bd9e2022-03-28 18:52:46 +0530782 frappe.msgprint(
783 _("Row {0}: user has not applied the rule {1} on the item {2}").format(
784 item.idx, frappe.bold(title), frappe.bold(item.item_code)
785 )
786 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530787
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530788 def set_pricing_rule_details(self, item_row, args):
789 pricing_rules = get_applied_pricing_rules(args.get("pricing_rules"))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530790 if not pricing_rules:
791 return
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530792
793 for pricing_rule in pricing_rules:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530794 self.append(
795 "pricing_rules",
796 {
797 "pricing_rule": pricing_rule,
798 "item_code": item_row.item_code,
799 "child_docname": item_row.name,
800 "rule_applied": True,
801 },
802 )
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530803
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530804 def set_taxes(self):
805 if not self.meta.get_field("taxes"):
Anand Doshi3543f302013-05-24 19:25:01 +0530806 return
Anand Doshid2946502014-04-08 20:10:03 +0530807
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530808 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530809
rohitwaghchaure57914f12018-04-24 19:19:47 +0530810 if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"):
rohitwaghchaure505661b2017-12-11 14:52:28 +0530811 if self.company and not self.get("taxes_and_charges"):
Anand Doshi3543f302013-05-24 19:25:01 +0530812 # get the default tax master
Ankush Menat494bd9e2022-03-28 18:52:46 +0530813 self.taxes_and_charges = frappe.db.get_value(
814 tax_master_doctype, {"is_default": 1, "company": self.company}
815 )
Anand Doshid2946502014-04-08 20:10:03 +0530816
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530817 self.append_taxes_from_master(tax_master_doctype)
Anand Doshid2946502014-04-08 20:10:03 +0530818
rohitwaghchaure57914f12018-04-24 19:19:47 +0530819 def is_pos_profile_changed(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530820 if (
821 self.doctype == "Sales Invoice"
822 and self.is_pos
823 and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile")
824 ):
rohitwaghchaure57914f12018-04-24 19:19:47 +0530825 return True
826
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530827 def append_taxes_from_master(self, tax_master_doctype=None):
828 if self.get("taxes_and_charges"):
Anand Doshi99100a42013-07-04 17:13:53 +0530829 if not tax_master_doctype:
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530830 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530831
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530832 self.extend("taxes", get_taxes_and_charges(tax_master_doctype, self.get("taxes_and_charges")))
Akhilesh Darjee4cdb7992014-01-30 13:56:57 +0530833
Anand Doshiac32bad2014-04-18 01:30:14 +0530834 def set_other_charges(self):
Nabin Haite7d15362014-12-25 16:01:55 +0530835 self.set("taxes", [])
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530836 self.set_taxes()
Anand Doshid2946502014-04-08 20:10:03 +0530837
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530838 def validate_enabled_taxes_and_charges(self):
839 taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges")
Shariq Ansari21c11412023-08-17 12:14:13 +0530840 if self.taxes_and_charges and frappe.get_cached_value(
841 taxes_and_charges_doctype, self.taxes_and_charges, "disabled"
842 ):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530843 frappe.throw(
844 _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)
845 )
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530846
Nabin Haita2426fc2018-01-15 17:45:46 +0530847 def validate_tax_account_company(self):
848 for d in self.get("taxes"):
849 if d.account_head:
Daizy Modi4efc9472022-11-07 09:21:03 +0530850 tax_account_company = frappe.get_cached_value("Account", d.account_head, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +0530851 if tax_account_company != self.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530852 frappe.throw(
853 _("Row #{0}: Account {1} does not belong to company {2}").format(
854 d.idx, d.account_head, self.company
855 )
856 )
Nabin Haita2426fc2018-01-15 17:45:46 +0530857
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530858 def get_gl_dict(self, args, account_currency=None, item=None):
Nabin Hait2df4d542013-01-29 11:34:39 +0530859 """this method populates the common properties of a gl entry record"""
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530860
Ankush Menat494bd9e2022-03-28 18:52:46 +0530861 posting_date = args.get("posting_date") or self.get("posting_date")
Rohit Waghchaureaa7b4342018-05-11 01:56:05 +0530862 fiscal_years = get_fiscal_years(posting_date, company=self.company)
Nabin Hait2ed0b592016-03-29 13:14:17 +0530863 if len(fiscal_years) > 1:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530864 frappe.throw(
865 _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format(
866 formatdate(posting_date)
867 )
868 )
Nabin Hait2ed0b592016-03-29 13:14:17 +0530869 else:
870 fiscal_year = fiscal_years[0][0]
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530871
Ankush Menat494bd9e2022-03-28 18:52:46 +0530872 gl_dict = frappe._dict(
873 {
874 "company": self.company,
875 "posting_date": posting_date,
876 "fiscal_year": fiscal_year,
877 "voucher_type": self.doctype,
878 "voucher_no": self.name,
879 "remarks": self.get("remarks") or self.get("remark"),
880 "debit": 0,
881 "credit": 0,
882 "debit_in_account_currency": 0,
883 "credit_in_account_currency": 0,
884 "is_opening": self.get("is_opening") or "No",
885 "party_type": None,
886 "party": None,
887 "project": self.get("project"),
888 "post_net_value": args.get("post_net_value"),
Deepesh Gargda6bc1a2023-06-23 20:57:51 +0530889 "voucher_detail_no": args.get("voucher_detail_no"),
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530890 "voucher_subtype": self.get_voucher_subtype(),
Ankush Menat494bd9e2022-03-28 18:52:46 +0530891 }
892 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530893
Sagar Vora4205f562023-07-24 18:37:36 +0530894 with temporary_flag("company", self.company):
895 update_gl_dict_with_regional_fields(self, gl_dict)
896
deepeshgarg007d83cf652019-05-12 18:34:23 +0530897 accounting_dimensions = get_accounting_dimensions()
898 dimension_dict = frappe._dict()
899
900 for dimension in accounting_dimensions:
901 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530902 if item and item.get(dimension):
903 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530904
905 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530906 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530907
Nabin Hait895029d2015-08-20 14:55:39 +0530908 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530909 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530910
Ankush Menat494bd9e2022-03-28 18:52:46 +0530911 if gl_dict.account and self.doctype not in [
912 "Journal Entry",
913 "Period Closing Voucher",
914 "Payment Entry",
915 "Purchase Receipt",
916 "Purchase Invoice",
917 "Stock Entry",
918 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530919 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530920
Ankush Menat494bd9e2022-03-28 18:52:46 +0530921 if gl_dict.account and self.doctype not in [
922 "Journal Entry",
923 "Period Closing Voucher",
924 "Payment Entry",
925 ]:
926 set_balance_in_account_currency(
927 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
928 )
Anand Doshi979326b2015-09-11 16:22:37 +0530929
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530930 # Update details in transaction currency
931 gl_dict.update(
932 {
Deepesh Garg41d92252024-01-14 10:51:30 +0530933 "transaction_currency": self.get("currency") or self.company_currency,
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530934 "transaction_exchange_rate": self.get("conversion_rate", 1),
935 "debit_in_transaction_currency": self.get_value_in_transaction_currency(
936 account_currency, args, "debit"
937 ),
938 "credit_in_transaction_currency": self.get_value_in_transaction_currency(
939 account_currency, args, "credit"
940 ),
941 }
942 )
943
Deepesh Gargbeee98d2024-01-03 10:03:27 +0530944 if not args.get("against_voucher_type") and self.get("against_voucher_type"):
945 gl_dict.update({"against_voucher_type": self.get("against_voucher_type")})
946
947 if not args.get("against_voucher") and self.get("against_voucher"):
948 gl_dict.update({"against_voucher": self.get("against_voucher")})
949
Nabin Haitc561a492015-08-19 19:22:34 +0530950 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530951
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530952 def get_voucher_subtype(self):
953 voucher_subtypes = {
954 "Journal Entry": "voucher_type",
955 "Payment Entry": "payment_type",
956 "Stock Entry": "stock_entry_type",
957 "Asset Capitalization": "entry_type",
958 }
959 if self.doctype in voucher_subtypes:
960 return self.get(voucher_subtypes[self.doctype])
961 elif self.doctype == "Purchase Receipt" and self.is_return:
962 return "Purchase Return"
963 elif self.doctype == "Delivery Note" and self.is_return:
964 return "Sales Return"
965 elif (self.doctype == "Sales Invoice" and self.is_return) or self.doctype == "Purchase Invoice":
966 return "Credit Note"
967 elif (self.doctype == "Purchase Invoice" and self.is_return) or self.doctype == "Sales Invoice":
968 return "Debit Note"
969 return self.doctype
970
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530971 def get_value_in_transaction_currency(self, account_currency, args, field):
Deepesh Garg41d92252024-01-14 10:51:30 +0530972 if account_currency == self.get("currency"):
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530973 return args.get(field + "_in_account_currency")
974 else:
Deepesh Garg41d92252024-01-14 10:51:30 +0530975 return flt(args.get(field, 0) / self.get("conversion_rate", 1))
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530976
Anurag Mishrae657fe82018-11-26 15:19:17 +0530977 def validate_qty_is_not_zero(self):
Maricab9f5a1c2023-11-27 09:05:22 +0530978 for item in self.items:
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +0100979 if self.doctype == "Purchase Receipt" and item.rejected_qty:
980 continue
981
Maricab9f5a1c2023-11-27 09:05:22 +0530982 if not flt(item.qty):
983 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +0100984 msg=_("Row #{0}: Quantity for Item {1} cannot be zero.").format(
985 item.idx, frappe.bold(item.item_code)
986 ),
Maricab9f5a1c2023-11-27 09:05:22 +0530987 title=_("Invalid Quantity"),
988 exc=InvalidQtyError,
989 )
Anurag Mishrae657fe82018-11-26 15:19:17 +0530990
Nabin Hait895029d2015-08-20 14:55:39 +0530991 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +0530992 valid_currency = [self.company_currency]
993 if self.get("currency") and self.currency != self.company_currency:
994 valid_currency.append(self.currency)
995
Nabin Hait895029d2015-08-20 14:55:39 +0530996 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530997 frappe.throw(
998 _("Account {0} is invalid. Account Currency must be {1}").format(
999 account, (" " + _("or") + " ").join(valid_currency)
1000 )
1001 )
Anand Doshi979326b2015-09-11 16:22:37 +05301002
Anand Doshi613cb6a2013-02-06 17:33:46 +05301003 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +05301004 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
1005
Ankush Menat494bd9e2022-03-28 18:52:46 +05301006 frappe.db.sql(
1007 """delete from `tab%s` where parentfield=%s and parent = %s
1008 and allocated_amount = 0"""
1009 % (childtype, "%s", "%s"),
1010 (parentfield, self.name),
1011 )
Anand Doshid2946502014-04-08 20:10:03 +05301012
Walstan Baptistad6360752021-03-31 12:30:32 +05301013 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301014 def apply_shipping_rule(self):
1015 if self.shipping_rule:
1016 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
1017 shipping_rule.apply(self)
1018 self.calculate_taxes_and_totals()
1019
1020 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301021 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301022
1023 # shipping address fields can be `shipping_address_name` or `shipping_address`
1024 # try getting value from both
1025
Ankush Menat494bd9e2022-03-28 18:52:46 +05301026 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301027 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301028 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301029 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301030 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301031
1032 return {}
1033
Walstan Baptistad6360752021-03-31 12:30:32 +05301034 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +05301035 def set_advances(self):
1036 """Returns list of advances against Account, Party, Reference"""
1037
Deepesh Gargfd3fb642023-04-05 12:02:44 +05301038 res = self.get_advance_entries(
1039 include_unallocated=not cint(self.get("only_include_allocated_payments"))
1040 )
Nabin Hait041a5c22018-08-01 18:07:39 +05301041
1042 self.set("advances", [])
1043 advance_allocated = 0
1044 for d in res:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301045 if self.get("party_account_currency") == self.company_currency:
1046 amount = self.get("base_rounded_total") or self.base_grand_total
Nabin Hait041a5c22018-08-01 18:07:39 +05301047 else:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301048 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg181df2f2022-11-04 15:49:37 +05301049 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +05301050 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +05301051
Saqiba20999c2021-07-12 14:33:23 +05301052 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +05301053 "doctype": self.doctype + " Advance",
1054 "reference_type": d.reference_type,
1055 "reference_name": d.reference_name,
1056 "reference_row": d.reference_row,
1057 "remarks": d.remarks,
1058 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +05301059 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301060 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +05301061 }
Gursheen Anand74619262023-06-02 17:13:51 +05301062 if d.get("paid_from"):
1063 advance_row["account"] = d.paid_from
1064 if d.get("paid_to"):
1065 advance_row["account"] = d.paid_to
Saqiba20999c2021-07-12 14:33:23 +05301066
1067 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +05301068
Nabin Hait28a05282016-06-27 17:41:39 +05301069 def get_advance_entries(self, include_unallocated=True):
1070 if self.doctype == "Sales Invoice":
Nabin Hait28a05282016-06-27 17:41:39 +05301071 party_type = "Customer"
1072 party = self.customer
1073 amount_field = "credit_in_account_currency"
1074 order_field = "sales_order"
1075 order_doctype = "Sales Order"
1076 else:
Nabin Hait28a05282016-06-27 17:41:39 +05301077 party_type = "Supplier"
1078 party = self.supplier
1079 amount_field = "debit_in_account_currency"
1080 order_field = "purchase_order"
1081 order_doctype = "Purchase Order"
Deepesh Garg92f845c2023-06-21 12:21:19 +05301082
1083 party_account = get_party_account(
1084 party_type, party=party, company=self.company, include_advance=True
1085 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301086
Ankush Menat494bd9e2022-03-28 18:52:46 +05301087 order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field)))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301088
Ankush Menat494bd9e2022-03-28 18:52:46 +05301089 journal_entries = get_advance_journal_entries(
1090 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
1091 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301092
Smit Vora3e282bf2023-09-19 20:47:21 +05301093 payment_entries = get_advance_payment_entries_for_regional(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301094 party_type, party, party_account, order_doctype, order_list, include_unallocated
1095 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301096
Nabin Hait28a05282016-06-27 17:41:39 +05301097 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301098
Nabin Hait28a05282016-06-27 17:41:39 +05301099 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +05301100
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301101 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301102 is_inclusive = cint(
1103 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
1104 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301105
1106 if is_inclusive:
1107 is_inclusive = 0
1108 if self.get("taxes", filters={"included_in_print_rate": 1}):
1109 is_inclusive = 1
1110
1111 return is_inclusive
1112
Anand Baburajan491a50a2023-06-13 19:42:56 +05301113 def should_show_taxes_as_table_in_print(self):
1114 return cint(frappe.db.get_single_value("Accounts Settings", "show_taxes_as_table_in_print"))
1115
Nabin Hait28a05282016-06-27 17:41:39 +05301116 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +05301117 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301118 order_list = list(set(d.get(order_field) for d in self.get("items") if d.get(order_field)))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301119
Ankush Menat494bd9e2022-03-28 18:52:46 +05301120 if not order_list:
1121 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301122
Nabin Hait28a05282016-06-27 17:41:39 +05301123 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301124
Nabin Hait28a05282016-06-27 17:41:39 +05301125 if advance_entries:
1126 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
1127 for d in advance_entries:
1128 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301129 frappe.msgprint(
1130 _(
1131 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
1132 ).format(d.reference_name, d.against_order)
1133 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301134
Saqiba20999c2021-07-12 14:33:23 +05301135 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301136 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301137 return
1138
Ankush Menat494bd9e2022-03-28 18:52:46 +05301139 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301140 party_account = self.credit_to if is_purchase_invoice else self.debit_to
1141 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +05301142 return
1143
1144 for d in self.get("advances"):
1145 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +05301146 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +05301147
1148 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
1149 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
1150 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
1151
1152 d.exchange_gain_loss = difference
1153
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301154 def make_precision_loss_gl_entry(self, gl_entries):
1155 round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(
1156 self.company, "Purchase Invoice", self.name, self.use_company_roundoff_cost_center
1157 )
1158
1159 precision_loss = self.get("base_net_total") - flt(
1160 self.get("net_total") * self.conversion_rate, self.precision("net_total")
1161 )
1162
1163 credit_or_debit = "credit" if self.doctype == "Purchase Invoice" else "debit"
1164 against = self.supplier if self.doctype == "Purchase Invoice" else self.customer
1165
1166 if precision_loss:
1167 gl_entries.append(
1168 self.get_gl_dict(
1169 {
1170 "account": round_off_account,
1171 "against": against,
1172 credit_or_debit: precision_loss,
1173 "cost_center": round_off_cost_center
1174 if self.use_company_roundoff_cost_center
1175 else self.cost_center or round_off_cost_center,
1176 "remarks": _("Net total calculation precision loss"),
1177 }
1178 )
1179 )
1180
ruthra kumar79c6f012023-09-01 14:57:12 +05301181 def gain_loss_journal_already_booked(
1182 self,
1183 gain_loss_account,
1184 exc_gain_loss,
1185 ref2_dt,
1186 ref2_dn,
1187 ref2_detail_no,
1188 ) -> bool:
1189 """
1190 Check if gain/loss is booked
1191 """
1192 if res := frappe.db.get_all(
1193 "Journal Entry Account",
1194 filters={
1195 "docstatus": 1,
1196 "account": gain_loss_account,
1197 "reference_type": ref2_dt, # this will be Journal Entry
1198 "reference_name": ref2_dn,
1199 "reference_detail_no": ref2_detail_no,
1200 },
1201 pluck="parent",
1202 ):
1203 # deduplicate
1204 res = list({x for x in res})
1205 if exc_vouchers := frappe.db.get_all(
1206 "Journal Entry",
1207 filters={"name": ["in", res], "voucher_type": "Exchange Gain Or Loss"},
1208 fields=["voucher_type", "total_debit", "total_credit"],
1209 ):
1210 booked_voucher = exc_vouchers[0]
1211 if (
1212 booked_voucher.total_debit == exc_gain_loss
1213 and booked_voucher.total_credit == exc_gain_loss
1214 and booked_voucher.voucher_type == "Exchange Gain Or Loss"
1215 ):
1216 return True
1217 return False
1218
ruthra kumar66286322023-07-25 10:30:08 +05301219 def make_exchange_gain_loss_journal(self, args: dict = None) -> None:
ruthra kumar81cd7872023-04-27 09:46:54 +05301220 """
1221 Make Exchange Gain/Loss journal for Invoices and Payments
1222 """
ruthra kumarcd42b262023-07-10 15:28:10 +05301223 # Cancelling existing exchange gain/loss journals is handled during the `on_cancel` event.
1224 # see accounts/utils.py:cancel_exchange_gain_loss_journal()
ruthra kumar81cd7872023-04-27 09:46:54 +05301225 if self.docstatus == 1:
ruthra kumar7b516f82023-06-26 17:34:28 +05301226 if self.get("doctype") == "Journal Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301227 # 'args' is populated with exchange gain/loss account and the amount to be booked.
1228 # These are generated by Sales/Purchase Invoice during reconciliation and advance allocation.
ruthra kumarc0b3b062023-07-25 10:51:58 +05301229 # and below logic is only for such scenarios
ruthra kumar7b516f82023-06-26 17:34:28 +05301230 if args:
1231 for arg in args:
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301232 # Advance section uses `exchange_gain_loss` and reconciliation uses `difference_amount`
1233 if (
1234 arg.get("difference_amount", 0) != 0 or arg.get("exchange_gain_loss", 0) != 0
1235 ) and arg.get("difference_account"):
ruthra kumar7b516f82023-06-26 17:34:28 +05301236
ruthra kumaree3ce822023-06-26 21:43:20 +05301237 party_account = arg.get("account")
ruthra kumarc0b3b062023-07-25 10:51:58 +05301238 gain_loss_account = arg.get("difference_account")
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301239 difference_amount = arg.get("difference_amount") or arg.get("exchange_gain_loss")
1240 if difference_amount > 0:
ruthra kumar05672432023-07-12 06:14:17 +05301241 dr_or_cr = "debit" if arg.get("party_type") == "Customer" else "credit"
1242 else:
1243 dr_or_cr = "credit" if arg.get("party_type") == "Customer" else "debit"
ruthra kumar7b516f82023-06-26 17:34:28 +05301244
1245 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1246
ruthra kumar79c6f012023-09-01 14:57:12 +05301247 if not self.gain_loss_journal_already_booked(
ruthra kumarc0b3b062023-07-25 10:51:58 +05301248 gain_loss_account,
1249 difference_amount,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301250 self.doctype,
1251 self.name,
ruthra kumar79c6f012023-09-01 14:57:12 +05301252 arg.get("referenced_row"),
1253 ):
ruthra kumar7e600a62023-10-22 20:26:45 +05301254 posting_date = arg.get("difference_posting_date") or frappe.db.get_value(
1255 arg.voucher_type, arg.voucher_no, "posting_date"
1256 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301257 je = create_gain_loss_journal(
1258 self.company,
ruthra kumarf7865da2023-09-04 20:38:10 +05301259 posting_date,
ruthra kumar79c6f012023-09-01 14:57:12 +05301260 arg.get("party_type"),
1261 arg.get("party"),
1262 party_account,
1263 gain_loss_account,
1264 difference_amount,
1265 dr_or_cr,
1266 reverse_dr_or_cr,
1267 arg.get("against_voucher_type"),
1268 arg.get("against_voucher"),
1269 arg.get("idx"),
1270 self.doctype,
1271 self.name,
1272 arg.get("referenced_row"),
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301273 arg.get("cost_center"),
ruthra kumaracc73222023-07-27 07:52:01 +05301274 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301275 frappe.msgprint(
1276 _("Exchange Gain/Loss amount has been booked through {0}").format(
1277 get_link_to_form("Journal Entry", je)
1278 )
1279 )
ruthra kumar7b516f82023-06-26 17:34:28 +05301280
ruthra kumar81cd7872023-04-27 09:46:54 +05301281 if self.get("doctype") == "Payment Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301282 # For Payment Entry, exchange_gain_loss field in the `references` table is the trigger for journal creation
ruthra kumar81cd7872023-04-27 09:46:54 +05301283 gain_loss_to_book = [x for x in self.references if x.exchange_gain_loss != 0]
1284 booked = []
1285 if gain_loss_to_book:
1286 vtypes = [x.reference_doctype for x in gain_loss_to_book]
1287 vnames = [x.reference_name for x in gain_loss_to_book]
1288 je = qb.DocType("Journal Entry")
1289 jea = qb.DocType("Journal Entry Account")
1290 parents = (
1291 qb.from_(jea)
1292 .select(jea.parent)
1293 .where(
1294 (jea.reference_type == "Payment Entry")
1295 & (jea.reference_name == self.name)
1296 & (jea.docstatus == 1)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301297 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301298 .run()
Saqiba20999c2021-07-12 14:33:23 +05301299 )
1300
ruthra kumar81cd7872023-04-27 09:46:54 +05301301 booked = []
1302 if parents:
1303 booked = (
1304 qb.from_(je)
1305 .inner_join(jea)
1306 .on(je.name == jea.parent)
1307 .select(jea.reference_type, jea.reference_name, jea.reference_detail_no)
1308 .where(
1309 (je.docstatus == 1)
1310 & (je.name.isin(parents))
1311 & (je.voucher_type == "Exchange Gain or Loss")
1312 )
1313 .run()
1314 )
Saqiba20999c2021-07-12 14:33:23 +05301315
ruthra kumar81cd7872023-04-27 09:46:54 +05301316 for d in gain_loss_to_book:
ruthra kumarc0b3b062023-07-25 10:51:58 +05301317 # Filter out References for which Gain/Loss is already booked
ruthra kumar81cd7872023-04-27 09:46:54 +05301318 if d.exchange_gain_loss and (
1319 (d.reference_doctype, d.reference_name, str(d.idx)) not in booked
1320 ):
ruthra kumar81cd7872023-04-27 09:46:54 +05301321 if self.payment_type == "Receive":
1322 party_account = self.paid_from
1323 elif self.payment_type == "Pay":
1324 party_account = self.paid_to
1325
ruthra kumar81cd7872023-04-27 09:46:54 +05301326 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
ruthra kumar34b5e842023-06-16 14:07:44 +05301327
1328 if d.reference_doctype == "Purchase Invoice":
1329 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1330
ruthra kumar81cd7872023-04-27 09:46:54 +05301331 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1332
1333 gain_loss_account = frappe.get_cached_value(
1334 "Company", self.company, "exchange_gain_loss_account"
1335 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301336
ruthra kumaracc73222023-07-27 07:52:01 +05301337 je = create_gain_loss_journal(
ruthra kumar1ea1bfe2023-07-26 16:19:38 +05301338 self.company,
ruthra kumar7e600a62023-10-22 20:26:45 +05301339 args.get("difference_posting_date") if args else self.posting_date,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301340 self.party_type,
1341 self.party,
1342 party_account,
1343 gain_loss_account,
1344 d.exchange_gain_loss,
1345 dr_or_cr,
1346 reverse_dr_or_cr,
1347 d.reference_doctype,
1348 d.reference_name,
1349 d.idx,
1350 self.doctype,
1351 self.name,
1352 d.idx,
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301353 self.cost_center,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301354 )
ruthra kumaracc73222023-07-27 07:52:01 +05301355 frappe.msgprint(
1356 _("Exchange Gain/Loss amount has been booked through {0}").format(
1357 get_link_to_form("Journal Entry", je)
1358 )
1359 )
Saqiba20999c2021-07-12 14:33:23 +05301360
Deepesh Garg016ed952023-06-20 13:22:32 +05301361 def update_against_document_in_jv(self):
Nabin Hait28a05282016-06-27 17:41:39 +05301362 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301363 Links invoice and advance voucher:
1364 1. cancel advance voucher
1365 2. split into multiple rows if partially adjusted, assign against voucher
1366 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +05301367 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301368
Nabin Hait28a05282016-06-27 17:41:39 +05301369 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301370 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +05301371 party = self.customer
1372 party_account = self.debit_to
1373 dr_or_cr = "credit_in_account_currency"
1374 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301375 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +05301376 party = self.supplier
1377 party_account = self.credit_to
1378 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +05301379
Nabin Hait28a05282016-06-27 17:41:39 +05301380 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +05301381 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +05301382 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301383 args = frappe._dict(
1384 {
1385 "voucher_type": d.reference_type,
1386 "voucher_no": d.reference_name,
1387 "voucher_detail_no": d.reference_row,
1388 "against_voucher_type": self.doctype,
1389 "against_voucher": self.name,
1390 "account": party_account,
1391 "party_type": party_type,
1392 "party": party,
1393 "is_advance": "Yes",
1394 "dr_or_cr": dr_or_cr,
1395 "unadjusted_amount": flt(d.advance_amount),
1396 "allocated_amount": flt(d.allocated_amount),
1397 "precision": d.precision("advance_amount"),
1398 "exchange_rate": (
1399 self.conversion_rate if self.party_account_currency != self.company_currency else 1
1400 ),
1401 "grand_total": (
1402 self.base_grand_total
1403 if self.party_account_currency == self.company_currency
1404 else self.grand_total
1405 ),
1406 "outstanding_amount": self.outstanding_amount,
Daizy Modi4efc9472022-11-07 09:21:03 +05301407 "difference_account": frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301408 "Company", self.company, "exchange_gain_loss_account"
1409 ),
1410 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
1411 }
1412 )
Nabin Hait28a05282016-06-27 17:41:39 +05301413 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301414
Nabin Hait28a05282016-06-27 17:41:39 +05301415 if lst:
1416 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +05301417
Deepesh Garg016ed952023-06-20 13:22:32 +05301418 reconcile_against_document(lst)
Anand Doshid2946502014-04-08 20:10:03 +05301419
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301420 def on_cancel(self):
barredterra0a95b382023-12-27 23:05:37 +01001421 from erpnext.accounts.doctype.bank_transaction.bank_transaction import (
1422 remove_from_bank_transaction,
1423 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301424 from erpnext.accounts.utils import (
1425 cancel_exchange_gain_loss_journal,
1426 unlink_ref_doc_from_payment_entries,
1427 )
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301428
barredterra0a95b382023-12-27 23:05:37 +01001429 remove_from_bank_transaction(self.doctype, self.name)
1430
ruthra kumar6e18bb62023-07-11 12:21:10 +05301431 if self.doctype in ["Sales Invoice", "Purchase Invoice", "Payment Entry", "Journal Entry"]:
ruthra kumar81cd7872023-04-27 09:46:54 +05301432 # Cancel Exchange Gain/Loss Journal before unlinking
1433 cancel_exchange_gain_loss_journal(self)
1434
Ankush Menat494bd9e2022-03-28 18:52:46 +05301435 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301436 unlink_ref_doc_from_payment_entries(self)
1437
1438 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301439 if frappe.db.get_single_value(
1440 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1441 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301442 unlink_ref_doc_from_payment_entries(self)
1443
GangaManoj8396f242021-09-20 19:01:46 +05301444 if self.doctype == "Sales Order":
1445 self.unlink_ref_doc_from_po()
1446
1447 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301448 so_items = []
1449 for item in self.items:
1450 so_items.append(item.name)
1451
Ankush Menat494bd9e2022-03-28 18:52:46 +05301452 linked_po = list(
1453 set(
1454 frappe.get_all(
1455 "Purchase Order Item",
1456 filters={
1457 "sales_order": self.name,
1458 "sales_order_item": ["in", so_items],
1459 "docstatus": ["<", 2],
1460 },
1461 pluck="parent",
1462 )
1463 )
1464 )
GangaManoj8396f242021-09-20 19:01:46 +05301465
GangaManoj8396f242021-09-20 19:01:46 +05301466 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301467 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301468 "Purchase Order Item",
1469 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1470 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301471 )
GangaManoj8396f242021-09-20 19:01:46 +05301472
1473 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1474
Deepesh Gargd18dde72020-11-29 21:40:04 +05301475 def get_tax_map(self):
1476 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301477 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301478 tax_map.setdefault(tax.account_head, 0.0)
1479 tax_map[tax.account_head] += tax.tax_amount
1480
1481 return tax_map
1482
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301483 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1484 amount = item.net_amount
1485 base_amount = item.base_net_amount
1486
Ankush Menat494bd9e2022-03-28 18:52:46 +05301487 if (
1488 enable_discount_accounting
1489 and self.get("discount_amount")
1490 and self.get("additional_discount_account")
1491 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301492 amount = item.amount
1493 base_amount = item.base_amount
1494
1495 return amount, base_amount
1496
1497 def get_tax_amounts(self, tax, enable_discount_accounting):
1498 amount = tax.tax_amount_after_discount_amount
1499 base_amount = tax.base_tax_amount_after_discount_amount
1500
Ankush Menat494bd9e2022-03-28 18:52:46 +05301501 if (
1502 enable_discount_accounting
1503 and self.get("discount_amount")
1504 and self.get("additional_discount_account")
1505 and self.get("apply_discount_on") == "Grand Total"
1506 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301507 amount = tax.tax_amount
1508 base_amount = tax.base_tax_amount
1509
1510 return amount, base_amount
1511
GangaManoj8f7b0a12021-07-13 03:01:02 +05301512 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301513 if self.doctype == "Purchase Invoice":
1514 enable_discount_accounting = cint(
1515 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1516 )
1517 elif self.doctype == "Sales Invoice":
1518 enable_discount_accounting = cint(
1519 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1520 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301521
Deepesh Garg3b159662022-08-21 17:51:05 +05301522 if self.doctype == "Purchase Invoice":
1523 dr_or_cr = "credit"
1524 rev_dr_cr = "debit"
1525 supplier_or_customer = self.supplier
1526
1527 else:
1528 dr_or_cr = "debit"
1529 rev_dr_cr = "credit"
1530 supplier_or_customer = self.customer
1531
GangaManoj8f7b0a12021-07-13 03:01:02 +05301532 if enable_discount_accounting:
1533 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301534 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301535 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301536 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301537 income_or_expense_account = (
1538 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301539 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301540 else item.deferred_expense_account
1541 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301542 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301543 income_or_expense_account = (
1544 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301545 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301546 else item.deferred_revenue_account
1547 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301548
1549 account_currency = get_account_currency(item.discount_account)
1550 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301551 self.get_gl_dict(
1552 {
1553 "account": item.discount_account,
1554 "against": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301555 dr_or_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301556 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1557 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301558 dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301559 "cost_center": item.cost_center,
1560 "project": item.project,
1561 },
1562 account_currency,
1563 item=item,
1564 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301565 )
1566
1567 account_currency = get_account_currency(income_or_expense_account)
1568 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301569 self.get_gl_dict(
1570 {
1571 "account": income_or_expense_account,
1572 "against": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301573 rev_dr_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301574 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1575 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301576 rev_dr_cr
1577 + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301578 "cost_center": item.cost_center,
1579 "project": item.project or self.project,
1580 },
1581 account_currency,
1582 item=item,
1583 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301584 )
GangaManoj857501c2021-07-15 22:03:46 +05301585
Deepesh Garg3b159662022-08-21 17:51:05 +05301586 if (
Deepesh Gargae3dce02022-08-22 08:57:58 +05301587 (enable_discount_accounting or self.get("is_cash_or_non_trade_discount"))
Deepesh Garg3b159662022-08-21 17:51:05 +05301588 and self.get("additional_discount_account")
1589 and self.get("discount_amount")
1590 ):
1591 gl_entries.append(
1592 self.get_gl_dict(
1593 {
1594 "account": self.additional_discount_account,
1595 "against": supplier_or_customer,
Gursheen Anand112cfe62023-08-31 17:08:51 +05301596 dr_or_cr: self.base_discount_amount,
vr-greycube4ada5a42023-09-27 10:38:32 +05301597 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
Deepesh Garg3b159662022-08-21 17:51:05 +05301598 },
1599 item=self,
Ankush Menat4551d7d2021-08-19 13:41:10 +05301600 )
Deepesh Garg3b159662022-08-21 17:51:05 +05301601 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301602
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301603 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on):
Nabin Hait868766d2019-07-15 18:02:58 +05301604 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301605
Nabin Hait868766d2019-07-15 18:02:58 +05301606 item_allowance = {}
1607 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301608
Ankush Menat494bd9e2022-03-28 18:52:46 +05301609 role_allowed_to_over_bill = frappe.db.get_single_value(
1610 "Accounts Settings", "role_allowed_to_over_bill"
1611 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301612 user_roles = frappe.get_roles()
1613
Ankush Menat43bf82b2021-09-20 16:31:20 +05301614 total_overbilled_amt = 0.0
1615
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301616 reference_names = [d.get(item_ref_dn) for d in self.get("items") if d.get(item_ref_dn)]
1617 reference_details = self.get_billing_reference_details(
1618 reference_names, ref_dt + " Item", based_on
1619 )
1620
Nabin Hait4b8185d2014-12-25 18:19:39 +05301621 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301622 if not item.get(item_ref_dn):
1623 continue
Anand Doshid2946502014-04-08 20:10:03 +05301624
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301625 ref_amt = flt(reference_details.get(item.get(item_ref_dn)), self.precision(based_on, item))
1626
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301627 if not ref_amt:
1628 frappe.msgprint(
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301629 _("System will not check over billing since amount for Item {0} in {1} is zero").format(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301630 item.item_code, ref_dt
1631 ),
1632 title=_("Warning"),
1633 indicator="orange",
1634 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301635 continue
Anand Doshid2946502014-04-08 20:10:03 +05301636
Saqib9c913c92021-11-26 12:00:13 +05301637 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301638
Ankush Menat494bd9e2022-03-28 18:52:46 +05301639 total_billed_amt = flt(
1640 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1641 )
Anand Doshid2946502014-04-08 20:10:03 +05301642
Ankush Menat494bd9e2022-03-28 18:52:46 +05301643 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1644 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1645 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301646
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301647 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301648
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301649 if total_billed_amt < 0 and max_allowed_amt < 0:
1650 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1651 total_billed_amt = abs(total_billed_amt)
1652 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301653
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301654 overbill_amt = total_billed_amt - max_allowed_amt
1655 total_overbilled_amt += overbill_amt
1656
1657 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1658 if self.doctype != "Purchase Invoice":
1659 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301660 elif not cint(
1661 frappe.db.get_single_value(
1662 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1663 )
1664 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301665 self.throw_overbill_exception(item, max_allowed_amt)
1666
1667 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301668 frappe.msgprint(
1669 _("Overbilling of {} ignored because you have {} role.").format(
1670 total_overbilled_amt, role_allowed_to_over_bill
1671 ),
1672 indicator="orange",
1673 alert=True,
1674 )
Afshan53fefd72021-06-24 10:09:02 +05301675
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301676 def get_billing_reference_details(self, reference_names, reference_doctype, based_on):
1677 return frappe._dict(
1678 frappe.get_all(
1679 reference_doctype,
1680 filters={"name": ("in", reference_names)},
1681 fields=["name", based_on],
1682 as_list=1,
1683 )
1684 )
1685
Saqib9c913c92021-11-26 12:00:13 +05301686 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301687 """
1688 Returns Sum of Amount of
1689 Sales/Purchase Invoice Items
1690 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1691 that are submitted OR not submitted but are under current invoice
1692 """
Saqib9c913c92021-11-26 12:00:13 +05301693
1694 from frappe.query_builder import Criterion
1695 from frappe.query_builder.functions import Sum
1696
1697 item_doctype = frappe.qb.DocType(item.doctype)
1698 based_on_field = frappe.qb.Field(based_on)
1699 join_field = frappe.qb.Field(item_ref_dn)
1700
1701 result = (
1702 frappe.qb.from_(item_doctype)
1703 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301704 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301705 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301706 Criterion.any(
1707 [ # select all items from other invoices OR current invoices
1708 Criterion.all(
1709 [ # for selecting items from other invoices
1710 item_doctype.docstatus == 1,
1711 item_doctype.parent != self.name,
1712 ]
1713 ),
1714 Criterion.all(
1715 [ # for selecting items from current invoice, that are linked to same reference
1716 item_doctype.docstatus == 0,
1717 item_doctype.parent == self.name,
1718 item_doctype.name != item.name,
1719 ]
1720 ),
1721 ]
1722 )
Saqib9c913c92021-11-26 12:00:13 +05301723 )
1724 ).run()
1725
1726 return result[0][0] if result else 0
1727
Afshan53fefd72021-06-24 10:09:02 +05301728 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301729 frappe.throw(
1730 _(
1731 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1732 ).format(item.item_code, item.idx, max_allowed_amt)
1733 )
Anand Doshid2946502014-04-08 20:10:03 +05301734
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301735 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301736 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301737
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301738 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301739
Nabin Haita36adbd2013-08-02 14:50:12 +05301740 def get_stock_items(self):
1741 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301742 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301743 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301744 stock_items = frappe.db.get_values(
1745 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1746 )
Anand Doshid2946502014-04-08 20:10:03 +05301747
Nabin Haita36adbd2013-08-02 14:50:12 +05301748 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301749
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301750 def set_total_advance_paid(self):
ruthra kumar44870652022-11-01 10:11:38 +05301751 ple = frappe.qb.DocType("Payment Ledger Entry")
1752 party = self.customer if self.doctype == "Sales Order" else self.supplier
1753 advance = (
1754 frappe.qb.from_(ple)
ruthra kumarbf76b852022-11-22 12:16:11 +05301755 .select(ple.account_currency, Abs(Sum(ple.amount_in_account_currency)).as_("amount"))
ruthra kumar44870652022-11-01 10:11:38 +05301756 .where(
1757 (ple.against_voucher_type == self.doctype)
1758 & (ple.against_voucher_no == self.name)
1759 & (ple.party == party)
ruthra kumarbf76b852022-11-22 12:16:11 +05301760 & (ple.docstatus == 1)
ruthra kumar44870652022-11-01 10:11:38 +05301761 & (ple.company == self.company)
1762 )
1763 .run(as_dict=True)
1764 )
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301765
Nabin Haitb2206d12016-01-27 15:43:12 +05301766 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301767 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301768
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301769 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301770 formatted_advance_paid = fmt_money(
1771 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1772 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301773
Ankush Menat494bd9e2022-03-28 18:52:46 +05301774 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301775
1776 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301777 order_total = self.get("rounded_total") or self.grand_total
1778 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301779 else:
finbyz5efc7972019-01-05 11:12:11 +05301780 order_total = self.get("base_rounded_total") or self.base_grand_total
1781 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301782
Ankush Menat494bd9e2022-03-28 18:52:46 +05301783 formatted_order_total = fmt_money(
1784 order_total, precision=self.precision(precision), currency=advance.account_currency
1785 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301786
Nabin Hait9db1b222016-06-30 12:37:53 +05301787 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301788 frappe.throw(
1789 _(
1790 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1791 ).format(formatted_advance_paid, self.name, formatted_order_total)
1792 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301793
Nabin Hait13093b42016-06-29 18:04:37 +05301794 frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid)
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301795
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301796 @property
1797 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301798 if not hasattr(self, "_abbr"):
Daizy Modi4efc9472022-11-07 09:21:03 +05301799 self._abbr = frappe.get_cached_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301800
1801 return self._abbr
1802
marination4be5b5c2020-10-08 19:08:27 +05301803 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301804 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301805 db_or_cr = (
1806 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1807 )
marination4be5b5c2020-10-08 19:08:27 +05301808 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1809
1810 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1811 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1812
Ankush Menat494bd9e2022-03-28 18:52:46 +05301813 message = _("{0} Account not found against Customer {1}.").format(
1814 db_or_cr, frappe.bold(party) or ""
1815 )
marination4be5b5c2020-10-08 19:08:27 +05301816 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301817 message += (
1818 "<br><ul><li>"
1819 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1820 + "</li>"
1821 )
1822 message += (
1823 "<li>"
1824 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1825 + "</li></ul>"
1826 )
marination4be5b5c2020-10-08 19:08:27 +05301827
marination53b1a9a2020-11-03 15:45:25 +05301828 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301829
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301830 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301831 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301832 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301833
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301834 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301835 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301836 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301837 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301838
Ankush Menat494bd9e2022-03-28 18:52:46 +05301839 elif self.doctype in (
1840 "Supplier Quotation",
1841 "Purchase Order",
1842 "Purchase Receipt",
1843 "Purchase Invoice",
1844 ):
1845 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301846
1847 elif self.meta.get_field("customer"):
1848 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301849
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301850 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301851 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301852
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301853 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301854
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301855 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301856
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301857 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301858 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301859 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301860 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301861 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301862
Ankush Menat494bd9e2022-03-28 18:52:46 +05301863 if (
1864 party_account_currency
1865 and party_account_currency != self.company_currency
1866 and self.currency != party_account_currency
1867 ):
Gursheen Anand112cfe62023-08-31 17:08:51 +05301868
Ankush Menat494bd9e2022-03-28 18:52:46 +05301869 frappe.throw(
1870 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1871 party_type, party, party_account_currency
1872 ),
1873 InvalidCurrency,
1874 )
Anand Doshi979326b2015-09-11 16:22:37 +05301875
shreyas29b565f2016-01-25 17:30:49 +05301876 # Note: not validating with gle account because we don't have the account
1877 # at quotation / sales order level and we shouldn't stop someone
1878 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301879
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301880 def validate_party_account_currency(self):
Deepesh Garg33d97672022-05-12 16:40:29 +05301881 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301882 return
1883
Deepesh Garg33d97672022-05-12 16:40:29 +05301884 if self.is_opening == "Yes":
Deepesh Garg60915e82021-08-21 23:05:48 +05301885 return
1886
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301887 party_type, party = self.get_party()
1888 party_gle_currency = get_party_gle_currency(party_type, party, self.company)
Deepesh Garg33d97672022-05-12 16:40:29 +05301889 party_account = (
1890 self.get("debit_to") if self.doctype == "Sales Invoice" else self.get("credit_to")
1891 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301892 party_account_currency = get_account_currency(party_account)
Deepesh Garge04e67c2022-07-11 19:25:18 +05301893 allow_multi_currency_invoices_against_single_party_account = frappe.db.get_singles_value(
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301894 "Accounts Settings", "allow_multi_currency_invoices_against_single_party_account"
1895 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301896
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301897 if (
1898 not party_gle_currency
1899 and (party_account_currency != self.currency)
1900 and not allow_multi_currency_invoices_against_single_party_account
1901 ):
Deepesh Garg33d97672022-05-12 16:40:29 +05301902 frappe.throw(
Devin Slauenwhite3a1c9232022-06-02 14:15:50 -04001903 _("Party Account {0} currency ({1}) and document currency ({2}) should be same").format(
Devin Slauenwhiteb061ea42022-06-02 14:23:54 -04001904 frappe.bold(party_account), party_account_currency, self.currency
Deepesh Garg33d97672022-05-12 16:40:29 +05301905 )
1906 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301907
Nabin Hait297d74a2016-11-23 15:58:51 +05301908 def delink_advance_entries(self, linked_doc_name):
1909 total_allocated_amount = 0
1910 for adv in self.advances:
1911 consider_for_total_advance = True
1912 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301913 frappe.db.sql(
1914 """delete from `tab{0} Advance`
1915 where name = %s""".format(
1916 self.doctype
1917 ),
1918 adv.name,
1919 )
Nabin Hait297d74a2016-11-23 15:58:51 +05301920 consider_for_total_advance = False
1921
1922 if consider_for_total_advance:
1923 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
1924
Ankush Menat494bd9e2022-03-28 18:52:46 +05301925 frappe.db.set_value(
1926 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
1927 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05301928
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301929 def group_similar_items(self):
1930 group_item_qty = {}
1931 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05301932 # to update serial number in print
1933 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301934
1935 for item in self.items:
1936 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
1937 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
1938
1939 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301940 for item in self.items:
1941 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05301942 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301943 item.qty = group_item_qty[item.item_code]
1944 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05301945
1946 if item.qty:
1947 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
1948 else:
1949 item.rate = 0
1950
Shreya Shah785f1aa2018-10-11 10:14:25 +05301951 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301952 del group_item_qty[item.item_code]
1953 else:
1954 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301955 for item in duplicate_list:
1956 self.remove(item)
1957
tunde32aa7c12017-09-07 06:52:15 +01001958 def set_payment_schedule(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05301959 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301960 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05301961 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301962
Ankush Menat494bd9e2022-03-28 18:52:46 +05301963 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301964 if not party_account_currency:
1965 party_type, party = self.get_party()
1966
1967 if party_type and party:
1968 party_account_currency = get_party_account_currency(party_type, party, self.company)
1969
rohitwaghchaureda941af2018-01-17 16:23:04 +05301970 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01001971 date = self.get("due_date")
1972 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05301973
Saqib Ansarid552fe62021-04-23 14:46:52 +05301974 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1975 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg5c758942023-04-16 17:11:24 +05301976 automatically_fetch_payment_terms = 0
Deepesh Garg26210162020-08-11 16:06:13 +05301977
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301978 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301979 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301980 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301981 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05301982 automatically_fetch_payment_terms = cint(
1983 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
1984 )
tunde96b8f222017-09-08 15:35:59 +01001985
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301986 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301987 if party_account_currency == self.company_currency:
1988 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301989 grand_total = flt(
1990 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
1991 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05301992 else:
1993 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301994 base_grand_total = flt(
1995 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
1996 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301997
Nabin Hait0551f7b2017-11-21 19:58:16 +05301998 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301999 if (
2000 self.doctype in ["Sales Invoice", "Purchase Invoice"]
2001 and automatically_fetch_payment_terms
2002 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2003 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302004 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302005 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302006 self.ignore_default_payment_terms_template = 1
2007 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302008 data = get_payment_terms(
2009 self.payment_terms_template, posting_date, grand_total, base_grand_total
2010 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302011 for item in data:
2012 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05302013 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302014 data = dict(
2015 due_date=due_date,
2016 invoice_portion=100,
2017 payment_amount=grand_total,
2018 base_payment_amount=base_grand_total,
2019 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302020 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302021
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302022 allocate_payment_based_on_payment_terms = frappe.db.get_value(
2023 "Payment Terms Template", self.payment_terms_template, "allocate_payment_based_on_payment_terms"
2024 )
2025
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302026 if not (
2027 automatically_fetch_payment_terms
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302028 and allocate_payment_based_on_payment_terms
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302029 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2030 ):
Deepesh Garg5c758942023-04-16 17:11:24 +05302031 for d in self.get("payment_schedule"):
2032 if d.invoice_portion:
2033 d.payment_amount = flt(
2034 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
2035 )
2036 d.base_payment_amount = flt(
2037 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
2038 )
2039 d.outstanding = d.payment_amount
2040 elif not d.invoice_portion:
2041 d.base_payment_amount = flt(
2042 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
2043 )
ruthra kumar0da6c162023-05-16 18:57:42 +05302044 else:
2045 self.fetch_payment_terms_from_order(po_or_so, doctype)
2046 self.ignore_default_payment_terms_template = 1
tunde43870aa2017-08-18 11:59:30 +01002047
GangaManoj4323f4b2021-07-22 05:57:42 +05302048 def get_order_details(self):
2049 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302050 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302051 po_or_so_doctype = "Sales Order"
2052 po_or_so_doctype_name = "sales_order"
2053
tunde43870aa2017-08-18 11:59:30 +01002054 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302055 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302056 po_or_so_doctype = "Purchase Order"
2057 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05302058
GangaManoj4323f4b2021-07-22 05:57:42 +05302059 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
2060
GangaManojc7c90242021-07-29 19:18:35 +05302061 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302062 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05302063 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302064 return True
2065 elif self.linked_order_has_payment_schedule(po_or_so):
2066 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05302067
GangaManoj4323f4b2021-07-22 05:57:42 +05302068 return False
2069
2070 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302071 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05302072 if item.get(fieldname) != po_or_so:
2073 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05302074
GangaManoj4323f4b2021-07-22 05:57:42 +05302075 return True
2076
GangaManojc7c90242021-07-29 19:18:35 +05302077 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302078 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05302079
2080 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302081 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05302082
2083 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
2084 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302085 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05302086 """
2087 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
2088
2089 self.payment_schedule = []
2090 self.payment_terms_template = po_or_so.payment_terms_template
2091
2092 for schedule in po_or_so.payment_schedule:
2093 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302094 "payment_term": schedule.payment_term,
2095 "due_date": schedule.due_date,
2096 "invoice_portion": schedule.invoice_portion,
2097 "mode_of_payment": schedule.mode_of_payment,
2098 "description": schedule.description,
Deepesh Garg5c758942023-04-16 17:11:24 +05302099 "payment_amount": schedule.payment_amount,
2100 "base_payment_amount": schedule.base_payment_amount,
2101 "outstanding": schedule.outstanding,
2102 "paid_amount": schedule.paid_amount,
GangaManoj4323f4b2021-07-22 05:57:42 +05302103 }
GangaManoj5b33e752021-08-05 21:50:09 +05302104
Ankush Menat494bd9e2022-03-28 18:52:46 +05302105 if schedule.discount_type == "Percentage":
2106 payment_schedule["discount_type"] = schedule.discount_type
2107 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05302108
ruthra kumar9bd56b02022-02-01 14:14:04 +05302109 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302110 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05302111
GangaManoj4323f4b2021-07-22 05:57:42 +05302112 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01002113
tundebe1b8712017-08-19 08:21:44 +01002114 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05302115 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
2116 if due_dates:
2117 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01002118
2119 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01002120 dates = []
tunde9bed2de2017-09-25 10:19:35 +01002121 li = []
tunde43870aa2017-08-18 11:59:30 +01002122
Ankush Menat494bd9e2022-03-28 18:52:46 +05302123 if self.doctype == "Sales Invoice" and self.is_pos:
2124 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302125
tunde43870aa2017-08-18 11:59:30 +01002126 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302127 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302128 frappe.throw(
2129 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
2130 )
tunde77ecacc2017-09-22 23:12:55 +01002131 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03002132 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01002133 dates.append(d.due_date)
2134
2135 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302136 duplicates = "<br>" + "<br>".join(li)
2137 frappe.throw(
2138 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
2139 )
tunde43870aa2017-08-18 11:59:30 +01002140
tunde62af5c52017-09-22 15:16:38 +01002141 def validate_payment_schedule_amount(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05302142 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302143 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302144
Ankush Menat494bd9e2022-03-28 18:52:46 +05302145 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302146 if not party_account_currency:
2147 party_type, party = self.get_party()
2148
2149 if party_type and party:
2150 party_account_currency = get_party_account_currency(party_type, party, self.company)
2151
Nabin Hait0551f7b2017-11-21 19:58:16 +05302152 if self.get("payment_schedule"):
2153 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05302154 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05302155 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05302156 total += flt(d.payment_amount, d.precision("payment_amount"))
2157 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01002158
Saqib Ansarid552fe62021-04-23 14:46:52 +05302159 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2160 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302161
Nabin Haite591c852017-12-21 11:46:30 +05302162 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302163 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05302164 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05302165
2166 if self.get("total_advance"):
2167 if party_account_currency == self.company_currency:
2168 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302169 grand_total = flt(
2170 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2171 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302172 else:
2173 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302174 base_grand_total = flt(
2175 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2176 )
Deepesh Garg9c170522021-10-25 20:06:24 +05302177
Ankush Menat494bd9e2022-03-28 18:52:46 +05302178 if (
2179 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
2180 > 0.1
2181 or flt(base_total, self.precision("base_grand_total"))
2182 - flt(base_grand_total, self.precision("base_grand_total"))
2183 > 0.1
2184 ):
2185 frappe.throw(
2186 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
2187 )
tunde43870aa2017-08-18 11:59:30 +01002188
Nabin Hait877e1bb2017-11-17 12:27:43 +05302189 def is_rounded_total_disabled(self):
2190 if self.meta.get_field("disable_rounded_total"):
2191 return self.disable_rounded_total
2192 else:
2193 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
2194
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302195 def set_inter_company_account(self):
2196 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302197 Set intercompany account for inter warehouse transactions
2198 This account will be used in case billing company and internal customer's
2199 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302200 """
2201
2202 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Daizy Modi4efc9472022-11-07 09:21:03 +05302203 unrealized_profit_loss_account = frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302204 "Company", self.company, "unrealized_profit_loss_account"
2205 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302206
2207 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302208 msg = _(
2209 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
2210 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302211 frappe.throw(msg)
2212
2213 self.unrealized_profit_loss_account = unrealized_profit_loss_account
2214
2215 def is_internal_transfer(self):
2216 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302217 It will an internal transfer if its an internal customer and representation
2218 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302219 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302220 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
2221 internal_party_field = "is_internal_customer"
2222 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
2223 internal_party_field = "is_internal_supplier"
Ankush Menat3714e362022-05-16 18:09:14 +05302224 else:
2225 return False
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302226
2227 if self.get(internal_party_field) and (self.represents_company == self.company):
2228 return True
2229
2230 return False
2231
Saqib Ansari977b09b2021-08-19 17:57:30 +05302232 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302233 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05302234 if not is_invoice:
2235 return
2236
Ankush Menat494bd9e2022-03-28 18:52:46 +05302237 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05302238 party_link = self.get_common_party_link()
2239 if party_link and self.outstanding_amount:
2240 self.create_advance_and_reconcile(party_link)
2241
2242 def get_common_party_link(self):
2243 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05302244 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302245 doctype="Party Link",
2246 filters={"secondary_role": party_type, "secondary_party": party},
2247 fieldname=["primary_role", "primary_party"],
2248 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05302249 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302250
2251 def create_advance_and_reconcile(self, party_link):
2252 secondary_party_type, secondary_party = self.get_party()
2253 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
2254
2255 primary_account = get_party_account(primary_party_type, primary_party, self.company)
2256 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
2257
Ankush Menat494bd9e2022-03-28 18:52:46 +05302258 jv = frappe.new_doc("Journal Entry")
2259 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302260 jv.posting_date = self.posting_date
2261 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05302262 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302263
2264 reconcilation_entry = frappe._dict()
2265 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05302266
2267 reconcilation_entry.account = secondary_account
2268 reconcilation_entry.party_type = secondary_party_type
2269 reconcilation_entry.party = secondary_party
2270 reconcilation_entry.reference_type = self.doctype
2271 reconcilation_entry.reference_name = self.name
Deepesh Gargf88431a2023-04-25 20:54:22 +05302272 reconcilation_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(
2273 self.company
2274 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302275
2276 advance_entry.account = primary_account
2277 advance_entry.party_type = primary_party_type
2278 advance_entry.party = primary_party
Deepesh Gargf88431a2023-04-25 20:54:22 +05302279 advance_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(self.company)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302280 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302281
Ankush Menat494bd9e2022-03-28 18:52:46 +05302282 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05302283 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
2284 advance_entry.debit_in_account_currency = self.outstanding_amount
2285 else:
2286 advance_entry.credit_in_account_currency = self.outstanding_amount
2287 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
2288
Ankush Menat494bd9e2022-03-28 18:52:46 +05302289 jv.append("accounts", reconcilation_entry)
2290 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302291
2292 jv.save()
2293 jv.submit()
2294
Deepesh Gargd05d1532022-06-14 12:50:49 +05302295 def check_conversion_rate(self):
2296 default_currency = erpnext.get_company_currency(self.company)
2297 if not default_currency:
2298 throw(_("Please enter default currency in Company Master"))
2299 if (
2300 (self.currency == default_currency and flt(self.conversion_rate) != 1.00)
2301 or not self.conversion_rate
2302 or (self.currency != default_currency and flt(self.conversion_rate) == 1.00)
2303 ):
2304 throw(_("Conversion rate cannot be 0 or 1"))
2305
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002306 def check_finance_books(self, item, asset):
Nabin Haitfefe9502022-09-09 14:40:36 +05302307 if (
2308 len(asset.finance_books) > 1
2309 and not item.get("finance_book")
2310 and not self.get("finance_book")
2311 and asset.finance_books[0].finance_book
2312 ):
2313 frappe.throw(
2314 _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx)
2315 )
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002316
Gursheen Anand68effd92023-09-21 17:28:07 +05302317 def check_if_fields_updated(self, fields_to_check, child_tables):
2318 # Check if any field affecting accounting entry is altered
2319 doc_before_update = self.get_doc_before_save()
2320 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
2321
2322 # Check if opening entry check updated
2323 needs_repost = doc_before_update.get("is_opening") != self.is_opening
2324
2325 if not needs_repost:
2326 # Parent Level Accounts excluding party account
2327 fields_to_check += accounting_dimensions
2328 for field in fields_to_check:
2329 if doc_before_update.get(field) != self.get(field):
2330 needs_repost = 1
2331 break
2332
2333 if not needs_repost:
2334 # Check for child tables
2335 for table in child_tables:
2336 needs_repost = check_if_child_table_updated(
2337 doc_before_update.get(table), self.get(table), child_tables[table]
2338 )
2339 if needs_repost:
2340 break
2341
2342 return needs_repost
2343
2344 @frappe.whitelist()
2345 def repost_accounting_entries(self):
2346 if self.repost_required:
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302347 repost_ledger = frappe.new_doc("Repost Accounting Ledger")
2348 repost_ledger.company = self.company
2349 repost_ledger.append("vouchers", {"voucher_type": self.doctype, "voucher_no": self.name})
Gursheen Kaur Anand1b808e12023-11-02 14:01:26 +05302350 repost_ledger.flags.ignore_permissions = True
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302351 repost_ledger.insert()
2352 repost_ledger.submit()
Gursheen Anand68effd92023-09-21 17:28:07 +05302353 self.db_set("repost_required", 0)
2354 else:
2355 frappe.throw(_("No updates pending for reposting"))
2356
Ankush Menat494bd9e2022-03-28 18:52:46 +05302357
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05302358@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05302359def get_tax_rate(account_head):
Daizy Modi4efc9472022-11-07 09:21:03 +05302360 return frappe.get_cached_value(
2361 "Account", account_head, ["tax_rate", "account_name"], as_dict=True
2362 )
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05302363
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002364
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302365@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05302366def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302367 if not company:
2368 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05302369
Nabin Haita2426fc2018-01-15 17:45:46 +05302370 if tax_template and company:
Daizy Modi4efc9472022-11-07 09:21:03 +05302371 tax_template_company = frappe.get_cached_value(master_doctype, tax_template, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +05302372 if tax_template_company == company:
2373 return
2374
2375 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05302376
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302377 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302378 "taxes_and_charges": default_tax,
2379 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302380 }
Nabin Hait6b039142014-05-02 15:45:10 +05302381
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002382
Nabin Hait6b039142014-05-02 15:45:10 +05302383@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302384def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05302385 if not master_name:
2386 return
Ankush Menat77dcdff2022-06-01 22:01:07 +05302387 from frappe.model import child_table_fields, default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05302388
Nabin Hait6b039142014-05-02 15:45:10 +05302389 tax_master = frappe.get_doc(master_doctype, master_name)
2390
2391 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302392 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05302393 tax = tax.as_dict()
2394
Ankush Menat77dcdff2022-06-01 22:01:07 +05302395 for fieldname in default_fields + child_table_fields:
Nabin Hait6b039142014-05-02 15:45:10 +05302396 if fieldname in tax:
2397 del tax[fieldname]
2398
2399 taxes_and_charges.append(tax)
2400
2401 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302402
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002403
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302404def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
2405 """common validation for currency and price list currency"""
2406
Ankush Menat494bd9e2022-03-28 18:52:46 +05302407 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302408
2409 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05302410 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302411 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
2412 conversion_rate_label, currency, company_currency
2413 )
Saqib60212ff2020-10-26 11:17:04 +05302414 )
Nabin Hait613d0812015-02-23 11:58:15 +05302415
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002416
Nabin Hait613d0812015-02-23 11:58:15 +05302417def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302418 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
2419 frappe.throw(
2420 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
2421 )
2422 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05302423 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002424 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302425 _(
2426 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
2427 )
2428 )
Nabin Hait613d0812015-02-23 11:58:15 +05302429 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302430 frappe.throw(
2431 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
2432 )
Nabin Hait613d0812015-02-23 11:58:15 +05302433 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302434 frappe.throw(
2435 _("Cannot refer row number greater than or equal to current row number for this Charge type")
2436 )
Nabin Hait613d0812015-02-23 11:58:15 +05302437
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302438 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05302439 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302440
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002441
Ankush Menat494bd9e2022-03-28 18:52:46 +05302442def validate_account_head(idx, account, company, context=""):
2443 account_company = frappe.get_cached_value("Account", account, "company")
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302444 is_group = frappe.get_cached_value("Account", account, "is_group")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302445
Deepesh Garg5a2b5712022-02-18 20:05:49 +05302446 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302447 frappe.throw(
2448 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
2449 idx, frappe.bold(account), frappe.bold(company), context
2450 ),
2451 title=_("Invalid Account"),
2452 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302453
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302454 if is_group:
2455 frappe.throw(
2456 _("Row {0}: Account {1} is a Group Account").format(idx, frappe.bold(account)),
2457 title=_("Invalid Account"),
2458 )
2459
Anuja Pawar0e337be2021-08-10 17:26:35 +05302460
2461def validate_cost_center(tax, doc):
2462 if not tax.cost_center:
2463 return
2464
Ankush Menat494bd9e2022-03-28 18:52:46 +05302465 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302466
2467 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302468 frappe.throw(
2469 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
2470 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
2471 ),
2472 title=_("Invalid Cost Center"),
2473 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302474
2475
Nabin Hait613d0812015-02-23 11:58:15 +05302476def validate_inclusive_tax(tax, doc):
2477 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302478 throw(
2479 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
2480 tax.idx, row_range
2481 )
2482 )
Nabin Hait613d0812015-02-23 11:58:15 +05302483
2484 if cint(getattr(tax, "included_in_print_rate", None)):
2485 if tax.charge_type == "Actual":
2486 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05302487 throw(
2488 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
2489 tax.idx
2490 )
2491 )
2492 elif tax.charge_type == "On Previous Row Amount" and not cint(
2493 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
2494 ):
Nabin Hait613d0812015-02-23 11:58:15 +05302495 # referred row should also be inclusive
2496 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302497 elif tax.charge_type == "On Previous Row Total" and not all(
2498 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
2499 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05302500 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05302501 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05302502 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05302503 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302504
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302505
Ankush Menat494bd9e2022-03-28 18:52:46 +05302506def set_balance_in_account_currency(
2507 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
2508):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002509 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302510 frappe.throw(
2511 _("Account: {0} with currency: {1} can not be selected").format(
2512 gl_dict.account, account_currency
2513 )
2514 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002515
Ankush Menat494bd9e2022-03-28 18:52:46 +05302516 gl_dict["account_currency"] = (
2517 company_currency if account_currency == company_currency else account_currency
2518 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302519
2520 # set debit/credit in account currency if not provided
2521 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302522 gl_dict.debit_in_account_currency = (
2523 gl_dict.debit
2524 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302525 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302526 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302527
2528 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302529 gl_dict.credit_in_account_currency = (
2530 gl_dict.credit
2531 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302532 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302533 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302534
2535
Ankush Menat494bd9e2022-03-28 18:52:46 +05302536def get_advance_journal_entries(
2537 party_type,
2538 party,
2539 party_account,
2540 amount_field,
2541 order_doctype,
2542 order_list,
2543 include_unallocated=True,
2544):
Gursheen Anand4ee16372023-06-08 13:15:23 +05302545 journal_entry = frappe.qb.DocType("Journal Entry")
2546 journal_acc = frappe.qb.DocType("Journal Entry Account")
2547 q = (
2548 frappe.qb.from_(journal_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302549 .inner_join(journal_acc)
2550 .on(journal_entry.name == journal_acc.parent)
2551 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302552 ConstantColumn("Journal Entry").as_("reference_type"),
2553 (journal_entry.name).as_("reference_name"),
2554 (journal_entry.remark).as_("remarks"),
Deepesh Garg3aead052023-06-22 11:41:43 +05302555 (journal_acc[amount_field]).as_("amount"),
Gursheen Anand4ee16372023-06-08 13:15:23 +05302556 (journal_acc.name).as_("reference_row"),
2557 (journal_acc.reference_name).as_("against_order"),
2558 (journal_acc.exchange_rate),
Gursheen Anand74619262023-06-02 17:13:51 +05302559 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302560 .where(
2561 journal_acc.account.isin(party_account)
2562 & (journal_acc.party_type == party_type)
2563 & (journal_acc.party == party)
2564 & (journal_acc.is_advance == "Yes")
2565 & (journal_entry.docstatus == 1)
2566 )
2567 )
Gursheen Anand74619262023-06-02 17:13:51 +05302568 if party_type == "Customer":
2569 q = q.where(journal_acc.credit_in_account_currency > 0)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302570
Gursheen Anand4ee16372023-06-08 13:15:23 +05302571 else:
2572 q = q.where(journal_acc.debit_in_account_currency > 0)
2573
Deepesh Garg3aead052023-06-22 11:41:43 +05302574 if include_unallocated:
2575 q = q.where((journal_acc.reference_name.isnull()) | (journal_acc.reference_name == ""))
2576
Nabin Hait1991c7b2016-06-27 20:09:05 +05302577 if order_list:
Deepesh Garg3aead052023-06-22 11:41:43 +05302578 q = q.where(
Deepesh Garg6d121ae2023-06-22 13:03:09 +05302579 (journal_acc.reference_type == order_doctype) & ((journal_acc.reference_type).isin(order_list))
Deepesh Garg3aead052023-06-22 11:41:43 +05302580 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302581
Gursheen Anand74619262023-06-02 17:13:51 +05302582 q = q.orderby(journal_entry.posting_date)
Rushabh Mehta66958302017-01-16 16:57:53 +05302583
Gursheen Anand74619262023-06-02 17:13:51 +05302584 journal_entries = q.run(as_dict=True)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302585 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302586
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002587
Smit Vora3e282bf2023-09-19 20:47:21 +05302588@erpnext.allow_regional
2589def get_advance_payment_entries_for_regional(*args, **kwargs):
2590 return get_advance_payment_entries(*args, **kwargs)
2591
2592
Ankush Menat494bd9e2022-03-28 18:52:46 +05302593def get_advance_payment_entries(
2594 party_type,
2595 party,
2596 party_account,
2597 order_doctype,
2598 order_list=None,
2599 include_unallocated=True,
2600 against_all_orders=False,
2601 limit=None,
2602 condition=None,
2603):
Gursheen Anand74619262023-06-02 17:13:51 +05302604
Deepesh Garg92f845c2023-06-21 12:21:19 +05302605 payment_entries = []
2606 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand74619262023-06-02 17:13:51 +05302607
Deepesh Garg92f845c2023-06-21 12:21:19 +05302608 if order_list or against_all_orders:
2609 q = get_common_query(
2610 party_type,
2611 party,
2612 party_account,
2613 limit,
2614 condition,
2615 )
2616 payment_ref = frappe.qb.DocType("Payment Entry Reference")
Gursheen Anand74619262023-06-02 17:13:51 +05302617
Deepesh Garg92f845c2023-06-21 12:21:19 +05302618 q = q.inner_join(payment_ref).on(payment_entry.name == payment_ref.parent)
2619 q = q.select(
2620 (payment_ref.allocated_amount).as_("amount"),
2621 (payment_ref.name).as_("reference_row"),
2622 (payment_ref.reference_name).as_("against_order"),
Deepesh Garg92f845c2023-06-21 12:21:19 +05302623 )
2624
Deepesh Garg3aead052023-06-22 11:41:43 +05302625 q = q.where(payment_ref.reference_doctype == order_doctype)
Deepesh Garg92f845c2023-06-21 12:21:19 +05302626 if order_list:
2627 q = q.where(payment_ref.reference_name.isin(order_list))
2628
2629 allocated = list(q.run(as_dict=True))
2630 payment_entries += allocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302631 if include_unallocated:
2632 q = get_common_query(
2633 party_type,
2634 party,
2635 party_account,
2636 limit,
2637 condition,
2638 )
2639 q = q.select((payment_entry.unallocated_amount).as_("amount"))
2640 q = q.where(payment_entry.unallocated_amount > 0)
2641
2642 unallocated = list(q.run(as_dict=True))
2643 payment_entries += unallocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302644 return payment_entries
Gursheen Anand74619262023-06-02 17:13:51 +05302645
Saqiba20999c2021-07-12 14:33:23 +05302646
Deepesh Garg92f845c2023-06-21 12:21:19 +05302647def get_common_query(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302648 party_type,
2649 party,
2650 party_account,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302651 limit,
2652 condition,
2653):
RitvikSardanad2f03c82023-09-05 12:00:54 +05302654 account_type = frappe.db.get_value("Party Type", party_type, "account_type")
2655 payment_type = "Receive" if account_type == "Receivable" else "Pay"
Gursheen Anand4ee16372023-06-08 13:15:23 +05302656 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand4ee16372023-06-08 13:15:23 +05302657
2658 q = (
2659 frappe.qb.from_(payment_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302660 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302661 ConstantColumn("Payment Entry").as_("reference_type"),
2662 (payment_entry.name).as_("reference_name"),
Gursheen Anand74619262023-06-02 17:13:51 +05302663 payment_entry.posting_date,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302664 (payment_entry.remarks).as_("remarks"),
Ankush Menat494bd9e2022-03-28 18:52:46 +05302665 )
Gursheen Anand74619262023-06-02 17:13:51 +05302666 .where(payment_entry.payment_type == payment_type)
2667 .where(payment_entry.party_type == party_type)
2668 .where(payment_entry.party == party)
2669 .where(payment_entry.docstatus == 1)
2670 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302671
RitvikSardanad2f03c82023-09-05 12:00:54 +05302672 if payment_type == "Receive":
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302673 q = q.select((payment_entry.paid_from_account_currency).as_("currency"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302674 q = q.select(payment_entry.paid_from)
2675 q = q.where(payment_entry.paid_from.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302676 else:
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302677 q = q.select((payment_entry.paid_to_account_currency).as_("currency"))
Gursheen Anand74619262023-06-02 17:13:51 +05302678 q = q.select(payment_entry.paid_to)
Gursheen Anand4ee16372023-06-08 13:15:23 +05302679 q = q.where(payment_entry.paid_to.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302680
2681 if payment_type == "Receive":
Deepesh Garg92f845c2023-06-21 12:21:19 +05302682 q = q.select((payment_entry.source_exchange_rate).as_("exchange_rate"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302683 else:
Deepesh Garg92f845c2023-06-21 12:21:19 +05302684 q = q.select((payment_entry.target_exchange_rate).as_("exchange_rate"))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302685
Deepesh Garg92f845c2023-06-21 12:21:19 +05302686 if condition:
ruthra kumar86bac2c2023-07-04 09:02:05 +05302687 if condition.get("name", None):
2688 q = q.where(payment_entry.name.like(f"%{condition.get('name')}%"))
2689
Deepesh Garg92f845c2023-06-21 12:21:19 +05302690 q = q.where(payment_entry.company == condition["company"])
2691 q = (
2692 q.where(payment_entry.posting_date >= condition["from_payment_date"])
2693 if condition.get("from_payment_date")
2694 else q
Gursheen Anand74619262023-06-02 17:13:51 +05302695 )
Deepesh Garg92f845c2023-06-21 12:21:19 +05302696 q = (
2697 q.where(payment_entry.posting_date <= condition["to_payment_date"])
2698 if condition.get("to_payment_date")
2699 else q
2700 )
2701 if condition.get("get_payments") == True:
2702 q = (
2703 q.where(payment_entry.cost_center == condition["cost_center"])
2704 if condition.get("cost_center")
2705 else q
2706 )
2707 q = (
2708 q.where(payment_entry.unallocated_amount >= condition["minimum_payment_amount"])
2709 if condition.get("minimum_payment_amount")
2710 else q
2711 )
2712 q = (
2713 q.where(payment_entry.unallocated_amount <= condition["maximum_payment_amount"])
2714 if condition.get("maximum_payment_amount")
2715 else q
2716 )
2717 else:
2718 q = (
2719 q.where(payment_entry.total_debit >= condition["minimum_payment_amount"])
2720 if condition.get("minimum_payment_amount")
2721 else q
2722 )
2723 q = (
2724 q.where(payment_entry.total_debit <= condition["maximum_payment_amount"])
2725 if condition.get("maximum_payment_amount")
2726 else q
2727 )
Gursheen Anand74619262023-06-02 17:13:51 +05302728
2729 q = q.orderby(payment_entry.posting_date)
2730 q = q.limit(limit) if limit else q
Deepesh Garg92f845c2023-06-21 12:21:19 +05302731
Gursheen Anand74619262023-06-02 17:13:51 +05302732 return q
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302733
Ankush Menat494bd9e2022-03-28 18:52:46 +05302734
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302735def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302736 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302737 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302738 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302739 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302740 invoice = frappe.qb.DocType(doctype)
2741
2742 consider_base_amount = invoice.party_account_currency != invoice.currency
2743 payment_amount = (
2744 frappe.qb.terms.Case()
2745 .when(consider_base_amount, payment_schedule.base_payment_amount)
2746 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302747 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002748
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302749 payable_amount = (
2750 frappe.qb.from_(payment_schedule)
2751 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302752 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302753 )
2754
2755 total = (
2756 frappe.qb.terms.Case()
2757 .when(invoice.disable_rounded_total, invoice.grand_total)
2758 .else_(invoice.rounded_total)
2759 )
2760
2761 base_total = (
2762 frappe.qb.terms.Case()
2763 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2764 .else_(invoice.base_rounded_total)
2765 )
2766
Ankush Menat494bd9e2022-03-28 18:52:46 +05302767 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302768
2769 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2770
2771 conditions = (
2772 (invoice.docstatus == 1)
2773 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302774 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302775 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302776 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302777 if doctype == "Sales Invoice"
2778 else is_overdue
2779 )
2780 )
2781
Pruthvi Patel0799f372021-11-12 12:56:29 +05302782 status = (
2783 frappe.qb.terms.Case()
2784 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2785 .else_("Overdue")
2786 )
2787
2788 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302789
2790
Nabin Hait92759692017-08-15 08:23:51 +05302791@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302792def get_payment_terms(
2793 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2794):
Nabin Hait92759692017-08-15 08:23:51 +05302795 if not terms_template:
2796 return
2797
2798 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2799
2800 schedule = []
tundefb144302017-08-19 15:01:40 +01002801 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302802 term_details = get_payment_term_details(
2803 d, posting_date, grand_total, base_grand_total, bill_date
2804 )
Nabin Hait92759692017-08-15 08:23:51 +05302805 schedule.append(term_details)
2806
2807 return schedule
2808
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002809
Nabin Hait92759692017-08-15 08:23:51 +05302810@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302811def get_payment_term_details(
2812 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2813):
Nabin Hait92759692017-08-15 08:23:51 +05302814 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302815 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302816 term = frappe.get_doc("Payment Term", term)
2817 else:
2818 term_details.payment_term = term.payment_term
2819 term_details.description = term.description
2820 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302821 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302822 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302823 term_details.discount_type = term.discount_type
2824 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302825 term_details.outstanding = term_details.payment_amount
2826 term_details.mode_of_payment = term.mode_of_payment
2827
Shreya Shah3a9eec22018-02-16 13:05:21 +05302828 if bill_date:
2829 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302830 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302831 elif posting_date:
2832 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302833 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302834
2835 if getdate(term_details.due_date) < getdate(posting_date):
2836 term_details.due_date = posting_date
2837
Nabin Hait92759692017-08-15 08:23:51 +05302838 return term_details
2839
Ankush Menat494bd9e2022-03-28 18:52:46 +05302840
Shreya Shah3a9eec22018-02-16 13:05:21 +05302841def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302842 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302843 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302844 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302845 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302846 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302847 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302848 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302849 due_date = get_last_day(add_months(date, term.credit_months))
tunde96b8f222017-09-08 15:35:59 +01002850 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002851
Ankush Menat494bd9e2022-03-28 18:52:46 +05302852
Saqib0586b7d2021-03-31 15:03:53 +05302853def get_discount_date(term, posting_date=None, bill_date=None):
2854 discount_validity = None
2855 date = bill_date or posting_date
2856 if term.discount_validity_based_on == "Day(s) after invoice date":
2857 discount_validity = add_days(date, term.discount_validity)
2858 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2859 discount_validity = add_days(get_last_day(date), term.discount_validity)
2860 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302861 discount_validity = get_last_day(add_months(date, term.discount_validity))
Saqib0586b7d2021-03-31 15:03:53 +05302862 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002863
Ankush Menat494bd9e2022-03-28 18:52:46 +05302864
tundebabzyad08d4c2018-05-16 07:01:41 +01002865def get_supplier_block_status(party_name):
2866 """
2867 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2868 a `Supplier`
2869 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302870 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002871 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302872 "on_hold": supplier.on_hold,
2873 "release_date": supplier.release_date,
2874 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002875 }
2876 return info
2877
Ankush Menat494bd9e2022-03-28 18:52:46 +05302878
marination698d9832020-08-19 14:59:46 +05302879def set_child_tax_template_and_map(item, child_item, parent_doc):
2880 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302881 "item_code": item.item_code,
2882 "posting_date": parent_doc.transaction_date,
2883 "tax_category": parent_doc.get("tax_category"),
2884 "company": parent_doc.get("company"),
2885 }
marination698d9832020-08-19 14:59:46 +05302886
2887 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2888 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302889 child_item.item_tax_rate = get_item_tax_map(
2890 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2891 )
2892
marination698d9832020-08-19 14:59:46 +05302893
Afshanb3bbebd2021-08-09 14:39:32 +05302894def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302895 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2896 "Accounts Settings", "add_taxes_from_item_tax_template"
2897 )
Marica3b1be2b2020-10-22 17:04:31 +05302898
2899 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2900 tax_map = json.loads(child_item.get("item_tax_rate"))
2901 for tax_type in tax_map:
2902 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302903 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302904 # add new row for tax head only if missing
2905 found = any(tax.account_head == tax_type for tax in taxes)
2906 if not found:
2907 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302908 tax_row.update(
2909 {
2910 "description": str(tax_type).split(" - ")[0],
2911 "charge_type": "On Net Total",
2912 "account_head": tax_type,
2913 "rate": tax_rate,
2914 }
2915 )
Marica3b1be2b2020-10-22 17:04:31 +05302916 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302917 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302918 if db_insert:
2919 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302920
Ankush Menat494bd9e2022-03-28 18:52:46 +05302921
2922def set_order_defaults(
2923 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2924):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002925 """
pateljannat637ddff2021-02-09 16:17:30 +05302926 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002927 """
Saqib438e0432020-04-03 10:02:56 +05302928 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
Ankush Menat686685b2023-05-31 12:50:14 +05302929 child_item = frappe.new_doc(child_doctype, parent_doc=p_doc, parentfield=child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302930 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05302931
pateljannat637ddff2021-02-09 16:17:30 +05302932 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05302933 child_item.update({field: item.get(field)})
2934
pateljannat637ddff2021-02-09 16:17:30 +05302935 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05302936 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05302937 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05302938 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13002939 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302940 conversion_factor = flt(
2941 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
2942 )
2943 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05302944
pateljannat637ddff2021-02-09 16:17:30 +05302945 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05302946 # Initialized value will update in parent validation
2947 child_item.base_rate = 1
2948 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05302949 if child_doctype == "Sales Order Item":
2950 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
2951 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302952 frappe.throw(
2953 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
2954 frappe.bold("default warehouse"), frappe.bold(item.item_code)
2955 )
2956 )
marination0673f552021-03-31 01:38:22 +05302957
marination698d9832020-08-19 14:59:46 +05302958 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05302959 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002960 return child_item
2961
Ankush Menat494bd9e2022-03-28 18:52:46 +05302962
marination0673f552021-03-31 01:38:22 +05302963def validate_child_on_delete(row, parent):
2964 """Check if partially transacted item (row) is being deleted."""
2965 if parent.doctype == "Sales Order":
2966 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302967 frappe.throw(
2968 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
2969 row.idx, row.item_code
2970 )
2971 )
marination0673f552021-03-31 01:38:22 +05302972 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302973 frappe.throw(
2974 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
2975 row.idx, row.item_code
2976 )
2977 )
marination0673f552021-03-31 01:38:22 +05302978 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302979 frappe.throw(
2980 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
2981 row.idx, row.item_code
2982 )
2983 )
marination0673f552021-03-31 01:38:22 +05302984
2985 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302986 frappe.throw(
2987 _("Row #{0}: Cannot delete item {1} which has already been received").format(
2988 row.idx, row.item_code
2989 )
2990 )
marination0673f552021-03-31 01:38:22 +05302991
2992 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302993 frappe.throw(
2994 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
2995 row.idx, row.item_code
2996 )
2997 )
2998
marination0673f552021-03-31 01:38:22 +05302999
3000def update_bin_on_delete(row, doctype):
3001 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05303002 from erpnext.stock.stock_balance import (
3003 get_indented_qty,
3004 get_ordered_qty,
3005 get_reserved_qty,
3006 update_bin_qty,
3007 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05303008
marination0673f552021-03-31 01:38:22 +05303009 qty_dict = {}
3010
3011 if doctype == "Sales Order":
3012 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
3013 else:
3014 if row.material_request_item:
3015 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
3016
3017 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
3018
Deepesh Garga61790c2022-02-22 20:58:10 +05303019 if row.warehouse:
3020 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05303021
Ankush Menat494bd9e2022-03-28 18:52:46 +05303022
Ankush Menatdd11f262022-06-27 15:55:08 +05303023def validate_and_delete_children(parent, data) -> bool:
Saqib0ad74492019-12-24 16:42:30 +05303024 deleted_children = []
3025 updated_item_names = [d.get("docname") for d in data]
3026 for item in parent.items:
3027 if item.name not in updated_item_names:
3028 deleted_children.append(item)
3029
3030 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05303031 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05303032 d.cancel()
3033 d.delete()
marination0673f552021-03-31 01:38:22 +05303034
Gursheen Kaur Anand9087e142023-12-02 19:53:00 +05303035 if parent.doctype == "Purchase Order":
3036 parent.update_ordered_qty_in_so_for_removed_items(deleted_children)
3037
marination0673f552021-03-31 01:38:22 +05303038 # need to update ordered qty in Material Request first
3039 # bin uses Material Request Items to recalculate & update
3040 parent.update_prevdoc_status()
3041
3042 for d in deleted_children:
3043 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003044
Ankush Menatdd11f262022-06-27 15:55:08 +05303045 return bool(deleted_children)
3046
Rohan Bansala93b5142021-04-06 17:10:52 +05303047
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003048@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003049def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303050 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303051 try:
3052 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05303053 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303054 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05303055
Ankush Menat494bd9e2022-03-28 18:52:46 +05303056 frappe.throw(
3057 _("You do not have permissions to {} items in a {}.").format(
3058 actions[perm_type], parent_doctype
3059 ),
3060 title=_("Insufficient Permissions"),
3061 )
marination665c27a2020-09-15 12:04:38 +05303062
Saqib6db92fb2020-09-14 19:54:17 +05303063 def validate_workflow_conditions(doc):
3064 workflow = get_workflow_name(doc.doctype)
3065 if not workflow:
3066 return
3067
3068 workflow_doc = frappe.get_doc("Workflow", workflow)
3069 current_state = doc.get(workflow_doc.workflow_state_field)
3070 roles = frappe.get_roles()
3071
3072 transitions = []
3073 for transition in workflow_doc.transitions:
3074 if transition.next_state == current_state and transition.allowed in roles:
3075 if not is_transition_condition_satisfied(transition, doc):
3076 continue
3077 transitions.append(transition.as_dict())
3078
3079 if not transitions:
Saqib18318932020-09-23 13:01:49 +05303080 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05303081 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
3082 get_link_to_form("Workflow", workflow)
3083 ),
3084 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05303085 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303086
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303087 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05303088 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303089 return set_order_defaults(
3090 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
3091 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303092
marination0c915432022-05-10 18:04:02 +05303093 def validate_quantity(child_item, new_data):
3094 if not flt(new_data.get("qty")):
3095 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +01003096 _("Row #{0}: Quantity for Item {1} cannot be zero.").format(
marination0c915432022-05-10 18:04:02 +05303097 new_data.get("idx"), frappe.bold(new_data.get("item_code"))
3098 ),
3099 title=_("Invalid Qty"),
3100 )
3101
3102 if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303103 frappe.throw(_("Cannot set quantity less than delivered quantity"))
3104
marination0c915432022-05-10 18:04:02 +05303105 if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt(
3106 child_item.received_qty
3107 ):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303108 frappe.throw(_("Cannot set quantity less than received quantity"))
3109
Ankush Menatdd11f262022-06-27 15:55:08 +05303110 def should_update_supplied_items(doc) -> bool:
3111 """Subcontracted PO can allow following changes *after submit*:
3112
3113 1. Change rate of subcontracting - regardless of other changes.
3114 2. Change qty and/or add new items and/or remove items
3115 Exception: Transfer/Consumption is already made, qty change not allowed.
3116 """
3117
3118 supplied_items_processed = any(
3119 item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items
3120 )
3121
3122 update_supplied_items = (
3123 any_qty_changed or items_added_or_removed or any_conversion_factor_changed
3124 )
3125 if update_supplied_items and supplied_items_processed:
3126 frappe.throw(_("Item qty can not be updated as raw materials are already processed."))
3127
3128 return update_supplied_items
3129
s-aga-r9588bb72023-08-21 22:23:57 +05303130 def validate_fg_item_for_subcontracting(new_data, is_new):
3131 if is_new:
3132 if not new_data.get("fg_item"):
3133 frappe.throw(
3134 _("Finished Good Item is not specified for service item {0}").format(new_data["item_code"])
3135 )
3136 else:
3137 is_sub_contracted_item, default_bom = frappe.db.get_value(
3138 "Item", new_data["fg_item"], ["is_sub_contracted_item", "default_bom"]
3139 )
3140
3141 if not is_sub_contracted_item:
3142 frappe.throw(
3143 _("Finished Good Item {0} must be a sub-contracted item").format(new_data["fg_item"])
3144 )
3145 elif not default_bom:
3146 frappe.throw(_("Default BOM not found for FG Item {0}").format(new_data["fg_item"]))
3147
3148 if not new_data.get("fg_item_qty"):
3149 frappe.throw(_("Finished Good Item {0} Qty can not be zero").format(new_data["fg_item"]))
3150
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003151 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003152
Ankush Menatdd11f262022-06-27 15:55:08 +05303153 any_qty_changed = False # updated to true if any item's qty changes
3154 items_added_or_removed = False # updated to true if any new item is added or removed
3155 any_conversion_factor_changed = False
3156
Ankush Menat494bd9e2022-03-28 18:52:46 +05303157 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303158 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05303159
Ankush Menat494bd9e2022-03-28 18:52:46 +05303160 check_doc_permissions(parent, "write")
Ankush Menatdd11f262022-06-27 15:55:08 +05303161 _removed_items = validate_and_delete_children(parent, data)
3162 items_added_or_removed |= _removed_items
Saqib0ad74492019-12-24 16:42:30 +05303163
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003164 for d in data:
3165 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05303166
3167 if not d.get("item_code"):
3168 # ignore empty rows
3169 continue
3170
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003171 if not d.get("docname"):
3172 new_child_flag = True
Ankush Menatdd11f262022-06-27 15:55:08 +05303173 items_added_or_removed = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05303174 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303175 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003176 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303177 check_doc_permissions(parent, "write")
3178 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303179
Saqib Ansaric579b082020-05-29 22:21:50 +05303180 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
3181 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
s-aga-r9588bb72023-08-21 22:23:57 +05303182 prev_fg_qty, new_fg_qty = flt(child_item.get("fg_item_qty")), flt(d.get("fg_item_qty"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05303183 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
3184 d.get("conversion_factor")
3185 )
Saqib61314242020-09-15 11:14:31 +05303186 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05303187
Ankush Menat494bd9e2022-03-28 18:52:46 +05303188 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05303189 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303190 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05303191 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303192
3193 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05303194 qty_unchanged = prev_qty == new_qty
s-aga-r9588bb72023-08-21 22:23:57 +05303195 fg_qty_unchanged = prev_fg_qty == new_fg_qty
Saqib61314242020-09-15 11:14:31 +05303196 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05303197 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menatdd11f262022-06-27 15:55:08 +05303198 any_conversion_factor_changed |= not conversion_factor_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303199 date_unchanged = (
3200 prev_date == getdate(new_date) if prev_date and new_date else False
3201 ) # in case of delivery note etc
3202 if (
3203 rate_unchanged
3204 and qty_unchanged
s-aga-r9588bb72023-08-21 22:23:57 +05303205 and fg_qty_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303206 and conversion_factor_unchanged
3207 and uom_unchanged
3208 and date_unchanged
3209 ):
Saqibdd374ff2020-02-27 12:51:31 +05303210 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003211
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303212 validate_quantity(child_item, d)
Ankush Menatdd11f262022-06-27 15:55:08 +05303213 if flt(child_item.get("qty")) != flt(d.get("qty")):
3214 any_qty_changed = True
deepeshgarg00777cde832018-12-27 15:56:51 +05303215
s-aga-r9588bb72023-08-21 22:23:57 +05303216 if (
3217 parent.doctype == "Purchase Order"
3218 and parent.is_subcontracted
3219 and not parent.is_old_subcontracting_flow
3220 ):
3221 validate_fg_item_for_subcontracting(d, new_child_flag)
3222 child_item.fg_item_qty = flt(d["fg_item_qty"])
3223
3224 if new_child_flag:
3225 child_item.fg_item = d["fg_item"]
3226
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003227 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05303228 rate_precision = child_item.precision("rate") or 2
3229 conv_fac_precision = child_item.precision("conversion_factor") or 2
3230 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003231
Maricab9f5a1c2023-11-27 09:05:22 +05303232 # Amount cannot be lesser than billed amount, except for negative amounts
3233 row_rate = flt(d.get("rate"), rate_precision)
3234 amount_below_billed_amt = flt(child_item.billed_amt, rate_precision) > flt(
3235 row_rate * flt(d.get("qty"), qty_precision), rate_precision
3236 )
3237 if amount_below_billed_amt and row_rate > 0.0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303238 frappe.throw(
3239 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
3240 child_item.idx, child_item.item_code
3241 )
3242 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003243 else:
Maricab9f5a1c2023-11-27 09:05:22 +05303244 child_item.rate = row_rate
marinationf9c4b202020-06-12 15:49:53 +05303245
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303246 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05303247 if child_item.stock_uom == child_item.uom:
3248 child_item.conversion_factor = 1
3249 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303250 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05303251
Saqib61314242020-09-15 11:14:31 +05303252 if d.get("uom"):
3253 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303254 conversion_factor = flt(
3255 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
3256 )
3257 child_item.conversion_factor = (
3258 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
3259 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303260
Ankush Menat494bd9e2022-03-28 18:52:46 +05303261 if d.get("delivery_date") and parent_doctype == "Sales Order":
3262 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05303263
Ankush Menat494bd9e2022-03-28 18:52:46 +05303264 if d.get("schedule_date") and parent_doctype == "Purchase Order":
3265 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303266
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303267 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05303268 if flt(child_item.rate) > flt(child_item.price_list_rate):
3269 # if rate is greater than price_list_rate, set margin
3270 # or set discount
3271 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05303272
3273 if parent_doctype in sales_doctypes:
3274 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303275 child_item.margin_rate_or_amount = flt(
3276 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
3277 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05303278 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05303279 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303280 child_item.discount_percentage = flt(
3281 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
3282 child_item.precision("discount_percentage"),
3283 )
3284 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05303285
3286 if parent_doctype in sales_doctypes:
3287 child_item.margin_type = ""
3288 child_item.margin_rate_or_amount = 0
3289 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303290
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003291 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003292 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05303293 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303294 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003295 child_item.insert()
3296 else:
3297 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003298
Rushabh Mehtafafbb022018-12-24 22:09:15 +05303299 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303300 parent.flags.ignore_validate_update_after_submit = True
3301 parent.set_qty_as_per_stock_uom()
3302 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05303303 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05303304 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05303305 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05303306 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303307 frappe.get_doc("Authorization Control").validate_approving_authority(
3308 parent.doctype, parent.company, parent.base_grand_total
3309 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003310
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303311 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303312 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303313 parent.validate_minimum_order_qty()
3314 parent.validate_budget()
3315 if parent.is_against_so():
3316 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05303317 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303318 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05303319
3320 # reset index of child table
3321 for idx, row in enumerate(parent.get(child_docname), start=1):
3322 row.idx = idx
3323
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303324 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05303325
Ankush Menat494bd9e2022-03-28 18:52:46 +05303326 if parent_doctype == "Purchase Order":
3327 update_last_purchase_rate(parent, is_submit=1)
s-aga-r68f5dd32023-12-01 14:45:01 +05303328
3329 if any_qty_changed or items_added_or_removed or any_conversion_factor_changed:
3330 parent.update_prevdoc_status()
3331
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303332 parent.update_requested_qty()
3333 parent.update_ordered_qty()
3334 parent.update_ordered_and_reserved_qty()
3335 parent.update_receiving_percentage()
s-aga-rb9b17172023-08-22 16:53:54 +05303336
3337 if parent.is_subcontracted:
3338 if parent.is_old_subcontracting_flow:
3339 if should_update_supplied_items(parent):
3340 parent.update_reserved_qty_for_subcontract()
3341 parent.create_raw_materials_supplied()
3342 parent.save()
3343 else:
3344 if not parent.can_update_items():
3345 frappe.throw(
3346 _(
3347 "Items cannot be updated as Subcontracting Order is created against the Purchase Order {0}."
3348 ).format(frappe.bold(parent.name))
3349 )
Ankush Menatc84e11a2022-06-01 12:55:10 +05303350 else: # Sales Order
3351 parent.validate_warehouse()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303352 parent.update_reserved_qty()
3353 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303354 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303355 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05303356
Saqib6db92fb2020-09-14 19:54:17 +05303357 parent.reload()
3358 validate_workflow_conditions(parent)
3359
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303360 parent.update_blanket_order()
3361 parent.update_billing_percentage()
3362 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05303363
s-aga-rac24d772023-04-05 19:48:15 +05303364 # Cancel and Recreate Stock Reservation Entries.
s-aga-r38e93672023-04-02 21:24:59 +05303365 if parent_doctype == "Sales Order":
3366 from erpnext.stock.doctype.stock_reservation_entry.stock_reservation_entry import (
3367 cancel_stock_reservation_entries,
3368 has_reserved_stock,
s-aga-r38e93672023-04-02 21:24:59 +05303369 )
3370
3371 if has_reserved_stock(parent.doctype, parent.name):
3372 cancel_stock_reservation_entries(parent.doctype, parent.name)
s-aga-r2d8363a2023-09-02 11:02:24 +05303373
3374 if parent.per_picked == 0:
3375 parent.create_stock_reservation_entries()
s-aga-r38e93672023-04-02 21:24:59 +05303376
Ankush Menat494bd9e2022-03-28 18:52:46 +05303377
Gursheen Anand68effd92023-09-21 17:28:07 +05303378def check_if_child_table_updated(
3379 child_table_before_update, child_table_after_update, fields_to_check
3380):
3381 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
3382 # Check if any field affecting accounting entry is altered
3383 for index, item in enumerate(child_table_after_update):
3384 for field in fields_to_check:
3385 if child_table_before_update[index].get(field) != item.get(field):
3386 return True
3387
3388 for dimension in accounting_dimensions:
3389 if child_table_before_update[index].get(dimension) != item.get(dimension):
3390 return True
3391
3392 return False
3393
3394
Gursheen Ananda06017c2023-06-12 15:24:53 +05303395@erpnext.allow_regional
3396def validate_regional(doc):
3397 pass
3398
3399
3400@erpnext.allow_regional
3401def validate_einvoice_fields(doc):
3402 pass
3403
3404
3405@erpnext.allow_regional
3406def update_gl_dict_with_regional_fields(doc, gl_dict):
3407 pass