blob: 7dfcb30ff5677335cc68f7cfdb892c09f59d4030 [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
ruthra kumarff60ec82023-12-15 17:25:02 +053010from frappe.query_builder import Criterion
Gursheen Anand74619262023-06-02 17:13:51 +053011from frappe.query_builder.custom import ConstantColumn
Gursheen Anand4ee16372023-06-08 13:15:23 +053012from frappe.query_builder.functions import Abs, Sum
Chillar Anand915b3432021-09-02 16:44:59 +053013from frappe.utils import (
14 add_days,
15 add_months,
16 cint,
ruthra kumar0cdd6432023-10-11 14:42:23 +053017 comma_and,
Chillar Anand915b3432021-09-02 16:44:59 +053018 flt,
19 fmt_money,
20 formatdate,
21 get_last_day,
22 get_link_to_form,
23 getdate,
24 nowdate,
Rohit Waghchaure7d3240a2024-01-24 23:45:06 +053025 parse_json,
GangaManojd24cfff2021-10-28 20:06:48 +053026 today,
Chillar Anand915b3432021-09-02 16:44:59 +053027)
Chillar Anand915b3432021-09-02 16:44:59 +053028
29import erpnext
30from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import (
31 get_accounting_dimensions,
ruthra kumarcbd443a2024-01-19 16:44:20 +053032 get_dimensions,
Chillar Anand915b3432021-09-02 16:44:59 +053033)
34from erpnext.accounts.doctype.pricing_rule.utils import (
35 apply_pricing_rule_for_free_items,
36 apply_pricing_rule_on_transaction,
37 get_applied_pricing_rules,
38)
Deepesh Garg492ea3b2023-08-08 11:39:44 +053039from erpnext.accounts.general_ledger import get_round_off_account_and_cost_center
Chillar Anand915b3432021-09-02 16:44:59 +053040from erpnext.accounts.party import (
41 get_party_account,
42 get_party_account_currency,
Deepesh Garga7f15a02021-12-12 21:09:11 +053043 get_party_gle_currency,
Chillar Anand915b3432021-09-02 16:44:59 +053044 validate_party_frozen_disabled,
45)
ruthra kumar1ea1bfe2023-07-26 16:19:38 +053046from erpnext.accounts.utils import (
47 create_gain_loss_journal,
48 get_account_currency,
49 get_fiscal_years,
50 validate_fiscal_year,
51)
Chillar Anand915b3432021-09-02 16:44:59 +053052from erpnext.buying.utils import update_last_purchase_rate
53from erpnext.controllers.print_settings import (
54 set_print_templates_for_item_table,
55 set_print_templates_for_taxes,
56)
57from erpnext.controllers.sales_and_purchase_return import validate_return
58from erpnext.exceptions import InvalidCurrency
59from erpnext.setup.utils import get_exchange_rate
Ankush Menat10583eb2022-06-17 12:13:27 +053060from erpnext.stock.doctype.item.item import get_uom_conv_factor
Marica3dee5272020-06-23 10:33:47 +053061from erpnext.stock.doctype.packed_item.packed_item import make_packing_list
Chillar Anand915b3432021-09-02 16:44:59 +053062from erpnext.stock.get_item_details import (
63 _get_item_tax_template,
64 get_conversion_factor,
65 get_item_details,
66 get_item_tax_map,
67 get_item_warehouse,
68)
Sagar Vora4205f562023-07-24 18:37:36 +053069from erpnext.utilities.regional import temporary_flag
Chillar Anand915b3432021-09-02 16:44:59 +053070from erpnext.utilities.transaction_base import TransactionBase
71
Nabin Hait1d218422015-07-17 15:19:02 +053072
Ankush Menat494bd9e2022-03-28 18:52:46 +053073class AccountMissingError(frappe.ValidationError):
74 pass
marination53b1a9a2020-11-03 15:45:25 +053075
Ankush Menat494bd9e2022-03-28 18:52:46 +053076
Maricab9f5a1c2023-11-27 09:05:22 +053077class InvalidQtyError(frappe.ValidationError):
78 pass
79
80
Ankush Menat494bd9e2022-03-28 18:52:46 +053081force_item_fields = (
82 "item_group",
83 "brand",
84 "stock_uom",
85 "is_fixed_asset",
86 "item_tax_rate",
87 "pricing_rules",
88 "weight_per_unit",
89 "weight_uom",
90 "total_weight",
91)
92
Doridel Cahanap6f06cc22018-05-17 16:28:58 +080093
Nabin Haitbf495c92013-01-30 12:49:08 +053094class AccountsController(TransactionBase):
Nabin Hait7eba1a32017-10-02 15:59:27 +053095 def __init__(self, *args, **kwargs):
96 super(AccountsController, self).__init__(*args, **kwargs)
Anand Doshi979326b2015-09-11 16:22:37 +053097
prssanna71e5b602020-10-29 14:19:34 +053098 def get_print_settings(self):
99 print_setting_fields = []
Ankush Menat494bd9e2022-03-28 18:52:46 +0530100 items_field = self.meta.get_field("items")
prssanna71e5b602020-10-29 14:19:34 +0530101
Ankush Menat494bd9e2022-03-28 18:52:46 +0530102 if items_field and items_field.fieldtype == "Table":
103 print_setting_fields += ["compact_item_print", "print_uom_after_quantity"]
prssanna71e5b602020-10-29 14:19:34 +0530104
Ankush Menat494bd9e2022-03-28 18:52:46 +0530105 taxes_field = self.meta.get_field("taxes")
106 if taxes_field and taxes_field.fieldtype == "Table":
107 print_setting_fields += ["print_taxes_with_zero_amount"]
prssanna71e5b602020-10-29 14:19:34 +0530108
109 return print_setting_fields
110
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530111 @property
112 def company_currency(self):
113 if not hasattr(self, "__company_currency"):
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530114 self.__company_currency = erpnext.get_company_currency(self.company)
Anand Doshi979326b2015-09-11 16:22:37 +0530115
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530116 return self.__company_currency
Anand Doshi979326b2015-09-11 16:22:37 +0530117
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530118 def onload(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530119 self.set_onload(
120 "make_payment_via_journal_entry",
121 frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"),
122 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530123
tundee52bb822017-09-25 09:02:23 +0100124 if self.is_new():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530125 relevant_docs = (
126 "Quotation",
127 "Purchase Order",
128 "Sales Order",
129 "Purchase Invoice",
130 "Sales Invoice",
131 )
tundee52bb822017-09-25 09:02:23 +0100132 if self.doctype in relevant_docs:
133 self.set_payment_schedule()
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530134
rohitwaghchauref09e2132024-01-04 14:58:02 +0530135 def remove_bundle_for_non_stock_invoices(self):
136 has_sabb = False
137 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.update_stock:
138 for item in self.get("items"):
139 if item.serial_and_batch_bundle:
140 item.serial_and_batch_bundle = None
141 has_sabb = True
142
143 if has_sabb:
144 self.remove_serial_and_batch_bundle()
145
tundebabzyad08d4c2018-05-16 07:01:41 +0100146 def ensure_supplier_is_not_blocked(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530147 is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier"
148 is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"]
tundebabzyad08d4c2018-05-16 07:01:41 +0100149 supplier = None
150 supplier_name = None
151
152 if is_buying_invoice or is_supplier_payment:
153 supplier_name = self.supplier if is_buying_invoice else self.party
Ankush Menat494bd9e2022-03-28 18:52:46 +0530154 supplier = frappe.get_doc("Supplier", supplier_name)
tundebabzyad08d4c2018-05-16 07:01:41 +0100155
156 if supplier and supplier_name and supplier.on_hold:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530157 if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or (
158 is_supplier_payment and supplier.hold_type in ["All", "Payments"]
159 ):
tundebabzyad08d4c2018-05-16 07:01:41 +0100160 if not supplier.release_date or getdate(nowdate()) <= supplier.release_date:
161 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530162 _("{0} is blocked so this transaction cannot proceed").format(supplier_name),
163 raise_exception=1,
164 )
tundebabzyad08d4c2018-05-16 07:01:41 +0100165
Saurabh6f753182013-03-20 12:55:28 +0530166 def validate(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530167 if not self.get("is_return") and not self.get("is_debit_note"):
Deepesh Gargd301d262019-07-31 15:58:19 +0530168 self.validate_qty_is_not_zero()
169
nabinhait23cce732014-07-03 12:25:06 +0530170 if self.get("_action") and self._action != "update_after_submit":
Nabin Hait704a4532014-06-05 16:55:31 +0530171 self.set_missing_values(for_validate=True)
tunde62af5c52017-09-22 15:16:38 +0100172
rohitwaghchauref09e2132024-01-04 14:58:02 +0530173 if self.get("_action") == "submit":
174 self.remove_bundle_for_non_stock_invoices()
175
tundebabzyad08d4c2018-05-16 07:01:41 +0100176 self.ensure_supplier_is_not_blocked()
177
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530178 self.validate_date_with_fiscal_year()
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530179 self.validate_party_accounts()
180
Deepesh Gargb4be2922021-01-28 13:09:56 +0530181 self.validate_inter_company_reference()
182
Ankush Menat3714e362022-05-16 18:09:14 +0530183 self.disable_pricing_rule_on_internal_transfer()
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530184 self.disable_tax_included_prices_for_internal_transfer()
Deepesh Gargb4be2922021-01-28 13:09:56 +0530185 self.set_incoming_rate()
Deepesh Garg25889702023-12-12 15:18:54 +0530186 self.init_internal_values()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530187
Anand Doshi3543f302013-05-24 19:25:01 +0530188 if self.meta.get_field("currency"):
Anand Doshi923d41d2013-05-28 17:23:36 +0530189 self.calculate_taxes_and_totals()
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530190
Nabin Hait1d218422015-07-17 15:19:02 +0530191 if not self.meta.get_field("is_return") or not self.is_return:
192 self.validate_value("base_grand_total", ">=", 0)
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530193
Nabin Hait3cf67a42015-07-24 13:26:36 +0530194 validate_return(self)
Anand Doshid2946502014-04-08 20:10:03 +0530195
tunde62af5c52017-09-22 15:16:38 +0100196 self.validate_all_documents_schedule()
Anand Doshid2946502014-04-08 20:10:03 +0530197
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530198 if self.meta.get_field("taxes_and_charges"):
199 self.validate_enabled_taxes_and_charges()
Nabin Haita2426fc2018-01-15 17:45:46 +0530200 self.validate_tax_account_company()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530201
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +0530202 self.validate_party()
Nabin Hait895029d2015-08-20 14:55:39 +0530203 self.validate_currency()
Deepesh Garg80c85dd2021-08-12 15:39:07 +0530204 self.validate_party_account_currency()
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530205
Ankush Menat494bd9e2022-03-28 18:52:46 +0530206 if self.doctype in ["Purchase Invoice", "Sales Invoice"]:
ruthra kumar0cdd6432023-10-11 14:42:23 +0530207 if invalid_advances := [
208 x for x in self.advances if not x.reference_type or not x.reference_name
209 ]:
210 frappe.throw(
211 _(
212 "Rows: {0} in {1} section are Invalid. Reference Name should point to a valid Payment Entry or Journal Entry."
213 ).format(
214 frappe.bold(comma_and([x.idx for x in invalid_advances])), frappe.bold(_("Advance Payments"))
215 )
216 )
217
Ankush Menat494bd9e2022-03-28 18:52:46 +0530218 pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid"
Nabin Hait4a994d42019-04-25 17:47:26 +0530219 if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)):
Nabin Hait041a5c22018-08-01 18:07:39 +0530220 self.set_advances()
221
Saqiba20999c2021-07-12 14:33:23 +0530222 self.set_advance_gain_or_loss()
223
Nabin Hait041a5c22018-08-01 18:07:39 +0530224 if self.is_return:
225 self.validate_qty()
Nabin Haitacdd5082019-12-04 15:30:01 +0530226 else:
227 self.validate_deferred_start_and_end_date()
rohitwaghchaure70489252018-06-11 12:02:14 +0530228
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530229 self.validate_deferred_income_expense_account()
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530230 self.set_inter_company_account()
231
Ankush Menat494bd9e2022-03-28 18:52:46 +0530232 if self.doctype == "Purchase Invoice":
Deepesh Garg7f06c8c2021-11-26 10:27:57 +0530233 self.calculate_paid_amount()
234 # apply tax withholding only if checked and applicable
235 self.set_tax_withholding()
236
Dany Robert9bc59522023-08-26 18:14:40 +0530237 with temporary_flag("company", self.company):
238 validate_regional(self)
239 validate_einvoice_fields(self)
Saqib Ansaric5782b02022-01-27 20:09:56 +0530240
Deepesh Gargb741ae12022-12-02 17:14:06 +0530241 if self.doctype != "Material Request" and not self.ignore_pricing_rule:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530242 apply_pricing_rule_on_transaction(self)
Gauravf1e28e02019-02-13 16:46:24 +0530243
RitvikSardana03f0abf2023-09-19 13:08:17 +0530244 self.set_total_in_words()
Deepesh Garg3b4b2272023-12-29 08:25:38 +0530245 self.set_default_letter_head()
246
247 def set_default_letter_head(self):
248 if hasattr(self, "letter_head") and not self.letter_head:
249 self.letter_head = frappe.db.get_value("Company", self.company, "default_letter_head")
RitvikSardana03f0abf2023-09-19 13:08:17 +0530250
Deepesh Garg25889702023-12-12 15:18:54 +0530251 def init_internal_values(self):
252 # init all the internal values as 0 on sa
253 if self.docstatus.is_draft():
254 # TODO: Add all such pending values here
255 fields = ["billed_amt", "delivered_qty"]
256 for item in self.get("items"):
257 for field in fields:
258 if hasattr(item, field):
259 item.set(field, 0)
260
Saqib Ansaric5782b02022-01-27 20:09:56 +0530261 def before_cancel(self):
262 validate_einvoice_fields(self)
263
ruthra kumar42df0d32023-08-28 17:36:12 +0530264 def _remove_references_in_unreconcile(self):
ruthra kumar9a1588f2023-08-30 20:50:16 +0530265 upe = frappe.qb.DocType("Unreconcile Payment Entries")
ruthra kumar42df0d32023-08-28 17:36:12 +0530266 rows = (
267 frappe.qb.from_(upe)
268 .select(upe.name, upe.parent)
269 .where((upe.reference_doctype == self.doctype) & (upe.reference_name == self.name))
270 .run(as_dict=True)
271 )
272
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530273 if rows:
274 references_map = frappe._dict()
275 for x in rows:
276 references_map.setdefault(x.parent, []).append(x.name)
ruthra kumar42df0d32023-08-28 17:36:12 +0530277
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530278 for doc, rows in references_map.items():
ruthra kumar74f9e342023-11-21 16:51:06 +0530279 unreconcile_doc = frappe.get_doc("Unreconcile Payment", doc)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530280 for row in rows:
281 unreconcile_doc.remove(unreconcile_doc.get("allocations", {"name": row})[0])
ruthra kumar42df0d32023-08-28 17:36:12 +0530282
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530283 unreconcile_doc.flags.ignore_validate_update_after_submit = True
284 unreconcile_doc.flags.ignore_links = True
285 unreconcile_doc.save(ignore_permissions=True)
286
287 # delete docs upon parent doc deletion
ruthra kumar74f9e342023-11-21 16:51:06 +0530288 unreconcile_docs = frappe.db.get_all("Unreconcile Payment", filters={"voucher_no": self.name})
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530289 for x in unreconcile_docs:
ruthra kumar74f9e342023-11-21 16:51:06 +0530290 _doc = frappe.get_doc("Unreconcile Payment", x.name)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530291 if _doc.docstatus == 1:
292 _doc.cancel()
293 _doc.delete()
ruthra kumar42df0d32023-08-28 17:36:12 +0530294
ruthra kumared7f67b2023-09-26 14:23:21 +0530295 def _remove_references_in_repost_doctypes(self):
296 repost_doctypes = ["Repost Payment Ledger Items", "Repost Accounting Ledger Items"]
ruthra kumarc722f282023-02-19 12:09:10 +0530297
ruthra kumared7f67b2023-09-26 14:23:21 +0530298 for _doctype in repost_doctypes:
299 dt = frappe.qb.DocType(_doctype)
300 rows = (
301 frappe.qb.from_(dt)
302 .select(dt.name, dt.parent, dt.parenttype)
303 .where((dt.voucher_type == self.doctype) & (dt.voucher_no == self.name))
304 .run(as_dict=True)
305 )
306
307 if rows:
308 references_map = frappe._dict()
309 for x in rows:
310 references_map.setdefault((x.parenttype, x.parent), []).append(x.name)
311
312 for doc, rows in references_map.items():
313 repost_doc = frappe.get_doc(doc[0], doc[1])
314
315 for row in rows:
316 if _doctype == "Repost Payment Ledger Items":
317 repost_doc.remove(repost_doc.get("repost_vouchers", {"name": row})[0])
318 else:
319 repost_doc.remove(repost_doc.get("vouchers", {"name": row})[0])
320
321 repost_doc.flags.ignore_validate_update_after_submit = True
322 repost_doc.flags.ignore_links = True
323 repost_doc.save(ignore_permissions=True)
324
325 def on_trash(self):
326 self._remove_references_in_repost_doctypes()
ruthra kumar42df0d32023-08-28 17:36:12 +0530327 self._remove_references_in_unreconcile()
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530328 self.remove_serial_and_batch_bundle()
ruthra kumarfbdfb812023-08-28 16:27:29 +0530329
Saqib8e556772021-01-28 12:26:45 +0530330 # delete sl and gl entries on deletion of transaction
Ankush Menat494bd9e2022-03-28 18:52:46 +0530331 if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"):
ruthra kumar70313df2022-09-08 18:53:30 +0530332 ple = frappe.qb.DocType("Payment Ledger Entry")
333 frappe.qb.from_(ple).delete().where(
334 (ple.voucher_type == self.doctype) & (ple.voucher_no == self.name)
335 ).run()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530336 frappe.db.sql(
337 "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)
338 )
339 frappe.db.sql(
340 "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s",
341 (self.doctype, self.name),
342 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530343
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530344 def remove_serial_and_batch_bundle(self):
345 bundles = frappe.get_all(
346 "Serial and Batch Bundle",
347 filters={"voucher_type": self.doctype, "voucher_no": self.name, "docstatus": ("!=", 1)},
348 )
349
350 for bundle in bundles:
351 frappe.delete_doc("Serial and Batch Bundle", bundle.name)
352
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530353 def validate_deferred_income_expense_account(self):
354 field_map = {
355 "Sales Invoice": "deferred_revenue_account",
356 "Purchase Invoice": "deferred_expense_account",
357 }
358
359 for item in self.get("items"):
360 if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"):
361 if not item.get(field_map.get(self.doctype)):
Daizy Modi4efc9472022-11-07 09:21:03 +0530362 default_deferred_account = frappe.get_cached_value(
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530363 "Company", self.company, "default_" + field_map.get(self.doctype)
364 )
365 if not default_deferred_account:
366 frappe.throw(
367 _(
368 "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master"
369 ).format(item.idx)
370 )
371 else:
372 item.set(field_map.get(self.doctype), default_deferred_account)
373
Deepesh Gargfa152212022-11-28 19:22:35 +0530374 def validate_auto_repeat_subscription_dates(self):
Deepesh Garg6a47fb62022-11-28 22:47:44 +0530375 if (
376 self.get("from_date")
377 and self.get("to_date")
378 and getdate(self.from_date) > getdate(self.to_date)
379 ):
Deepesh Gargfa152212022-11-28 19:22:35 +0530380 frappe.throw(_("To Date cannot be before From Date"), title=_("Invalid Auto Repeat Date"))
381
Nabin Haitacdd5082019-12-04 15:30:01 +0530382 def validate_deferred_start_and_end_date(self):
383 for d in self.items:
384 if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"):
385 if not (d.service_start_date and d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530386 frappe.throw(
387 _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)
388 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530389 elif getdate(d.service_start_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530390 frappe.throw(
391 _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)
392 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530393 elif getdate(self.posting_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530394 frappe.throw(
395 _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)
396 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530397
tunde62af5c52017-09-22 15:16:38 +0100398 def validate_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530399 self.validate_payment_schedule_dates()
400 self.set_due_date()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530401 self.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530402 if not self.get("ignore_default_payment_terms_template"):
Deepesh Garg5c758942023-04-16 17:11:24 +0530403 self.validate_payment_schedule_amount()
Deepesh Gargbd709f82021-08-23 19:05:52 +0530404 self.validate_due_date()
tunde62af5c52017-09-22 15:16:38 +0100405 self.validate_advance_entries()
406
407 def validate_non_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530408 self.set_payment_schedule()
Nabin Hait2f9f4f92017-12-20 12:24:59 +0530409 self.validate_payment_schedule_dates()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530410 self.validate_payment_schedule_amount()
tunde62af5c52017-09-22 15:16:38 +0100411
412 def validate_all_documents_schedule(self):
413 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.is_return:
414 self.validate_invoice_documents_schedule()
415 elif self.doctype in ("Quotation", "Purchase Order", "Sales Order"):
416 self.validate_non_invoice_documents_schedule()
417
prssanna71e5b602020-10-29 14:19:34 +0530418 def before_print(self, settings=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530419 if self.doctype in [
420 "Purchase Order",
421 "Sales Order",
422 "Sales Invoice",
423 "Purchase Invoice",
424 "Supplier Quotation",
425 "Purchase Receipt",
426 "Delivery Note",
427 "Quotation",
428 ]:
KanchanChauhan49a50fe2016-11-18 13:57:53 +0530429 if self.get("group_same_items"):
430 self.group_similar_items()
431
Zarrar5be6d192018-11-08 12:16:26 +0530432 df = self.meta.get_field("discount_amount")
433 if self.get("discount_amount") and hasattr(self, "taxes") and not len(self.taxes):
434 df.set("print_hide", 0)
435 self.discount_amount = -self.discount_amount
436 else:
437 df.set("print_hide", 1)
438
prssanna71e5b602020-10-29 14:19:34 +0530439 set_print_templates_for_item_table(self, settings)
440 set_print_templates_for_taxes(self, settings)
441
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530442 def calculate_paid_amount(self):
Saurabh43520f92016-03-21 18:32:48 +0530443 if hasattr(self, "is_pos") or hasattr(self, "is_paid"):
444 is_paid = self.get("is_pos") or self.get("is_paid")
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530445
446 if is_paid:
447 if not self.cash_bank_account:
448 # show message that the amount is not paid
Ankush Menat494bd9e2022-03-28 18:52:46 +0530449 frappe.throw(
450 _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")
451 )
Marica23d7b092019-09-25 17:17:36 +0530452
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530453 if cint(self.is_return) and self.grand_total > self.paid_amount:
454 self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount"))
455
456 elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0:
457 self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount"))
458
Ankush Menat494bd9e2022-03-28 18:52:46 +0530459 self.base_paid_amount = flt(
460 self.paid_amount * self.conversion_rate, self.precision("base_paid_amount")
461 )
Saurabh43520f92016-03-21 18:32:48 +0530462
Anand Doshiabc10032013-06-14 17:44:03 +0530463 def set_missing_values(self, for_validate=False):
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530464 if frappe.flags.in_test:
tunde62af5c52017-09-22 15:16:38 +0100465 for fieldname in ["posting_date", "transaction_date"]:
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530466 if self.meta.get_field(fieldname) and not self.get(fieldname):
467 self.set(fieldname, today())
468 break
Anand Doshid2946502014-04-08 20:10:03 +0530469
Nabin Hait3237c752015-02-17 11:11:11 +0530470 def calculate_taxes_and_totals(self):
Nabin Haitfe81da22015-02-18 12:23:18 +0530471 from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals
Ankush Menat494bd9e2022-03-28 18:52:46 +0530472
Nabin Haitfe81da22015-02-18 12:23:18 +0530473 calculate_taxes_and_totals(self)
Nabin Hait3237c752015-02-17 11:11:11 +0530474
Raffael Meyere10ab162021-11-30 13:24:18 +0100475 if self.doctype in (
Ankush Menat494bd9e2022-03-28 18:52:46 +0530476 "Sales Order",
477 "Delivery Note",
478 "Sales Invoice",
479 "POS Invoice",
Raffael Meyere10ab162021-11-30 13:24:18 +0100480 ):
Nabin Hait3237c752015-02-17 11:11:11 +0530481 self.calculate_commission()
482 self.calculate_contribution()
483
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530484 def validate_date_with_fiscal_year(self):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +0800485 if self.meta.get_field("fiscal_year"):
Rohan Bansal1e3a3b22021-05-26 15:18:10 +0530486 date_field = None
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530487 if self.meta.get_field("posting_date"):
488 date_field = "posting_date"
489 elif self.meta.get_field("transaction_date"):
490 date_field = "transaction_date"
Anand Doshid2946502014-04-08 20:10:03 +0530491
Rushabh Mehtaf2227d02014-03-31 23:37:40 +0530492 if date_field and self.get(date_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530493 validate_fiscal_year(
494 self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self
495 )
Anand Doshid2946502014-04-08 20:10:03 +0530496
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530497 def validate_party_accounts(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530498 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530499 return
500
Ankush Menat494bd9e2022-03-28 18:52:46 +0530501 if self.doctype == "Sales Invoice":
502 party_account_field = "debit_to"
503 item_field = "income_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530504 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530505 party_account_field = "credit_to"
506 item_field = "expense_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530507
Ankush Menat494bd9e2022-03-28 18:52:46 +0530508 for item in self.get("items"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530509 if item.get(item_field) == self.get(party_account_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530510 frappe.throw(
511 _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(
512 item.idx,
513 frappe.bold(frappe.unscrub(item_field)),
514 item.get(item_field),
515 frappe.bold(frappe.unscrub(party_account_field)),
516 self.get(party_account_field),
517 )
518 )
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530519
Deepesh Gargb4be2922021-01-28 13:09:56 +0530520 def validate_inter_company_reference(self):
Rohit Waghchaure38aaba52023-05-13 13:00:05 +0530521 if self.get("is_return"):
522 return
523
Rohit Waghchaureb4a102d2022-09-06 16:22:00 +0530524 if self.doctype not in ("Purchase Invoice", "Purchase Receipt"):
Deepesh Gargb4be2922021-01-28 13:09:56 +0530525 return
526
527 if self.is_internal_transfer():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530528 if not (
529 self.get("inter_company_reference")
530 or self.get("inter_company_invoice_reference")
531 or self.get("inter_company_order_reference")
Deepesh Garg906ad102023-01-15 17:32:57 +0530532 ) and not self.get("is_return"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530533 msg = _("Internal Sale or Delivery Reference missing.")
Deepesh Gargb4be2922021-01-28 13:09:56 +0530534 msg += _("Please create purchase from internal sale or delivery document itself")
535 frappe.throw(msg, title=_("Internal Sales Reference Missing"))
536
Rohit Waghchaure19911b42023-04-21 16:49:48 +0530537 label = "Delivery Note Item" if self.doctype == "Purchase Receipt" else "Sales Invoice Item"
538
539 field = frappe.scrub(label)
540
541 for row in self.get("items"):
542 if not row.get(field):
543 msg = f"At Row {row.idx}: The field {bold(label)} is mandatory for internal transfer"
544 frappe.throw(_(msg), title=_("Internal Transfer Reference Missing"))
545
Ankush Menat3714e362022-05-16 18:09:14 +0530546 def disable_pricing_rule_on_internal_transfer(self):
547 if not self.get("ignore_pricing_rule") and self.is_internal_transfer():
548 self.ignore_pricing_rule = 1
549 frappe.msgprint(
550 _("Disabled pricing rules since this {} is an internal transfer").format(self.doctype),
551 alert=1,
552 )
553
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530554 def disable_tax_included_prices_for_internal_transfer(self):
555 if self.is_internal_transfer():
556 tax_updated = False
557 for tax in self.get("taxes"):
558 if tax.get("included_in_print_rate"):
559 tax.included_in_print_rate = 0
560 tax_updated = True
561
562 if tax_updated:
563 frappe.msgprint(
564 _("Disabled tax included prices since this {} is an internal transfer").format(self.doctype),
565 alert=1,
566 )
567
Nabin Haite9daefe2014-08-27 16:46:33 +0530568 def validate_due_date(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530569 if self.get("is_pos"):
570 return
rohitwaghchaureea943c62018-07-06 12:28:58 +0530571
Nabin Haite9daefe2014-08-27 16:46:33 +0530572 from erpnext.accounts.party import validate_due_date
Ankush Menat494bd9e2022-03-28 18:52:46 +0530573
Nabin Haite9daefe2014-08-27 16:46:33 +0530574 if self.doctype == "Sales Invoice":
Nabin Hait04d244a2015-07-22 17:47:49 +0530575 if not self.due_date:
576 frappe.throw(_("Due Date is mandatory"))
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530577
Ankush Menat494bd9e2022-03-28 18:52:46 +0530578 validate_due_date(
579 self.posting_date,
580 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530581 self.payment_terms_template,
582 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530583 elif self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530584 validate_due_date(
585 self.bill_date or self.posting_date,
586 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530587 self.bill_date,
588 self.payment_terms_template,
589 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530590
Nabin Hait096d3632013-10-17 17:01:14 +0530591 def set_price_list_currency(self, buying_or_selling):
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530592 if self.meta.get_field("posting_date"):
Nabin Hait288a18e2016-12-08 15:36:23 +0530593 transaction_date = self.posting_date
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530594 else:
Nabin Hait288a18e2016-12-08 15:36:23 +0530595 transaction_date = self.transaction_date
Rushabh Mehta66958302017-01-16 16:57:53 +0530596
Rushabh Mehta4a404e92013-08-09 18:11:35 +0530597 if self.meta.get_field("currency"):
Nabin Hait7a75e102013-09-17 10:21:20 +0530598 # price list part
Shreya3f778522018-05-15 16:59:20 +0530599 if buying_or_selling.lower() == "selling":
600 fieldname = "selling_price_list"
601 args = "for_selling"
602 else:
603 fieldname = "buying_price_list"
604 args = "for_buying"
605
Anand Doshif78d1ae2014-03-28 13:55:00 +0530606 if self.meta.get_field(fieldname) and self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530607 self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency")
Anand Doshid2946502014-04-08 20:10:03 +0530608
Nabin Hait6e439a52015-08-28 19:24:22 +0530609 if self.price_list_currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530610 self.plc_conversion_rate = 1.0
Nabin Hait11f41952013-09-24 14:36:55 +0530611
Anand Doshif78d1ae2014-03-28 13:55:00 +0530612 elif not self.plc_conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530613 self.plc_conversion_rate = get_exchange_rate(
614 self.price_list_currency, self.company_currency, transaction_date, args
615 )
Anand Doshid2946502014-04-08 20:10:03 +0530616
Nabin Hait7a75e102013-09-17 10:21:20 +0530617 # currency
Anand Doshif78d1ae2014-03-28 13:55:00 +0530618 if not self.currency:
619 self.currency = self.price_list_currency
620 self.conversion_rate = self.plc_conversion_rate
Nabin Hait6e439a52015-08-28 19:24:22 +0530621 elif self.currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530622 self.conversion_rate = 1.0
623 elif not self.conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530624 self.conversion_rate = get_exchange_rate(
625 self.currency, self.company_currency, transaction_date, args
626 )
Nabin Hait7a75e102013-09-17 10:21:20 +0530627
ruthra kumar08315522023-10-03 09:53:41 +0530628 if (
629 self.currency
630 and buying_or_selling == "Buying"
631 and frappe.db.get_single_value("Buying Settings", "use_transaction_date_exchange_rate")
632 and self.doctype == "Purchase Invoice"
633 ):
634 self.use_transaction_date_exchange_rate = True
635 self.conversion_rate = get_exchange_rate(
636 self.currency, self.company_currency, transaction_date, args
637 )
638
Nabin Haitcccc45e2016-10-05 17:15:43 +0530639 def set_missing_item_details(self, for_validate=False):
Anand Doshi3543f302013-05-24 19:25:01 +0530640 """set missing item values"""
Nabin Haitf37d43d2017-07-18 12:14:42 +0530641 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530642
Nabin Haitdd38a262014-12-26 13:15:21 +0530643 if hasattr(self, "items"):
Nabin Hait444f9562014-06-20 15:59:49 +0530644 parent_dict = {}
Pratik Vyasf7daab72014-04-10 17:53:30 +0530645 for fieldname in self.meta.get_valid_columns():
646 parent_dict[fieldname] = self.get(fieldname)
647
mbauskara52472c2016-03-05 15:10:25 +0530648 if self.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
649 document_type = "{} Item".format(self.doctype)
mbauskarc97becb2016-01-18 16:28:21 +0530650 parent_dict.update({"document_type": document_type})
651
Nabin Hait34c551d2019-07-03 10:34:31 +0530652 # party_name field used for customer in quotation
Ankush Menat494bd9e2022-03-28 18:52:46 +0530653 if (
654 self.doctype == "Quotation"
655 and self.quotation_to == "Customer"
656 and parent_dict.get("party_name")
657 ):
Nabin Hait34c551d2019-07-03 10:34:31 +0530658 parent_dict.update({"customer": parent_dict.get("party_name")})
659
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530660 self.pricing_rules = []
Deepesh Garg4c61ee32023-04-02 09:35:27 +0530661
Nabin Haitdd38a262014-12-26 13:15:21 +0530662 for item in self.get("items"):
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530663 if item.get("item_code"):
Nabin Hait444f9562014-06-20 15:59:49 +0530664 args = parent_dict.copy()
665 args.update(item.as_dict())
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530666
Nabin Hait34d28222016-01-19 15:45:49 +0530667 args["doctype"] = self.doctype
668 args["name"] = self.name
Smit Vorab206b052023-11-23 15:10:47 +0530669 args["child_doctype"] = item.doctype
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530670 args["child_docname"] = item.name
Ankush Menat494bd9e2022-03-28 18:52:46 +0530671 args["ignore_pricing_rule"] = (
672 self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0
673 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530674
Nabin Haite2f054c2015-03-09 14:54:37 +0530675 if not args.get("transaction_date"):
676 args["transaction_date"] = args.get("posting_date")
Anand Doshi2b2b6392015-03-20 14:18:09 +0530677
678 if self.get("is_subcontracted"):
679 args["is_subcontracted"] = self.is_subcontracted
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530680
Deepesh Garga7051cb2023-04-14 09:59:42 +0530681 ret = get_item_details(args, self, for_validate=True, overwrite_warehouse=False)
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530682
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530683 for fieldname, value in ret.items():
Anand Doshi602e8252015-11-16 19:05:46 +0530684 if item.meta.get_field(fieldname) and value is not None:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530685 if item.get(fieldname) is None or fieldname in force_item_fields:
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530686 item.set(fieldname, value)
Anand Doshid2946502014-04-08 20:10:03 +0530687
Ankush Menat494bd9e2022-03-28 18:52:46 +0530688 elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname):
Anand Doshi602e8252015-11-16 19:05:46 +0530689 item.set(fieldname, value)
690
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530691 elif fieldname == "serial_no":
Alchez9155e402018-07-09 16:57:42 +0530692 # Ensure that serial numbers are matched against Stock UOM
693 item_conversion_factor = item.get("conversion_factor") or 1.0
694 item_qty = abs(item.get("qty")) * item_conversion_factor
Alchez8f2a0f32018-07-06 14:36:52 +0530695
Ankush Menat494bd9e2022-03-28 18:52:46 +0530696 if item_qty != len(get_serial_nos(item.get("serial_no"))):
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530697 item.set(fieldname, value)
Nabin Haita74468b2014-12-30 18:33:52 +0530698
Saqib Ansariab36b272022-02-09 10:10:17 +0530699 elif (
700 ret.get("pricing_rule_removed")
701 and value is not None
702 and fieldname
703 in [
704 "discount_percentage",
705 "discount_amount",
706 "rate",
707 "margin_rate_or_amount",
708 "margin_type",
709 "remove_free_item",
710 ]
711 ):
Saqib Ansarib8c41e32022-01-20 13:06:08 +0530712 # reset pricing rule fields if pricing_rule_removed
713 item.set(fieldname, value)
714
Ankush Menat494bd9e2022-03-28 18:52:46 +0530715 if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field(
716 "is_fixed_asset"
717 ):
718 item.set("is_fixed_asset", ret.get("is_fixed_asset", 0))
Rohit Waghchauref6f503a2018-12-19 15:06:44 +0530719
Deepesh Garga60c3082021-05-11 16:38:33 +0530720 # Double check for cost center
721 # Items add via promotional scheme may not have cost center set
Ankush Menat494bd9e2022-03-28 18:52:46 +0530722 if hasattr(item, "cost_center") and not item.get("cost_center"):
723 item.set(
724 "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company)
725 )
Deepesh Garga60c3082021-05-11 16:38:33 +0530726
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530727 if ret.get("pricing_rules"):
728 self.apply_pricing_rule_on_items(item, ret)
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530729 self.set_pricing_rule_details(item, ret)
Ankush Menat10583eb2022-06-17 12:13:27 +0530730 else:
731 # Transactions line item without item code
732
733 uom = item.get("uom")
734 stock_uom = item.get("stock_uom")
735 if bool(uom) != bool(stock_uom): # xor
736 item.stock_uom = item.uom = uom or stock_uom
737
Deepesh Garg61751832022-12-29 10:41:36 +0530738 # UOM cannot be zero so substitute as 1
739 item.conversion_factor = (
740 get_uom_conv_factor(item.get("uom"), item.get("stock_uom"))
741 or item.get("conversion_factor")
742 or 1
743 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530744
Nabin Hait14aa9c52016-04-18 15:54:01 +0530745 if self.doctype == "Purchase Invoice":
Nabin Haitcccc45e2016-10-05 17:15:43 +0530746 self.set_expense_account(for_validate)
Nabin Haita3dd72a2014-05-28 12:49:20 +0530747
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530748 def apply_pricing_rule_on_items(self, item, pricing_rule_args):
749 if not pricing_rule_args.get("validate_applied_rule", 0):
750 # if user changed the discount percentage then set user's discount percentage ?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530751 if pricing_rule_args.get("price_or_product_discount") == "Price":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530752 item.set("pricing_rules", pricing_rule_args.get("pricing_rules"))
Rohit Waghchauref5bd3fa2022-09-16 15:23:10 +0530753 if pricing_rule_args.get("apply_rule_on_other_items"):
754 other_items = json.loads(pricing_rule_args.get("apply_rule_on_other_items"))
755 if other_items and item.item_code not in other_items:
756 return
757
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530758 item.set("discount_percentage", pricing_rule_args.get("discount_percentage"))
759 item.set("discount_amount", pricing_rule_args.get("discount_amount"))
760 if pricing_rule_args.get("pricing_rule_for") == "Rate":
761 item.set("price_list_rate", pricing_rule_args.get("price_list_rate"))
762
763 if item.get("price_list_rate"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530764 item.rate = flt(
765 item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)),
766 item.precision("rate"),
767 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530768
Ankush Menat494bd9e2022-03-28 18:52:46 +0530769 if item.get("discount_amount"):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530770 item.rate = item.price_list_rate - item.discount_amount
771
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530772 if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"):
773 item.rate = pricing_rule_args.get("rate")
774
Ankush Menat494bd9e2022-03-28 18:52:46 +0530775 elif pricing_rule_args.get("free_item_data"):
776 apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data"))
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530777
778 elif pricing_rule_args.get("validate_applied_rule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530779 for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530780 pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530781 for field in ["discount_percentage", "discount_amount", "rate"]:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530782 if item.get(field) < pricing_rule_doc.get(field):
783 title = get_link_to_form("Pricing Rule", pricing_rule)
784
Ankush Menat494bd9e2022-03-28 18:52:46 +0530785 frappe.msgprint(
786 _("Row {0}: user has not applied the rule {1} on the item {2}").format(
787 item.idx, frappe.bold(title), frappe.bold(item.item_code)
788 )
789 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530790
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530791 def set_pricing_rule_details(self, item_row, args):
792 pricing_rules = get_applied_pricing_rules(args.get("pricing_rules"))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530793 if not pricing_rules:
794 return
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530795
796 for pricing_rule in pricing_rules:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530797 self.append(
798 "pricing_rules",
799 {
800 "pricing_rule": pricing_rule,
801 "item_code": item_row.item_code,
802 "child_docname": item_row.name,
803 "rule_applied": True,
804 },
805 )
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530806
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530807 def set_taxes(self):
808 if not self.meta.get_field("taxes"):
Anand Doshi3543f302013-05-24 19:25:01 +0530809 return
Anand Doshid2946502014-04-08 20:10:03 +0530810
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530811 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530812
rohitwaghchaure57914f12018-04-24 19:19:47 +0530813 if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"):
rohitwaghchaure505661b2017-12-11 14:52:28 +0530814 if self.company and not self.get("taxes_and_charges"):
Anand Doshi3543f302013-05-24 19:25:01 +0530815 # get the default tax master
Ankush Menat494bd9e2022-03-28 18:52:46 +0530816 self.taxes_and_charges = frappe.db.get_value(
817 tax_master_doctype, {"is_default": 1, "company": self.company}
818 )
Anand Doshid2946502014-04-08 20:10:03 +0530819
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530820 self.append_taxes_from_master(tax_master_doctype)
Anand Doshid2946502014-04-08 20:10:03 +0530821
rohitwaghchaure57914f12018-04-24 19:19:47 +0530822 def is_pos_profile_changed(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530823 if (
824 self.doctype == "Sales Invoice"
825 and self.is_pos
826 and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile")
827 ):
rohitwaghchaure57914f12018-04-24 19:19:47 +0530828 return True
829
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530830 def append_taxes_from_master(self, tax_master_doctype=None):
831 if self.get("taxes_and_charges"):
Anand Doshi99100a42013-07-04 17:13:53 +0530832 if not tax_master_doctype:
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530833 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530834
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530835 self.extend("taxes", get_taxes_and_charges(tax_master_doctype, self.get("taxes_and_charges")))
Akhilesh Darjee4cdb7992014-01-30 13:56:57 +0530836
Rohit Waghchaure7d3240a2024-01-24 23:45:06 +0530837 def append_taxes_from_item_tax_template(self):
838 if not frappe.db.get_single_value("Accounts Settings", "add_taxes_from_item_tax_template"):
839 return
840
841 for row in self.items:
842 item_tax_rate = row.get("item_tax_rate")
843 if not item_tax_rate:
844 continue
845
846 if isinstance(item_tax_rate, str):
847 item_tax_rate = parse_json(item_tax_rate)
848
849 for account_head, rate in item_tax_rate.items():
850 row = self.get_tax_row(account_head)
851
852 if not row:
853 self.append(
854 "taxes",
855 {
856 "charge_type": "On Net Total",
857 "account_head": account_head,
858 "rate": 0,
859 "description": account_head,
860 },
861 )
862
863 def get_tax_row(self, account_head):
864 for row in self.taxes:
865 if row.account_head == account_head:
866 return row
867
Anand Doshiac32bad2014-04-18 01:30:14 +0530868 def set_other_charges(self):
Nabin Haite7d15362014-12-25 16:01:55 +0530869 self.set("taxes", [])
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530870 self.set_taxes()
Anand Doshid2946502014-04-08 20:10:03 +0530871
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530872 def validate_enabled_taxes_and_charges(self):
873 taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges")
Shariq Ansari21c11412023-08-17 12:14:13 +0530874 if self.taxes_and_charges and frappe.get_cached_value(
875 taxes_and_charges_doctype, self.taxes_and_charges, "disabled"
876 ):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530877 frappe.throw(
878 _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)
879 )
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530880
Nabin Haita2426fc2018-01-15 17:45:46 +0530881 def validate_tax_account_company(self):
882 for d in self.get("taxes"):
883 if d.account_head:
Daizy Modi4efc9472022-11-07 09:21:03 +0530884 tax_account_company = frappe.get_cached_value("Account", d.account_head, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +0530885 if tax_account_company != self.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530886 frappe.throw(
887 _("Row #{0}: Account {1} does not belong to company {2}").format(
888 d.idx, d.account_head, self.company
889 )
890 )
Nabin Haita2426fc2018-01-15 17:45:46 +0530891
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530892 def get_gl_dict(self, args, account_currency=None, item=None):
Nabin Hait2df4d542013-01-29 11:34:39 +0530893 """this method populates the common properties of a gl entry record"""
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530894
Ankush Menat494bd9e2022-03-28 18:52:46 +0530895 posting_date = args.get("posting_date") or self.get("posting_date")
Rohit Waghchaureaa7b4342018-05-11 01:56:05 +0530896 fiscal_years = get_fiscal_years(posting_date, company=self.company)
Nabin Hait2ed0b592016-03-29 13:14:17 +0530897 if len(fiscal_years) > 1:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530898 frappe.throw(
899 _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format(
900 formatdate(posting_date)
901 )
902 )
Nabin Hait2ed0b592016-03-29 13:14:17 +0530903 else:
904 fiscal_year = fiscal_years[0][0]
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530905
Ankush Menat494bd9e2022-03-28 18:52:46 +0530906 gl_dict = frappe._dict(
907 {
908 "company": self.company,
909 "posting_date": posting_date,
910 "fiscal_year": fiscal_year,
911 "voucher_type": self.doctype,
912 "voucher_no": self.name,
913 "remarks": self.get("remarks") or self.get("remark"),
914 "debit": 0,
915 "credit": 0,
916 "debit_in_account_currency": 0,
917 "credit_in_account_currency": 0,
918 "is_opening": self.get("is_opening") or "No",
919 "party_type": None,
920 "party": None,
921 "project": self.get("project"),
922 "post_net_value": args.get("post_net_value"),
Deepesh Gargda6bc1a2023-06-23 20:57:51 +0530923 "voucher_detail_no": args.get("voucher_detail_no"),
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530924 "voucher_subtype": self.get_voucher_subtype(),
Ankush Menat494bd9e2022-03-28 18:52:46 +0530925 }
926 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530927
Sagar Vora4205f562023-07-24 18:37:36 +0530928 with temporary_flag("company", self.company):
929 update_gl_dict_with_regional_fields(self, gl_dict)
930
deepeshgarg007d83cf652019-05-12 18:34:23 +0530931 accounting_dimensions = get_accounting_dimensions()
932 dimension_dict = frappe._dict()
933
934 for dimension in accounting_dimensions:
935 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530936 if item and item.get(dimension):
937 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530938
939 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530940 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530941
Nabin Hait895029d2015-08-20 14:55:39 +0530942 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530943 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530944
Ankush Menat494bd9e2022-03-28 18:52:46 +0530945 if gl_dict.account and self.doctype not in [
946 "Journal Entry",
947 "Period Closing Voucher",
948 "Payment Entry",
949 "Purchase Receipt",
950 "Purchase Invoice",
951 "Stock Entry",
952 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530953 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530954
Ankush Menat494bd9e2022-03-28 18:52:46 +0530955 if gl_dict.account and self.doctype not in [
956 "Journal Entry",
957 "Period Closing Voucher",
958 "Payment Entry",
959 ]:
960 set_balance_in_account_currency(
961 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
962 )
Anand Doshi979326b2015-09-11 16:22:37 +0530963
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530964 # Update details in transaction currency
965 gl_dict.update(
966 {
Deepesh Garg41d92252024-01-14 10:51:30 +0530967 "transaction_currency": self.get("currency") or self.company_currency,
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530968 "transaction_exchange_rate": self.get("conversion_rate", 1),
969 "debit_in_transaction_currency": self.get_value_in_transaction_currency(
970 account_currency, args, "debit"
971 ),
972 "credit_in_transaction_currency": self.get_value_in_transaction_currency(
973 account_currency, args, "credit"
974 ),
975 }
976 )
977
Deepesh Gargbeee98d2024-01-03 10:03:27 +0530978 if not args.get("against_voucher_type") and self.get("against_voucher_type"):
979 gl_dict.update({"against_voucher_type": self.get("against_voucher_type")})
980
981 if not args.get("against_voucher") and self.get("against_voucher"):
982 gl_dict.update({"against_voucher": self.get("against_voucher")})
983
Nabin Haitc561a492015-08-19 19:22:34 +0530984 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530985
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530986 def get_voucher_subtype(self):
987 voucher_subtypes = {
988 "Journal Entry": "voucher_type",
989 "Payment Entry": "payment_type",
990 "Stock Entry": "stock_entry_type",
991 "Asset Capitalization": "entry_type",
992 }
993 if self.doctype in voucher_subtypes:
994 return self.get(voucher_subtypes[self.doctype])
995 elif self.doctype == "Purchase Receipt" and self.is_return:
996 return "Purchase Return"
997 elif self.doctype == "Delivery Note" and self.is_return:
998 return "Sales Return"
999 elif (self.doctype == "Sales Invoice" and self.is_return) or self.doctype == "Purchase Invoice":
1000 return "Credit Note"
1001 elif (self.doctype == "Purchase Invoice" and self.is_return) or self.doctype == "Sales Invoice":
1002 return "Debit Note"
1003 return self.doctype
1004
Deepesh Garg35be3ac2023-08-17 11:31:40 +05301005 def get_value_in_transaction_currency(self, account_currency, args, field):
Deepesh Garg41d92252024-01-14 10:51:30 +05301006 if account_currency == self.get("currency"):
Deepesh Garg35be3ac2023-08-17 11:31:40 +05301007 return args.get(field + "_in_account_currency")
1008 else:
Deepesh Garg41d92252024-01-14 10:51:30 +05301009 return flt(args.get(field, 0) / self.get("conversion_rate", 1))
Deepesh Garg35be3ac2023-08-17 11:31:40 +05301010
Anurag Mishrae657fe82018-11-26 15:19:17 +05301011 def validate_qty_is_not_zero(self):
Maricab9f5a1c2023-11-27 09:05:22 +05301012 for item in self.items:
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +01001013 if self.doctype == "Purchase Receipt" and item.rejected_qty:
1014 continue
1015
Maricab9f5a1c2023-11-27 09:05:22 +05301016 if not flt(item.qty):
1017 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +01001018 msg=_("Row #{0}: Quantity for Item {1} cannot be zero.").format(
1019 item.idx, frappe.bold(item.item_code)
1020 ),
Maricab9f5a1c2023-11-27 09:05:22 +05301021 title=_("Invalid Quantity"),
1022 exc=InvalidQtyError,
1023 )
Anurag Mishrae657fe82018-11-26 15:19:17 +05301024
Nabin Hait895029d2015-08-20 14:55:39 +05301025 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +05301026 valid_currency = [self.company_currency]
1027 if self.get("currency") and self.currency != self.company_currency:
1028 valid_currency.append(self.currency)
1029
Nabin Hait895029d2015-08-20 14:55:39 +05301030 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301031 frappe.throw(
1032 _("Account {0} is invalid. Account Currency must be {1}").format(
1033 account, (" " + _("or") + " ").join(valid_currency)
1034 )
1035 )
Anand Doshi979326b2015-09-11 16:22:37 +05301036
Anand Doshi613cb6a2013-02-06 17:33:46 +05301037 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +05301038 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
1039
Ankush Menat494bd9e2022-03-28 18:52:46 +05301040 frappe.db.sql(
1041 """delete from `tab%s` where parentfield=%s and parent = %s
1042 and allocated_amount = 0"""
1043 % (childtype, "%s", "%s"),
1044 (parentfield, self.name),
1045 )
Anand Doshid2946502014-04-08 20:10:03 +05301046
Walstan Baptistad6360752021-03-31 12:30:32 +05301047 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301048 def apply_shipping_rule(self):
1049 if self.shipping_rule:
1050 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
1051 shipping_rule.apply(self)
1052 self.calculate_taxes_and_totals()
1053
1054 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301055 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301056
1057 # shipping address fields can be `shipping_address_name` or `shipping_address`
1058 # try getting value from both
1059
Ankush Menat494bd9e2022-03-28 18:52:46 +05301060 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301061 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301062 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301063 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301064 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301065
1066 return {}
1067
Walstan Baptistad6360752021-03-31 12:30:32 +05301068 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +05301069 def set_advances(self):
1070 """Returns list of advances against Account, Party, Reference"""
1071
Deepesh Gargfd3fb642023-04-05 12:02:44 +05301072 res = self.get_advance_entries(
1073 include_unallocated=not cint(self.get("only_include_allocated_payments"))
1074 )
Nabin Hait041a5c22018-08-01 18:07:39 +05301075
1076 self.set("advances", [])
1077 advance_allocated = 0
1078 for d in res:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301079 if self.get("party_account_currency") == self.company_currency:
1080 amount = self.get("base_rounded_total") or self.base_grand_total
Nabin Hait041a5c22018-08-01 18:07:39 +05301081 else:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301082 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg181df2f2022-11-04 15:49:37 +05301083 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +05301084 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +05301085
Saqiba20999c2021-07-12 14:33:23 +05301086 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +05301087 "doctype": self.doctype + " Advance",
1088 "reference_type": d.reference_type,
1089 "reference_name": d.reference_name,
1090 "reference_row": d.reference_row,
1091 "remarks": d.remarks,
1092 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +05301093 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301094 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +05301095 }
Gursheen Anand74619262023-06-02 17:13:51 +05301096 if d.get("paid_from"):
1097 advance_row["account"] = d.paid_from
1098 if d.get("paid_to"):
1099 advance_row["account"] = d.paid_to
Saqiba20999c2021-07-12 14:33:23 +05301100
1101 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +05301102
Nabin Hait28a05282016-06-27 17:41:39 +05301103 def get_advance_entries(self, include_unallocated=True):
1104 if self.doctype == "Sales Invoice":
Nabin Hait28a05282016-06-27 17:41:39 +05301105 party_type = "Customer"
1106 party = self.customer
1107 amount_field = "credit_in_account_currency"
1108 order_field = "sales_order"
1109 order_doctype = "Sales Order"
1110 else:
Nabin Hait28a05282016-06-27 17:41:39 +05301111 party_type = "Supplier"
1112 party = self.supplier
1113 amount_field = "debit_in_account_currency"
1114 order_field = "purchase_order"
1115 order_doctype = "Purchase Order"
Deepesh Garg92f845c2023-06-21 12:21:19 +05301116
1117 party_account = get_party_account(
1118 party_type, party=party, company=self.company, include_advance=True
1119 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301120
Ankush Menat494bd9e2022-03-28 18:52:46 +05301121 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 +05301122
Ankush Menat494bd9e2022-03-28 18:52:46 +05301123 journal_entries = get_advance_journal_entries(
1124 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
1125 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301126
Smit Vora3e282bf2023-09-19 20:47:21 +05301127 payment_entries = get_advance_payment_entries_for_regional(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301128 party_type, party, party_account, order_doctype, order_list, include_unallocated
1129 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301130
Nabin Hait28a05282016-06-27 17:41:39 +05301131 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301132
Nabin Hait28a05282016-06-27 17:41:39 +05301133 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +05301134
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301135 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301136 is_inclusive = cint(
1137 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
1138 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301139
1140 if is_inclusive:
1141 is_inclusive = 0
1142 if self.get("taxes", filters={"included_in_print_rate": 1}):
1143 is_inclusive = 1
1144
1145 return is_inclusive
1146
Anand Baburajan491a50a2023-06-13 19:42:56 +05301147 def should_show_taxes_as_table_in_print(self):
1148 return cint(frappe.db.get_single_value("Accounts Settings", "show_taxes_as_table_in_print"))
1149
Nabin Hait28a05282016-06-27 17:41:39 +05301150 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +05301151 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301152 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 +05301153
Ankush Menat494bd9e2022-03-28 18:52:46 +05301154 if not order_list:
1155 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301156
Nabin Hait28a05282016-06-27 17:41:39 +05301157 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301158
Nabin Hait28a05282016-06-27 17:41:39 +05301159 if advance_entries:
1160 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
1161 for d in advance_entries:
1162 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301163 frappe.msgprint(
1164 _(
1165 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
1166 ).format(d.reference_name, d.against_order)
1167 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301168
Saqiba20999c2021-07-12 14:33:23 +05301169 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301170 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301171 return
1172
Ankush Menat494bd9e2022-03-28 18:52:46 +05301173 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301174 party_account = self.credit_to if is_purchase_invoice else self.debit_to
1175 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +05301176 return
1177
1178 for d in self.get("advances"):
1179 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +05301180 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +05301181
1182 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
1183 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
1184 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
1185
1186 d.exchange_gain_loss = difference
1187
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301188 def make_precision_loss_gl_entry(self, gl_entries):
1189 round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(
1190 self.company, "Purchase Invoice", self.name, self.use_company_roundoff_cost_center
1191 )
1192
1193 precision_loss = self.get("base_net_total") - flt(
1194 self.get("net_total") * self.conversion_rate, self.precision("net_total")
1195 )
1196
1197 credit_or_debit = "credit" if self.doctype == "Purchase Invoice" else "debit"
1198 against = self.supplier if self.doctype == "Purchase Invoice" else self.customer
1199
1200 if precision_loss:
1201 gl_entries.append(
1202 self.get_gl_dict(
1203 {
1204 "account": round_off_account,
1205 "against": against,
1206 credit_or_debit: precision_loss,
1207 "cost_center": round_off_cost_center
1208 if self.use_company_roundoff_cost_center
1209 else self.cost_center or round_off_cost_center,
1210 "remarks": _("Net total calculation precision loss"),
1211 }
1212 )
1213 )
1214
ruthra kumar79c6f012023-09-01 14:57:12 +05301215 def gain_loss_journal_already_booked(
1216 self,
1217 gain_loss_account,
1218 exc_gain_loss,
1219 ref2_dt,
1220 ref2_dn,
1221 ref2_detail_no,
1222 ) -> bool:
1223 """
1224 Check if gain/loss is booked
1225 """
1226 if res := frappe.db.get_all(
1227 "Journal Entry Account",
1228 filters={
1229 "docstatus": 1,
1230 "account": gain_loss_account,
1231 "reference_type": ref2_dt, # this will be Journal Entry
1232 "reference_name": ref2_dn,
1233 "reference_detail_no": ref2_detail_no,
1234 },
1235 pluck="parent",
1236 ):
1237 # deduplicate
1238 res = list({x for x in res})
1239 if exc_vouchers := frappe.db.get_all(
1240 "Journal Entry",
1241 filters={"name": ["in", res], "voucher_type": "Exchange Gain Or Loss"},
1242 fields=["voucher_type", "total_debit", "total_credit"],
1243 ):
1244 booked_voucher = exc_vouchers[0]
1245 if (
1246 booked_voucher.total_debit == exc_gain_loss
1247 and booked_voucher.total_credit == exc_gain_loss
1248 and booked_voucher.voucher_type == "Exchange Gain Or Loss"
1249 ):
1250 return True
1251 return False
1252
ruthra kumarc44eb432024-01-18 14:35:06 +05301253 def make_exchange_gain_loss_journal(
1254 self, args: dict = None, dimensions_dict: dict = None
1255 ) -> None:
ruthra kumar81cd7872023-04-27 09:46:54 +05301256 """
1257 Make Exchange Gain/Loss journal for Invoices and Payments
1258 """
ruthra kumarcd42b262023-07-10 15:28:10 +05301259 # Cancelling existing exchange gain/loss journals is handled during the `on_cancel` event.
1260 # see accounts/utils.py:cancel_exchange_gain_loss_journal()
ruthra kumar81cd7872023-04-27 09:46:54 +05301261 if self.docstatus == 1:
ruthra kumar7b516f82023-06-26 17:34:28 +05301262 if self.get("doctype") == "Journal Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301263 # 'args' is populated with exchange gain/loss account and the amount to be booked.
1264 # These are generated by Sales/Purchase Invoice during reconciliation and advance allocation.
ruthra kumarc0b3b062023-07-25 10:51:58 +05301265 # and below logic is only for such scenarios
ruthra kumar7b516f82023-06-26 17:34:28 +05301266 if args:
1267 for arg in args:
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301268 # Advance section uses `exchange_gain_loss` and reconciliation uses `difference_amount`
1269 if (
1270 arg.get("difference_amount", 0) != 0 or arg.get("exchange_gain_loss", 0) != 0
1271 ) and arg.get("difference_account"):
ruthra kumar7b516f82023-06-26 17:34:28 +05301272
ruthra kumaree3ce822023-06-26 21:43:20 +05301273 party_account = arg.get("account")
ruthra kumarc0b3b062023-07-25 10:51:58 +05301274 gain_loss_account = arg.get("difference_account")
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301275 difference_amount = arg.get("difference_amount") or arg.get("exchange_gain_loss")
1276 if difference_amount > 0:
ruthra kumar05672432023-07-12 06:14:17 +05301277 dr_or_cr = "debit" if arg.get("party_type") == "Customer" else "credit"
1278 else:
1279 dr_or_cr = "credit" if arg.get("party_type") == "Customer" else "debit"
ruthra kumar7b516f82023-06-26 17:34:28 +05301280
1281 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1282
ruthra kumar79c6f012023-09-01 14:57:12 +05301283 if not self.gain_loss_journal_already_booked(
ruthra kumarc0b3b062023-07-25 10:51:58 +05301284 gain_loss_account,
1285 difference_amount,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301286 self.doctype,
1287 self.name,
ruthra kumar79c6f012023-09-01 14:57:12 +05301288 arg.get("referenced_row"),
1289 ):
ruthra kumar7e600a62023-10-22 20:26:45 +05301290 posting_date = arg.get("difference_posting_date") or frappe.db.get_value(
1291 arg.voucher_type, arg.voucher_no, "posting_date"
1292 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301293 je = create_gain_loss_journal(
1294 self.company,
ruthra kumarf7865da2023-09-04 20:38:10 +05301295 posting_date,
ruthra kumar79c6f012023-09-01 14:57:12 +05301296 arg.get("party_type"),
1297 arg.get("party"),
1298 party_account,
1299 gain_loss_account,
1300 difference_amount,
1301 dr_or_cr,
1302 reverse_dr_or_cr,
1303 arg.get("against_voucher_type"),
1304 arg.get("against_voucher"),
1305 arg.get("idx"),
1306 self.doctype,
1307 self.name,
1308 arg.get("referenced_row"),
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301309 arg.get("cost_center"),
ruthra kumarc44eb432024-01-18 14:35:06 +05301310 dimensions_dict,
ruthra kumaracc73222023-07-27 07:52:01 +05301311 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301312 frappe.msgprint(
1313 _("Exchange Gain/Loss amount has been booked through {0}").format(
1314 get_link_to_form("Journal Entry", je)
1315 )
1316 )
ruthra kumar7b516f82023-06-26 17:34:28 +05301317
ruthra kumar81cd7872023-04-27 09:46:54 +05301318 if self.get("doctype") == "Payment Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301319 # For Payment Entry, exchange_gain_loss field in the `references` table is the trigger for journal creation
ruthra kumar81cd7872023-04-27 09:46:54 +05301320 gain_loss_to_book = [x for x in self.references if x.exchange_gain_loss != 0]
1321 booked = []
1322 if gain_loss_to_book:
1323 vtypes = [x.reference_doctype for x in gain_loss_to_book]
1324 vnames = [x.reference_name for x in gain_loss_to_book]
1325 je = qb.DocType("Journal Entry")
1326 jea = qb.DocType("Journal Entry Account")
1327 parents = (
1328 qb.from_(jea)
1329 .select(jea.parent)
1330 .where(
1331 (jea.reference_type == "Payment Entry")
1332 & (jea.reference_name == self.name)
1333 & (jea.docstatus == 1)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301334 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301335 .run()
Saqiba20999c2021-07-12 14:33:23 +05301336 )
1337
ruthra kumar81cd7872023-04-27 09:46:54 +05301338 booked = []
1339 if parents:
1340 booked = (
1341 qb.from_(je)
1342 .inner_join(jea)
1343 .on(je.name == jea.parent)
1344 .select(jea.reference_type, jea.reference_name, jea.reference_detail_no)
1345 .where(
1346 (je.docstatus == 1)
1347 & (je.name.isin(parents))
1348 & (je.voucher_type == "Exchange Gain or Loss")
1349 )
1350 .run()
1351 )
Saqiba20999c2021-07-12 14:33:23 +05301352
ruthra kumar81cd7872023-04-27 09:46:54 +05301353 for d in gain_loss_to_book:
ruthra kumarc0b3b062023-07-25 10:51:58 +05301354 # Filter out References for which Gain/Loss is already booked
ruthra kumar81cd7872023-04-27 09:46:54 +05301355 if d.exchange_gain_loss and (
1356 (d.reference_doctype, d.reference_name, str(d.idx)) not in booked
1357 ):
ruthra kumar81cd7872023-04-27 09:46:54 +05301358 if self.payment_type == "Receive":
1359 party_account = self.paid_from
1360 elif self.payment_type == "Pay":
1361 party_account = self.paid_to
1362
ruthra kumar81cd7872023-04-27 09:46:54 +05301363 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
ruthra kumar34b5e842023-06-16 14:07:44 +05301364
1365 if d.reference_doctype == "Purchase Invoice":
1366 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1367
ruthra kumar81cd7872023-04-27 09:46:54 +05301368 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1369
1370 gain_loss_account = frappe.get_cached_value(
1371 "Company", self.company, "exchange_gain_loss_account"
1372 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301373
ruthra kumaracc73222023-07-27 07:52:01 +05301374 je = create_gain_loss_journal(
ruthra kumar1ea1bfe2023-07-26 16:19:38 +05301375 self.company,
ruthra kumar7e600a62023-10-22 20:26:45 +05301376 args.get("difference_posting_date") if args else self.posting_date,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301377 self.party_type,
1378 self.party,
1379 party_account,
1380 gain_loss_account,
1381 d.exchange_gain_loss,
1382 dr_or_cr,
1383 reverse_dr_or_cr,
1384 d.reference_doctype,
1385 d.reference_name,
1386 d.idx,
1387 self.doctype,
1388 self.name,
1389 d.idx,
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301390 self.cost_center,
ruthra kumarc44eb432024-01-18 14:35:06 +05301391 dimensions_dict,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301392 )
ruthra kumaracc73222023-07-27 07:52:01 +05301393 frappe.msgprint(
1394 _("Exchange Gain/Loss amount has been booked through {0}").format(
1395 get_link_to_form("Journal Entry", je)
1396 )
1397 )
Saqiba20999c2021-07-12 14:33:23 +05301398
Deepesh Garg016ed952023-06-20 13:22:32 +05301399 def update_against_document_in_jv(self):
Nabin Hait28a05282016-06-27 17:41:39 +05301400 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301401 Links invoice and advance voucher:
1402 1. cancel advance voucher
1403 2. split into multiple rows if partially adjusted, assign against voucher
1404 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +05301405 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301406
Nabin Hait28a05282016-06-27 17:41:39 +05301407 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301408 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +05301409 party = self.customer
1410 party_account = self.debit_to
1411 dr_or_cr = "credit_in_account_currency"
1412 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301413 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +05301414 party = self.supplier
1415 party_account = self.credit_to
1416 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +05301417
Nabin Hait28a05282016-06-27 17:41:39 +05301418 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +05301419 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +05301420 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301421 args = frappe._dict(
1422 {
1423 "voucher_type": d.reference_type,
1424 "voucher_no": d.reference_name,
1425 "voucher_detail_no": d.reference_row,
1426 "against_voucher_type": self.doctype,
1427 "against_voucher": self.name,
1428 "account": party_account,
1429 "party_type": party_type,
1430 "party": party,
1431 "is_advance": "Yes",
1432 "dr_or_cr": dr_or_cr,
1433 "unadjusted_amount": flt(d.advance_amount),
1434 "allocated_amount": flt(d.allocated_amount),
1435 "precision": d.precision("advance_amount"),
1436 "exchange_rate": (
1437 self.conversion_rate if self.party_account_currency != self.company_currency else 1
1438 ),
1439 "grand_total": (
1440 self.base_grand_total
1441 if self.party_account_currency == self.company_currency
1442 else self.grand_total
1443 ),
1444 "outstanding_amount": self.outstanding_amount,
Daizy Modi4efc9472022-11-07 09:21:03 +05301445 "difference_account": frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301446 "Company", self.company, "exchange_gain_loss_account"
1447 ),
1448 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
1449 }
1450 )
Nabin Hait28a05282016-06-27 17:41:39 +05301451 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301452
Nabin Hait28a05282016-06-27 17:41:39 +05301453 if lst:
1454 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +05301455
ruthra kumarcbd443a2024-01-19 16:44:20 +05301456 # pass dimension values to utility method
1457 active_dimensions = get_dimensions()[0]
1458 for x in lst:
1459 for dim in active_dimensions:
1460 if self.get(dim.fieldname):
1461 x.update({dim.fieldname: self.get(dim.fieldname)})
1462 reconcile_against_document(lst, active_dimensions=active_dimensions)
Anand Doshid2946502014-04-08 20:10:03 +05301463
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301464 def on_cancel(self):
barredterra0a95b382023-12-27 23:05:37 +01001465 from erpnext.accounts.doctype.bank_transaction.bank_transaction import (
1466 remove_from_bank_transaction,
1467 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301468 from erpnext.accounts.utils import (
1469 cancel_exchange_gain_loss_journal,
1470 unlink_ref_doc_from_payment_entries,
1471 )
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301472
barredterra0a95b382023-12-27 23:05:37 +01001473 remove_from_bank_transaction(self.doctype, self.name)
1474
ruthra kumar6e18bb62023-07-11 12:21:10 +05301475 if self.doctype in ["Sales Invoice", "Purchase Invoice", "Payment Entry", "Journal Entry"]:
ruthra kumar81cd7872023-04-27 09:46:54 +05301476 # Cancel Exchange Gain/Loss Journal before unlinking
1477 cancel_exchange_gain_loss_journal(self)
1478
Ankush Menat494bd9e2022-03-28 18:52:46 +05301479 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301480 unlink_ref_doc_from_payment_entries(self)
1481
1482 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301483 if frappe.db.get_single_value(
1484 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1485 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301486 unlink_ref_doc_from_payment_entries(self)
1487
GangaManoj8396f242021-09-20 19:01:46 +05301488 if self.doctype == "Sales Order":
1489 self.unlink_ref_doc_from_po()
1490
1491 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301492 so_items = []
1493 for item in self.items:
1494 so_items.append(item.name)
1495
Ankush Menat494bd9e2022-03-28 18:52:46 +05301496 linked_po = list(
1497 set(
1498 frappe.get_all(
1499 "Purchase Order Item",
1500 filters={
1501 "sales_order": self.name,
1502 "sales_order_item": ["in", so_items],
1503 "docstatus": ["<", 2],
1504 },
1505 pluck="parent",
1506 )
1507 )
1508 )
GangaManoj8396f242021-09-20 19:01:46 +05301509
GangaManoj8396f242021-09-20 19:01:46 +05301510 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301511 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301512 "Purchase Order Item",
1513 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1514 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301515 )
GangaManoj8396f242021-09-20 19:01:46 +05301516
1517 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1518
Deepesh Gargd18dde72020-11-29 21:40:04 +05301519 def get_tax_map(self):
1520 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301521 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301522 tax_map.setdefault(tax.account_head, 0.0)
1523 tax_map[tax.account_head] += tax.tax_amount
1524
1525 return tax_map
1526
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301527 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1528 amount = item.net_amount
1529 base_amount = item.base_net_amount
1530
Ankush Menat494bd9e2022-03-28 18:52:46 +05301531 if (
1532 enable_discount_accounting
1533 and self.get("discount_amount")
1534 and self.get("additional_discount_account")
1535 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301536 amount = item.amount
1537 base_amount = item.base_amount
1538
1539 return amount, base_amount
1540
1541 def get_tax_amounts(self, tax, enable_discount_accounting):
1542 amount = tax.tax_amount_after_discount_amount
1543 base_amount = tax.base_tax_amount_after_discount_amount
1544
Ankush Menat494bd9e2022-03-28 18:52:46 +05301545 if (
1546 enable_discount_accounting
1547 and self.get("discount_amount")
1548 and self.get("additional_discount_account")
1549 and self.get("apply_discount_on") == "Grand Total"
1550 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301551 amount = tax.tax_amount
1552 base_amount = tax.base_tax_amount
1553
1554 return amount, base_amount
1555
GangaManoj8f7b0a12021-07-13 03:01:02 +05301556 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301557 if self.doctype == "Purchase Invoice":
1558 enable_discount_accounting = cint(
1559 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1560 )
1561 elif self.doctype == "Sales Invoice":
1562 enable_discount_accounting = cint(
1563 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1564 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301565
Deepesh Garg3b159662022-08-21 17:51:05 +05301566 if self.doctype == "Purchase Invoice":
1567 dr_or_cr = "credit"
1568 rev_dr_cr = "debit"
1569 supplier_or_customer = self.supplier
1570
1571 else:
1572 dr_or_cr = "debit"
1573 rev_dr_cr = "credit"
1574 supplier_or_customer = self.customer
1575
GangaManoj8f7b0a12021-07-13 03:01:02 +05301576 if enable_discount_accounting:
1577 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301578 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301579 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301580 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301581 income_or_expense_account = (
1582 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301583 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301584 else item.deferred_expense_account
1585 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301586 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301587 income_or_expense_account = (
1588 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301589 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301590 else item.deferred_revenue_account
1591 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301592
1593 account_currency = get_account_currency(item.discount_account)
1594 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301595 self.get_gl_dict(
1596 {
1597 "account": item.discount_account,
1598 "against": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301599 dr_or_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301600 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1601 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301602 dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301603 "cost_center": item.cost_center,
1604 "project": item.project,
1605 },
1606 account_currency,
1607 item=item,
1608 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301609 )
1610
1611 account_currency = get_account_currency(income_or_expense_account)
1612 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301613 self.get_gl_dict(
1614 {
1615 "account": income_or_expense_account,
1616 "against": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301617 rev_dr_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301618 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1619 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301620 rev_dr_cr
1621 + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301622 "cost_center": item.cost_center,
1623 "project": item.project or self.project,
1624 },
1625 account_currency,
1626 item=item,
1627 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301628 )
GangaManoj857501c2021-07-15 22:03:46 +05301629
Deepesh Garg3b159662022-08-21 17:51:05 +05301630 if (
Deepesh Gargae3dce02022-08-22 08:57:58 +05301631 (enable_discount_accounting or self.get("is_cash_or_non_trade_discount"))
Deepesh Garg3b159662022-08-21 17:51:05 +05301632 and self.get("additional_discount_account")
1633 and self.get("discount_amount")
1634 ):
1635 gl_entries.append(
1636 self.get_gl_dict(
1637 {
1638 "account": self.additional_discount_account,
1639 "against": supplier_or_customer,
Gursheen Anand112cfe62023-08-31 17:08:51 +05301640 dr_or_cr: self.base_discount_amount,
vr-greycube4ada5a42023-09-27 10:38:32 +05301641 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
Deepesh Garg3b159662022-08-21 17:51:05 +05301642 },
1643 item=self,
Ankush Menat4551d7d2021-08-19 13:41:10 +05301644 )
Deepesh Garg3b159662022-08-21 17:51:05 +05301645 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301646
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301647 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on):
Nabin Hait868766d2019-07-15 18:02:58 +05301648 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301649
Nabin Hait868766d2019-07-15 18:02:58 +05301650 item_allowance = {}
1651 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301652
Ankush Menat494bd9e2022-03-28 18:52:46 +05301653 role_allowed_to_over_bill = frappe.db.get_single_value(
1654 "Accounts Settings", "role_allowed_to_over_bill"
1655 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301656 user_roles = frappe.get_roles()
1657
Ankush Menat43bf82b2021-09-20 16:31:20 +05301658 total_overbilled_amt = 0.0
1659
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301660 reference_names = [d.get(item_ref_dn) for d in self.get("items") if d.get(item_ref_dn)]
1661 reference_details = self.get_billing_reference_details(
1662 reference_names, ref_dt + " Item", based_on
1663 )
1664
Nabin Hait4b8185d2014-12-25 18:19:39 +05301665 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301666 if not item.get(item_ref_dn):
1667 continue
Anand Doshid2946502014-04-08 20:10:03 +05301668
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301669 ref_amt = flt(reference_details.get(item.get(item_ref_dn)), self.precision(based_on, item))
1670
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301671 if not ref_amt:
1672 frappe.msgprint(
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301673 _("System will not check over billing since amount for Item {0} in {1} is zero").format(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301674 item.item_code, ref_dt
1675 ),
1676 title=_("Warning"),
1677 indicator="orange",
1678 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301679 continue
Anand Doshid2946502014-04-08 20:10:03 +05301680
Saqib9c913c92021-11-26 12:00:13 +05301681 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301682
Ankush Menat494bd9e2022-03-28 18:52:46 +05301683 total_billed_amt = flt(
1684 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1685 )
Anand Doshid2946502014-04-08 20:10:03 +05301686
Ankush Menat494bd9e2022-03-28 18:52:46 +05301687 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1688 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1689 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301690
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301691 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301692
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301693 if total_billed_amt < 0 and max_allowed_amt < 0:
1694 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1695 total_billed_amt = abs(total_billed_amt)
1696 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301697
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301698 overbill_amt = total_billed_amt - max_allowed_amt
1699 total_overbilled_amt += overbill_amt
1700
1701 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1702 if self.doctype != "Purchase Invoice":
1703 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301704 elif not cint(
1705 frappe.db.get_single_value(
1706 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1707 )
1708 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301709 self.throw_overbill_exception(item, max_allowed_amt)
1710
1711 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301712 frappe.msgprint(
1713 _("Overbilling of {} ignored because you have {} role.").format(
1714 total_overbilled_amt, role_allowed_to_over_bill
1715 ),
1716 indicator="orange",
1717 alert=True,
1718 )
Afshan53fefd72021-06-24 10:09:02 +05301719
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301720 def get_billing_reference_details(self, reference_names, reference_doctype, based_on):
1721 return frappe._dict(
1722 frappe.get_all(
1723 reference_doctype,
1724 filters={"name": ("in", reference_names)},
1725 fields=["name", based_on],
1726 as_list=1,
1727 )
1728 )
1729
Saqib9c913c92021-11-26 12:00:13 +05301730 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301731 """
1732 Returns Sum of Amount of
1733 Sales/Purchase Invoice Items
1734 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1735 that are submitted OR not submitted but are under current invoice
1736 """
Saqib9c913c92021-11-26 12:00:13 +05301737
1738 from frappe.query_builder import Criterion
1739 from frappe.query_builder.functions import Sum
1740
1741 item_doctype = frappe.qb.DocType(item.doctype)
1742 based_on_field = frappe.qb.Field(based_on)
1743 join_field = frappe.qb.Field(item_ref_dn)
1744
1745 result = (
1746 frappe.qb.from_(item_doctype)
1747 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301748 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301749 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301750 Criterion.any(
1751 [ # select all items from other invoices OR current invoices
1752 Criterion.all(
1753 [ # for selecting items from other invoices
1754 item_doctype.docstatus == 1,
1755 item_doctype.parent != self.name,
1756 ]
1757 ),
1758 Criterion.all(
1759 [ # for selecting items from current invoice, that are linked to same reference
1760 item_doctype.docstatus == 0,
1761 item_doctype.parent == self.name,
1762 item_doctype.name != item.name,
1763 ]
1764 ),
1765 ]
1766 )
Saqib9c913c92021-11-26 12:00:13 +05301767 )
1768 ).run()
1769
1770 return result[0][0] if result else 0
1771
Afshan53fefd72021-06-24 10:09:02 +05301772 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301773 frappe.throw(
1774 _(
1775 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1776 ).format(item.item_code, item.idx, max_allowed_amt)
1777 )
Anand Doshid2946502014-04-08 20:10:03 +05301778
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301779 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301780 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301781
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301782 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301783
Nabin Haita36adbd2013-08-02 14:50:12 +05301784 def get_stock_items(self):
1785 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301786 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301787 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301788 stock_items = frappe.db.get_values(
1789 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1790 )
Anand Doshid2946502014-04-08 20:10:03 +05301791
Nabin Haita36adbd2013-08-02 14:50:12 +05301792 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301793
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301794 def set_total_advance_paid(self):
ruthra kumar44870652022-11-01 10:11:38 +05301795 ple = frappe.qb.DocType("Payment Ledger Entry")
David Arnoldc88ce552024-01-22 22:04:30 +01001796 if self.doctype in frappe.get_hooks("advance_payment_customer_doctypes"):
1797 party = self.customer
1798 if self.doctype in frappe.get_hooks("advance_payment_supplier_doctypes"):
1799 party = self.supplier
ruthra kumar44870652022-11-01 10:11:38 +05301800 advance = (
1801 frappe.qb.from_(ple)
ruthra kumarbf76b852022-11-22 12:16:11 +05301802 .select(ple.account_currency, Abs(Sum(ple.amount_in_account_currency)).as_("amount"))
ruthra kumar44870652022-11-01 10:11:38 +05301803 .where(
1804 (ple.against_voucher_type == self.doctype)
1805 & (ple.against_voucher_no == self.name)
1806 & (ple.party == party)
ruthra kumarbf76b852022-11-22 12:16:11 +05301807 & (ple.docstatus == 1)
ruthra kumar44870652022-11-01 10:11:38 +05301808 & (ple.company == self.company)
1809 )
1810 .run(as_dict=True)
1811 )
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301812
David Arnoldb1aef012024-01-22 22:15:49 +01001813 advance_paid, order_total = None, None
1814
Nabin Haitb2206d12016-01-27 15:43:12 +05301815 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301816 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301817
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301818 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301819 formatted_advance_paid = fmt_money(
1820 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1821 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301822
Ankush Menat494bd9e2022-03-28 18:52:46 +05301823 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301824
1825 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301826 order_total = self.get("rounded_total") or self.grand_total
1827 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301828 else:
finbyz5efc7972019-01-05 11:12:11 +05301829 order_total = self.get("base_rounded_total") or self.base_grand_total
1830 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301831
Ankush Menat494bd9e2022-03-28 18:52:46 +05301832 formatted_order_total = fmt_money(
1833 order_total, precision=self.precision(precision), currency=advance.account_currency
1834 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301835
Nabin Hait9db1b222016-06-30 12:37:53 +05301836 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301837 frappe.throw(
1838 _(
1839 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1840 ).format(formatted_advance_paid, self.name, formatted_order_total)
1841 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301842
David Arnoldb1aef012024-01-22 22:15:49 +01001843 self.db_set("advance_paid", advance_paid)
1844
1845 self.set_advance_payment_status(advance_paid, order_total)
1846
1847 def set_advance_payment_status(
1848 self, advance_paid: float | None = None, order_total: float | None = None
1849 ):
1850 new_status = None
1851 # if money is paid set the paid states
1852 if advance_paid:
David Arnold7d8aa462024-01-22 22:46:03 +01001853 new_status = "Partially Paid" if advance_paid < order_total else "Fully Paid"
David Arnoldb1aef012024-01-22 22:15:49 +01001854
1855 if not new_status:
1856 prs = frappe.db.count(
1857 "Payment Request",
1858 {
1859 "reference_doctype": self.doctype,
1860 "reference_name": self.name,
1861 "docstatus": 1,
1862 },
David Arnoldc809e612023-10-10 20:40:50 +02001863 )
David Arnoldb1aef012024-01-22 22:15:49 +01001864 if self.doctype in frappe.get_hooks("advance_payment_customer_doctypes"):
1865 new_status = "Requested" if prs else "Not Requested"
1866 if self.doctype in frappe.get_hooks("advance_payment_supplier_doctypes"):
1867 new_status = "Initiated" if prs else "Not Initiated"
1868
1869 if new_status == self.advance_payment_status:
1870 return
1871
1872 self.db_set("advance_payment_status", new_status)
1873 self.set_status(update=True)
1874 self.notify_update()
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301875
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301876 @property
1877 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301878 if not hasattr(self, "_abbr"):
Daizy Modi4efc9472022-11-07 09:21:03 +05301879 self._abbr = frappe.get_cached_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301880
1881 return self._abbr
1882
marination4be5b5c2020-10-08 19:08:27 +05301883 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301884 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301885 db_or_cr = (
1886 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1887 )
marination4be5b5c2020-10-08 19:08:27 +05301888 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1889
1890 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1891 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1892
Ankush Menat494bd9e2022-03-28 18:52:46 +05301893 message = _("{0} Account not found against Customer {1}.").format(
1894 db_or_cr, frappe.bold(party) or ""
1895 )
marination4be5b5c2020-10-08 19:08:27 +05301896 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301897 message += (
1898 "<br><ul><li>"
1899 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1900 + "</li>"
1901 )
1902 message += (
1903 "<li>"
1904 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1905 + "</li></ul>"
1906 )
marination4be5b5c2020-10-08 19:08:27 +05301907
marination53b1a9a2020-11-03 15:45:25 +05301908 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301909
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301910 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301911 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301912 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301913
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301914 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301915 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301916 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301917 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301918
Ankush Menat494bd9e2022-03-28 18:52:46 +05301919 elif self.doctype in (
1920 "Supplier Quotation",
1921 "Purchase Order",
1922 "Purchase Receipt",
1923 "Purchase Invoice",
1924 ):
1925 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301926
1927 elif self.meta.get_field("customer"):
1928 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301929
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301930 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301931 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301932
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301933 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301934
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301935 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301936
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301937 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301938 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301939 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301940 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301941 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301942
Ankush Menat494bd9e2022-03-28 18:52:46 +05301943 if (
1944 party_account_currency
1945 and party_account_currency != self.company_currency
1946 and self.currency != party_account_currency
1947 ):
Gursheen Anand112cfe62023-08-31 17:08:51 +05301948
Ankush Menat494bd9e2022-03-28 18:52:46 +05301949 frappe.throw(
1950 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1951 party_type, party, party_account_currency
1952 ),
1953 InvalidCurrency,
1954 )
Anand Doshi979326b2015-09-11 16:22:37 +05301955
shreyas29b565f2016-01-25 17:30:49 +05301956 # Note: not validating with gle account because we don't have the account
1957 # at quotation / sales order level and we shouldn't stop someone
1958 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301959
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301960 def validate_party_account_currency(self):
Deepesh Garg33d97672022-05-12 16:40:29 +05301961 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301962 return
1963
Deepesh Garg33d97672022-05-12 16:40:29 +05301964 if self.is_opening == "Yes":
Deepesh Garg60915e82021-08-21 23:05:48 +05301965 return
1966
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301967 party_type, party = self.get_party()
1968 party_gle_currency = get_party_gle_currency(party_type, party, self.company)
Deepesh Garg33d97672022-05-12 16:40:29 +05301969 party_account = (
1970 self.get("debit_to") if self.doctype == "Sales Invoice" else self.get("credit_to")
1971 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301972 party_account_currency = get_account_currency(party_account)
Deepesh Garge04e67c2022-07-11 19:25:18 +05301973 allow_multi_currency_invoices_against_single_party_account = frappe.db.get_singles_value(
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301974 "Accounts Settings", "allow_multi_currency_invoices_against_single_party_account"
1975 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301976
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301977 if (
1978 not party_gle_currency
1979 and (party_account_currency != self.currency)
1980 and not allow_multi_currency_invoices_against_single_party_account
1981 ):
Deepesh Garg33d97672022-05-12 16:40:29 +05301982 frappe.throw(
Devin Slauenwhite3a1c9232022-06-02 14:15:50 -04001983 _("Party Account {0} currency ({1}) and document currency ({2}) should be same").format(
Devin Slauenwhiteb061ea42022-06-02 14:23:54 -04001984 frappe.bold(party_account), party_account_currency, self.currency
Deepesh Garg33d97672022-05-12 16:40:29 +05301985 )
1986 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301987
Nabin Hait297d74a2016-11-23 15:58:51 +05301988 def delink_advance_entries(self, linked_doc_name):
1989 total_allocated_amount = 0
1990 for adv in self.advances:
1991 consider_for_total_advance = True
1992 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301993 frappe.db.sql(
1994 """delete from `tab{0} Advance`
1995 where name = %s""".format(
1996 self.doctype
1997 ),
1998 adv.name,
1999 )
Nabin Hait297d74a2016-11-23 15:58:51 +05302000 consider_for_total_advance = False
2001
2002 if consider_for_total_advance:
2003 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
2004
Ankush Menat494bd9e2022-03-28 18:52:46 +05302005 frappe.db.set_value(
2006 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
2007 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05302008
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302009 def group_similar_items(self):
2010 group_item_qty = {}
2011 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05302012 # to update serial number in print
2013 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302014
2015 for item in self.items:
2016 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
2017 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
2018
2019 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302020 for item in self.items:
2021 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05302022 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302023 item.qty = group_item_qty[item.item_code]
2024 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05302025
2026 if item.qty:
2027 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
2028 else:
2029 item.rate = 0
2030
Shreya Shah785f1aa2018-10-11 10:14:25 +05302031 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302032 del group_item_qty[item.item_code]
2033 else:
2034 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05302035 for item in duplicate_list:
2036 self.remove(item)
2037
tunde32aa7c12017-09-07 06:52:15 +01002038 def set_payment_schedule(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05302039 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302040 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05302041 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302042
Ankush Menat494bd9e2022-03-28 18:52:46 +05302043 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302044 if not party_account_currency:
2045 party_type, party = self.get_party()
2046
2047 if party_type and party:
2048 party_account_currency = get_party_account_currency(party_type, party, self.company)
2049
rohitwaghchaureda941af2018-01-17 16:23:04 +05302050 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01002051 date = self.get("due_date")
2052 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05302053
Saqib Ansarid552fe62021-04-23 14:46:52 +05302054 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2055 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg5c758942023-04-16 17:11:24 +05302056 automatically_fetch_payment_terms = 0
Deepesh Garg26210162020-08-11 16:06:13 +05302057
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302058 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302059 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302060 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302061 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302062 automatically_fetch_payment_terms = cint(
2063 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
2064 )
tunde96b8f222017-09-08 15:35:59 +01002065
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302066 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302067 if party_account_currency == self.company_currency:
2068 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302069 grand_total = flt(
2070 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2071 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302072 else:
2073 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302074 base_grand_total = flt(
2075 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2076 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302077
Nabin Hait0551f7b2017-11-21 19:58:16 +05302078 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302079 if (
2080 self.doctype in ["Sales Invoice", "Purchase Invoice"]
2081 and automatically_fetch_payment_terms
2082 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2083 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302084 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302085 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302086 self.ignore_default_payment_terms_template = 1
2087 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302088 data = get_payment_terms(
2089 self.payment_terms_template, posting_date, grand_total, base_grand_total
2090 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302091 for item in data:
2092 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05302093 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302094 data = dict(
2095 due_date=due_date,
2096 invoice_portion=100,
2097 payment_amount=grand_total,
2098 base_payment_amount=base_grand_total,
2099 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302100 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302101
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302102 allocate_payment_based_on_payment_terms = frappe.db.get_value(
2103 "Payment Terms Template", self.payment_terms_template, "allocate_payment_based_on_payment_terms"
2104 )
2105
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302106 if not (
2107 automatically_fetch_payment_terms
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302108 and allocate_payment_based_on_payment_terms
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302109 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2110 ):
Deepesh Garg5c758942023-04-16 17:11:24 +05302111 for d in self.get("payment_schedule"):
2112 if d.invoice_portion:
2113 d.payment_amount = flt(
2114 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
2115 )
2116 d.base_payment_amount = flt(
2117 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
2118 )
2119 d.outstanding = d.payment_amount
2120 elif not d.invoice_portion:
2121 d.base_payment_amount = flt(
2122 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
2123 )
ruthra kumar0da6c162023-05-16 18:57:42 +05302124 else:
2125 self.fetch_payment_terms_from_order(po_or_so, doctype)
2126 self.ignore_default_payment_terms_template = 1
tunde43870aa2017-08-18 11:59:30 +01002127
GangaManoj4323f4b2021-07-22 05:57:42 +05302128 def get_order_details(self):
2129 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302130 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302131 po_or_so_doctype = "Sales Order"
2132 po_or_so_doctype_name = "sales_order"
2133
tunde43870aa2017-08-18 11:59:30 +01002134 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302135 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302136 po_or_so_doctype = "Purchase Order"
2137 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05302138
GangaManoj4323f4b2021-07-22 05:57:42 +05302139 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
2140
GangaManojc7c90242021-07-29 19:18:35 +05302141 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302142 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05302143 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302144 return True
2145 elif self.linked_order_has_payment_schedule(po_or_so):
2146 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05302147
GangaManoj4323f4b2021-07-22 05:57:42 +05302148 return False
2149
2150 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302151 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05302152 if item.get(fieldname) != po_or_so:
2153 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05302154
GangaManoj4323f4b2021-07-22 05:57:42 +05302155 return True
2156
GangaManojc7c90242021-07-29 19:18:35 +05302157 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302158 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05302159
2160 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302161 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05302162
2163 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
2164 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302165 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05302166 """
2167 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
2168
2169 self.payment_schedule = []
2170 self.payment_terms_template = po_or_so.payment_terms_template
2171
2172 for schedule in po_or_so.payment_schedule:
2173 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302174 "payment_term": schedule.payment_term,
2175 "due_date": schedule.due_date,
2176 "invoice_portion": schedule.invoice_portion,
2177 "mode_of_payment": schedule.mode_of_payment,
2178 "description": schedule.description,
Deepesh Garg5c758942023-04-16 17:11:24 +05302179 "payment_amount": schedule.payment_amount,
2180 "base_payment_amount": schedule.base_payment_amount,
2181 "outstanding": schedule.outstanding,
2182 "paid_amount": schedule.paid_amount,
GangaManoj4323f4b2021-07-22 05:57:42 +05302183 }
GangaManoj5b33e752021-08-05 21:50:09 +05302184
Ankush Menat494bd9e2022-03-28 18:52:46 +05302185 if schedule.discount_type == "Percentage":
2186 payment_schedule["discount_type"] = schedule.discount_type
2187 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05302188
ruthra kumar9bd56b02022-02-01 14:14:04 +05302189 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302190 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05302191
GangaManoj4323f4b2021-07-22 05:57:42 +05302192 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01002193
tundebe1b8712017-08-19 08:21:44 +01002194 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05302195 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
2196 if due_dates:
2197 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01002198
2199 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01002200 dates = []
tunde9bed2de2017-09-25 10:19:35 +01002201 li = []
tunde43870aa2017-08-18 11:59:30 +01002202
Ankush Menat494bd9e2022-03-28 18:52:46 +05302203 if self.doctype == "Sales Invoice" and self.is_pos:
2204 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302205
tunde43870aa2017-08-18 11:59:30 +01002206 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302207 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302208 frappe.throw(
2209 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
2210 )
tunde77ecacc2017-09-22 23:12:55 +01002211 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03002212 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01002213 dates.append(d.due_date)
2214
2215 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302216 duplicates = "<br>" + "<br>".join(li)
2217 frappe.throw(
2218 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
2219 )
tunde43870aa2017-08-18 11:59:30 +01002220
tunde62af5c52017-09-22 15:16:38 +01002221 def validate_payment_schedule_amount(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05302222 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302223 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302224
Ankush Menat494bd9e2022-03-28 18:52:46 +05302225 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302226 if not party_account_currency:
2227 party_type, party = self.get_party()
2228
2229 if party_type and party:
2230 party_account_currency = get_party_account_currency(party_type, party, self.company)
2231
Nabin Hait0551f7b2017-11-21 19:58:16 +05302232 if self.get("payment_schedule"):
2233 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05302234 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05302235 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05302236 total += flt(d.payment_amount, d.precision("payment_amount"))
2237 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01002238
Saqib Ansarid552fe62021-04-23 14:46:52 +05302239 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2240 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302241
Nabin Haite591c852017-12-21 11:46:30 +05302242 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302243 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05302244 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05302245
2246 if self.get("total_advance"):
2247 if party_account_currency == self.company_currency:
2248 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302249 grand_total = flt(
2250 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2251 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302252 else:
2253 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302254 base_grand_total = flt(
2255 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2256 )
Deepesh Garg9c170522021-10-25 20:06:24 +05302257
Ankush Menat494bd9e2022-03-28 18:52:46 +05302258 if (
2259 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
2260 > 0.1
2261 or flt(base_total, self.precision("base_grand_total"))
2262 - flt(base_grand_total, self.precision("base_grand_total"))
2263 > 0.1
2264 ):
2265 frappe.throw(
2266 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
2267 )
tunde43870aa2017-08-18 11:59:30 +01002268
Nabin Hait877e1bb2017-11-17 12:27:43 +05302269 def is_rounded_total_disabled(self):
2270 if self.meta.get_field("disable_rounded_total"):
2271 return self.disable_rounded_total
2272 else:
2273 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
2274
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302275 def set_inter_company_account(self):
2276 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302277 Set intercompany account for inter warehouse transactions
2278 This account will be used in case billing company and internal customer's
2279 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302280 """
2281
2282 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Daizy Modi4efc9472022-11-07 09:21:03 +05302283 unrealized_profit_loss_account = frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302284 "Company", self.company, "unrealized_profit_loss_account"
2285 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302286
2287 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302288 msg = _(
2289 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
2290 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302291 frappe.throw(msg)
2292
2293 self.unrealized_profit_loss_account = unrealized_profit_loss_account
2294
2295 def is_internal_transfer(self):
2296 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302297 It will an internal transfer if its an internal customer and representation
2298 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302299 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302300 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
2301 internal_party_field = "is_internal_customer"
2302 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
2303 internal_party_field = "is_internal_supplier"
Ankush Menat3714e362022-05-16 18:09:14 +05302304 else:
2305 return False
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302306
2307 if self.get(internal_party_field) and (self.represents_company == self.company):
2308 return True
2309
2310 return False
2311
Saqib Ansari977b09b2021-08-19 17:57:30 +05302312 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302313 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05302314 if not is_invoice:
2315 return
2316
Ankush Menat494bd9e2022-03-28 18:52:46 +05302317 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05302318 party_link = self.get_common_party_link()
2319 if party_link and self.outstanding_amount:
2320 self.create_advance_and_reconcile(party_link)
2321
2322 def get_common_party_link(self):
2323 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05302324 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302325 doctype="Party Link",
2326 filters={"secondary_role": party_type, "secondary_party": party},
2327 fieldname=["primary_role", "primary_party"],
2328 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05302329 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302330
2331 def create_advance_and_reconcile(self, party_link):
2332 secondary_party_type, secondary_party = self.get_party()
2333 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
2334
2335 primary_account = get_party_account(primary_party_type, primary_party, self.company)
2336 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
2337
Ankush Menat494bd9e2022-03-28 18:52:46 +05302338 jv = frappe.new_doc("Journal Entry")
2339 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302340 jv.posting_date = self.posting_date
2341 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05302342 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302343
2344 reconcilation_entry = frappe._dict()
2345 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05302346
2347 reconcilation_entry.account = secondary_account
2348 reconcilation_entry.party_type = secondary_party_type
2349 reconcilation_entry.party = secondary_party
2350 reconcilation_entry.reference_type = self.doctype
2351 reconcilation_entry.reference_name = self.name
Deepesh Gargf88431a2023-04-25 20:54:22 +05302352 reconcilation_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(
2353 self.company
2354 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302355
2356 advance_entry.account = primary_account
2357 advance_entry.party_type = primary_party_type
2358 advance_entry.party = primary_party
Deepesh Gargf88431a2023-04-25 20:54:22 +05302359 advance_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(self.company)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302360 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302361
Ankush Menat494bd9e2022-03-28 18:52:46 +05302362 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05302363 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
2364 advance_entry.debit_in_account_currency = self.outstanding_amount
2365 else:
2366 advance_entry.credit_in_account_currency = self.outstanding_amount
2367 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
2368
Ankush Menat494bd9e2022-03-28 18:52:46 +05302369 jv.append("accounts", reconcilation_entry)
2370 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302371
2372 jv.save()
2373 jv.submit()
2374
Deepesh Gargd05d1532022-06-14 12:50:49 +05302375 def check_conversion_rate(self):
2376 default_currency = erpnext.get_company_currency(self.company)
2377 if not default_currency:
2378 throw(_("Please enter default currency in Company Master"))
2379 if (
2380 (self.currency == default_currency and flt(self.conversion_rate) != 1.00)
2381 or not self.conversion_rate
2382 or (self.currency != default_currency and flt(self.conversion_rate) == 1.00)
2383 ):
2384 throw(_("Conversion rate cannot be 0 or 1"))
2385
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002386 def check_finance_books(self, item, asset):
Nabin Haitfefe9502022-09-09 14:40:36 +05302387 if (
2388 len(asset.finance_books) > 1
2389 and not item.get("finance_book")
2390 and not self.get("finance_book")
2391 and asset.finance_books[0].finance_book
2392 ):
2393 frappe.throw(
2394 _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx)
2395 )
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002396
Gursheen Anand68effd92023-09-21 17:28:07 +05302397 def check_if_fields_updated(self, fields_to_check, child_tables):
2398 # Check if any field affecting accounting entry is altered
2399 doc_before_update = self.get_doc_before_save()
2400 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
2401
2402 # Check if opening entry check updated
2403 needs_repost = doc_before_update.get("is_opening") != self.is_opening
2404
2405 if not needs_repost:
2406 # Parent Level Accounts excluding party account
2407 fields_to_check += accounting_dimensions
2408 for field in fields_to_check:
2409 if doc_before_update.get(field) != self.get(field):
2410 needs_repost = 1
2411 break
2412
2413 if not needs_repost:
2414 # Check for child tables
2415 for table in child_tables:
2416 needs_repost = check_if_child_table_updated(
2417 doc_before_update.get(table), self.get(table), child_tables[table]
2418 )
2419 if needs_repost:
2420 break
2421
2422 return needs_repost
2423
2424 @frappe.whitelist()
2425 def repost_accounting_entries(self):
2426 if self.repost_required:
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302427 repost_ledger = frappe.new_doc("Repost Accounting Ledger")
2428 repost_ledger.company = self.company
2429 repost_ledger.append("vouchers", {"voucher_type": self.doctype, "voucher_no": self.name})
Gursheen Kaur Anand1b808e12023-11-02 14:01:26 +05302430 repost_ledger.flags.ignore_permissions = True
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302431 repost_ledger.insert()
2432 repost_ledger.submit()
Gursheen Anand68effd92023-09-21 17:28:07 +05302433 self.db_set("repost_required", 0)
2434 else:
2435 frappe.throw(_("No updates pending for reposting"))
2436
Ankush Menat494bd9e2022-03-28 18:52:46 +05302437
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05302438@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05302439def get_tax_rate(account_head):
Daizy Modi4efc9472022-11-07 09:21:03 +05302440 return frappe.get_cached_value(
2441 "Account", account_head, ["tax_rate", "account_name"], as_dict=True
2442 )
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05302443
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002444
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302445@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05302446def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302447 if not company:
2448 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05302449
Nabin Haita2426fc2018-01-15 17:45:46 +05302450 if tax_template and company:
Daizy Modi4efc9472022-11-07 09:21:03 +05302451 tax_template_company = frappe.get_cached_value(master_doctype, tax_template, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +05302452 if tax_template_company == company:
2453 return
2454
2455 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05302456
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302457 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302458 "taxes_and_charges": default_tax,
2459 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302460 }
Nabin Hait6b039142014-05-02 15:45:10 +05302461
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002462
Nabin Hait6b039142014-05-02 15:45:10 +05302463@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302464def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05302465 if not master_name:
2466 return
Ankush Menat77dcdff2022-06-01 22:01:07 +05302467 from frappe.model import child_table_fields, default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05302468
Nabin Hait6b039142014-05-02 15:45:10 +05302469 tax_master = frappe.get_doc(master_doctype, master_name)
2470
2471 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302472 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05302473 tax = tax.as_dict()
2474
Ankush Menat77dcdff2022-06-01 22:01:07 +05302475 for fieldname in default_fields + child_table_fields:
Nabin Hait6b039142014-05-02 15:45:10 +05302476 if fieldname in tax:
2477 del tax[fieldname]
2478
2479 taxes_and_charges.append(tax)
2480
2481 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302482
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002483
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302484def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
2485 """common validation for currency and price list currency"""
2486
Ankush Menat494bd9e2022-03-28 18:52:46 +05302487 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302488
2489 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05302490 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302491 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
2492 conversion_rate_label, currency, company_currency
2493 )
Saqib60212ff2020-10-26 11:17:04 +05302494 )
Nabin Hait613d0812015-02-23 11:58:15 +05302495
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002496
Nabin Hait613d0812015-02-23 11:58:15 +05302497def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302498 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
2499 frappe.throw(
2500 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
2501 )
2502 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05302503 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002504 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302505 _(
2506 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
2507 )
2508 )
Nabin Hait613d0812015-02-23 11:58:15 +05302509 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302510 frappe.throw(
2511 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
2512 )
Nabin Hait613d0812015-02-23 11:58:15 +05302513 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302514 frappe.throw(
2515 _("Cannot refer row number greater than or equal to current row number for this Charge type")
2516 )
Nabin Hait613d0812015-02-23 11:58:15 +05302517
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302518 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05302519 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302520
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002521
Ankush Menat494bd9e2022-03-28 18:52:46 +05302522def validate_account_head(idx, account, company, context=""):
2523 account_company = frappe.get_cached_value("Account", account, "company")
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302524 is_group = frappe.get_cached_value("Account", account, "is_group")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302525
Deepesh Garg5a2b5712022-02-18 20:05:49 +05302526 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302527 frappe.throw(
2528 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
2529 idx, frappe.bold(account), frappe.bold(company), context
2530 ),
2531 title=_("Invalid Account"),
2532 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302533
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302534 if is_group:
2535 frappe.throw(
2536 _("Row {0}: Account {1} is a Group Account").format(idx, frappe.bold(account)),
2537 title=_("Invalid Account"),
2538 )
2539
Anuja Pawar0e337be2021-08-10 17:26:35 +05302540
2541def validate_cost_center(tax, doc):
2542 if not tax.cost_center:
2543 return
2544
Ankush Menat494bd9e2022-03-28 18:52:46 +05302545 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302546
2547 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302548 frappe.throw(
2549 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
2550 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
2551 ),
2552 title=_("Invalid Cost Center"),
2553 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302554
2555
Nabin Hait613d0812015-02-23 11:58:15 +05302556def validate_inclusive_tax(tax, doc):
2557 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302558 throw(
2559 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
2560 tax.idx, row_range
2561 )
2562 )
Nabin Hait613d0812015-02-23 11:58:15 +05302563
2564 if cint(getattr(tax, "included_in_print_rate", None)):
2565 if tax.charge_type == "Actual":
2566 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05302567 throw(
2568 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
2569 tax.idx
2570 )
2571 )
2572 elif tax.charge_type == "On Previous Row Amount" and not cint(
2573 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
2574 ):
Nabin Hait613d0812015-02-23 11:58:15 +05302575 # referred row should also be inclusive
2576 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302577 elif tax.charge_type == "On Previous Row Total" and not all(
2578 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
2579 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05302580 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05302581 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05302582 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05302583 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302584
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302585
Ankush Menat494bd9e2022-03-28 18:52:46 +05302586def set_balance_in_account_currency(
2587 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
2588):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002589 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302590 frappe.throw(
2591 _("Account: {0} with currency: {1} can not be selected").format(
2592 gl_dict.account, account_currency
2593 )
2594 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002595
Ankush Menat494bd9e2022-03-28 18:52:46 +05302596 gl_dict["account_currency"] = (
2597 company_currency if account_currency == company_currency else account_currency
2598 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302599
2600 # set debit/credit in account currency if not provided
2601 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302602 gl_dict.debit_in_account_currency = (
2603 gl_dict.debit
2604 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302605 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302606 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302607
2608 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302609 gl_dict.credit_in_account_currency = (
2610 gl_dict.credit
2611 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302612 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302613 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302614
2615
Ankush Menat494bd9e2022-03-28 18:52:46 +05302616def get_advance_journal_entries(
2617 party_type,
2618 party,
2619 party_account,
2620 amount_field,
2621 order_doctype,
2622 order_list,
2623 include_unallocated=True,
2624):
Gursheen Anand4ee16372023-06-08 13:15:23 +05302625 journal_entry = frappe.qb.DocType("Journal Entry")
2626 journal_acc = frappe.qb.DocType("Journal Entry Account")
2627 q = (
2628 frappe.qb.from_(journal_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302629 .inner_join(journal_acc)
2630 .on(journal_entry.name == journal_acc.parent)
2631 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302632 ConstantColumn("Journal Entry").as_("reference_type"),
2633 (journal_entry.name).as_("reference_name"),
2634 (journal_entry.remark).as_("remarks"),
Deepesh Garg3aead052023-06-22 11:41:43 +05302635 (journal_acc[amount_field]).as_("amount"),
Gursheen Anand4ee16372023-06-08 13:15:23 +05302636 (journal_acc.name).as_("reference_row"),
2637 (journal_acc.reference_name).as_("against_order"),
2638 (journal_acc.exchange_rate),
Gursheen Anand74619262023-06-02 17:13:51 +05302639 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302640 .where(
2641 journal_acc.account.isin(party_account)
2642 & (journal_acc.party_type == party_type)
2643 & (journal_acc.party == party)
2644 & (journal_acc.is_advance == "Yes")
2645 & (journal_entry.docstatus == 1)
2646 )
2647 )
Gursheen Anand74619262023-06-02 17:13:51 +05302648 if party_type == "Customer":
2649 q = q.where(journal_acc.credit_in_account_currency > 0)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302650
Gursheen Anand4ee16372023-06-08 13:15:23 +05302651 else:
2652 q = q.where(journal_acc.debit_in_account_currency > 0)
2653
Deepesh Garg3aead052023-06-22 11:41:43 +05302654 if include_unallocated:
2655 q = q.where((journal_acc.reference_name.isnull()) | (journal_acc.reference_name == ""))
2656
Nabin Hait1991c7b2016-06-27 20:09:05 +05302657 if order_list:
Deepesh Garg3aead052023-06-22 11:41:43 +05302658 q = q.where(
Deepesh Garg6d121ae2023-06-22 13:03:09 +05302659 (journal_acc.reference_type == order_doctype) & ((journal_acc.reference_type).isin(order_list))
Deepesh Garg3aead052023-06-22 11:41:43 +05302660 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302661
Gursheen Anand74619262023-06-02 17:13:51 +05302662 q = q.orderby(journal_entry.posting_date)
Rushabh Mehta66958302017-01-16 16:57:53 +05302663
Gursheen Anand74619262023-06-02 17:13:51 +05302664 journal_entries = q.run(as_dict=True)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302665 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302666
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002667
Smit Vora3e282bf2023-09-19 20:47:21 +05302668@erpnext.allow_regional
2669def get_advance_payment_entries_for_regional(*args, **kwargs):
2670 return get_advance_payment_entries(*args, **kwargs)
2671
2672
Ankush Menat494bd9e2022-03-28 18:52:46 +05302673def get_advance_payment_entries(
2674 party_type,
2675 party,
2676 party_account,
2677 order_doctype,
2678 order_list=None,
2679 include_unallocated=True,
2680 against_all_orders=False,
2681 limit=None,
2682 condition=None,
2683):
Gursheen Anand74619262023-06-02 17:13:51 +05302684
Deepesh Garg92f845c2023-06-21 12:21:19 +05302685 payment_entries = []
2686 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand74619262023-06-02 17:13:51 +05302687
Deepesh Garg92f845c2023-06-21 12:21:19 +05302688 if order_list or against_all_orders:
2689 q = get_common_query(
2690 party_type,
2691 party,
2692 party_account,
2693 limit,
2694 condition,
2695 )
2696 payment_ref = frappe.qb.DocType("Payment Entry Reference")
Gursheen Anand74619262023-06-02 17:13:51 +05302697
Deepesh Garg92f845c2023-06-21 12:21:19 +05302698 q = q.inner_join(payment_ref).on(payment_entry.name == payment_ref.parent)
2699 q = q.select(
2700 (payment_ref.allocated_amount).as_("amount"),
2701 (payment_ref.name).as_("reference_row"),
2702 (payment_ref.reference_name).as_("against_order"),
Deepesh Garg92f845c2023-06-21 12:21:19 +05302703 )
2704
Deepesh Garg3aead052023-06-22 11:41:43 +05302705 q = q.where(payment_ref.reference_doctype == order_doctype)
Deepesh Garg92f845c2023-06-21 12:21:19 +05302706 if order_list:
2707 q = q.where(payment_ref.reference_name.isin(order_list))
2708
2709 allocated = list(q.run(as_dict=True))
2710 payment_entries += allocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302711 if include_unallocated:
2712 q = get_common_query(
2713 party_type,
2714 party,
2715 party_account,
2716 limit,
2717 condition,
2718 )
2719 q = q.select((payment_entry.unallocated_amount).as_("amount"))
2720 q = q.where(payment_entry.unallocated_amount > 0)
2721
2722 unallocated = list(q.run(as_dict=True))
2723 payment_entries += unallocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302724 return payment_entries
Gursheen Anand74619262023-06-02 17:13:51 +05302725
Saqiba20999c2021-07-12 14:33:23 +05302726
Deepesh Garg92f845c2023-06-21 12:21:19 +05302727def get_common_query(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302728 party_type,
2729 party,
2730 party_account,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302731 limit,
2732 condition,
2733):
RitvikSardanad2f03c82023-09-05 12:00:54 +05302734 account_type = frappe.db.get_value("Party Type", party_type, "account_type")
2735 payment_type = "Receive" if account_type == "Receivable" else "Pay"
Gursheen Anand4ee16372023-06-08 13:15:23 +05302736 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand4ee16372023-06-08 13:15:23 +05302737
2738 q = (
2739 frappe.qb.from_(payment_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302740 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302741 ConstantColumn("Payment Entry").as_("reference_type"),
2742 (payment_entry.name).as_("reference_name"),
Gursheen Anand74619262023-06-02 17:13:51 +05302743 payment_entry.posting_date,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302744 (payment_entry.remarks).as_("remarks"),
Ankush Menat494bd9e2022-03-28 18:52:46 +05302745 )
Gursheen Anand74619262023-06-02 17:13:51 +05302746 .where(payment_entry.payment_type == payment_type)
2747 .where(payment_entry.party_type == party_type)
2748 .where(payment_entry.party == party)
2749 .where(payment_entry.docstatus == 1)
2750 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302751
RitvikSardanad2f03c82023-09-05 12:00:54 +05302752 if payment_type == "Receive":
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302753 q = q.select((payment_entry.paid_from_account_currency).as_("currency"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302754 q = q.select(payment_entry.paid_from)
2755 q = q.where(payment_entry.paid_from.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302756 else:
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302757 q = q.select((payment_entry.paid_to_account_currency).as_("currency"))
Gursheen Anand74619262023-06-02 17:13:51 +05302758 q = q.select(payment_entry.paid_to)
Gursheen Anand4ee16372023-06-08 13:15:23 +05302759 q = q.where(payment_entry.paid_to.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302760
2761 if payment_type == "Receive":
Deepesh Garg92f845c2023-06-21 12:21:19 +05302762 q = q.select((payment_entry.source_exchange_rate).as_("exchange_rate"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302763 else:
Deepesh Garg92f845c2023-06-21 12:21:19 +05302764 q = q.select((payment_entry.target_exchange_rate).as_("exchange_rate"))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302765
Deepesh Garg92f845c2023-06-21 12:21:19 +05302766 if condition:
ruthra kumarff60ec82023-12-15 17:25:02 +05302767 # conditions should be built as an array and passed as Criterion
2768 common_filter_conditions = []
ruthra kumar86bac2c2023-07-04 09:02:05 +05302769
ruthra kumarff60ec82023-12-15 17:25:02 +05302770 common_filter_conditions.append(payment_entry.company == condition["company"])
2771 if condition.get("name", None):
2772 common_filter_conditions.append(payment_entry.name.like(f"%{condition.get('name')}%"))
2773
2774 if condition.get("from_payment_date"):
2775 common_filter_conditions.append(payment_entry.posting_date.gte(condition["from_payment_date"]))
2776
2777 if condition.get("to_payment_date"):
2778 common_filter_conditions.append(payment_entry.posting_date.lte(condition["to_payment_date"]))
2779
Deepesh Garg92f845c2023-06-21 12:21:19 +05302780 if condition.get("get_payments") == True:
ruthra kumarff60ec82023-12-15 17:25:02 +05302781 if condition.get("cost_center"):
2782 common_filter_conditions.append(payment_entry.cost_center == condition["cost_center"])
2783
2784 if condition.get("accounting_dimensions"):
2785 for field, val in condition.get("accounting_dimensions").items():
2786 common_filter_conditions.append(payment_entry[field] == val)
2787
2788 if condition.get("minimum_payment_amount"):
2789 common_filter_conditions.append(
2790 payment_entry.unallocated_amount.gte(condition["minimum_payment_amount"])
2791 )
2792
2793 if condition.get("maximum_payment_amount"):
2794 common_filter_conditions.append(
2795 payment_entry.unallocated_amount.lte(condition["maximum_payment_amount"])
2796 )
2797 q = q.where(Criterion.all(common_filter_conditions))
Gursheen Anand74619262023-06-02 17:13:51 +05302798
2799 q = q.orderby(payment_entry.posting_date)
2800 q = q.limit(limit) if limit else q
Deepesh Garg92f845c2023-06-21 12:21:19 +05302801
Gursheen Anand74619262023-06-02 17:13:51 +05302802 return q
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302803
Ankush Menat494bd9e2022-03-28 18:52:46 +05302804
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302805def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302806 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302807 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302808 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302809 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302810 invoice = frappe.qb.DocType(doctype)
2811
2812 consider_base_amount = invoice.party_account_currency != invoice.currency
2813 payment_amount = (
2814 frappe.qb.terms.Case()
2815 .when(consider_base_amount, payment_schedule.base_payment_amount)
2816 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302817 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002818
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302819 payable_amount = (
2820 frappe.qb.from_(payment_schedule)
2821 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302822 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302823 )
2824
2825 total = (
2826 frappe.qb.terms.Case()
2827 .when(invoice.disable_rounded_total, invoice.grand_total)
2828 .else_(invoice.rounded_total)
2829 )
2830
2831 base_total = (
2832 frappe.qb.terms.Case()
2833 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2834 .else_(invoice.base_rounded_total)
2835 )
2836
Ankush Menat494bd9e2022-03-28 18:52:46 +05302837 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302838
2839 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2840
2841 conditions = (
2842 (invoice.docstatus == 1)
2843 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302844 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302845 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302846 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302847 if doctype == "Sales Invoice"
2848 else is_overdue
2849 )
2850 )
2851
Pruthvi Patel0799f372021-11-12 12:56:29 +05302852 status = (
2853 frappe.qb.terms.Case()
2854 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2855 .else_("Overdue")
2856 )
2857
2858 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302859
2860
Nabin Hait92759692017-08-15 08:23:51 +05302861@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302862def get_payment_terms(
2863 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2864):
Nabin Hait92759692017-08-15 08:23:51 +05302865 if not terms_template:
2866 return
2867
2868 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2869
2870 schedule = []
tundefb144302017-08-19 15:01:40 +01002871 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302872 term_details = get_payment_term_details(
2873 d, posting_date, grand_total, base_grand_total, bill_date
2874 )
Nabin Hait92759692017-08-15 08:23:51 +05302875 schedule.append(term_details)
2876
2877 return schedule
2878
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002879
Nabin Hait92759692017-08-15 08:23:51 +05302880@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302881def get_payment_term_details(
2882 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2883):
Nabin Hait92759692017-08-15 08:23:51 +05302884 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302885 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302886 term = frappe.get_doc("Payment Term", term)
2887 else:
2888 term_details.payment_term = term.payment_term
2889 term_details.description = term.description
2890 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302891 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302892 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302893 term_details.discount_type = term.discount_type
2894 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302895 term_details.outstanding = term_details.payment_amount
2896 term_details.mode_of_payment = term.mode_of_payment
2897
Shreya Shah3a9eec22018-02-16 13:05:21 +05302898 if bill_date:
2899 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302900 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302901 elif posting_date:
2902 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302903 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302904
2905 if getdate(term_details.due_date) < getdate(posting_date):
2906 term_details.due_date = posting_date
2907
Nabin Hait92759692017-08-15 08:23:51 +05302908 return term_details
2909
Ankush Menat494bd9e2022-03-28 18:52:46 +05302910
Shreya Shah3a9eec22018-02-16 13:05:21 +05302911def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302912 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302913 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302914 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302915 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302916 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302917 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302918 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302919 due_date = get_last_day(add_months(date, term.credit_months))
tunde96b8f222017-09-08 15:35:59 +01002920 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002921
Ankush Menat494bd9e2022-03-28 18:52:46 +05302922
Saqib0586b7d2021-03-31 15:03:53 +05302923def get_discount_date(term, posting_date=None, bill_date=None):
2924 discount_validity = None
2925 date = bill_date or posting_date
2926 if term.discount_validity_based_on == "Day(s) after invoice date":
2927 discount_validity = add_days(date, term.discount_validity)
2928 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2929 discount_validity = add_days(get_last_day(date), term.discount_validity)
2930 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302931 discount_validity = get_last_day(add_months(date, term.discount_validity))
Saqib0586b7d2021-03-31 15:03:53 +05302932 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002933
Ankush Menat494bd9e2022-03-28 18:52:46 +05302934
tundebabzyad08d4c2018-05-16 07:01:41 +01002935def get_supplier_block_status(party_name):
2936 """
2937 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2938 a `Supplier`
2939 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302940 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002941 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302942 "on_hold": supplier.on_hold,
2943 "release_date": supplier.release_date,
2944 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002945 }
2946 return info
2947
Ankush Menat494bd9e2022-03-28 18:52:46 +05302948
marination698d9832020-08-19 14:59:46 +05302949def set_child_tax_template_and_map(item, child_item, parent_doc):
2950 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302951 "item_code": item.item_code,
2952 "posting_date": parent_doc.transaction_date,
2953 "tax_category": parent_doc.get("tax_category"),
2954 "company": parent_doc.get("company"),
2955 }
marination698d9832020-08-19 14:59:46 +05302956
2957 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2958 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302959 child_item.item_tax_rate = get_item_tax_map(
2960 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2961 )
2962
marination698d9832020-08-19 14:59:46 +05302963
Afshanb3bbebd2021-08-09 14:39:32 +05302964def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302965 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2966 "Accounts Settings", "add_taxes_from_item_tax_template"
2967 )
Marica3b1be2b2020-10-22 17:04:31 +05302968
2969 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2970 tax_map = json.loads(child_item.get("item_tax_rate"))
2971 for tax_type in tax_map:
2972 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302973 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302974 # add new row for tax head only if missing
2975 found = any(tax.account_head == tax_type for tax in taxes)
2976 if not found:
2977 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302978 tax_row.update(
2979 {
2980 "description": str(tax_type).split(" - ")[0],
2981 "charge_type": "On Net Total",
2982 "account_head": tax_type,
2983 "rate": tax_rate,
2984 }
2985 )
Marica3b1be2b2020-10-22 17:04:31 +05302986 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302987 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302988 if db_insert:
2989 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302990
Ankush Menat494bd9e2022-03-28 18:52:46 +05302991
2992def set_order_defaults(
2993 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2994):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002995 """
pateljannat637ddff2021-02-09 16:17:30 +05302996 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002997 """
Saqib438e0432020-04-03 10:02:56 +05302998 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
Ankush Menat686685b2023-05-31 12:50:14 +05302999 child_item = frappe.new_doc(child_doctype, parent_doc=p_doc, parentfield=child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05303000 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05303001
pateljannat637ddff2021-02-09 16:17:30 +05303002 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05303003 child_item.update({field: item.get(field)})
3004
pateljannat637ddff2021-02-09 16:17:30 +05303005 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05303006 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05303007 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05303008 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13003009 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05303010 conversion_factor = flt(
3011 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
3012 )
3013 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05303014
pateljannat637ddff2021-02-09 16:17:30 +05303015 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05303016 # Initialized value will update in parent validation
3017 child_item.base_rate = 1
3018 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05303019 if child_doctype == "Sales Order Item":
3020 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
3021 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303022 frappe.throw(
3023 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
3024 frappe.bold("default warehouse"), frappe.bold(item.item_code)
3025 )
3026 )
marination0673f552021-03-31 01:38:22 +05303027
marination698d9832020-08-19 14:59:46 +05303028 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05303029 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003030 return child_item
3031
Ankush Menat494bd9e2022-03-28 18:52:46 +05303032
marination0673f552021-03-31 01:38:22 +05303033def validate_child_on_delete(row, parent):
3034 """Check if partially transacted item (row) is being deleted."""
3035 if parent.doctype == "Sales Order":
3036 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303037 frappe.throw(
3038 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
3039 row.idx, row.item_code
3040 )
3041 )
marination0673f552021-03-31 01:38:22 +05303042 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303043 frappe.throw(
3044 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
3045 row.idx, row.item_code
3046 )
3047 )
marination0673f552021-03-31 01:38:22 +05303048 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303049 frappe.throw(
3050 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
3051 row.idx, row.item_code
3052 )
3053 )
marination0673f552021-03-31 01:38:22 +05303054
3055 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303056 frappe.throw(
3057 _("Row #{0}: Cannot delete item {1} which has already been received").format(
3058 row.idx, row.item_code
3059 )
3060 )
marination0673f552021-03-31 01:38:22 +05303061
3062 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303063 frappe.throw(
3064 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
3065 row.idx, row.item_code
3066 )
3067 )
3068
marination0673f552021-03-31 01:38:22 +05303069
3070def update_bin_on_delete(row, doctype):
3071 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05303072 from erpnext.stock.stock_balance import (
3073 get_indented_qty,
3074 get_ordered_qty,
3075 get_reserved_qty,
3076 update_bin_qty,
3077 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05303078
marination0673f552021-03-31 01:38:22 +05303079 qty_dict = {}
3080
3081 if doctype == "Sales Order":
3082 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
3083 else:
3084 if row.material_request_item:
3085 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
3086
3087 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
3088
Deepesh Garga61790c2022-02-22 20:58:10 +05303089 if row.warehouse:
3090 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05303091
Ankush Menat494bd9e2022-03-28 18:52:46 +05303092
Ankush Menatdd11f262022-06-27 15:55:08 +05303093def validate_and_delete_children(parent, data) -> bool:
Saqib0ad74492019-12-24 16:42:30 +05303094 deleted_children = []
3095 updated_item_names = [d.get("docname") for d in data]
3096 for item in parent.items:
3097 if item.name not in updated_item_names:
3098 deleted_children.append(item)
3099
3100 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05303101 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05303102 d.cancel()
3103 d.delete()
marination0673f552021-03-31 01:38:22 +05303104
Gursheen Kaur Anand9087e142023-12-02 19:53:00 +05303105 if parent.doctype == "Purchase Order":
3106 parent.update_ordered_qty_in_so_for_removed_items(deleted_children)
3107
marination0673f552021-03-31 01:38:22 +05303108 # need to update ordered qty in Material Request first
3109 # bin uses Material Request Items to recalculate & update
3110 parent.update_prevdoc_status()
3111
3112 for d in deleted_children:
3113 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003114
Ankush Menatdd11f262022-06-27 15:55:08 +05303115 return bool(deleted_children)
3116
Rohan Bansala93b5142021-04-06 17:10:52 +05303117
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003118@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003119def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303120 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303121 try:
3122 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05303123 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303124 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05303125
Ankush Menat494bd9e2022-03-28 18:52:46 +05303126 frappe.throw(
3127 _("You do not have permissions to {} items in a {}.").format(
3128 actions[perm_type], parent_doctype
3129 ),
3130 title=_("Insufficient Permissions"),
3131 )
marination665c27a2020-09-15 12:04:38 +05303132
Saqib6db92fb2020-09-14 19:54:17 +05303133 def validate_workflow_conditions(doc):
3134 workflow = get_workflow_name(doc.doctype)
3135 if not workflow:
3136 return
3137
3138 workflow_doc = frappe.get_doc("Workflow", workflow)
3139 current_state = doc.get(workflow_doc.workflow_state_field)
3140 roles = frappe.get_roles()
3141
3142 transitions = []
3143 for transition in workflow_doc.transitions:
3144 if transition.next_state == current_state and transition.allowed in roles:
3145 if not is_transition_condition_satisfied(transition, doc):
3146 continue
3147 transitions.append(transition.as_dict())
3148
3149 if not transitions:
Saqib18318932020-09-23 13:01:49 +05303150 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05303151 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
3152 get_link_to_form("Workflow", workflow)
3153 ),
3154 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05303155 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303156
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303157 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05303158 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303159 return set_order_defaults(
3160 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
3161 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303162
marination0c915432022-05-10 18:04:02 +05303163 def validate_quantity(child_item, new_data):
3164 if not flt(new_data.get("qty")):
3165 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +01003166 _("Row #{0}: Quantity for Item {1} cannot be zero.").format(
marination0c915432022-05-10 18:04:02 +05303167 new_data.get("idx"), frappe.bold(new_data.get("item_code"))
3168 ),
3169 title=_("Invalid Qty"),
3170 )
3171
3172 if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303173 frappe.throw(_("Cannot set quantity less than delivered quantity"))
3174
marination0c915432022-05-10 18:04:02 +05303175 if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt(
3176 child_item.received_qty
3177 ):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303178 frappe.throw(_("Cannot set quantity less than received quantity"))
3179
Ankush Menatdd11f262022-06-27 15:55:08 +05303180 def should_update_supplied_items(doc) -> bool:
3181 """Subcontracted PO can allow following changes *after submit*:
3182
3183 1. Change rate of subcontracting - regardless of other changes.
3184 2. Change qty and/or add new items and/or remove items
3185 Exception: Transfer/Consumption is already made, qty change not allowed.
3186 """
3187
3188 supplied_items_processed = any(
3189 item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items
3190 )
3191
3192 update_supplied_items = (
3193 any_qty_changed or items_added_or_removed or any_conversion_factor_changed
3194 )
3195 if update_supplied_items and supplied_items_processed:
3196 frappe.throw(_("Item qty can not be updated as raw materials are already processed."))
3197
3198 return update_supplied_items
3199
s-aga-r9588bb72023-08-21 22:23:57 +05303200 def validate_fg_item_for_subcontracting(new_data, is_new):
3201 if is_new:
3202 if not new_data.get("fg_item"):
3203 frappe.throw(
3204 _("Finished Good Item is not specified for service item {0}").format(new_data["item_code"])
3205 )
3206 else:
3207 is_sub_contracted_item, default_bom = frappe.db.get_value(
3208 "Item", new_data["fg_item"], ["is_sub_contracted_item", "default_bom"]
3209 )
3210
3211 if not is_sub_contracted_item:
3212 frappe.throw(
3213 _("Finished Good Item {0} must be a sub-contracted item").format(new_data["fg_item"])
3214 )
3215 elif not default_bom:
3216 frappe.throw(_("Default BOM not found for FG Item {0}").format(new_data["fg_item"]))
3217
3218 if not new_data.get("fg_item_qty"):
3219 frappe.throw(_("Finished Good Item {0} Qty can not be zero").format(new_data["fg_item"]))
3220
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003221 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003222
Ankush Menatdd11f262022-06-27 15:55:08 +05303223 any_qty_changed = False # updated to true if any item's qty changes
3224 items_added_or_removed = False # updated to true if any new item is added or removed
3225 any_conversion_factor_changed = False
3226
Ankush Menat494bd9e2022-03-28 18:52:46 +05303227 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303228 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05303229
Ankush Menat494bd9e2022-03-28 18:52:46 +05303230 check_doc_permissions(parent, "write")
Ankush Menatdd11f262022-06-27 15:55:08 +05303231 _removed_items = validate_and_delete_children(parent, data)
3232 items_added_or_removed |= _removed_items
Saqib0ad74492019-12-24 16:42:30 +05303233
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003234 for d in data:
3235 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05303236
3237 if not d.get("item_code"):
3238 # ignore empty rows
3239 continue
3240
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003241 if not d.get("docname"):
3242 new_child_flag = True
Ankush Menatdd11f262022-06-27 15:55:08 +05303243 items_added_or_removed = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05303244 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303245 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003246 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303247 check_doc_permissions(parent, "write")
3248 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303249
Saqib Ansaric579b082020-05-29 22:21:50 +05303250 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
3251 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
s-aga-r9588bb72023-08-21 22:23:57 +05303252 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 +05303253 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
3254 d.get("conversion_factor")
3255 )
Saqib61314242020-09-15 11:14:31 +05303256 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05303257
Ankush Menat494bd9e2022-03-28 18:52:46 +05303258 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05303259 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303260 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05303261 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303262
3263 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05303264 qty_unchanged = prev_qty == new_qty
s-aga-r9588bb72023-08-21 22:23:57 +05303265 fg_qty_unchanged = prev_fg_qty == new_fg_qty
Saqib61314242020-09-15 11:14:31 +05303266 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05303267 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menatdd11f262022-06-27 15:55:08 +05303268 any_conversion_factor_changed |= not conversion_factor_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303269 date_unchanged = (
3270 prev_date == getdate(new_date) if prev_date and new_date else False
3271 ) # in case of delivery note etc
3272 if (
3273 rate_unchanged
3274 and qty_unchanged
s-aga-r9588bb72023-08-21 22:23:57 +05303275 and fg_qty_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303276 and conversion_factor_unchanged
3277 and uom_unchanged
3278 and date_unchanged
3279 ):
Saqibdd374ff2020-02-27 12:51:31 +05303280 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003281
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303282 validate_quantity(child_item, d)
Ankush Menatdd11f262022-06-27 15:55:08 +05303283 if flt(child_item.get("qty")) != flt(d.get("qty")):
3284 any_qty_changed = True
deepeshgarg00777cde832018-12-27 15:56:51 +05303285
s-aga-r9588bb72023-08-21 22:23:57 +05303286 if (
3287 parent.doctype == "Purchase Order"
3288 and parent.is_subcontracted
3289 and not parent.is_old_subcontracting_flow
3290 ):
3291 validate_fg_item_for_subcontracting(d, new_child_flag)
3292 child_item.fg_item_qty = flt(d["fg_item_qty"])
3293
3294 if new_child_flag:
3295 child_item.fg_item = d["fg_item"]
3296
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003297 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05303298 rate_precision = child_item.precision("rate") or 2
3299 conv_fac_precision = child_item.precision("conversion_factor") or 2
3300 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003301
Maricab9f5a1c2023-11-27 09:05:22 +05303302 # Amount cannot be lesser than billed amount, except for negative amounts
3303 row_rate = flt(d.get("rate"), rate_precision)
3304 amount_below_billed_amt = flt(child_item.billed_amt, rate_precision) > flt(
3305 row_rate * flt(d.get("qty"), qty_precision), rate_precision
3306 )
3307 if amount_below_billed_amt and row_rate > 0.0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303308 frappe.throw(
3309 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
3310 child_item.idx, child_item.item_code
3311 )
3312 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003313 else:
Maricab9f5a1c2023-11-27 09:05:22 +05303314 child_item.rate = row_rate
marinationf9c4b202020-06-12 15:49:53 +05303315
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303316 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05303317 if child_item.stock_uom == child_item.uom:
3318 child_item.conversion_factor = 1
3319 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303320 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05303321
Saqib61314242020-09-15 11:14:31 +05303322 if d.get("uom"):
3323 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303324 conversion_factor = flt(
3325 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
3326 )
3327 child_item.conversion_factor = (
3328 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
3329 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303330
Ankush Menat494bd9e2022-03-28 18:52:46 +05303331 if d.get("delivery_date") and parent_doctype == "Sales Order":
3332 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05303333
Ankush Menat494bd9e2022-03-28 18:52:46 +05303334 if d.get("schedule_date") and parent_doctype == "Purchase Order":
3335 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303336
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303337 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05303338 if flt(child_item.rate) > flt(child_item.price_list_rate):
3339 # if rate is greater than price_list_rate, set margin
3340 # or set discount
3341 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05303342
3343 if parent_doctype in sales_doctypes:
3344 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303345 child_item.margin_rate_or_amount = flt(
3346 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
3347 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05303348 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05303349 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303350 child_item.discount_percentage = flt(
3351 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
3352 child_item.precision("discount_percentage"),
3353 )
3354 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05303355
3356 if parent_doctype in sales_doctypes:
3357 child_item.margin_type = ""
3358 child_item.margin_rate_or_amount = 0
3359 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303360
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003361 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003362 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05303363 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303364 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003365 child_item.insert()
3366 else:
3367 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003368
Rushabh Mehtafafbb022018-12-24 22:09:15 +05303369 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303370 parent.flags.ignore_validate_update_after_submit = True
3371 parent.set_qty_as_per_stock_uom()
3372 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05303373 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05303374 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05303375 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05303376 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303377 frappe.get_doc("Authorization Control").validate_approving_authority(
3378 parent.doctype, parent.company, parent.base_grand_total
3379 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003380
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303381 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303382 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303383 parent.validate_minimum_order_qty()
3384 parent.validate_budget()
3385 if parent.is_against_so():
3386 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05303387 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303388 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05303389
3390 # reset index of child table
3391 for idx, row in enumerate(parent.get(child_docname), start=1):
3392 row.idx = idx
3393
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303394 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05303395
Ankush Menat494bd9e2022-03-28 18:52:46 +05303396 if parent_doctype == "Purchase Order":
3397 update_last_purchase_rate(parent, is_submit=1)
s-aga-r68f5dd32023-12-01 14:45:01 +05303398
3399 if any_qty_changed or items_added_or_removed or any_conversion_factor_changed:
3400 parent.update_prevdoc_status()
3401
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303402 parent.update_requested_qty()
3403 parent.update_ordered_qty()
3404 parent.update_ordered_and_reserved_qty()
3405 parent.update_receiving_percentage()
s-aga-rb9b17172023-08-22 16:53:54 +05303406
3407 if parent.is_subcontracted:
3408 if parent.is_old_subcontracting_flow:
3409 if should_update_supplied_items(parent):
3410 parent.update_reserved_qty_for_subcontract()
3411 parent.create_raw_materials_supplied()
3412 parent.save()
3413 else:
3414 if not parent.can_update_items():
3415 frappe.throw(
3416 _(
3417 "Items cannot be updated as Subcontracting Order is created against the Purchase Order {0}."
3418 ).format(frappe.bold(parent.name))
3419 )
Ankush Menatc84e11a2022-06-01 12:55:10 +05303420 else: # Sales Order
3421 parent.validate_warehouse()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303422 parent.update_reserved_qty()
3423 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303424 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303425 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05303426
Saqib6db92fb2020-09-14 19:54:17 +05303427 parent.reload()
3428 validate_workflow_conditions(parent)
3429
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303430 parent.update_blanket_order()
3431 parent.update_billing_percentage()
3432 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05303433
s-aga-rac24d772023-04-05 19:48:15 +05303434 # Cancel and Recreate Stock Reservation Entries.
s-aga-r38e93672023-04-02 21:24:59 +05303435 if parent_doctype == "Sales Order":
3436 from erpnext.stock.doctype.stock_reservation_entry.stock_reservation_entry import (
3437 cancel_stock_reservation_entries,
3438 has_reserved_stock,
s-aga-r38e93672023-04-02 21:24:59 +05303439 )
3440
3441 if has_reserved_stock(parent.doctype, parent.name):
3442 cancel_stock_reservation_entries(parent.doctype, parent.name)
s-aga-r2d8363a2023-09-02 11:02:24 +05303443
3444 if parent.per_picked == 0:
3445 parent.create_stock_reservation_entries()
s-aga-r38e93672023-04-02 21:24:59 +05303446
Ankush Menat494bd9e2022-03-28 18:52:46 +05303447
Gursheen Anand68effd92023-09-21 17:28:07 +05303448def check_if_child_table_updated(
3449 child_table_before_update, child_table_after_update, fields_to_check
3450):
3451 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
3452 # Check if any field affecting accounting entry is altered
3453 for index, item in enumerate(child_table_after_update):
3454 for field in fields_to_check:
3455 if child_table_before_update[index].get(field) != item.get(field):
3456 return True
3457
3458 for dimension in accounting_dimensions:
3459 if child_table_before_update[index].get(dimension) != item.get(dimension):
3460 return True
3461
3462 return False
3463
3464
Gursheen Ananda06017c2023-06-12 15:24:53 +05303465@erpnext.allow_regional
3466def validate_regional(doc):
3467 pass
3468
3469
3470@erpnext.allow_regional
3471def validate_einvoice_fields(doc):
3472 pass
3473
3474
3475@erpnext.allow_regional
3476def update_gl_dict_with_regional_fields(doc, gl_dict):
3477 pass