blob: 31ff79906f9bf469d204e437e9086d9a11107530 [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,
GangaManojd24cfff2021-10-28 20:06:48 +053025 today,
Chillar Anand915b3432021-09-02 16:44:59 +053026)
Chillar Anand915b3432021-09-02 16:44:59 +053027
28import erpnext
29from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import (
30 get_accounting_dimensions,
31)
32from erpnext.accounts.doctype.pricing_rule.utils import (
33 apply_pricing_rule_for_free_items,
34 apply_pricing_rule_on_transaction,
35 get_applied_pricing_rules,
36)
Deepesh Garg492ea3b2023-08-08 11:39:44 +053037from erpnext.accounts.general_ledger import get_round_off_account_and_cost_center
Chillar Anand915b3432021-09-02 16:44:59 +053038from erpnext.accounts.party import (
39 get_party_account,
40 get_party_account_currency,
Deepesh Garga7f15a02021-12-12 21:09:11 +053041 get_party_gle_currency,
Chillar Anand915b3432021-09-02 16:44:59 +053042 validate_party_frozen_disabled,
43)
ruthra kumar1ea1bfe2023-07-26 16:19:38 +053044from erpnext.accounts.utils import (
45 create_gain_loss_journal,
46 get_account_currency,
47 get_fiscal_years,
48 validate_fiscal_year,
49)
Chillar Anand915b3432021-09-02 16:44:59 +053050from erpnext.buying.utils import update_last_purchase_rate
51from erpnext.controllers.print_settings import (
52 set_print_templates_for_item_table,
53 set_print_templates_for_taxes,
54)
55from erpnext.controllers.sales_and_purchase_return import validate_return
56from erpnext.exceptions import InvalidCurrency
57from erpnext.setup.utils import get_exchange_rate
Ankush Menat10583eb2022-06-17 12:13:27 +053058from erpnext.stock.doctype.item.item import get_uom_conv_factor
Marica3dee5272020-06-23 10:33:47 +053059from erpnext.stock.doctype.packed_item.packed_item import make_packing_list
Chillar Anand915b3432021-09-02 16:44:59 +053060from erpnext.stock.get_item_details import (
61 _get_item_tax_template,
62 get_conversion_factor,
63 get_item_details,
64 get_item_tax_map,
65 get_item_warehouse,
66)
Sagar Vora4205f562023-07-24 18:37:36 +053067from erpnext.utilities.regional import temporary_flag
Chillar Anand915b3432021-09-02 16:44:59 +053068from erpnext.utilities.transaction_base import TransactionBase
69
Nabin Hait1d218422015-07-17 15:19:02 +053070
Ankush Menat494bd9e2022-03-28 18:52:46 +053071class AccountMissingError(frappe.ValidationError):
72 pass
marination53b1a9a2020-11-03 15:45:25 +053073
Ankush Menat494bd9e2022-03-28 18:52:46 +053074
Maricab9f5a1c2023-11-27 09:05:22 +053075class InvalidQtyError(frappe.ValidationError):
76 pass
77
78
Ankush Menat494bd9e2022-03-28 18:52:46 +053079force_item_fields = (
80 "item_group",
81 "brand",
82 "stock_uom",
83 "is_fixed_asset",
84 "item_tax_rate",
85 "pricing_rules",
86 "weight_per_unit",
87 "weight_uom",
88 "total_weight",
89)
90
Doridel Cahanap6f06cc22018-05-17 16:28:58 +080091
Nabin Haitbf495c92013-01-30 12:49:08 +053092class AccountsController(TransactionBase):
Nabin Hait7eba1a32017-10-02 15:59:27 +053093 def __init__(self, *args, **kwargs):
94 super(AccountsController, self).__init__(*args, **kwargs)
Anand Doshi979326b2015-09-11 16:22:37 +053095
prssanna71e5b602020-10-29 14:19:34 +053096 def get_print_settings(self):
97 print_setting_fields = []
Ankush Menat494bd9e2022-03-28 18:52:46 +053098 items_field = self.meta.get_field("items")
prssanna71e5b602020-10-29 14:19:34 +053099
Ankush Menat494bd9e2022-03-28 18:52:46 +0530100 if items_field and items_field.fieldtype == "Table":
101 print_setting_fields += ["compact_item_print", "print_uom_after_quantity"]
prssanna71e5b602020-10-29 14:19:34 +0530102
Ankush Menat494bd9e2022-03-28 18:52:46 +0530103 taxes_field = self.meta.get_field("taxes")
104 if taxes_field and taxes_field.fieldtype == "Table":
105 print_setting_fields += ["print_taxes_with_zero_amount"]
prssanna71e5b602020-10-29 14:19:34 +0530106
107 return print_setting_fields
108
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530109 @property
110 def company_currency(self):
111 if not hasattr(self, "__company_currency"):
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530112 self.__company_currency = erpnext.get_company_currency(self.company)
Anand Doshi979326b2015-09-11 16:22:37 +0530113
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530114 return self.__company_currency
Anand Doshi979326b2015-09-11 16:22:37 +0530115
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530116 def onload(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530117 self.set_onload(
118 "make_payment_via_journal_entry",
119 frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"),
120 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530121
tundee52bb822017-09-25 09:02:23 +0100122 if self.is_new():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530123 relevant_docs = (
124 "Quotation",
125 "Purchase Order",
126 "Sales Order",
127 "Purchase Invoice",
128 "Sales Invoice",
129 )
tundee52bb822017-09-25 09:02:23 +0100130 if self.doctype in relevant_docs:
131 self.set_payment_schedule()
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530132
rohitwaghchauref09e2132024-01-04 14:58:02 +0530133 def remove_bundle_for_non_stock_invoices(self):
134 has_sabb = False
135 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.update_stock:
136 for item in self.get("items"):
137 if item.serial_and_batch_bundle:
138 item.serial_and_batch_bundle = None
139 has_sabb = True
140
141 if has_sabb:
142 self.remove_serial_and_batch_bundle()
143
tundebabzyad08d4c2018-05-16 07:01:41 +0100144 def ensure_supplier_is_not_blocked(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530145 is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier"
146 is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"]
tundebabzyad08d4c2018-05-16 07:01:41 +0100147 supplier = None
148 supplier_name = None
149
150 if is_buying_invoice or is_supplier_payment:
151 supplier_name = self.supplier if is_buying_invoice else self.party
Ankush Menat494bd9e2022-03-28 18:52:46 +0530152 supplier = frappe.get_doc("Supplier", supplier_name)
tundebabzyad08d4c2018-05-16 07:01:41 +0100153
154 if supplier and supplier_name and supplier.on_hold:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530155 if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or (
156 is_supplier_payment and supplier.hold_type in ["All", "Payments"]
157 ):
tundebabzyad08d4c2018-05-16 07:01:41 +0100158 if not supplier.release_date or getdate(nowdate()) <= supplier.release_date:
159 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530160 _("{0} is blocked so this transaction cannot proceed").format(supplier_name),
161 raise_exception=1,
162 )
tundebabzyad08d4c2018-05-16 07:01:41 +0100163
Saurabh6f753182013-03-20 12:55:28 +0530164 def validate(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530165 if not self.get("is_return") and not self.get("is_debit_note"):
Deepesh Gargd301d262019-07-31 15:58:19 +0530166 self.validate_qty_is_not_zero()
167
nabinhait23cce732014-07-03 12:25:06 +0530168 if self.get("_action") and self._action != "update_after_submit":
Nabin Hait704a4532014-06-05 16:55:31 +0530169 self.set_missing_values(for_validate=True)
tunde62af5c52017-09-22 15:16:38 +0100170
rohitwaghchauref09e2132024-01-04 14:58:02 +0530171 if self.get("_action") == "submit":
172 self.remove_bundle_for_non_stock_invoices()
173
tundebabzyad08d4c2018-05-16 07:01:41 +0100174 self.ensure_supplier_is_not_blocked()
175
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530176 self.validate_date_with_fiscal_year()
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530177 self.validate_party_accounts()
178
Deepesh Gargb4be2922021-01-28 13:09:56 +0530179 self.validate_inter_company_reference()
180
Ankush Menat3714e362022-05-16 18:09:14 +0530181 self.disable_pricing_rule_on_internal_transfer()
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530182 self.disable_tax_included_prices_for_internal_transfer()
Deepesh Gargb4be2922021-01-28 13:09:56 +0530183 self.set_incoming_rate()
Deepesh Garg25889702023-12-12 15:18:54 +0530184 self.init_internal_values()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530185
Anand Doshi3543f302013-05-24 19:25:01 +0530186 if self.meta.get_field("currency"):
Anand Doshi923d41d2013-05-28 17:23:36 +0530187 self.calculate_taxes_and_totals()
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530188
Nabin Hait1d218422015-07-17 15:19:02 +0530189 if not self.meta.get_field("is_return") or not self.is_return:
190 self.validate_value("base_grand_total", ">=", 0)
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530191
Nabin Hait3cf67a42015-07-24 13:26:36 +0530192 validate_return(self)
Anand Doshid2946502014-04-08 20:10:03 +0530193
tunde62af5c52017-09-22 15:16:38 +0100194 self.validate_all_documents_schedule()
Anand Doshid2946502014-04-08 20:10:03 +0530195
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530196 if self.meta.get_field("taxes_and_charges"):
197 self.validate_enabled_taxes_and_charges()
Nabin Haita2426fc2018-01-15 17:45:46 +0530198 self.validate_tax_account_company()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530199
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +0530200 self.validate_party()
Nabin Hait895029d2015-08-20 14:55:39 +0530201 self.validate_currency()
Deepesh Garg80c85dd2021-08-12 15:39:07 +0530202 self.validate_party_account_currency()
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530203
Ankush Menat494bd9e2022-03-28 18:52:46 +0530204 if self.doctype in ["Purchase Invoice", "Sales Invoice"]:
ruthra kumar0cdd6432023-10-11 14:42:23 +0530205 if invalid_advances := [
206 x for x in self.advances if not x.reference_type or not x.reference_name
207 ]:
208 frappe.throw(
209 _(
210 "Rows: {0} in {1} section are Invalid. Reference Name should point to a valid Payment Entry or Journal Entry."
211 ).format(
212 frappe.bold(comma_and([x.idx for x in invalid_advances])), frappe.bold(_("Advance Payments"))
213 )
214 )
215
Ankush Menat494bd9e2022-03-28 18:52:46 +0530216 pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid"
Nabin Hait4a994d42019-04-25 17:47:26 +0530217 if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)):
Nabin Hait041a5c22018-08-01 18:07:39 +0530218 self.set_advances()
219
Saqiba20999c2021-07-12 14:33:23 +0530220 self.set_advance_gain_or_loss()
221
Nabin Hait041a5c22018-08-01 18:07:39 +0530222 if self.is_return:
223 self.validate_qty()
Nabin Haitacdd5082019-12-04 15:30:01 +0530224 else:
225 self.validate_deferred_start_and_end_date()
rohitwaghchaure70489252018-06-11 12:02:14 +0530226
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530227 self.validate_deferred_income_expense_account()
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530228 self.set_inter_company_account()
229
Ankush Menat494bd9e2022-03-28 18:52:46 +0530230 if self.doctype == "Purchase Invoice":
Deepesh Garg7f06c8c2021-11-26 10:27:57 +0530231 self.calculate_paid_amount()
232 # apply tax withholding only if checked and applicable
233 self.set_tax_withholding()
234
Dany Robert9bc59522023-08-26 18:14:40 +0530235 with temporary_flag("company", self.company):
236 validate_regional(self)
237 validate_einvoice_fields(self)
Saqib Ansaric5782b02022-01-27 20:09:56 +0530238
Deepesh Gargb741ae12022-12-02 17:14:06 +0530239 if self.doctype != "Material Request" and not self.ignore_pricing_rule:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530240 apply_pricing_rule_on_transaction(self)
Gauravf1e28e02019-02-13 16:46:24 +0530241
RitvikSardana03f0abf2023-09-19 13:08:17 +0530242 self.set_total_in_words()
Deepesh Garg3b4b2272023-12-29 08:25:38 +0530243 self.set_default_letter_head()
244
245 def set_default_letter_head(self):
246 if hasattr(self, "letter_head") and not self.letter_head:
247 self.letter_head = frappe.db.get_value("Company", self.company, "default_letter_head")
RitvikSardana03f0abf2023-09-19 13:08:17 +0530248
Deepesh Garg25889702023-12-12 15:18:54 +0530249 def init_internal_values(self):
250 # init all the internal values as 0 on sa
251 if self.docstatus.is_draft():
252 # TODO: Add all such pending values here
253 fields = ["billed_amt", "delivered_qty"]
254 for item in self.get("items"):
255 for field in fields:
256 if hasattr(item, field):
257 item.set(field, 0)
258
Saqib Ansaric5782b02022-01-27 20:09:56 +0530259 def before_cancel(self):
260 validate_einvoice_fields(self)
261
ruthra kumar42df0d32023-08-28 17:36:12 +0530262 def _remove_references_in_unreconcile(self):
ruthra kumar9a1588f2023-08-30 20:50:16 +0530263 upe = frappe.qb.DocType("Unreconcile Payment Entries")
ruthra kumar42df0d32023-08-28 17:36:12 +0530264 rows = (
265 frappe.qb.from_(upe)
266 .select(upe.name, upe.parent)
267 .where((upe.reference_doctype == self.doctype) & (upe.reference_name == self.name))
268 .run(as_dict=True)
269 )
270
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530271 if rows:
272 references_map = frappe._dict()
273 for x in rows:
274 references_map.setdefault(x.parent, []).append(x.name)
ruthra kumar42df0d32023-08-28 17:36:12 +0530275
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530276 for doc, rows in references_map.items():
ruthra kumar74f9e342023-11-21 16:51:06 +0530277 unreconcile_doc = frappe.get_doc("Unreconcile Payment", doc)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530278 for row in rows:
279 unreconcile_doc.remove(unreconcile_doc.get("allocations", {"name": row})[0])
ruthra kumar42df0d32023-08-28 17:36:12 +0530280
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530281 unreconcile_doc.flags.ignore_validate_update_after_submit = True
282 unreconcile_doc.flags.ignore_links = True
283 unreconcile_doc.save(ignore_permissions=True)
284
285 # delete docs upon parent doc deletion
ruthra kumar74f9e342023-11-21 16:51:06 +0530286 unreconcile_docs = frappe.db.get_all("Unreconcile Payment", filters={"voucher_no": self.name})
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530287 for x in unreconcile_docs:
ruthra kumar74f9e342023-11-21 16:51:06 +0530288 _doc = frappe.get_doc("Unreconcile Payment", x.name)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530289 if _doc.docstatus == 1:
290 _doc.cancel()
291 _doc.delete()
ruthra kumar42df0d32023-08-28 17:36:12 +0530292
ruthra kumared7f67b2023-09-26 14:23:21 +0530293 def _remove_references_in_repost_doctypes(self):
294 repost_doctypes = ["Repost Payment Ledger Items", "Repost Accounting Ledger Items"]
ruthra kumarc722f282023-02-19 12:09:10 +0530295
ruthra kumared7f67b2023-09-26 14:23:21 +0530296 for _doctype in repost_doctypes:
297 dt = frappe.qb.DocType(_doctype)
298 rows = (
299 frappe.qb.from_(dt)
300 .select(dt.name, dt.parent, dt.parenttype)
301 .where((dt.voucher_type == self.doctype) & (dt.voucher_no == self.name))
302 .run(as_dict=True)
303 )
304
305 if rows:
306 references_map = frappe._dict()
307 for x in rows:
308 references_map.setdefault((x.parenttype, x.parent), []).append(x.name)
309
310 for doc, rows in references_map.items():
311 repost_doc = frappe.get_doc(doc[0], doc[1])
312
313 for row in rows:
314 if _doctype == "Repost Payment Ledger Items":
315 repost_doc.remove(repost_doc.get("repost_vouchers", {"name": row})[0])
316 else:
317 repost_doc.remove(repost_doc.get("vouchers", {"name": row})[0])
318
319 repost_doc.flags.ignore_validate_update_after_submit = True
320 repost_doc.flags.ignore_links = True
321 repost_doc.save(ignore_permissions=True)
322
323 def on_trash(self):
324 self._remove_references_in_repost_doctypes()
ruthra kumar42df0d32023-08-28 17:36:12 +0530325 self._remove_references_in_unreconcile()
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530326 self.remove_serial_and_batch_bundle()
ruthra kumarfbdfb812023-08-28 16:27:29 +0530327
Saqib8e556772021-01-28 12:26:45 +0530328 # delete sl and gl entries on deletion of transaction
Ankush Menat494bd9e2022-03-28 18:52:46 +0530329 if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"):
ruthra kumar70313df2022-09-08 18:53:30 +0530330 ple = frappe.qb.DocType("Payment Ledger Entry")
331 frappe.qb.from_(ple).delete().where(
332 (ple.voucher_type == self.doctype) & (ple.voucher_no == self.name)
333 ).run()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530334 frappe.db.sql(
335 "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)
336 )
337 frappe.db.sql(
338 "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s",
339 (self.doctype, self.name),
340 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530341
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530342 def remove_serial_and_batch_bundle(self):
343 bundles = frappe.get_all(
344 "Serial and Batch Bundle",
345 filters={"voucher_type": self.doctype, "voucher_no": self.name, "docstatus": ("!=", 1)},
346 )
347
348 for bundle in bundles:
349 frappe.delete_doc("Serial and Batch Bundle", bundle.name)
350
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530351 def validate_deferred_income_expense_account(self):
352 field_map = {
353 "Sales Invoice": "deferred_revenue_account",
354 "Purchase Invoice": "deferred_expense_account",
355 }
356
357 for item in self.get("items"):
358 if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"):
359 if not item.get(field_map.get(self.doctype)):
Daizy Modi4efc9472022-11-07 09:21:03 +0530360 default_deferred_account = frappe.get_cached_value(
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530361 "Company", self.company, "default_" + field_map.get(self.doctype)
362 )
363 if not default_deferred_account:
364 frappe.throw(
365 _(
366 "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master"
367 ).format(item.idx)
368 )
369 else:
370 item.set(field_map.get(self.doctype), default_deferred_account)
371
Deepesh Gargfa152212022-11-28 19:22:35 +0530372 def validate_auto_repeat_subscription_dates(self):
Deepesh Garg6a47fb62022-11-28 22:47:44 +0530373 if (
374 self.get("from_date")
375 and self.get("to_date")
376 and getdate(self.from_date) > getdate(self.to_date)
377 ):
Deepesh Gargfa152212022-11-28 19:22:35 +0530378 frappe.throw(_("To Date cannot be before From Date"), title=_("Invalid Auto Repeat Date"))
379
Nabin Haitacdd5082019-12-04 15:30:01 +0530380 def validate_deferred_start_and_end_date(self):
381 for d in self.items:
382 if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"):
383 if not (d.service_start_date and d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530384 frappe.throw(
385 _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)
386 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530387 elif getdate(d.service_start_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530388 frappe.throw(
389 _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)
390 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530391 elif getdate(self.posting_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530392 frappe.throw(
393 _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)
394 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530395
tunde62af5c52017-09-22 15:16:38 +0100396 def validate_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530397 self.validate_payment_schedule_dates()
398 self.set_due_date()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530399 self.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530400 if not self.get("ignore_default_payment_terms_template"):
Deepesh Garg5c758942023-04-16 17:11:24 +0530401 self.validate_payment_schedule_amount()
Deepesh Gargbd709f82021-08-23 19:05:52 +0530402 self.validate_due_date()
tunde62af5c52017-09-22 15:16:38 +0100403 self.validate_advance_entries()
404
405 def validate_non_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530406 self.set_payment_schedule()
Nabin Hait2f9f4f92017-12-20 12:24:59 +0530407 self.validate_payment_schedule_dates()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530408 self.validate_payment_schedule_amount()
tunde62af5c52017-09-22 15:16:38 +0100409
410 def validate_all_documents_schedule(self):
411 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.is_return:
412 self.validate_invoice_documents_schedule()
413 elif self.doctype in ("Quotation", "Purchase Order", "Sales Order"):
414 self.validate_non_invoice_documents_schedule()
415
prssanna71e5b602020-10-29 14:19:34 +0530416 def before_print(self, settings=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530417 if self.doctype in [
418 "Purchase Order",
419 "Sales Order",
420 "Sales Invoice",
421 "Purchase Invoice",
422 "Supplier Quotation",
423 "Purchase Receipt",
424 "Delivery Note",
425 "Quotation",
426 ]:
KanchanChauhan49a50fe2016-11-18 13:57:53 +0530427 if self.get("group_same_items"):
428 self.group_similar_items()
429
Zarrar5be6d192018-11-08 12:16:26 +0530430 df = self.meta.get_field("discount_amount")
431 if self.get("discount_amount") and hasattr(self, "taxes") and not len(self.taxes):
432 df.set("print_hide", 0)
433 self.discount_amount = -self.discount_amount
434 else:
435 df.set("print_hide", 1)
436
prssanna71e5b602020-10-29 14:19:34 +0530437 set_print_templates_for_item_table(self, settings)
438 set_print_templates_for_taxes(self, settings)
439
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530440 def calculate_paid_amount(self):
Saurabh43520f92016-03-21 18:32:48 +0530441 if hasattr(self, "is_pos") or hasattr(self, "is_paid"):
442 is_paid = self.get("is_pos") or self.get("is_paid")
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530443
444 if is_paid:
445 if not self.cash_bank_account:
446 # show message that the amount is not paid
Ankush Menat494bd9e2022-03-28 18:52:46 +0530447 frappe.throw(
448 _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")
449 )
Marica23d7b092019-09-25 17:17:36 +0530450
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530451 if cint(self.is_return) and self.grand_total > self.paid_amount:
452 self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount"))
453
454 elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0:
455 self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount"))
456
Ankush Menat494bd9e2022-03-28 18:52:46 +0530457 self.base_paid_amount = flt(
458 self.paid_amount * self.conversion_rate, self.precision("base_paid_amount")
459 )
Saurabh43520f92016-03-21 18:32:48 +0530460
Anand Doshiabc10032013-06-14 17:44:03 +0530461 def set_missing_values(self, for_validate=False):
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530462 if frappe.flags.in_test:
tunde62af5c52017-09-22 15:16:38 +0100463 for fieldname in ["posting_date", "transaction_date"]:
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530464 if self.meta.get_field(fieldname) and not self.get(fieldname):
465 self.set(fieldname, today())
466 break
Anand Doshid2946502014-04-08 20:10:03 +0530467
Nabin Hait3237c752015-02-17 11:11:11 +0530468 def calculate_taxes_and_totals(self):
Nabin Haitfe81da22015-02-18 12:23:18 +0530469 from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals
Ankush Menat494bd9e2022-03-28 18:52:46 +0530470
Nabin Haitfe81da22015-02-18 12:23:18 +0530471 calculate_taxes_and_totals(self)
Nabin Hait3237c752015-02-17 11:11:11 +0530472
Raffael Meyere10ab162021-11-30 13:24:18 +0100473 if self.doctype in (
Ankush Menat494bd9e2022-03-28 18:52:46 +0530474 "Sales Order",
475 "Delivery Note",
476 "Sales Invoice",
477 "POS Invoice",
Raffael Meyere10ab162021-11-30 13:24:18 +0100478 ):
Nabin Hait3237c752015-02-17 11:11:11 +0530479 self.calculate_commission()
480 self.calculate_contribution()
481
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530482 def validate_date_with_fiscal_year(self):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +0800483 if self.meta.get_field("fiscal_year"):
Rohan Bansal1e3a3b22021-05-26 15:18:10 +0530484 date_field = None
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530485 if self.meta.get_field("posting_date"):
486 date_field = "posting_date"
487 elif self.meta.get_field("transaction_date"):
488 date_field = "transaction_date"
Anand Doshid2946502014-04-08 20:10:03 +0530489
Rushabh Mehtaf2227d02014-03-31 23:37:40 +0530490 if date_field and self.get(date_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530491 validate_fiscal_year(
492 self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self
493 )
Anand Doshid2946502014-04-08 20:10:03 +0530494
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530495 def validate_party_accounts(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530496 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530497 return
498
Ankush Menat494bd9e2022-03-28 18:52:46 +0530499 if self.doctype == "Sales Invoice":
500 party_account_field = "debit_to"
501 item_field = "income_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530502 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530503 party_account_field = "credit_to"
504 item_field = "expense_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530505
Ankush Menat494bd9e2022-03-28 18:52:46 +0530506 for item in self.get("items"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530507 if item.get(item_field) == self.get(party_account_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530508 frappe.throw(
509 _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(
510 item.idx,
511 frappe.bold(frappe.unscrub(item_field)),
512 item.get(item_field),
513 frappe.bold(frappe.unscrub(party_account_field)),
514 self.get(party_account_field),
515 )
516 )
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530517
Deepesh Gargb4be2922021-01-28 13:09:56 +0530518 def validate_inter_company_reference(self):
Rohit Waghchaure38aaba52023-05-13 13:00:05 +0530519 if self.get("is_return"):
520 return
521
Rohit Waghchaureb4a102d2022-09-06 16:22:00 +0530522 if self.doctype not in ("Purchase Invoice", "Purchase Receipt"):
Deepesh Gargb4be2922021-01-28 13:09:56 +0530523 return
524
525 if self.is_internal_transfer():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530526 if not (
527 self.get("inter_company_reference")
528 or self.get("inter_company_invoice_reference")
529 or self.get("inter_company_order_reference")
Deepesh Garg906ad102023-01-15 17:32:57 +0530530 ) and not self.get("is_return"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530531 msg = _("Internal Sale or Delivery Reference missing.")
Deepesh Gargb4be2922021-01-28 13:09:56 +0530532 msg += _("Please create purchase from internal sale or delivery document itself")
533 frappe.throw(msg, title=_("Internal Sales Reference Missing"))
534
Rohit Waghchaure19911b42023-04-21 16:49:48 +0530535 label = "Delivery Note Item" if self.doctype == "Purchase Receipt" else "Sales Invoice Item"
536
537 field = frappe.scrub(label)
538
539 for row in self.get("items"):
540 if not row.get(field):
541 msg = f"At Row {row.idx}: The field {bold(label)} is mandatory for internal transfer"
542 frappe.throw(_(msg), title=_("Internal Transfer Reference Missing"))
543
Ankush Menat3714e362022-05-16 18:09:14 +0530544 def disable_pricing_rule_on_internal_transfer(self):
545 if not self.get("ignore_pricing_rule") and self.is_internal_transfer():
546 self.ignore_pricing_rule = 1
547 frappe.msgprint(
548 _("Disabled pricing rules since this {} is an internal transfer").format(self.doctype),
549 alert=1,
550 )
551
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530552 def disable_tax_included_prices_for_internal_transfer(self):
553 if self.is_internal_transfer():
554 tax_updated = False
555 for tax in self.get("taxes"):
556 if tax.get("included_in_print_rate"):
557 tax.included_in_print_rate = 0
558 tax_updated = True
559
560 if tax_updated:
561 frappe.msgprint(
562 _("Disabled tax included prices since this {} is an internal transfer").format(self.doctype),
563 alert=1,
564 )
565
Nabin Haite9daefe2014-08-27 16:46:33 +0530566 def validate_due_date(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530567 if self.get("is_pos"):
568 return
rohitwaghchaureea943c62018-07-06 12:28:58 +0530569
Nabin Haite9daefe2014-08-27 16:46:33 +0530570 from erpnext.accounts.party import validate_due_date
Ankush Menat494bd9e2022-03-28 18:52:46 +0530571
Nabin Haite9daefe2014-08-27 16:46:33 +0530572 if self.doctype == "Sales Invoice":
Nabin Hait04d244a2015-07-22 17:47:49 +0530573 if not self.due_date:
574 frappe.throw(_("Due Date is mandatory"))
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530575
Ankush Menat494bd9e2022-03-28 18:52:46 +0530576 validate_due_date(
577 self.posting_date,
578 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530579 self.payment_terms_template,
580 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530581 elif self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530582 validate_due_date(
583 self.bill_date or self.posting_date,
584 self.due_date,
Ankush Menat494bd9e2022-03-28 18:52:46 +0530585 self.bill_date,
586 self.payment_terms_template,
587 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530588
Nabin Hait096d3632013-10-17 17:01:14 +0530589 def set_price_list_currency(self, buying_or_selling):
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530590 if self.meta.get_field("posting_date"):
Nabin Hait288a18e2016-12-08 15:36:23 +0530591 transaction_date = self.posting_date
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530592 else:
Nabin Hait288a18e2016-12-08 15:36:23 +0530593 transaction_date = self.transaction_date
Rushabh Mehta66958302017-01-16 16:57:53 +0530594
Rushabh Mehta4a404e92013-08-09 18:11:35 +0530595 if self.meta.get_field("currency"):
Nabin Hait7a75e102013-09-17 10:21:20 +0530596 # price list part
Shreya3f778522018-05-15 16:59:20 +0530597 if buying_or_selling.lower() == "selling":
598 fieldname = "selling_price_list"
599 args = "for_selling"
600 else:
601 fieldname = "buying_price_list"
602 args = "for_buying"
603
Anand Doshif78d1ae2014-03-28 13:55:00 +0530604 if self.meta.get_field(fieldname) and self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530605 self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency")
Anand Doshid2946502014-04-08 20:10:03 +0530606
Nabin Hait6e439a52015-08-28 19:24:22 +0530607 if self.price_list_currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530608 self.plc_conversion_rate = 1.0
Nabin Hait11f41952013-09-24 14:36:55 +0530609
Anand Doshif78d1ae2014-03-28 13:55:00 +0530610 elif not self.plc_conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530611 self.plc_conversion_rate = get_exchange_rate(
612 self.price_list_currency, self.company_currency, transaction_date, args
613 )
Anand Doshid2946502014-04-08 20:10:03 +0530614
Nabin Hait7a75e102013-09-17 10:21:20 +0530615 # currency
Anand Doshif78d1ae2014-03-28 13:55:00 +0530616 if not self.currency:
617 self.currency = self.price_list_currency
618 self.conversion_rate = self.plc_conversion_rate
Nabin Hait6e439a52015-08-28 19:24:22 +0530619 elif self.currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530620 self.conversion_rate = 1.0
621 elif not self.conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530622 self.conversion_rate = get_exchange_rate(
623 self.currency, self.company_currency, transaction_date, args
624 )
Nabin Hait7a75e102013-09-17 10:21:20 +0530625
ruthra kumar08315522023-10-03 09:53:41 +0530626 if (
627 self.currency
628 and buying_or_selling == "Buying"
629 and frappe.db.get_single_value("Buying Settings", "use_transaction_date_exchange_rate")
630 and self.doctype == "Purchase Invoice"
631 ):
632 self.use_transaction_date_exchange_rate = True
633 self.conversion_rate = get_exchange_rate(
634 self.currency, self.company_currency, transaction_date, args
635 )
636
Nabin Haitcccc45e2016-10-05 17:15:43 +0530637 def set_missing_item_details(self, for_validate=False):
Anand Doshi3543f302013-05-24 19:25:01 +0530638 """set missing item values"""
Nabin Haitf37d43d2017-07-18 12:14:42 +0530639 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530640
Nabin Haitdd38a262014-12-26 13:15:21 +0530641 if hasattr(self, "items"):
Nabin Hait444f9562014-06-20 15:59:49 +0530642 parent_dict = {}
Pratik Vyasf7daab72014-04-10 17:53:30 +0530643 for fieldname in self.meta.get_valid_columns():
644 parent_dict[fieldname] = self.get(fieldname)
645
mbauskara52472c2016-03-05 15:10:25 +0530646 if self.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
647 document_type = "{} Item".format(self.doctype)
mbauskarc97becb2016-01-18 16:28:21 +0530648 parent_dict.update({"document_type": document_type})
649
Nabin Hait34c551d2019-07-03 10:34:31 +0530650 # party_name field used for customer in quotation
Ankush Menat494bd9e2022-03-28 18:52:46 +0530651 if (
652 self.doctype == "Quotation"
653 and self.quotation_to == "Customer"
654 and parent_dict.get("party_name")
655 ):
Nabin Hait34c551d2019-07-03 10:34:31 +0530656 parent_dict.update({"customer": parent_dict.get("party_name")})
657
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530658 self.pricing_rules = []
Deepesh Garg4c61ee32023-04-02 09:35:27 +0530659
Nabin Haitdd38a262014-12-26 13:15:21 +0530660 for item in self.get("items"):
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530661 if item.get("item_code"):
Nabin Hait444f9562014-06-20 15:59:49 +0530662 args = parent_dict.copy()
663 args.update(item.as_dict())
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530664
Nabin Hait34d28222016-01-19 15:45:49 +0530665 args["doctype"] = self.doctype
666 args["name"] = self.name
Smit Vorab206b052023-11-23 15:10:47 +0530667 args["child_doctype"] = item.doctype
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530668 args["child_docname"] = item.name
Ankush Menat494bd9e2022-03-28 18:52:46 +0530669 args["ignore_pricing_rule"] = (
670 self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0
671 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530672
Nabin Haite2f054c2015-03-09 14:54:37 +0530673 if not args.get("transaction_date"):
674 args["transaction_date"] = args.get("posting_date")
Anand Doshi2b2b6392015-03-20 14:18:09 +0530675
676 if self.get("is_subcontracted"):
677 args["is_subcontracted"] = self.is_subcontracted
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530678
Deepesh Garga7051cb2023-04-14 09:59:42 +0530679 ret = get_item_details(args, self, for_validate=True, overwrite_warehouse=False)
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530680
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530681 for fieldname, value in ret.items():
Anand Doshi602e8252015-11-16 19:05:46 +0530682 if item.meta.get_field(fieldname) and value is not None:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530683 if item.get(fieldname) is None or fieldname in force_item_fields:
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530684 item.set(fieldname, value)
Anand Doshid2946502014-04-08 20:10:03 +0530685
Ankush Menat494bd9e2022-03-28 18:52:46 +0530686 elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname):
Anand Doshi602e8252015-11-16 19:05:46 +0530687 item.set(fieldname, value)
688
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530689 elif fieldname == "serial_no":
Alchez9155e402018-07-09 16:57:42 +0530690 # Ensure that serial numbers are matched against Stock UOM
691 item_conversion_factor = item.get("conversion_factor") or 1.0
692 item_qty = abs(item.get("qty")) * item_conversion_factor
Alchez8f2a0f32018-07-06 14:36:52 +0530693
Ankush Menat494bd9e2022-03-28 18:52:46 +0530694 if item_qty != len(get_serial_nos(item.get("serial_no"))):
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530695 item.set(fieldname, value)
Nabin Haita74468b2014-12-30 18:33:52 +0530696
Saqib Ansariab36b272022-02-09 10:10:17 +0530697 elif (
698 ret.get("pricing_rule_removed")
699 and value is not None
700 and fieldname
701 in [
702 "discount_percentage",
703 "discount_amount",
704 "rate",
705 "margin_rate_or_amount",
706 "margin_type",
707 "remove_free_item",
708 ]
709 ):
Saqib Ansarib8c41e32022-01-20 13:06:08 +0530710 # reset pricing rule fields if pricing_rule_removed
711 item.set(fieldname, value)
712
Ankush Menat494bd9e2022-03-28 18:52:46 +0530713 if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field(
714 "is_fixed_asset"
715 ):
716 item.set("is_fixed_asset", ret.get("is_fixed_asset", 0))
Rohit Waghchauref6f503a2018-12-19 15:06:44 +0530717
Deepesh Garga60c3082021-05-11 16:38:33 +0530718 # Double check for cost center
719 # Items add via promotional scheme may not have cost center set
Ankush Menat494bd9e2022-03-28 18:52:46 +0530720 if hasattr(item, "cost_center") and not item.get("cost_center"):
721 item.set(
722 "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company)
723 )
Deepesh Garga60c3082021-05-11 16:38:33 +0530724
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530725 if ret.get("pricing_rules"):
726 self.apply_pricing_rule_on_items(item, ret)
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530727 self.set_pricing_rule_details(item, ret)
Ankush Menat10583eb2022-06-17 12:13:27 +0530728 else:
729 # Transactions line item without item code
730
731 uom = item.get("uom")
732 stock_uom = item.get("stock_uom")
733 if bool(uom) != bool(stock_uom): # xor
734 item.stock_uom = item.uom = uom or stock_uom
735
Deepesh Garg61751832022-12-29 10:41:36 +0530736 # UOM cannot be zero so substitute as 1
737 item.conversion_factor = (
738 get_uom_conv_factor(item.get("uom"), item.get("stock_uom"))
739 or item.get("conversion_factor")
740 or 1
741 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530742
Nabin Hait14aa9c52016-04-18 15:54:01 +0530743 if self.doctype == "Purchase Invoice":
Nabin Haitcccc45e2016-10-05 17:15:43 +0530744 self.set_expense_account(for_validate)
Nabin Haita3dd72a2014-05-28 12:49:20 +0530745
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530746 def apply_pricing_rule_on_items(self, item, pricing_rule_args):
747 if not pricing_rule_args.get("validate_applied_rule", 0):
748 # if user changed the discount percentage then set user's discount percentage ?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530749 if pricing_rule_args.get("price_or_product_discount") == "Price":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530750 item.set("pricing_rules", pricing_rule_args.get("pricing_rules"))
Rohit Waghchauref5bd3fa2022-09-16 15:23:10 +0530751 if pricing_rule_args.get("apply_rule_on_other_items"):
752 other_items = json.loads(pricing_rule_args.get("apply_rule_on_other_items"))
753 if other_items and item.item_code not in other_items:
754 return
755
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530756 item.set("discount_percentage", pricing_rule_args.get("discount_percentage"))
757 item.set("discount_amount", pricing_rule_args.get("discount_amount"))
758 if pricing_rule_args.get("pricing_rule_for") == "Rate":
759 item.set("price_list_rate", pricing_rule_args.get("price_list_rate"))
760
761 if item.get("price_list_rate"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530762 item.rate = flt(
763 item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)),
764 item.precision("rate"),
765 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530766
Ankush Menat494bd9e2022-03-28 18:52:46 +0530767 if item.get("discount_amount"):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530768 item.rate = item.price_list_rate - item.discount_amount
769
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530770 if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"):
771 item.rate = pricing_rule_args.get("rate")
772
Ankush Menat494bd9e2022-03-28 18:52:46 +0530773 elif pricing_rule_args.get("free_item_data"):
774 apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data"))
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530775
776 elif pricing_rule_args.get("validate_applied_rule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530777 for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530778 pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530779 for field in ["discount_percentage", "discount_amount", "rate"]:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530780 if item.get(field) < pricing_rule_doc.get(field):
781 title = get_link_to_form("Pricing Rule", pricing_rule)
782
Ankush Menat494bd9e2022-03-28 18:52:46 +0530783 frappe.msgprint(
784 _("Row {0}: user has not applied the rule {1} on the item {2}").format(
785 item.idx, frappe.bold(title), frappe.bold(item.item_code)
786 )
787 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530788
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530789 def set_pricing_rule_details(self, item_row, args):
790 pricing_rules = get_applied_pricing_rules(args.get("pricing_rules"))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530791 if not pricing_rules:
792 return
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530793
794 for pricing_rule in pricing_rules:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530795 self.append(
796 "pricing_rules",
797 {
798 "pricing_rule": pricing_rule,
799 "item_code": item_row.item_code,
800 "child_docname": item_row.name,
801 "rule_applied": True,
802 },
803 )
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530804
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530805 def set_taxes(self):
806 if not self.meta.get_field("taxes"):
Anand Doshi3543f302013-05-24 19:25:01 +0530807 return
Anand Doshid2946502014-04-08 20:10:03 +0530808
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530809 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530810
rohitwaghchaure57914f12018-04-24 19:19:47 +0530811 if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"):
rohitwaghchaure505661b2017-12-11 14:52:28 +0530812 if self.company and not self.get("taxes_and_charges"):
Anand Doshi3543f302013-05-24 19:25:01 +0530813 # get the default tax master
Ankush Menat494bd9e2022-03-28 18:52:46 +0530814 self.taxes_and_charges = frappe.db.get_value(
815 tax_master_doctype, {"is_default": 1, "company": self.company}
816 )
Anand Doshid2946502014-04-08 20:10:03 +0530817
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530818 self.append_taxes_from_master(tax_master_doctype)
Anand Doshid2946502014-04-08 20:10:03 +0530819
rohitwaghchaure57914f12018-04-24 19:19:47 +0530820 def is_pos_profile_changed(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530821 if (
822 self.doctype == "Sales Invoice"
823 and self.is_pos
824 and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile")
825 ):
rohitwaghchaure57914f12018-04-24 19:19:47 +0530826 return True
827
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530828 def append_taxes_from_master(self, tax_master_doctype=None):
829 if self.get("taxes_and_charges"):
Anand Doshi99100a42013-07-04 17:13:53 +0530830 if not tax_master_doctype:
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530831 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530832
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530833 self.extend("taxes", get_taxes_and_charges(tax_master_doctype, self.get("taxes_and_charges")))
Akhilesh Darjee4cdb7992014-01-30 13:56:57 +0530834
Anand Doshiac32bad2014-04-18 01:30:14 +0530835 def set_other_charges(self):
Nabin Haite7d15362014-12-25 16:01:55 +0530836 self.set("taxes", [])
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530837 self.set_taxes()
Anand Doshid2946502014-04-08 20:10:03 +0530838
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530839 def validate_enabled_taxes_and_charges(self):
840 taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges")
Shariq Ansari21c11412023-08-17 12:14:13 +0530841 if self.taxes_and_charges and frappe.get_cached_value(
842 taxes_and_charges_doctype, self.taxes_and_charges, "disabled"
843 ):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530844 frappe.throw(
845 _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)
846 )
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530847
Nabin Haita2426fc2018-01-15 17:45:46 +0530848 def validate_tax_account_company(self):
849 for d in self.get("taxes"):
850 if d.account_head:
Daizy Modi4efc9472022-11-07 09:21:03 +0530851 tax_account_company = frappe.get_cached_value("Account", d.account_head, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +0530852 if tax_account_company != self.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530853 frappe.throw(
854 _("Row #{0}: Account {1} does not belong to company {2}").format(
855 d.idx, d.account_head, self.company
856 )
857 )
Nabin Haita2426fc2018-01-15 17:45:46 +0530858
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530859 def get_gl_dict(self, args, account_currency=None, item=None):
Nabin Hait2df4d542013-01-29 11:34:39 +0530860 """this method populates the common properties of a gl entry record"""
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530861
Ankush Menat494bd9e2022-03-28 18:52:46 +0530862 posting_date = args.get("posting_date") or self.get("posting_date")
Rohit Waghchaureaa7b4342018-05-11 01:56:05 +0530863 fiscal_years = get_fiscal_years(posting_date, company=self.company)
Nabin Hait2ed0b592016-03-29 13:14:17 +0530864 if len(fiscal_years) > 1:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530865 frappe.throw(
866 _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format(
867 formatdate(posting_date)
868 )
869 )
Nabin Hait2ed0b592016-03-29 13:14:17 +0530870 else:
871 fiscal_year = fiscal_years[0][0]
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530872
Ankush Menat494bd9e2022-03-28 18:52:46 +0530873 gl_dict = frappe._dict(
874 {
875 "company": self.company,
876 "posting_date": posting_date,
877 "fiscal_year": fiscal_year,
878 "voucher_type": self.doctype,
879 "voucher_no": self.name,
880 "remarks": self.get("remarks") or self.get("remark"),
881 "debit": 0,
882 "credit": 0,
883 "debit_in_account_currency": 0,
884 "credit_in_account_currency": 0,
885 "is_opening": self.get("is_opening") or "No",
886 "party_type": None,
887 "party": None,
888 "project": self.get("project"),
889 "post_net_value": args.get("post_net_value"),
Deepesh Gargda6bc1a2023-06-23 20:57:51 +0530890 "voucher_detail_no": args.get("voucher_detail_no"),
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530891 "voucher_subtype": self.get_voucher_subtype(),
Ankush Menat494bd9e2022-03-28 18:52:46 +0530892 }
893 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530894
Sagar Vora4205f562023-07-24 18:37:36 +0530895 with temporary_flag("company", self.company):
896 update_gl_dict_with_regional_fields(self, gl_dict)
897
deepeshgarg007d83cf652019-05-12 18:34:23 +0530898 accounting_dimensions = get_accounting_dimensions()
899 dimension_dict = frappe._dict()
900
901 for dimension in accounting_dimensions:
902 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530903 if item and item.get(dimension):
904 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530905
906 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530907 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530908
Nabin Hait895029d2015-08-20 14:55:39 +0530909 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530910 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530911
Ankush Menat494bd9e2022-03-28 18:52:46 +0530912 if gl_dict.account and self.doctype not in [
913 "Journal Entry",
914 "Period Closing Voucher",
915 "Payment Entry",
916 "Purchase Receipt",
917 "Purchase Invoice",
918 "Stock Entry",
919 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530920 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530921
Ankush Menat494bd9e2022-03-28 18:52:46 +0530922 if gl_dict.account and self.doctype not in [
923 "Journal Entry",
924 "Period Closing Voucher",
925 "Payment Entry",
926 ]:
927 set_balance_in_account_currency(
928 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
929 )
Anand Doshi979326b2015-09-11 16:22:37 +0530930
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530931 # Update details in transaction currency
932 gl_dict.update(
933 {
Deepesh Garg41d92252024-01-14 10:51:30 +0530934 "transaction_currency": self.get("currency") or self.company_currency,
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530935 "transaction_exchange_rate": self.get("conversion_rate", 1),
936 "debit_in_transaction_currency": self.get_value_in_transaction_currency(
937 account_currency, args, "debit"
938 ),
939 "credit_in_transaction_currency": self.get_value_in_transaction_currency(
940 account_currency, args, "credit"
941 ),
942 }
943 )
944
Deepesh Gargbeee98d2024-01-03 10:03:27 +0530945 if not args.get("against_voucher_type") and self.get("against_voucher_type"):
946 gl_dict.update({"against_voucher_type": self.get("against_voucher_type")})
947
948 if not args.get("against_voucher") and self.get("against_voucher"):
949 gl_dict.update({"against_voucher": self.get("against_voucher")})
950
Nabin Haitc561a492015-08-19 19:22:34 +0530951 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530952
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530953 def get_voucher_subtype(self):
954 voucher_subtypes = {
955 "Journal Entry": "voucher_type",
956 "Payment Entry": "payment_type",
957 "Stock Entry": "stock_entry_type",
958 "Asset Capitalization": "entry_type",
959 }
960 if self.doctype in voucher_subtypes:
961 return self.get(voucher_subtypes[self.doctype])
962 elif self.doctype == "Purchase Receipt" and self.is_return:
963 return "Purchase Return"
964 elif self.doctype == "Delivery Note" and self.is_return:
965 return "Sales Return"
966 elif (self.doctype == "Sales Invoice" and self.is_return) or self.doctype == "Purchase Invoice":
967 return "Credit Note"
968 elif (self.doctype == "Purchase Invoice" and self.is_return) or self.doctype == "Sales Invoice":
969 return "Debit Note"
970 return self.doctype
971
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530972 def get_value_in_transaction_currency(self, account_currency, args, field):
Deepesh Garg41d92252024-01-14 10:51:30 +0530973 if account_currency == self.get("currency"):
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530974 return args.get(field + "_in_account_currency")
975 else:
Deepesh Garg41d92252024-01-14 10:51:30 +0530976 return flt(args.get(field, 0) / self.get("conversion_rate", 1))
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530977
Anurag Mishrae657fe82018-11-26 15:19:17 +0530978 def validate_qty_is_not_zero(self):
Maricab9f5a1c2023-11-27 09:05:22 +0530979 for item in self.items:
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +0100980 if self.doctype == "Purchase Receipt" and item.rejected_qty:
981 continue
982
Maricab9f5a1c2023-11-27 09:05:22 +0530983 if not flt(item.qty):
984 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +0100985 msg=_("Row #{0}: Quantity for Item {1} cannot be zero.").format(
986 item.idx, frappe.bold(item.item_code)
987 ),
Maricab9f5a1c2023-11-27 09:05:22 +0530988 title=_("Invalid Quantity"),
989 exc=InvalidQtyError,
990 )
Anurag Mishrae657fe82018-11-26 15:19:17 +0530991
Nabin Hait895029d2015-08-20 14:55:39 +0530992 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +0530993 valid_currency = [self.company_currency]
994 if self.get("currency") and self.currency != self.company_currency:
995 valid_currency.append(self.currency)
996
Nabin Hait895029d2015-08-20 14:55:39 +0530997 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530998 frappe.throw(
999 _("Account {0} is invalid. Account Currency must be {1}").format(
1000 account, (" " + _("or") + " ").join(valid_currency)
1001 )
1002 )
Anand Doshi979326b2015-09-11 16:22:37 +05301003
Anand Doshi613cb6a2013-02-06 17:33:46 +05301004 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +05301005 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
1006
Ankush Menat494bd9e2022-03-28 18:52:46 +05301007 frappe.db.sql(
1008 """delete from `tab%s` where parentfield=%s and parent = %s
1009 and allocated_amount = 0"""
1010 % (childtype, "%s", "%s"),
1011 (parentfield, self.name),
1012 )
Anand Doshid2946502014-04-08 20:10:03 +05301013
Walstan Baptistad6360752021-03-31 12:30:32 +05301014 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301015 def apply_shipping_rule(self):
1016 if self.shipping_rule:
1017 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
1018 shipping_rule.apply(self)
1019 self.calculate_taxes_and_totals()
1020
1021 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301022 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301023
1024 # shipping address fields can be `shipping_address_name` or `shipping_address`
1025 # try getting value from both
1026
Ankush Menat494bd9e2022-03-28 18:52:46 +05301027 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301028 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301029 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301030 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301031 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301032
1033 return {}
1034
Walstan Baptistad6360752021-03-31 12:30:32 +05301035 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +05301036 def set_advances(self):
1037 """Returns list of advances against Account, Party, Reference"""
1038
Deepesh Gargfd3fb642023-04-05 12:02:44 +05301039 res = self.get_advance_entries(
1040 include_unallocated=not cint(self.get("only_include_allocated_payments"))
1041 )
Nabin Hait041a5c22018-08-01 18:07:39 +05301042
1043 self.set("advances", [])
1044 advance_allocated = 0
1045 for d in res:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301046 if self.get("party_account_currency") == self.company_currency:
1047 amount = self.get("base_rounded_total") or self.base_grand_total
Nabin Hait041a5c22018-08-01 18:07:39 +05301048 else:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301049 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg181df2f2022-11-04 15:49:37 +05301050 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +05301051 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +05301052
Saqiba20999c2021-07-12 14:33:23 +05301053 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +05301054 "doctype": self.doctype + " Advance",
1055 "reference_type": d.reference_type,
1056 "reference_name": d.reference_name,
1057 "reference_row": d.reference_row,
1058 "remarks": d.remarks,
1059 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +05301060 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301061 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +05301062 }
Gursheen Anand74619262023-06-02 17:13:51 +05301063 if d.get("paid_from"):
1064 advance_row["account"] = d.paid_from
1065 if d.get("paid_to"):
1066 advance_row["account"] = d.paid_to
Saqiba20999c2021-07-12 14:33:23 +05301067
1068 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +05301069
Nabin Hait28a05282016-06-27 17:41:39 +05301070 def get_advance_entries(self, include_unallocated=True):
1071 if self.doctype == "Sales Invoice":
Nabin Hait28a05282016-06-27 17:41:39 +05301072 party_type = "Customer"
1073 party = self.customer
1074 amount_field = "credit_in_account_currency"
1075 order_field = "sales_order"
1076 order_doctype = "Sales Order"
1077 else:
Nabin Hait28a05282016-06-27 17:41:39 +05301078 party_type = "Supplier"
1079 party = self.supplier
1080 amount_field = "debit_in_account_currency"
1081 order_field = "purchase_order"
1082 order_doctype = "Purchase Order"
Deepesh Garg92f845c2023-06-21 12:21:19 +05301083
1084 party_account = get_party_account(
1085 party_type, party=party, company=self.company, include_advance=True
1086 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301087
Ankush Menat494bd9e2022-03-28 18:52:46 +05301088 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 +05301089
Ankush Menat494bd9e2022-03-28 18:52:46 +05301090 journal_entries = get_advance_journal_entries(
1091 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
1092 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301093
Smit Vora3e282bf2023-09-19 20:47:21 +05301094 payment_entries = get_advance_payment_entries_for_regional(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301095 party_type, party, party_account, order_doctype, order_list, include_unallocated
1096 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301097
Nabin Hait28a05282016-06-27 17:41:39 +05301098 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301099
Nabin Hait28a05282016-06-27 17:41:39 +05301100 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +05301101
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301102 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301103 is_inclusive = cint(
1104 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
1105 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301106
1107 if is_inclusive:
1108 is_inclusive = 0
1109 if self.get("taxes", filters={"included_in_print_rate": 1}):
1110 is_inclusive = 1
1111
1112 return is_inclusive
1113
Anand Baburajan491a50a2023-06-13 19:42:56 +05301114 def should_show_taxes_as_table_in_print(self):
1115 return cint(frappe.db.get_single_value("Accounts Settings", "show_taxes_as_table_in_print"))
1116
Nabin Hait28a05282016-06-27 17:41:39 +05301117 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +05301118 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301119 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 +05301120
Ankush Menat494bd9e2022-03-28 18:52:46 +05301121 if not order_list:
1122 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301123
Nabin Hait28a05282016-06-27 17:41:39 +05301124 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301125
Nabin Hait28a05282016-06-27 17:41:39 +05301126 if advance_entries:
1127 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
1128 for d in advance_entries:
1129 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301130 frappe.msgprint(
1131 _(
1132 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
1133 ).format(d.reference_name, d.against_order)
1134 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301135
Saqiba20999c2021-07-12 14:33:23 +05301136 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301137 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301138 return
1139
Ankush Menat494bd9e2022-03-28 18:52:46 +05301140 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301141 party_account = self.credit_to if is_purchase_invoice else self.debit_to
1142 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +05301143 return
1144
1145 for d in self.get("advances"):
1146 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +05301147 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +05301148
1149 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
1150 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
1151 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
1152
1153 d.exchange_gain_loss = difference
1154
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301155 def make_precision_loss_gl_entry(self, gl_entries):
1156 round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(
1157 self.company, "Purchase Invoice", self.name, self.use_company_roundoff_cost_center
1158 )
1159
1160 precision_loss = self.get("base_net_total") - flt(
1161 self.get("net_total") * self.conversion_rate, self.precision("net_total")
1162 )
1163
1164 credit_or_debit = "credit" if self.doctype == "Purchase Invoice" else "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301165 against_type = "Supplier" if self.doctype == "Purchase Invoice" else "Customer"
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301166 against = self.supplier if self.doctype == "Purchase Invoice" else self.customer
1167
1168 if precision_loss:
1169 gl_entries.append(
1170 self.get_gl_dict(
1171 {
1172 "account": round_off_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301173 "against_type": against_type,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301174 "against": against,
Gursheen Anand09439332023-11-08 12:57:00 +05301175 "against_link": against,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301176 credit_or_debit: precision_loss,
1177 "cost_center": round_off_cost_center
1178 if self.use_company_roundoff_cost_center
1179 else self.cost_center or round_off_cost_center,
1180 "remarks": _("Net total calculation precision loss"),
1181 }
1182 )
1183 )
1184
ruthra kumar79c6f012023-09-01 14:57:12 +05301185 def gain_loss_journal_already_booked(
1186 self,
1187 gain_loss_account,
1188 exc_gain_loss,
1189 ref2_dt,
1190 ref2_dn,
1191 ref2_detail_no,
1192 ) -> bool:
1193 """
1194 Check if gain/loss is booked
1195 """
1196 if res := frappe.db.get_all(
1197 "Journal Entry Account",
1198 filters={
1199 "docstatus": 1,
1200 "account": gain_loss_account,
1201 "reference_type": ref2_dt, # this will be Journal Entry
1202 "reference_name": ref2_dn,
1203 "reference_detail_no": ref2_detail_no,
1204 },
1205 pluck="parent",
1206 ):
1207 # deduplicate
1208 res = list({x for x in res})
1209 if exc_vouchers := frappe.db.get_all(
1210 "Journal Entry",
1211 filters={"name": ["in", res], "voucher_type": "Exchange Gain Or Loss"},
1212 fields=["voucher_type", "total_debit", "total_credit"],
1213 ):
1214 booked_voucher = exc_vouchers[0]
1215 if (
1216 booked_voucher.total_debit == exc_gain_loss
1217 and booked_voucher.total_credit == exc_gain_loss
1218 and booked_voucher.voucher_type == "Exchange Gain Or Loss"
1219 ):
1220 return True
1221 return False
1222
ruthra kumar66286322023-07-25 10:30:08 +05301223 def make_exchange_gain_loss_journal(self, args: dict = None) -> None:
ruthra kumar81cd7872023-04-27 09:46:54 +05301224 """
1225 Make Exchange Gain/Loss journal for Invoices and Payments
1226 """
ruthra kumarcd42b262023-07-10 15:28:10 +05301227 # Cancelling existing exchange gain/loss journals is handled during the `on_cancel` event.
1228 # see accounts/utils.py:cancel_exchange_gain_loss_journal()
ruthra kumar81cd7872023-04-27 09:46:54 +05301229 if self.docstatus == 1:
ruthra kumar7b516f82023-06-26 17:34:28 +05301230 if self.get("doctype") == "Journal Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301231 # 'args' is populated with exchange gain/loss account and the amount to be booked.
1232 # These are generated by Sales/Purchase Invoice during reconciliation and advance allocation.
ruthra kumarc0b3b062023-07-25 10:51:58 +05301233 # and below logic is only for such scenarios
ruthra kumar7b516f82023-06-26 17:34:28 +05301234 if args:
1235 for arg in args:
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301236 # Advance section uses `exchange_gain_loss` and reconciliation uses `difference_amount`
1237 if (
1238 arg.get("difference_amount", 0) != 0 or arg.get("exchange_gain_loss", 0) != 0
1239 ) and arg.get("difference_account"):
ruthra kumar7b516f82023-06-26 17:34:28 +05301240
ruthra kumaree3ce822023-06-26 21:43:20 +05301241 party_account = arg.get("account")
ruthra kumarc0b3b062023-07-25 10:51:58 +05301242 gain_loss_account = arg.get("difference_account")
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301243 difference_amount = arg.get("difference_amount") or arg.get("exchange_gain_loss")
1244 if difference_amount > 0:
ruthra kumar05672432023-07-12 06:14:17 +05301245 dr_or_cr = "debit" if arg.get("party_type") == "Customer" else "credit"
1246 else:
1247 dr_or_cr = "credit" if arg.get("party_type") == "Customer" else "debit"
ruthra kumar7b516f82023-06-26 17:34:28 +05301248
1249 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1250
ruthra kumar79c6f012023-09-01 14:57:12 +05301251 if not self.gain_loss_journal_already_booked(
ruthra kumarc0b3b062023-07-25 10:51:58 +05301252 gain_loss_account,
1253 difference_amount,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301254 self.doctype,
1255 self.name,
ruthra kumar79c6f012023-09-01 14:57:12 +05301256 arg.get("referenced_row"),
1257 ):
ruthra kumar7e600a62023-10-22 20:26:45 +05301258 posting_date = arg.get("difference_posting_date") or frappe.db.get_value(
1259 arg.voucher_type, arg.voucher_no, "posting_date"
1260 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301261 je = create_gain_loss_journal(
1262 self.company,
ruthra kumarf7865da2023-09-04 20:38:10 +05301263 posting_date,
ruthra kumar79c6f012023-09-01 14:57:12 +05301264 arg.get("party_type"),
1265 arg.get("party"),
1266 party_account,
1267 gain_loss_account,
1268 difference_amount,
1269 dr_or_cr,
1270 reverse_dr_or_cr,
1271 arg.get("against_voucher_type"),
1272 arg.get("against_voucher"),
1273 arg.get("idx"),
1274 self.doctype,
1275 self.name,
1276 arg.get("referenced_row"),
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301277 arg.get("cost_center"),
ruthra kumaracc73222023-07-27 07:52:01 +05301278 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301279 frappe.msgprint(
1280 _("Exchange Gain/Loss amount has been booked through {0}").format(
1281 get_link_to_form("Journal Entry", je)
1282 )
1283 )
ruthra kumar7b516f82023-06-26 17:34:28 +05301284
ruthra kumar81cd7872023-04-27 09:46:54 +05301285 if self.get("doctype") == "Payment Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301286 # For Payment Entry, exchange_gain_loss field in the `references` table is the trigger for journal creation
ruthra kumar81cd7872023-04-27 09:46:54 +05301287 gain_loss_to_book = [x for x in self.references if x.exchange_gain_loss != 0]
1288 booked = []
1289 if gain_loss_to_book:
1290 vtypes = [x.reference_doctype for x in gain_loss_to_book]
1291 vnames = [x.reference_name for x in gain_loss_to_book]
1292 je = qb.DocType("Journal Entry")
1293 jea = qb.DocType("Journal Entry Account")
1294 parents = (
1295 qb.from_(jea)
1296 .select(jea.parent)
1297 .where(
1298 (jea.reference_type == "Payment Entry")
1299 & (jea.reference_name == self.name)
1300 & (jea.docstatus == 1)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301301 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301302 .run()
Saqiba20999c2021-07-12 14:33:23 +05301303 )
1304
ruthra kumar81cd7872023-04-27 09:46:54 +05301305 booked = []
1306 if parents:
1307 booked = (
1308 qb.from_(je)
1309 .inner_join(jea)
1310 .on(je.name == jea.parent)
1311 .select(jea.reference_type, jea.reference_name, jea.reference_detail_no)
1312 .where(
1313 (je.docstatus == 1)
1314 & (je.name.isin(parents))
1315 & (je.voucher_type == "Exchange Gain or Loss")
1316 )
1317 .run()
1318 )
Saqiba20999c2021-07-12 14:33:23 +05301319
ruthra kumar81cd7872023-04-27 09:46:54 +05301320 for d in gain_loss_to_book:
ruthra kumarc0b3b062023-07-25 10:51:58 +05301321 # Filter out References for which Gain/Loss is already booked
ruthra kumar81cd7872023-04-27 09:46:54 +05301322 if d.exchange_gain_loss and (
1323 (d.reference_doctype, d.reference_name, str(d.idx)) not in booked
1324 ):
ruthra kumar81cd7872023-04-27 09:46:54 +05301325 if self.payment_type == "Receive":
1326 party_account = self.paid_from
1327 elif self.payment_type == "Pay":
1328 party_account = self.paid_to
1329
ruthra kumar81cd7872023-04-27 09:46:54 +05301330 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
ruthra kumar34b5e842023-06-16 14:07:44 +05301331
1332 if d.reference_doctype == "Purchase Invoice":
1333 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1334
ruthra kumar81cd7872023-04-27 09:46:54 +05301335 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1336
1337 gain_loss_account = frappe.get_cached_value(
1338 "Company", self.company, "exchange_gain_loss_account"
1339 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301340
ruthra kumaracc73222023-07-27 07:52:01 +05301341 je = create_gain_loss_journal(
ruthra kumar1ea1bfe2023-07-26 16:19:38 +05301342 self.company,
ruthra kumar7e600a62023-10-22 20:26:45 +05301343 args.get("difference_posting_date") if args else self.posting_date,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301344 self.party_type,
1345 self.party,
1346 party_account,
1347 gain_loss_account,
1348 d.exchange_gain_loss,
1349 dr_or_cr,
1350 reverse_dr_or_cr,
1351 d.reference_doctype,
1352 d.reference_name,
1353 d.idx,
1354 self.doctype,
1355 self.name,
1356 d.idx,
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301357 self.cost_center,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301358 )
ruthra kumaracc73222023-07-27 07:52:01 +05301359 frappe.msgprint(
1360 _("Exchange Gain/Loss amount has been booked through {0}").format(
1361 get_link_to_form("Journal Entry", je)
1362 )
1363 )
Saqiba20999c2021-07-12 14:33:23 +05301364
Deepesh Garg016ed952023-06-20 13:22:32 +05301365 def update_against_document_in_jv(self):
Nabin Hait28a05282016-06-27 17:41:39 +05301366 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301367 Links invoice and advance voucher:
1368 1. cancel advance voucher
1369 2. split into multiple rows if partially adjusted, assign against voucher
1370 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +05301371 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301372
Nabin Hait28a05282016-06-27 17:41:39 +05301373 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301374 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +05301375 party = self.customer
1376 party_account = self.debit_to
1377 dr_or_cr = "credit_in_account_currency"
1378 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301379 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +05301380 party = self.supplier
1381 party_account = self.credit_to
1382 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +05301383
Nabin Hait28a05282016-06-27 17:41:39 +05301384 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +05301385 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +05301386 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301387 args = frappe._dict(
1388 {
1389 "voucher_type": d.reference_type,
1390 "voucher_no": d.reference_name,
1391 "voucher_detail_no": d.reference_row,
1392 "against_voucher_type": self.doctype,
1393 "against_voucher": self.name,
1394 "account": party_account,
1395 "party_type": party_type,
1396 "party": party,
1397 "is_advance": "Yes",
1398 "dr_or_cr": dr_or_cr,
1399 "unadjusted_amount": flt(d.advance_amount),
1400 "allocated_amount": flt(d.allocated_amount),
1401 "precision": d.precision("advance_amount"),
1402 "exchange_rate": (
1403 self.conversion_rate if self.party_account_currency != self.company_currency else 1
1404 ),
1405 "grand_total": (
1406 self.base_grand_total
1407 if self.party_account_currency == self.company_currency
1408 else self.grand_total
1409 ),
1410 "outstanding_amount": self.outstanding_amount,
Daizy Modi4efc9472022-11-07 09:21:03 +05301411 "difference_account": frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301412 "Company", self.company, "exchange_gain_loss_account"
1413 ),
1414 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
1415 }
1416 )
Nabin Hait28a05282016-06-27 17:41:39 +05301417 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301418
Nabin Hait28a05282016-06-27 17:41:39 +05301419 if lst:
1420 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +05301421
Deepesh Garg016ed952023-06-20 13:22:32 +05301422 reconcile_against_document(lst)
Anand Doshid2946502014-04-08 20:10:03 +05301423
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301424 def on_cancel(self):
barredterra0a95b382023-12-27 23:05:37 +01001425 from erpnext.accounts.doctype.bank_transaction.bank_transaction import (
1426 remove_from_bank_transaction,
1427 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301428 from erpnext.accounts.utils import (
1429 cancel_exchange_gain_loss_journal,
1430 unlink_ref_doc_from_payment_entries,
1431 )
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301432
barredterra0a95b382023-12-27 23:05:37 +01001433 remove_from_bank_transaction(self.doctype, self.name)
1434
ruthra kumar6e18bb62023-07-11 12:21:10 +05301435 if self.doctype in ["Sales Invoice", "Purchase Invoice", "Payment Entry", "Journal Entry"]:
ruthra kumar81cd7872023-04-27 09:46:54 +05301436 # Cancel Exchange Gain/Loss Journal before unlinking
1437 cancel_exchange_gain_loss_journal(self)
1438
Ankush Menat494bd9e2022-03-28 18:52:46 +05301439 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301440 unlink_ref_doc_from_payment_entries(self)
1441
1442 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301443 if frappe.db.get_single_value(
1444 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1445 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301446 unlink_ref_doc_from_payment_entries(self)
1447
GangaManoj8396f242021-09-20 19:01:46 +05301448 if self.doctype == "Sales Order":
1449 self.unlink_ref_doc_from_po()
1450
1451 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301452 so_items = []
1453 for item in self.items:
1454 so_items.append(item.name)
1455
Ankush Menat494bd9e2022-03-28 18:52:46 +05301456 linked_po = list(
1457 set(
1458 frappe.get_all(
1459 "Purchase Order Item",
1460 filters={
1461 "sales_order": self.name,
1462 "sales_order_item": ["in", so_items],
1463 "docstatus": ["<", 2],
1464 },
1465 pluck="parent",
1466 )
1467 )
1468 )
GangaManoj8396f242021-09-20 19:01:46 +05301469
GangaManoj8396f242021-09-20 19:01:46 +05301470 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301471 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301472 "Purchase Order Item",
1473 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1474 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301475 )
GangaManoj8396f242021-09-20 19:01:46 +05301476
1477 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1478
Deepesh Gargd18dde72020-11-29 21:40:04 +05301479 def get_tax_map(self):
1480 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301481 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301482 tax_map.setdefault(tax.account_head, 0.0)
1483 tax_map[tax.account_head] += tax.tax_amount
1484
1485 return tax_map
1486
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301487 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1488 amount = item.net_amount
1489 base_amount = item.base_net_amount
1490
Ankush Menat494bd9e2022-03-28 18:52:46 +05301491 if (
1492 enable_discount_accounting
1493 and self.get("discount_amount")
1494 and self.get("additional_discount_account")
1495 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301496 amount = item.amount
1497 base_amount = item.base_amount
1498
1499 return amount, base_amount
1500
1501 def get_tax_amounts(self, tax, enable_discount_accounting):
1502 amount = tax.tax_amount_after_discount_amount
1503 base_amount = tax.base_tax_amount_after_discount_amount
1504
Ankush Menat494bd9e2022-03-28 18:52:46 +05301505 if (
1506 enable_discount_accounting
1507 and self.get("discount_amount")
1508 and self.get("additional_discount_account")
1509 and self.get("apply_discount_on") == "Grand Total"
1510 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301511 amount = tax.tax_amount
1512 base_amount = tax.base_tax_amount
1513
1514 return amount, base_amount
1515
GangaManoj8f7b0a12021-07-13 03:01:02 +05301516 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301517 if self.doctype == "Purchase Invoice":
1518 enable_discount_accounting = cint(
1519 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1520 )
1521 elif self.doctype == "Sales Invoice":
1522 enable_discount_accounting = cint(
1523 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1524 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301525
Deepesh Garg3b159662022-08-21 17:51:05 +05301526 if self.doctype == "Purchase Invoice":
1527 dr_or_cr = "credit"
1528 rev_dr_cr = "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301529 against_type = "Supplier"
Deepesh Garg3b159662022-08-21 17:51:05 +05301530 supplier_or_customer = self.supplier
1531
1532 else:
1533 dr_or_cr = "debit"
1534 rev_dr_cr = "credit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301535 against_type = "Customer"
Deepesh Garg3b159662022-08-21 17:51:05 +05301536 supplier_or_customer = self.customer
1537
GangaManoj8f7b0a12021-07-13 03:01:02 +05301538 if enable_discount_accounting:
1539 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301540 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301541 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301542 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301543 income_or_expense_account = (
1544 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301545 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301546 else item.deferred_expense_account
1547 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301548 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301549 income_or_expense_account = (
1550 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301551 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301552 else item.deferred_revenue_account
1553 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301554
1555 account_currency = get_account_currency(item.discount_account)
1556 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301557 self.get_gl_dict(
1558 {
1559 "account": item.discount_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301560 "against_type": against_type,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301561 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301562 "against_link": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301563 dr_or_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301564 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1565 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301566 dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301567 "cost_center": item.cost_center,
1568 "project": item.project,
1569 },
1570 account_currency,
1571 item=item,
1572 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301573 )
1574
1575 account_currency = get_account_currency(income_or_expense_account)
1576 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301577 self.get_gl_dict(
1578 {
1579 "account": income_or_expense_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301580 "against_type": against_type,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301581 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301582 "against_link": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301583 rev_dr_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301584 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1585 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301586 rev_dr_cr
1587 + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301588 "cost_center": item.cost_center,
1589 "project": item.project or self.project,
1590 },
1591 account_currency,
1592 item=item,
1593 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301594 )
GangaManoj857501c2021-07-15 22:03:46 +05301595
Deepesh Garg3b159662022-08-21 17:51:05 +05301596 if (
Deepesh Gargae3dce02022-08-22 08:57:58 +05301597 (enable_discount_accounting or self.get("is_cash_or_non_trade_discount"))
Deepesh Garg3b159662022-08-21 17:51:05 +05301598 and self.get("additional_discount_account")
1599 and self.get("discount_amount")
1600 ):
1601 gl_entries.append(
1602 self.get_gl_dict(
1603 {
1604 "account": self.additional_discount_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301605 "against_type": against_type,
Deepesh Garg3b159662022-08-21 17:51:05 +05301606 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301607 "against_link": supplier_or_customer,
Gursheen Anand112cfe62023-08-31 17:08:51 +05301608 dr_or_cr: self.base_discount_amount,
vr-greycube4ada5a42023-09-27 10:38:32 +05301609 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
Deepesh Garg3b159662022-08-21 17:51:05 +05301610 },
1611 item=self,
Ankush Menat4551d7d2021-08-19 13:41:10 +05301612 )
Deepesh Garg3b159662022-08-21 17:51:05 +05301613 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301614
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301615 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on):
Nabin Hait868766d2019-07-15 18:02:58 +05301616 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301617
Nabin Hait868766d2019-07-15 18:02:58 +05301618 item_allowance = {}
1619 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301620
Ankush Menat494bd9e2022-03-28 18:52:46 +05301621 role_allowed_to_over_bill = frappe.db.get_single_value(
1622 "Accounts Settings", "role_allowed_to_over_bill"
1623 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301624 user_roles = frappe.get_roles()
1625
Ankush Menat43bf82b2021-09-20 16:31:20 +05301626 total_overbilled_amt = 0.0
1627
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301628 reference_names = [d.get(item_ref_dn) for d in self.get("items") if d.get(item_ref_dn)]
1629 reference_details = self.get_billing_reference_details(
1630 reference_names, ref_dt + " Item", based_on
1631 )
1632
Nabin Hait4b8185d2014-12-25 18:19:39 +05301633 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301634 if not item.get(item_ref_dn):
1635 continue
Anand Doshid2946502014-04-08 20:10:03 +05301636
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301637 ref_amt = flt(reference_details.get(item.get(item_ref_dn)), self.precision(based_on, item))
1638
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301639 if not ref_amt:
1640 frappe.msgprint(
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301641 _("System will not check over billing since amount for Item {0} in {1} is zero").format(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301642 item.item_code, ref_dt
1643 ),
1644 title=_("Warning"),
1645 indicator="orange",
1646 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301647 continue
Anand Doshid2946502014-04-08 20:10:03 +05301648
Saqib9c913c92021-11-26 12:00:13 +05301649 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301650
Ankush Menat494bd9e2022-03-28 18:52:46 +05301651 total_billed_amt = flt(
1652 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1653 )
Anand Doshid2946502014-04-08 20:10:03 +05301654
Ankush Menat494bd9e2022-03-28 18:52:46 +05301655 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1656 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1657 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301658
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301659 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301660
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301661 if total_billed_amt < 0 and max_allowed_amt < 0:
1662 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1663 total_billed_amt = abs(total_billed_amt)
1664 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301665
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301666 overbill_amt = total_billed_amt - max_allowed_amt
1667 total_overbilled_amt += overbill_amt
1668
1669 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1670 if self.doctype != "Purchase Invoice":
1671 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301672 elif not cint(
1673 frappe.db.get_single_value(
1674 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1675 )
1676 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301677 self.throw_overbill_exception(item, max_allowed_amt)
1678
1679 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301680 frappe.msgprint(
1681 _("Overbilling of {} ignored because you have {} role.").format(
1682 total_overbilled_amt, role_allowed_to_over_bill
1683 ),
1684 indicator="orange",
1685 alert=True,
1686 )
Afshan53fefd72021-06-24 10:09:02 +05301687
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301688 def get_billing_reference_details(self, reference_names, reference_doctype, based_on):
1689 return frappe._dict(
1690 frappe.get_all(
1691 reference_doctype,
1692 filters={"name": ("in", reference_names)},
1693 fields=["name", based_on],
1694 as_list=1,
1695 )
1696 )
1697
Saqib9c913c92021-11-26 12:00:13 +05301698 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301699 """
1700 Returns Sum of Amount of
1701 Sales/Purchase Invoice Items
1702 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1703 that are submitted OR not submitted but are under current invoice
1704 """
Saqib9c913c92021-11-26 12:00:13 +05301705
1706 from frappe.query_builder import Criterion
1707 from frappe.query_builder.functions import Sum
1708
1709 item_doctype = frappe.qb.DocType(item.doctype)
1710 based_on_field = frappe.qb.Field(based_on)
1711 join_field = frappe.qb.Field(item_ref_dn)
1712
1713 result = (
1714 frappe.qb.from_(item_doctype)
1715 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301716 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301717 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301718 Criterion.any(
1719 [ # select all items from other invoices OR current invoices
1720 Criterion.all(
1721 [ # for selecting items from other invoices
1722 item_doctype.docstatus == 1,
1723 item_doctype.parent != self.name,
1724 ]
1725 ),
1726 Criterion.all(
1727 [ # for selecting items from current invoice, that are linked to same reference
1728 item_doctype.docstatus == 0,
1729 item_doctype.parent == self.name,
1730 item_doctype.name != item.name,
1731 ]
1732 ),
1733 ]
1734 )
Saqib9c913c92021-11-26 12:00:13 +05301735 )
1736 ).run()
1737
1738 return result[0][0] if result else 0
1739
Afshan53fefd72021-06-24 10:09:02 +05301740 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301741 frappe.throw(
1742 _(
1743 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1744 ).format(item.item_code, item.idx, max_allowed_amt)
1745 )
Anand Doshid2946502014-04-08 20:10:03 +05301746
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301747 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301748 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301749
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301750 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301751
Nabin Haita36adbd2013-08-02 14:50:12 +05301752 def get_stock_items(self):
1753 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301754 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301755 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301756 stock_items = frappe.db.get_values(
1757 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1758 )
Anand Doshid2946502014-04-08 20:10:03 +05301759
Nabin Haita36adbd2013-08-02 14:50:12 +05301760 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301761
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301762 def set_total_advance_paid(self):
ruthra kumar44870652022-11-01 10:11:38 +05301763 ple = frappe.qb.DocType("Payment Ledger Entry")
1764 party = self.customer if self.doctype == "Sales Order" else self.supplier
1765 advance = (
1766 frappe.qb.from_(ple)
ruthra kumarbf76b852022-11-22 12:16:11 +05301767 .select(ple.account_currency, Abs(Sum(ple.amount_in_account_currency)).as_("amount"))
ruthra kumar44870652022-11-01 10:11:38 +05301768 .where(
1769 (ple.against_voucher_type == self.doctype)
1770 & (ple.against_voucher_no == self.name)
1771 & (ple.party == party)
ruthra kumarbf76b852022-11-22 12:16:11 +05301772 & (ple.docstatus == 1)
ruthra kumar44870652022-11-01 10:11:38 +05301773 & (ple.company == self.company)
1774 )
1775 .run(as_dict=True)
1776 )
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301777
Nabin Haitb2206d12016-01-27 15:43:12 +05301778 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301779 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301780
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301781 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301782 formatted_advance_paid = fmt_money(
1783 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1784 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301785
Ankush Menat494bd9e2022-03-28 18:52:46 +05301786 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301787
1788 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301789 order_total = self.get("rounded_total") or self.grand_total
1790 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301791 else:
finbyz5efc7972019-01-05 11:12:11 +05301792 order_total = self.get("base_rounded_total") or self.base_grand_total
1793 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301794
Ankush Menat494bd9e2022-03-28 18:52:46 +05301795 formatted_order_total = fmt_money(
1796 order_total, precision=self.precision(precision), currency=advance.account_currency
1797 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301798
Nabin Hait9db1b222016-06-30 12:37:53 +05301799 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301800 frappe.throw(
1801 _(
1802 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1803 ).format(formatted_advance_paid, self.name, formatted_order_total)
1804 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301805
Nabin Hait13093b42016-06-29 18:04:37 +05301806 frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid)
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301807
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301808 @property
1809 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301810 if not hasattr(self, "_abbr"):
Daizy Modi4efc9472022-11-07 09:21:03 +05301811 self._abbr = frappe.get_cached_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301812
1813 return self._abbr
1814
marination4be5b5c2020-10-08 19:08:27 +05301815 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301816 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301817 db_or_cr = (
1818 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1819 )
marination4be5b5c2020-10-08 19:08:27 +05301820 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1821
1822 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1823 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1824
Ankush Menat494bd9e2022-03-28 18:52:46 +05301825 message = _("{0} Account not found against Customer {1}.").format(
1826 db_or_cr, frappe.bold(party) or ""
1827 )
marination4be5b5c2020-10-08 19:08:27 +05301828 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301829 message += (
1830 "<br><ul><li>"
1831 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1832 + "</li>"
1833 )
1834 message += (
1835 "<li>"
1836 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1837 + "</li></ul>"
1838 )
marination4be5b5c2020-10-08 19:08:27 +05301839
marination53b1a9a2020-11-03 15:45:25 +05301840 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301841
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301842 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301843 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301844 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301845
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301846 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301847 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301848 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301849 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301850
Ankush Menat494bd9e2022-03-28 18:52:46 +05301851 elif self.doctype in (
1852 "Supplier Quotation",
1853 "Purchase Order",
1854 "Purchase Receipt",
1855 "Purchase Invoice",
1856 ):
1857 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301858
1859 elif self.meta.get_field("customer"):
1860 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301861
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301862 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301863 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301864
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301865 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301866
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301867 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301868
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301869 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301870 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301871 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301872 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301873 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301874
Ankush Menat494bd9e2022-03-28 18:52:46 +05301875 if (
1876 party_account_currency
1877 and party_account_currency != self.company_currency
1878 and self.currency != party_account_currency
1879 ):
Gursheen Anand112cfe62023-08-31 17:08:51 +05301880
Ankush Menat494bd9e2022-03-28 18:52:46 +05301881 frappe.throw(
1882 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1883 party_type, party, party_account_currency
1884 ),
1885 InvalidCurrency,
1886 )
Anand Doshi979326b2015-09-11 16:22:37 +05301887
shreyas29b565f2016-01-25 17:30:49 +05301888 # Note: not validating with gle account because we don't have the account
1889 # at quotation / sales order level and we shouldn't stop someone
1890 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301891
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301892 def validate_party_account_currency(self):
Deepesh Garg33d97672022-05-12 16:40:29 +05301893 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301894 return
1895
Deepesh Garg33d97672022-05-12 16:40:29 +05301896 if self.is_opening == "Yes":
Deepesh Garg60915e82021-08-21 23:05:48 +05301897 return
1898
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301899 party_type, party = self.get_party()
1900 party_gle_currency = get_party_gle_currency(party_type, party, self.company)
Deepesh Garg33d97672022-05-12 16:40:29 +05301901 party_account = (
1902 self.get("debit_to") if self.doctype == "Sales Invoice" else self.get("credit_to")
1903 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301904 party_account_currency = get_account_currency(party_account)
Deepesh Garge04e67c2022-07-11 19:25:18 +05301905 allow_multi_currency_invoices_against_single_party_account = frappe.db.get_singles_value(
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301906 "Accounts Settings", "allow_multi_currency_invoices_against_single_party_account"
1907 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301908
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301909 if (
1910 not party_gle_currency
1911 and (party_account_currency != self.currency)
1912 and not allow_multi_currency_invoices_against_single_party_account
1913 ):
Deepesh Garg33d97672022-05-12 16:40:29 +05301914 frappe.throw(
Devin Slauenwhite3a1c9232022-06-02 14:15:50 -04001915 _("Party Account {0} currency ({1}) and document currency ({2}) should be same").format(
Devin Slauenwhiteb061ea42022-06-02 14:23:54 -04001916 frappe.bold(party_account), party_account_currency, self.currency
Deepesh Garg33d97672022-05-12 16:40:29 +05301917 )
1918 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301919
Nabin Hait297d74a2016-11-23 15:58:51 +05301920 def delink_advance_entries(self, linked_doc_name):
1921 total_allocated_amount = 0
1922 for adv in self.advances:
1923 consider_for_total_advance = True
1924 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301925 frappe.db.sql(
1926 """delete from `tab{0} Advance`
1927 where name = %s""".format(
1928 self.doctype
1929 ),
1930 adv.name,
1931 )
Nabin Hait297d74a2016-11-23 15:58:51 +05301932 consider_for_total_advance = False
1933
1934 if consider_for_total_advance:
1935 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
1936
Ankush Menat494bd9e2022-03-28 18:52:46 +05301937 frappe.db.set_value(
1938 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
1939 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05301940
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301941 def group_similar_items(self):
1942 group_item_qty = {}
1943 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05301944 # to update serial number in print
1945 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301946
1947 for item in self.items:
1948 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
1949 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
1950
1951 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301952 for item in self.items:
1953 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05301954 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301955 item.qty = group_item_qty[item.item_code]
1956 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05301957
1958 if item.qty:
1959 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
1960 else:
1961 item.rate = 0
1962
Shreya Shah785f1aa2018-10-11 10:14:25 +05301963 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301964 del group_item_qty[item.item_code]
1965 else:
1966 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301967 for item in duplicate_list:
1968 self.remove(item)
1969
tunde32aa7c12017-09-07 06:52:15 +01001970 def set_payment_schedule(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05301971 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301972 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05301973 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301974
Ankush Menat494bd9e2022-03-28 18:52:46 +05301975 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301976 if not party_account_currency:
1977 party_type, party = self.get_party()
1978
1979 if party_type and party:
1980 party_account_currency = get_party_account_currency(party_type, party, self.company)
1981
rohitwaghchaureda941af2018-01-17 16:23:04 +05301982 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01001983 date = self.get("due_date")
1984 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05301985
Saqib Ansarid552fe62021-04-23 14:46:52 +05301986 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1987 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg5c758942023-04-16 17:11:24 +05301988 automatically_fetch_payment_terms = 0
Deepesh Garg26210162020-08-11 16:06:13 +05301989
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301990 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301991 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301992 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301993 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05301994 automatically_fetch_payment_terms = cint(
1995 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
1996 )
tunde96b8f222017-09-08 15:35:59 +01001997
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301998 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301999 if party_account_currency == self.company_currency:
2000 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302001 grand_total = flt(
2002 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2003 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302004 else:
2005 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302006 base_grand_total = flt(
2007 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2008 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302009
Nabin Hait0551f7b2017-11-21 19:58:16 +05302010 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302011 if (
2012 self.doctype in ["Sales Invoice", "Purchase Invoice"]
2013 and automatically_fetch_payment_terms
2014 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2015 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302016 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302017 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302018 self.ignore_default_payment_terms_template = 1
2019 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302020 data = get_payment_terms(
2021 self.payment_terms_template, posting_date, grand_total, base_grand_total
2022 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302023 for item in data:
2024 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05302025 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302026 data = dict(
2027 due_date=due_date,
2028 invoice_portion=100,
2029 payment_amount=grand_total,
2030 base_payment_amount=base_grand_total,
2031 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302032 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302033
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302034 allocate_payment_based_on_payment_terms = frappe.db.get_value(
2035 "Payment Terms Template", self.payment_terms_template, "allocate_payment_based_on_payment_terms"
2036 )
2037
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302038 if not (
2039 automatically_fetch_payment_terms
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302040 and allocate_payment_based_on_payment_terms
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302041 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2042 ):
Deepesh Garg5c758942023-04-16 17:11:24 +05302043 for d in self.get("payment_schedule"):
2044 if d.invoice_portion:
2045 d.payment_amount = flt(
2046 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
2047 )
2048 d.base_payment_amount = flt(
2049 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
2050 )
2051 d.outstanding = d.payment_amount
2052 elif not d.invoice_portion:
2053 d.base_payment_amount = flt(
2054 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
2055 )
ruthra kumar0da6c162023-05-16 18:57:42 +05302056 else:
2057 self.fetch_payment_terms_from_order(po_or_so, doctype)
2058 self.ignore_default_payment_terms_template = 1
tunde43870aa2017-08-18 11:59:30 +01002059
GangaManoj4323f4b2021-07-22 05:57:42 +05302060 def get_order_details(self):
2061 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302062 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302063 po_or_so_doctype = "Sales Order"
2064 po_or_so_doctype_name = "sales_order"
2065
tunde43870aa2017-08-18 11:59:30 +01002066 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302067 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302068 po_or_so_doctype = "Purchase Order"
2069 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05302070
GangaManoj4323f4b2021-07-22 05:57:42 +05302071 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
2072
GangaManojc7c90242021-07-29 19:18:35 +05302073 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302074 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05302075 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302076 return True
2077 elif self.linked_order_has_payment_schedule(po_or_so):
2078 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05302079
GangaManoj4323f4b2021-07-22 05:57:42 +05302080 return False
2081
2082 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302083 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05302084 if item.get(fieldname) != po_or_so:
2085 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05302086
GangaManoj4323f4b2021-07-22 05:57:42 +05302087 return True
2088
GangaManojc7c90242021-07-29 19:18:35 +05302089 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302090 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05302091
2092 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302093 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05302094
2095 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
2096 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302097 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05302098 """
2099 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
2100
2101 self.payment_schedule = []
2102 self.payment_terms_template = po_or_so.payment_terms_template
2103
2104 for schedule in po_or_so.payment_schedule:
2105 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302106 "payment_term": schedule.payment_term,
2107 "due_date": schedule.due_date,
2108 "invoice_portion": schedule.invoice_portion,
2109 "mode_of_payment": schedule.mode_of_payment,
2110 "description": schedule.description,
Deepesh Garg5c758942023-04-16 17:11:24 +05302111 "payment_amount": schedule.payment_amount,
2112 "base_payment_amount": schedule.base_payment_amount,
2113 "outstanding": schedule.outstanding,
2114 "paid_amount": schedule.paid_amount,
GangaManoj4323f4b2021-07-22 05:57:42 +05302115 }
GangaManoj5b33e752021-08-05 21:50:09 +05302116
Ankush Menat494bd9e2022-03-28 18:52:46 +05302117 if schedule.discount_type == "Percentage":
2118 payment_schedule["discount_type"] = schedule.discount_type
2119 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05302120
ruthra kumar9bd56b02022-02-01 14:14:04 +05302121 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302122 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05302123
GangaManoj4323f4b2021-07-22 05:57:42 +05302124 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01002125
tundebe1b8712017-08-19 08:21:44 +01002126 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05302127 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
2128 if due_dates:
2129 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01002130
2131 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01002132 dates = []
tunde9bed2de2017-09-25 10:19:35 +01002133 li = []
tunde43870aa2017-08-18 11:59:30 +01002134
Ankush Menat494bd9e2022-03-28 18:52:46 +05302135 if self.doctype == "Sales Invoice" and self.is_pos:
2136 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302137
tunde43870aa2017-08-18 11:59:30 +01002138 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302139 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302140 frappe.throw(
2141 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
2142 )
tunde77ecacc2017-09-22 23:12:55 +01002143 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03002144 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01002145 dates.append(d.due_date)
2146
2147 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302148 duplicates = "<br>" + "<br>".join(li)
2149 frappe.throw(
2150 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
2151 )
tunde43870aa2017-08-18 11:59:30 +01002152
tunde62af5c52017-09-22 15:16:38 +01002153 def validate_payment_schedule_amount(self):
Deepesh Garg53bf44d2024-01-09 15:57:38 +05302154 if (self.doctype == "Sales Invoice" and self.is_pos) or self.get("is_opening") == "Yes":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302155 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302156
Ankush Menat494bd9e2022-03-28 18:52:46 +05302157 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302158 if not party_account_currency:
2159 party_type, party = self.get_party()
2160
2161 if party_type and party:
2162 party_account_currency = get_party_account_currency(party_type, party, self.company)
2163
Nabin Hait0551f7b2017-11-21 19:58:16 +05302164 if self.get("payment_schedule"):
2165 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05302166 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05302167 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05302168 total += flt(d.payment_amount, d.precision("payment_amount"))
2169 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01002170
Saqib Ansarid552fe62021-04-23 14:46:52 +05302171 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2172 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302173
Nabin Haite591c852017-12-21 11:46:30 +05302174 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302175 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05302176 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05302177
2178 if self.get("total_advance"):
2179 if party_account_currency == self.company_currency:
2180 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302181 grand_total = flt(
2182 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2183 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302184 else:
2185 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302186 base_grand_total = flt(
2187 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2188 )
Deepesh Garg9c170522021-10-25 20:06:24 +05302189
Ankush Menat494bd9e2022-03-28 18:52:46 +05302190 if (
2191 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
2192 > 0.1
2193 or flt(base_total, self.precision("base_grand_total"))
2194 - flt(base_grand_total, self.precision("base_grand_total"))
2195 > 0.1
2196 ):
2197 frappe.throw(
2198 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
2199 )
tunde43870aa2017-08-18 11:59:30 +01002200
Nabin Hait877e1bb2017-11-17 12:27:43 +05302201 def is_rounded_total_disabled(self):
2202 if self.meta.get_field("disable_rounded_total"):
2203 return self.disable_rounded_total
2204 else:
2205 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
2206
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302207 def set_inter_company_account(self):
2208 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302209 Set intercompany account for inter warehouse transactions
2210 This account will be used in case billing company and internal customer's
2211 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302212 """
2213
2214 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Daizy Modi4efc9472022-11-07 09:21:03 +05302215 unrealized_profit_loss_account = frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302216 "Company", self.company, "unrealized_profit_loss_account"
2217 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302218
2219 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302220 msg = _(
2221 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
2222 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302223 frappe.throw(msg)
2224
2225 self.unrealized_profit_loss_account = unrealized_profit_loss_account
2226
2227 def is_internal_transfer(self):
2228 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302229 It will an internal transfer if its an internal customer and representation
2230 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302231 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302232 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
2233 internal_party_field = "is_internal_customer"
2234 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
2235 internal_party_field = "is_internal_supplier"
Ankush Menat3714e362022-05-16 18:09:14 +05302236 else:
2237 return False
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302238
2239 if self.get(internal_party_field) and (self.represents_company == self.company):
2240 return True
2241
2242 return False
2243
Saqib Ansari977b09b2021-08-19 17:57:30 +05302244 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302245 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05302246 if not is_invoice:
2247 return
2248
Ankush Menat494bd9e2022-03-28 18:52:46 +05302249 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05302250 party_link = self.get_common_party_link()
2251 if party_link and self.outstanding_amount:
2252 self.create_advance_and_reconcile(party_link)
2253
2254 def get_common_party_link(self):
2255 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05302256 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302257 doctype="Party Link",
2258 filters={"secondary_role": party_type, "secondary_party": party},
2259 fieldname=["primary_role", "primary_party"],
2260 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05302261 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302262
2263 def create_advance_and_reconcile(self, party_link):
2264 secondary_party_type, secondary_party = self.get_party()
2265 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
2266
2267 primary_account = get_party_account(primary_party_type, primary_party, self.company)
2268 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
2269
Ankush Menat494bd9e2022-03-28 18:52:46 +05302270 jv = frappe.new_doc("Journal Entry")
2271 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302272 jv.posting_date = self.posting_date
2273 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05302274 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302275
2276 reconcilation_entry = frappe._dict()
2277 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05302278
2279 reconcilation_entry.account = secondary_account
2280 reconcilation_entry.party_type = secondary_party_type
2281 reconcilation_entry.party = secondary_party
2282 reconcilation_entry.reference_type = self.doctype
2283 reconcilation_entry.reference_name = self.name
Deepesh Gargf88431a2023-04-25 20:54:22 +05302284 reconcilation_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(
2285 self.company
2286 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302287
2288 advance_entry.account = primary_account
2289 advance_entry.party_type = primary_party_type
2290 advance_entry.party = primary_party
Deepesh Gargf88431a2023-04-25 20:54:22 +05302291 advance_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(self.company)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302292 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302293
Ankush Menat494bd9e2022-03-28 18:52:46 +05302294 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05302295 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
2296 advance_entry.debit_in_account_currency = self.outstanding_amount
2297 else:
2298 advance_entry.credit_in_account_currency = self.outstanding_amount
2299 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
2300
Ankush Menat494bd9e2022-03-28 18:52:46 +05302301 jv.append("accounts", reconcilation_entry)
2302 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302303
2304 jv.save()
2305 jv.submit()
2306
Deepesh Gargd05d1532022-06-14 12:50:49 +05302307 def check_conversion_rate(self):
2308 default_currency = erpnext.get_company_currency(self.company)
2309 if not default_currency:
2310 throw(_("Please enter default currency in Company Master"))
2311 if (
2312 (self.currency == default_currency and flt(self.conversion_rate) != 1.00)
2313 or not self.conversion_rate
2314 or (self.currency != default_currency and flt(self.conversion_rate) == 1.00)
2315 ):
2316 throw(_("Conversion rate cannot be 0 or 1"))
2317
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002318 def check_finance_books(self, item, asset):
Nabin Haitfefe9502022-09-09 14:40:36 +05302319 if (
2320 len(asset.finance_books) > 1
2321 and not item.get("finance_book")
2322 and not self.get("finance_book")
2323 and asset.finance_books[0].finance_book
2324 ):
2325 frappe.throw(
2326 _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx)
2327 )
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002328
Gursheen Anand68effd92023-09-21 17:28:07 +05302329 def check_if_fields_updated(self, fields_to_check, child_tables):
2330 # Check if any field affecting accounting entry is altered
2331 doc_before_update = self.get_doc_before_save()
2332 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
2333
2334 # Check if opening entry check updated
2335 needs_repost = doc_before_update.get("is_opening") != self.is_opening
2336
2337 if not needs_repost:
2338 # Parent Level Accounts excluding party account
2339 fields_to_check += accounting_dimensions
2340 for field in fields_to_check:
2341 if doc_before_update.get(field) != self.get(field):
2342 needs_repost = 1
2343 break
2344
2345 if not needs_repost:
2346 # Check for child tables
2347 for table in child_tables:
2348 needs_repost = check_if_child_table_updated(
2349 doc_before_update.get(table), self.get(table), child_tables[table]
2350 )
2351 if needs_repost:
2352 break
2353
2354 return needs_repost
2355
2356 @frappe.whitelist()
2357 def repost_accounting_entries(self):
2358 if self.repost_required:
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302359 repost_ledger = frappe.new_doc("Repost Accounting Ledger")
2360 repost_ledger.company = self.company
2361 repost_ledger.append("vouchers", {"voucher_type": self.doctype, "voucher_no": self.name})
Gursheen Kaur Anand1b808e12023-11-02 14:01:26 +05302362 repost_ledger.flags.ignore_permissions = True
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302363 repost_ledger.insert()
2364 repost_ledger.submit()
Gursheen Anand68effd92023-09-21 17:28:07 +05302365 self.db_set("repost_required", 0)
2366 else:
2367 frappe.throw(_("No updates pending for reposting"))
2368
Ankush Menat494bd9e2022-03-28 18:52:46 +05302369
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05302370@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05302371def get_tax_rate(account_head):
Daizy Modi4efc9472022-11-07 09:21:03 +05302372 return frappe.get_cached_value(
2373 "Account", account_head, ["tax_rate", "account_name"], as_dict=True
2374 )
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05302375
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002376
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302377@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05302378def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302379 if not company:
2380 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05302381
Nabin Haita2426fc2018-01-15 17:45:46 +05302382 if tax_template and company:
Daizy Modi4efc9472022-11-07 09:21:03 +05302383 tax_template_company = frappe.get_cached_value(master_doctype, tax_template, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +05302384 if tax_template_company == company:
2385 return
2386
2387 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05302388
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302389 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302390 "taxes_and_charges": default_tax,
2391 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302392 }
Nabin Hait6b039142014-05-02 15:45:10 +05302393
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002394
Nabin Hait6b039142014-05-02 15:45:10 +05302395@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302396def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05302397 if not master_name:
2398 return
Ankush Menat77dcdff2022-06-01 22:01:07 +05302399 from frappe.model import child_table_fields, default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05302400
Nabin Hait6b039142014-05-02 15:45:10 +05302401 tax_master = frappe.get_doc(master_doctype, master_name)
2402
2403 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302404 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05302405 tax = tax.as_dict()
2406
Ankush Menat77dcdff2022-06-01 22:01:07 +05302407 for fieldname in default_fields + child_table_fields:
Nabin Hait6b039142014-05-02 15:45:10 +05302408 if fieldname in tax:
2409 del tax[fieldname]
2410
2411 taxes_and_charges.append(tax)
2412
2413 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302414
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002415
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302416def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
2417 """common validation for currency and price list currency"""
2418
Ankush Menat494bd9e2022-03-28 18:52:46 +05302419 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302420
2421 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05302422 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302423 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
2424 conversion_rate_label, currency, company_currency
2425 )
Saqib60212ff2020-10-26 11:17:04 +05302426 )
Nabin Hait613d0812015-02-23 11:58:15 +05302427
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002428
Nabin Hait613d0812015-02-23 11:58:15 +05302429def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302430 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
2431 frappe.throw(
2432 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
2433 )
2434 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05302435 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002436 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302437 _(
2438 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
2439 )
2440 )
Nabin Hait613d0812015-02-23 11:58:15 +05302441 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302442 frappe.throw(
2443 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
2444 )
Nabin Hait613d0812015-02-23 11:58:15 +05302445 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302446 frappe.throw(
2447 _("Cannot refer row number greater than or equal to current row number for this Charge type")
2448 )
Nabin Hait613d0812015-02-23 11:58:15 +05302449
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302450 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05302451 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302452
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002453
Ankush Menat494bd9e2022-03-28 18:52:46 +05302454def validate_account_head(idx, account, company, context=""):
2455 account_company = frappe.get_cached_value("Account", account, "company")
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302456 is_group = frappe.get_cached_value("Account", account, "is_group")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302457
Deepesh Garg5a2b5712022-02-18 20:05:49 +05302458 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302459 frappe.throw(
2460 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
2461 idx, frappe.bold(account), frappe.bold(company), context
2462 ),
2463 title=_("Invalid Account"),
2464 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302465
Deepesh Gargcd37fd72023-12-29 12:52:22 +05302466 if is_group:
2467 frappe.throw(
2468 _("Row {0}: Account {1} is a Group Account").format(idx, frappe.bold(account)),
2469 title=_("Invalid Account"),
2470 )
2471
Anuja Pawar0e337be2021-08-10 17:26:35 +05302472
2473def validate_cost_center(tax, doc):
2474 if not tax.cost_center:
2475 return
2476
Ankush Menat494bd9e2022-03-28 18:52:46 +05302477 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302478
2479 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302480 frappe.throw(
2481 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
2482 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
2483 ),
2484 title=_("Invalid Cost Center"),
2485 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302486
2487
Nabin Hait613d0812015-02-23 11:58:15 +05302488def validate_inclusive_tax(tax, doc):
2489 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302490 throw(
2491 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
2492 tax.idx, row_range
2493 )
2494 )
Nabin Hait613d0812015-02-23 11:58:15 +05302495
2496 if cint(getattr(tax, "included_in_print_rate", None)):
2497 if tax.charge_type == "Actual":
2498 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05302499 throw(
2500 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
2501 tax.idx
2502 )
2503 )
2504 elif tax.charge_type == "On Previous Row Amount" and not cint(
2505 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
2506 ):
Nabin Hait613d0812015-02-23 11:58:15 +05302507 # referred row should also be inclusive
2508 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302509 elif tax.charge_type == "On Previous Row Total" and not all(
2510 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
2511 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05302512 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05302513 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05302514 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05302515 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302516
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302517
Ankush Menat494bd9e2022-03-28 18:52:46 +05302518def set_balance_in_account_currency(
2519 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
2520):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002521 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302522 frappe.throw(
2523 _("Account: {0} with currency: {1} can not be selected").format(
2524 gl_dict.account, account_currency
2525 )
2526 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002527
Ankush Menat494bd9e2022-03-28 18:52:46 +05302528 gl_dict["account_currency"] = (
2529 company_currency if account_currency == company_currency else account_currency
2530 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302531
2532 # set debit/credit in account currency if not provided
2533 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302534 gl_dict.debit_in_account_currency = (
2535 gl_dict.debit
2536 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302537 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302538 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302539
2540 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302541 gl_dict.credit_in_account_currency = (
2542 gl_dict.credit
2543 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302544 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302545 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302546
2547
Ankush Menat494bd9e2022-03-28 18:52:46 +05302548def get_advance_journal_entries(
2549 party_type,
2550 party,
2551 party_account,
2552 amount_field,
2553 order_doctype,
2554 order_list,
2555 include_unallocated=True,
2556):
Gursheen Anand4ee16372023-06-08 13:15:23 +05302557 journal_entry = frappe.qb.DocType("Journal Entry")
2558 journal_acc = frappe.qb.DocType("Journal Entry Account")
2559 q = (
2560 frappe.qb.from_(journal_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302561 .inner_join(journal_acc)
2562 .on(journal_entry.name == journal_acc.parent)
2563 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302564 ConstantColumn("Journal Entry").as_("reference_type"),
2565 (journal_entry.name).as_("reference_name"),
2566 (journal_entry.remark).as_("remarks"),
Deepesh Garg3aead052023-06-22 11:41:43 +05302567 (journal_acc[amount_field]).as_("amount"),
Gursheen Anand4ee16372023-06-08 13:15:23 +05302568 (journal_acc.name).as_("reference_row"),
2569 (journal_acc.reference_name).as_("against_order"),
2570 (journal_acc.exchange_rate),
Gursheen Anand74619262023-06-02 17:13:51 +05302571 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302572 .where(
2573 journal_acc.account.isin(party_account)
2574 & (journal_acc.party_type == party_type)
2575 & (journal_acc.party == party)
2576 & (journal_acc.is_advance == "Yes")
2577 & (journal_entry.docstatus == 1)
2578 )
2579 )
Gursheen Anand74619262023-06-02 17:13:51 +05302580 if party_type == "Customer":
2581 q = q.where(journal_acc.credit_in_account_currency > 0)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302582
Gursheen Anand4ee16372023-06-08 13:15:23 +05302583 else:
2584 q = q.where(journal_acc.debit_in_account_currency > 0)
2585
Deepesh Garg3aead052023-06-22 11:41:43 +05302586 if include_unallocated:
2587 q = q.where((journal_acc.reference_name.isnull()) | (journal_acc.reference_name == ""))
2588
Nabin Hait1991c7b2016-06-27 20:09:05 +05302589 if order_list:
Deepesh Garg3aead052023-06-22 11:41:43 +05302590 q = q.where(
Deepesh Garg6d121ae2023-06-22 13:03:09 +05302591 (journal_acc.reference_type == order_doctype) & ((journal_acc.reference_type).isin(order_list))
Deepesh Garg3aead052023-06-22 11:41:43 +05302592 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302593
Gursheen Anand74619262023-06-02 17:13:51 +05302594 q = q.orderby(journal_entry.posting_date)
Rushabh Mehta66958302017-01-16 16:57:53 +05302595
Gursheen Anand74619262023-06-02 17:13:51 +05302596 journal_entries = q.run(as_dict=True)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302597 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302598
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002599
Smit Vora3e282bf2023-09-19 20:47:21 +05302600@erpnext.allow_regional
2601def get_advance_payment_entries_for_regional(*args, **kwargs):
2602 return get_advance_payment_entries(*args, **kwargs)
2603
2604
Ankush Menat494bd9e2022-03-28 18:52:46 +05302605def get_advance_payment_entries(
2606 party_type,
2607 party,
2608 party_account,
2609 order_doctype,
2610 order_list=None,
2611 include_unallocated=True,
2612 against_all_orders=False,
2613 limit=None,
2614 condition=None,
2615):
Gursheen Anand74619262023-06-02 17:13:51 +05302616
Deepesh Garg92f845c2023-06-21 12:21:19 +05302617 payment_entries = []
2618 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand74619262023-06-02 17:13:51 +05302619
Deepesh Garg92f845c2023-06-21 12:21:19 +05302620 if order_list or against_all_orders:
2621 q = get_common_query(
2622 party_type,
2623 party,
2624 party_account,
2625 limit,
2626 condition,
2627 )
2628 payment_ref = frappe.qb.DocType("Payment Entry Reference")
Gursheen Anand74619262023-06-02 17:13:51 +05302629
Deepesh Garg92f845c2023-06-21 12:21:19 +05302630 q = q.inner_join(payment_ref).on(payment_entry.name == payment_ref.parent)
2631 q = q.select(
2632 (payment_ref.allocated_amount).as_("amount"),
2633 (payment_ref.name).as_("reference_row"),
2634 (payment_ref.reference_name).as_("against_order"),
Deepesh Garg92f845c2023-06-21 12:21:19 +05302635 )
2636
Deepesh Garg3aead052023-06-22 11:41:43 +05302637 q = q.where(payment_ref.reference_doctype == order_doctype)
Deepesh Garg92f845c2023-06-21 12:21:19 +05302638 if order_list:
2639 q = q.where(payment_ref.reference_name.isin(order_list))
2640
2641 allocated = list(q.run(as_dict=True))
2642 payment_entries += allocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302643 if include_unallocated:
2644 q = get_common_query(
2645 party_type,
2646 party,
2647 party_account,
2648 limit,
2649 condition,
2650 )
2651 q = q.select((payment_entry.unallocated_amount).as_("amount"))
2652 q = q.where(payment_entry.unallocated_amount > 0)
2653
2654 unallocated = list(q.run(as_dict=True))
2655 payment_entries += unallocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302656 return payment_entries
Gursheen Anand74619262023-06-02 17:13:51 +05302657
Saqiba20999c2021-07-12 14:33:23 +05302658
Deepesh Garg92f845c2023-06-21 12:21:19 +05302659def get_common_query(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302660 party_type,
2661 party,
2662 party_account,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302663 limit,
2664 condition,
2665):
RitvikSardanad2f03c82023-09-05 12:00:54 +05302666 account_type = frappe.db.get_value("Party Type", party_type, "account_type")
2667 payment_type = "Receive" if account_type == "Receivable" else "Pay"
Gursheen Anand4ee16372023-06-08 13:15:23 +05302668 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand4ee16372023-06-08 13:15:23 +05302669
2670 q = (
2671 frappe.qb.from_(payment_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302672 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302673 ConstantColumn("Payment Entry").as_("reference_type"),
2674 (payment_entry.name).as_("reference_name"),
Gursheen Anand74619262023-06-02 17:13:51 +05302675 payment_entry.posting_date,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302676 (payment_entry.remarks).as_("remarks"),
Ankush Menat494bd9e2022-03-28 18:52:46 +05302677 )
Gursheen Anand74619262023-06-02 17:13:51 +05302678 .where(payment_entry.payment_type == payment_type)
2679 .where(payment_entry.party_type == party_type)
2680 .where(payment_entry.party == party)
2681 .where(payment_entry.docstatus == 1)
2682 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302683
RitvikSardanad2f03c82023-09-05 12:00:54 +05302684 if payment_type == "Receive":
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302685 q = q.select((payment_entry.paid_from_account_currency).as_("currency"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302686 q = q.select(payment_entry.paid_from)
2687 q = q.where(payment_entry.paid_from.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302688 else:
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302689 q = q.select((payment_entry.paid_to_account_currency).as_("currency"))
Gursheen Anand74619262023-06-02 17:13:51 +05302690 q = q.select(payment_entry.paid_to)
Gursheen Anand4ee16372023-06-08 13:15:23 +05302691 q = q.where(payment_entry.paid_to.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302692
2693 if payment_type == "Receive":
Deepesh Garg92f845c2023-06-21 12:21:19 +05302694 q = q.select((payment_entry.source_exchange_rate).as_("exchange_rate"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302695 else:
Deepesh Garg92f845c2023-06-21 12:21:19 +05302696 q = q.select((payment_entry.target_exchange_rate).as_("exchange_rate"))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302697
Deepesh Garg92f845c2023-06-21 12:21:19 +05302698 if condition:
ruthra kumarff60ec82023-12-15 17:25:02 +05302699 # conditions should be built as an array and passed as Criterion
2700 common_filter_conditions = []
ruthra kumar86bac2c2023-07-04 09:02:05 +05302701
ruthra kumarff60ec82023-12-15 17:25:02 +05302702 common_filter_conditions.append(payment_entry.company == condition["company"])
2703 if condition.get("name", None):
2704 common_filter_conditions.append(payment_entry.name.like(f"%{condition.get('name')}%"))
2705
2706 if condition.get("from_payment_date"):
2707 common_filter_conditions.append(payment_entry.posting_date.gte(condition["from_payment_date"]))
2708
2709 if condition.get("to_payment_date"):
2710 common_filter_conditions.append(payment_entry.posting_date.lte(condition["to_payment_date"]))
2711
Deepesh Garg92f845c2023-06-21 12:21:19 +05302712 if condition.get("get_payments") == True:
ruthra kumarff60ec82023-12-15 17:25:02 +05302713 if condition.get("cost_center"):
2714 common_filter_conditions.append(payment_entry.cost_center == condition["cost_center"])
2715
2716 if condition.get("accounting_dimensions"):
2717 for field, val in condition.get("accounting_dimensions").items():
2718 common_filter_conditions.append(payment_entry[field] == val)
2719
2720 if condition.get("minimum_payment_amount"):
2721 common_filter_conditions.append(
2722 payment_entry.unallocated_amount.gte(condition["minimum_payment_amount"])
2723 )
2724
2725 if condition.get("maximum_payment_amount"):
2726 common_filter_conditions.append(
2727 payment_entry.unallocated_amount.lte(condition["maximum_payment_amount"])
2728 )
2729 q = q.where(Criterion.all(common_filter_conditions))
Gursheen Anand74619262023-06-02 17:13:51 +05302730
2731 q = q.orderby(payment_entry.posting_date)
2732 q = q.limit(limit) if limit else q
Deepesh Garg92f845c2023-06-21 12:21:19 +05302733
Gursheen Anand74619262023-06-02 17:13:51 +05302734 return q
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302735
Ankush Menat494bd9e2022-03-28 18:52:46 +05302736
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302737def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302738 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302739 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302740 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302741 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302742 invoice = frappe.qb.DocType(doctype)
2743
2744 consider_base_amount = invoice.party_account_currency != invoice.currency
2745 payment_amount = (
2746 frappe.qb.terms.Case()
2747 .when(consider_base_amount, payment_schedule.base_payment_amount)
2748 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302749 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002750
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302751 payable_amount = (
2752 frappe.qb.from_(payment_schedule)
2753 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302754 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302755 )
2756
2757 total = (
2758 frappe.qb.terms.Case()
2759 .when(invoice.disable_rounded_total, invoice.grand_total)
2760 .else_(invoice.rounded_total)
2761 )
2762
2763 base_total = (
2764 frappe.qb.terms.Case()
2765 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2766 .else_(invoice.base_rounded_total)
2767 )
2768
Ankush Menat494bd9e2022-03-28 18:52:46 +05302769 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302770
2771 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2772
2773 conditions = (
2774 (invoice.docstatus == 1)
2775 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302776 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302777 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302778 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302779 if doctype == "Sales Invoice"
2780 else is_overdue
2781 )
2782 )
2783
Pruthvi Patel0799f372021-11-12 12:56:29 +05302784 status = (
2785 frappe.qb.terms.Case()
2786 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2787 .else_("Overdue")
2788 )
2789
2790 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302791
2792
Nabin Hait92759692017-08-15 08:23:51 +05302793@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302794def get_payment_terms(
2795 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2796):
Nabin Hait92759692017-08-15 08:23:51 +05302797 if not terms_template:
2798 return
2799
2800 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2801
2802 schedule = []
tundefb144302017-08-19 15:01:40 +01002803 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302804 term_details = get_payment_term_details(
2805 d, posting_date, grand_total, base_grand_total, bill_date
2806 )
Nabin Hait92759692017-08-15 08:23:51 +05302807 schedule.append(term_details)
2808
2809 return schedule
2810
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002811
Nabin Hait92759692017-08-15 08:23:51 +05302812@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302813def get_payment_term_details(
2814 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2815):
Nabin Hait92759692017-08-15 08:23:51 +05302816 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302817 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302818 term = frappe.get_doc("Payment Term", term)
2819 else:
2820 term_details.payment_term = term.payment_term
2821 term_details.description = term.description
2822 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302823 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302824 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302825 term_details.discount_type = term.discount_type
2826 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302827 term_details.outstanding = term_details.payment_amount
2828 term_details.mode_of_payment = term.mode_of_payment
2829
Shreya Shah3a9eec22018-02-16 13:05:21 +05302830 if bill_date:
2831 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302832 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302833 elif posting_date:
2834 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302835 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302836
2837 if getdate(term_details.due_date) < getdate(posting_date):
2838 term_details.due_date = posting_date
2839
Nabin Hait92759692017-08-15 08:23:51 +05302840 return term_details
2841
Ankush Menat494bd9e2022-03-28 18:52:46 +05302842
Shreya Shah3a9eec22018-02-16 13:05:21 +05302843def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302844 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302845 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302846 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302847 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302848 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302849 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302850 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302851 due_date = get_last_day(add_months(date, term.credit_months))
tunde96b8f222017-09-08 15:35:59 +01002852 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002853
Ankush Menat494bd9e2022-03-28 18:52:46 +05302854
Saqib0586b7d2021-03-31 15:03:53 +05302855def get_discount_date(term, posting_date=None, bill_date=None):
2856 discount_validity = None
2857 date = bill_date or posting_date
2858 if term.discount_validity_based_on == "Day(s) after invoice date":
2859 discount_validity = add_days(date, term.discount_validity)
2860 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2861 discount_validity = add_days(get_last_day(date), term.discount_validity)
2862 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302863 discount_validity = get_last_day(add_months(date, term.discount_validity))
Saqib0586b7d2021-03-31 15:03:53 +05302864 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002865
Ankush Menat494bd9e2022-03-28 18:52:46 +05302866
tundebabzyad08d4c2018-05-16 07:01:41 +01002867def get_supplier_block_status(party_name):
2868 """
2869 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2870 a `Supplier`
2871 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302872 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002873 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302874 "on_hold": supplier.on_hold,
2875 "release_date": supplier.release_date,
2876 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002877 }
2878 return info
2879
Ankush Menat494bd9e2022-03-28 18:52:46 +05302880
marination698d9832020-08-19 14:59:46 +05302881def set_child_tax_template_and_map(item, child_item, parent_doc):
2882 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302883 "item_code": item.item_code,
2884 "posting_date": parent_doc.transaction_date,
2885 "tax_category": parent_doc.get("tax_category"),
2886 "company": parent_doc.get("company"),
2887 }
marination698d9832020-08-19 14:59:46 +05302888
2889 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2890 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302891 child_item.item_tax_rate = get_item_tax_map(
2892 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2893 )
2894
marination698d9832020-08-19 14:59:46 +05302895
Afshanb3bbebd2021-08-09 14:39:32 +05302896def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302897 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2898 "Accounts Settings", "add_taxes_from_item_tax_template"
2899 )
Marica3b1be2b2020-10-22 17:04:31 +05302900
2901 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2902 tax_map = json.loads(child_item.get("item_tax_rate"))
2903 for tax_type in tax_map:
2904 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302905 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302906 # add new row for tax head only if missing
2907 found = any(tax.account_head == tax_type for tax in taxes)
2908 if not found:
2909 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302910 tax_row.update(
2911 {
2912 "description": str(tax_type).split(" - ")[0],
2913 "charge_type": "On Net Total",
2914 "account_head": tax_type,
2915 "rate": tax_rate,
2916 }
2917 )
Marica3b1be2b2020-10-22 17:04:31 +05302918 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302919 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302920 if db_insert:
2921 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302922
Ankush Menat494bd9e2022-03-28 18:52:46 +05302923
2924def set_order_defaults(
2925 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2926):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002927 """
pateljannat637ddff2021-02-09 16:17:30 +05302928 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002929 """
Saqib438e0432020-04-03 10:02:56 +05302930 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
Ankush Menat686685b2023-05-31 12:50:14 +05302931 child_item = frappe.new_doc(child_doctype, parent_doc=p_doc, parentfield=child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302932 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05302933
pateljannat637ddff2021-02-09 16:17:30 +05302934 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05302935 child_item.update({field: item.get(field)})
2936
pateljannat637ddff2021-02-09 16:17:30 +05302937 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05302938 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05302939 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05302940 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13002941 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302942 conversion_factor = flt(
2943 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
2944 )
2945 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05302946
pateljannat637ddff2021-02-09 16:17:30 +05302947 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05302948 # Initialized value will update in parent validation
2949 child_item.base_rate = 1
2950 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05302951 if child_doctype == "Sales Order Item":
2952 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
2953 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302954 frappe.throw(
2955 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
2956 frappe.bold("default warehouse"), frappe.bold(item.item_code)
2957 )
2958 )
marination0673f552021-03-31 01:38:22 +05302959
marination698d9832020-08-19 14:59:46 +05302960 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05302961 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002962 return child_item
2963
Ankush Menat494bd9e2022-03-28 18:52:46 +05302964
marination0673f552021-03-31 01:38:22 +05302965def validate_child_on_delete(row, parent):
2966 """Check if partially transacted item (row) is being deleted."""
2967 if parent.doctype == "Sales Order":
2968 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302969 frappe.throw(
2970 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
2971 row.idx, row.item_code
2972 )
2973 )
marination0673f552021-03-31 01:38:22 +05302974 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302975 frappe.throw(
2976 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
2977 row.idx, row.item_code
2978 )
2979 )
marination0673f552021-03-31 01:38:22 +05302980 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302981 frappe.throw(
2982 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
2983 row.idx, row.item_code
2984 )
2985 )
marination0673f552021-03-31 01:38:22 +05302986
2987 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302988 frappe.throw(
2989 _("Row #{0}: Cannot delete item {1} which has already been received").format(
2990 row.idx, row.item_code
2991 )
2992 )
marination0673f552021-03-31 01:38:22 +05302993
2994 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302995 frappe.throw(
2996 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
2997 row.idx, row.item_code
2998 )
2999 )
3000
marination0673f552021-03-31 01:38:22 +05303001
3002def update_bin_on_delete(row, doctype):
3003 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05303004 from erpnext.stock.stock_balance import (
3005 get_indented_qty,
3006 get_ordered_qty,
3007 get_reserved_qty,
3008 update_bin_qty,
3009 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05303010
marination0673f552021-03-31 01:38:22 +05303011 qty_dict = {}
3012
3013 if doctype == "Sales Order":
3014 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
3015 else:
3016 if row.material_request_item:
3017 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
3018
3019 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
3020
Deepesh Garga61790c2022-02-22 20:58:10 +05303021 if row.warehouse:
3022 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05303023
Ankush Menat494bd9e2022-03-28 18:52:46 +05303024
Ankush Menatdd11f262022-06-27 15:55:08 +05303025def validate_and_delete_children(parent, data) -> bool:
Saqib0ad74492019-12-24 16:42:30 +05303026 deleted_children = []
3027 updated_item_names = [d.get("docname") for d in data]
3028 for item in parent.items:
3029 if item.name not in updated_item_names:
3030 deleted_children.append(item)
3031
3032 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05303033 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05303034 d.cancel()
3035 d.delete()
marination0673f552021-03-31 01:38:22 +05303036
Gursheen Kaur Anand9087e142023-12-02 19:53:00 +05303037 if parent.doctype == "Purchase Order":
3038 parent.update_ordered_qty_in_so_for_removed_items(deleted_children)
3039
marination0673f552021-03-31 01:38:22 +05303040 # need to update ordered qty in Material Request first
3041 # bin uses Material Request Items to recalculate & update
3042 parent.update_prevdoc_status()
3043
3044 for d in deleted_children:
3045 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003046
Ankush Menatdd11f262022-06-27 15:55:08 +05303047 return bool(deleted_children)
3048
Rohan Bansala93b5142021-04-06 17:10:52 +05303049
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003050@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003051def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303052 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303053 try:
3054 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05303055 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303056 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05303057
Ankush Menat494bd9e2022-03-28 18:52:46 +05303058 frappe.throw(
3059 _("You do not have permissions to {} items in a {}.").format(
3060 actions[perm_type], parent_doctype
3061 ),
3062 title=_("Insufficient Permissions"),
3063 )
marination665c27a2020-09-15 12:04:38 +05303064
Saqib6db92fb2020-09-14 19:54:17 +05303065 def validate_workflow_conditions(doc):
3066 workflow = get_workflow_name(doc.doctype)
3067 if not workflow:
3068 return
3069
3070 workflow_doc = frappe.get_doc("Workflow", workflow)
3071 current_state = doc.get(workflow_doc.workflow_state_field)
3072 roles = frappe.get_roles()
3073
3074 transitions = []
3075 for transition in workflow_doc.transitions:
3076 if transition.next_state == current_state and transition.allowed in roles:
3077 if not is_transition_condition_satisfied(transition, doc):
3078 continue
3079 transitions.append(transition.as_dict())
3080
3081 if not transitions:
Saqib18318932020-09-23 13:01:49 +05303082 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05303083 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
3084 get_link_to_form("Workflow", workflow)
3085 ),
3086 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05303087 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303088
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303089 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05303090 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303091 return set_order_defaults(
3092 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
3093 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303094
marination0c915432022-05-10 18:04:02 +05303095 def validate_quantity(child_item, new_data):
3096 if not flt(new_data.get("qty")):
3097 frappe.throw(
Bernd Oliver Sünderhauf4918aeb2023-11-14 19:43:26 +01003098 _("Row #{0}: Quantity for Item {1} cannot be zero.").format(
marination0c915432022-05-10 18:04:02 +05303099 new_data.get("idx"), frappe.bold(new_data.get("item_code"))
3100 ),
3101 title=_("Invalid Qty"),
3102 )
3103
3104 if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303105 frappe.throw(_("Cannot set quantity less than delivered quantity"))
3106
marination0c915432022-05-10 18:04:02 +05303107 if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt(
3108 child_item.received_qty
3109 ):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303110 frappe.throw(_("Cannot set quantity less than received quantity"))
3111
Ankush Menatdd11f262022-06-27 15:55:08 +05303112 def should_update_supplied_items(doc) -> bool:
3113 """Subcontracted PO can allow following changes *after submit*:
3114
3115 1. Change rate of subcontracting - regardless of other changes.
3116 2. Change qty and/or add new items and/or remove items
3117 Exception: Transfer/Consumption is already made, qty change not allowed.
3118 """
3119
3120 supplied_items_processed = any(
3121 item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items
3122 )
3123
3124 update_supplied_items = (
3125 any_qty_changed or items_added_or_removed or any_conversion_factor_changed
3126 )
3127 if update_supplied_items and supplied_items_processed:
3128 frappe.throw(_("Item qty can not be updated as raw materials are already processed."))
3129
3130 return update_supplied_items
3131
s-aga-r9588bb72023-08-21 22:23:57 +05303132 def validate_fg_item_for_subcontracting(new_data, is_new):
3133 if is_new:
3134 if not new_data.get("fg_item"):
3135 frappe.throw(
3136 _("Finished Good Item is not specified for service item {0}").format(new_data["item_code"])
3137 )
3138 else:
3139 is_sub_contracted_item, default_bom = frappe.db.get_value(
3140 "Item", new_data["fg_item"], ["is_sub_contracted_item", "default_bom"]
3141 )
3142
3143 if not is_sub_contracted_item:
3144 frappe.throw(
3145 _("Finished Good Item {0} must be a sub-contracted item").format(new_data["fg_item"])
3146 )
3147 elif not default_bom:
3148 frappe.throw(_("Default BOM not found for FG Item {0}").format(new_data["fg_item"]))
3149
3150 if not new_data.get("fg_item_qty"):
3151 frappe.throw(_("Finished Good Item {0} Qty can not be zero").format(new_data["fg_item"]))
3152
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003153 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003154
Ankush Menatdd11f262022-06-27 15:55:08 +05303155 any_qty_changed = False # updated to true if any item's qty changes
3156 items_added_or_removed = False # updated to true if any new item is added or removed
3157 any_conversion_factor_changed = False
3158
Ankush Menat494bd9e2022-03-28 18:52:46 +05303159 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303160 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05303161
Ankush Menat494bd9e2022-03-28 18:52:46 +05303162 check_doc_permissions(parent, "write")
Ankush Menatdd11f262022-06-27 15:55:08 +05303163 _removed_items = validate_and_delete_children(parent, data)
3164 items_added_or_removed |= _removed_items
Saqib0ad74492019-12-24 16:42:30 +05303165
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003166 for d in data:
3167 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05303168
3169 if not d.get("item_code"):
3170 # ignore empty rows
3171 continue
3172
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003173 if not d.get("docname"):
3174 new_child_flag = True
Ankush Menatdd11f262022-06-27 15:55:08 +05303175 items_added_or_removed = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05303176 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303177 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003178 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303179 check_doc_permissions(parent, "write")
3180 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303181
Saqib Ansaric579b082020-05-29 22:21:50 +05303182 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
3183 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
s-aga-r9588bb72023-08-21 22:23:57 +05303184 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 +05303185 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
3186 d.get("conversion_factor")
3187 )
Saqib61314242020-09-15 11:14:31 +05303188 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05303189
Ankush Menat494bd9e2022-03-28 18:52:46 +05303190 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05303191 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303192 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05303193 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303194
3195 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05303196 qty_unchanged = prev_qty == new_qty
s-aga-r9588bb72023-08-21 22:23:57 +05303197 fg_qty_unchanged = prev_fg_qty == new_fg_qty
Saqib61314242020-09-15 11:14:31 +05303198 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05303199 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menatdd11f262022-06-27 15:55:08 +05303200 any_conversion_factor_changed |= not conversion_factor_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303201 date_unchanged = (
3202 prev_date == getdate(new_date) if prev_date and new_date else False
3203 ) # in case of delivery note etc
3204 if (
3205 rate_unchanged
3206 and qty_unchanged
s-aga-r9588bb72023-08-21 22:23:57 +05303207 and fg_qty_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303208 and conversion_factor_unchanged
3209 and uom_unchanged
3210 and date_unchanged
3211 ):
Saqibdd374ff2020-02-27 12:51:31 +05303212 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003213
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303214 validate_quantity(child_item, d)
Ankush Menatdd11f262022-06-27 15:55:08 +05303215 if flt(child_item.get("qty")) != flt(d.get("qty")):
3216 any_qty_changed = True
deepeshgarg00777cde832018-12-27 15:56:51 +05303217
s-aga-r9588bb72023-08-21 22:23:57 +05303218 if (
3219 parent.doctype == "Purchase Order"
3220 and parent.is_subcontracted
3221 and not parent.is_old_subcontracting_flow
3222 ):
3223 validate_fg_item_for_subcontracting(d, new_child_flag)
3224 child_item.fg_item_qty = flt(d["fg_item_qty"])
3225
3226 if new_child_flag:
3227 child_item.fg_item = d["fg_item"]
3228
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003229 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05303230 rate_precision = child_item.precision("rate") or 2
3231 conv_fac_precision = child_item.precision("conversion_factor") or 2
3232 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003233
Maricab9f5a1c2023-11-27 09:05:22 +05303234 # Amount cannot be lesser than billed amount, except for negative amounts
3235 row_rate = flt(d.get("rate"), rate_precision)
3236 amount_below_billed_amt = flt(child_item.billed_amt, rate_precision) > flt(
3237 row_rate * flt(d.get("qty"), qty_precision), rate_precision
3238 )
3239 if amount_below_billed_amt and row_rate > 0.0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303240 frappe.throw(
3241 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
3242 child_item.idx, child_item.item_code
3243 )
3244 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003245 else:
Maricab9f5a1c2023-11-27 09:05:22 +05303246 child_item.rate = row_rate
marinationf9c4b202020-06-12 15:49:53 +05303247
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303248 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05303249 if child_item.stock_uom == child_item.uom:
3250 child_item.conversion_factor = 1
3251 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303252 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05303253
Saqib61314242020-09-15 11:14:31 +05303254 if d.get("uom"):
3255 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303256 conversion_factor = flt(
3257 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
3258 )
3259 child_item.conversion_factor = (
3260 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
3261 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303262
Ankush Menat494bd9e2022-03-28 18:52:46 +05303263 if d.get("delivery_date") and parent_doctype == "Sales Order":
3264 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05303265
Ankush Menat494bd9e2022-03-28 18:52:46 +05303266 if d.get("schedule_date") and parent_doctype == "Purchase Order":
3267 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303268
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303269 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05303270 if flt(child_item.rate) > flt(child_item.price_list_rate):
3271 # if rate is greater than price_list_rate, set margin
3272 # or set discount
3273 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05303274
3275 if parent_doctype in sales_doctypes:
3276 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303277 child_item.margin_rate_or_amount = flt(
3278 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
3279 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05303280 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05303281 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303282 child_item.discount_percentage = flt(
3283 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
3284 child_item.precision("discount_percentage"),
3285 )
3286 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05303287
3288 if parent_doctype in sales_doctypes:
3289 child_item.margin_type = ""
3290 child_item.margin_rate_or_amount = 0
3291 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303292
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003293 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003294 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05303295 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303296 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003297 child_item.insert()
3298 else:
3299 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003300
Rushabh Mehtafafbb022018-12-24 22:09:15 +05303301 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303302 parent.flags.ignore_validate_update_after_submit = True
3303 parent.set_qty_as_per_stock_uom()
3304 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05303305 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05303306 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05303307 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05303308 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303309 frappe.get_doc("Authorization Control").validate_approving_authority(
3310 parent.doctype, parent.company, parent.base_grand_total
3311 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003312
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303313 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303314 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303315 parent.validate_minimum_order_qty()
3316 parent.validate_budget()
3317 if parent.is_against_so():
3318 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05303319 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303320 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05303321
3322 # reset index of child table
3323 for idx, row in enumerate(parent.get(child_docname), start=1):
3324 row.idx = idx
3325
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303326 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05303327
Ankush Menat494bd9e2022-03-28 18:52:46 +05303328 if parent_doctype == "Purchase Order":
3329 update_last_purchase_rate(parent, is_submit=1)
s-aga-r68f5dd32023-12-01 14:45:01 +05303330
3331 if any_qty_changed or items_added_or_removed or any_conversion_factor_changed:
3332 parent.update_prevdoc_status()
3333
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303334 parent.update_requested_qty()
3335 parent.update_ordered_qty()
3336 parent.update_ordered_and_reserved_qty()
3337 parent.update_receiving_percentage()
s-aga-rb9b17172023-08-22 16:53:54 +05303338
3339 if parent.is_subcontracted:
3340 if parent.is_old_subcontracting_flow:
3341 if should_update_supplied_items(parent):
3342 parent.update_reserved_qty_for_subcontract()
3343 parent.create_raw_materials_supplied()
3344 parent.save()
3345 else:
3346 if not parent.can_update_items():
3347 frappe.throw(
3348 _(
3349 "Items cannot be updated as Subcontracting Order is created against the Purchase Order {0}."
3350 ).format(frappe.bold(parent.name))
3351 )
Ankush Menatc84e11a2022-06-01 12:55:10 +05303352 else: # Sales Order
3353 parent.validate_warehouse()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303354 parent.update_reserved_qty()
3355 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303356 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303357 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05303358
Saqib6db92fb2020-09-14 19:54:17 +05303359 parent.reload()
3360 validate_workflow_conditions(parent)
3361
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303362 parent.update_blanket_order()
3363 parent.update_billing_percentage()
3364 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05303365
s-aga-rac24d772023-04-05 19:48:15 +05303366 # Cancel and Recreate Stock Reservation Entries.
s-aga-r38e93672023-04-02 21:24:59 +05303367 if parent_doctype == "Sales Order":
3368 from erpnext.stock.doctype.stock_reservation_entry.stock_reservation_entry import (
3369 cancel_stock_reservation_entries,
3370 has_reserved_stock,
s-aga-r38e93672023-04-02 21:24:59 +05303371 )
3372
3373 if has_reserved_stock(parent.doctype, parent.name):
3374 cancel_stock_reservation_entries(parent.doctype, parent.name)
s-aga-r2d8363a2023-09-02 11:02:24 +05303375
3376 if parent.per_picked == 0:
3377 parent.create_stock_reservation_entries()
s-aga-r38e93672023-04-02 21:24:59 +05303378
Ankush Menat494bd9e2022-03-28 18:52:46 +05303379
Gursheen Anand68effd92023-09-21 17:28:07 +05303380def check_if_child_table_updated(
3381 child_table_before_update, child_table_after_update, fields_to_check
3382):
3383 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
3384 # Check if any field affecting accounting entry is altered
3385 for index, item in enumerate(child_table_after_update):
3386 for field in fields_to_check:
3387 if child_table_before_update[index].get(field) != item.get(field):
3388 return True
3389
3390 for dimension in accounting_dimensions:
3391 if child_table_before_update[index].get(dimension) != item.get(dimension):
3392 return True
3393
3394 return False
3395
3396
Gursheen Ananda06017c2023-06-12 15:24:53 +05303397@erpnext.allow_regional
3398def validate_regional(doc):
3399 pass
3400
3401
3402@erpnext.allow_regional
3403def validate_einvoice_fields(doc):
3404 pass
3405
3406
3407@erpnext.allow_regional
3408def update_gl_dict_with_regional_fields(doc, gl_dict):
3409 pass