blob: d88424b7e728efd8327ee7c91b1ed35ca380134b [file] [log] [blame]
Anand Doshi885e0742015-03-03 14:55:30 +05301# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
Rushabh Mehtae67d1fb2013-08-05 14:59:54 +05302# License: GNU General Public License v3. See license.txt
Nabin Hait2df4d542013-01-29 11:34:39 +05303
Chillar Anand915b3432021-09-02 16:44:59 +05304
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08005import json
Chillar Anand915b3432021-09-02 16:44:59 +05306
7import frappe
ruthra kumar81cd7872023-04-27 09:46:54 +05308from frappe import _, bold, qb, throw
Chillar Anand915b3432021-09-02 16:44:59 +05309from frappe.model.workflow import get_workflow_name, is_transition_condition_satisfied
Gursheen Anand74619262023-06-02 17:13:51 +053010from frappe.query_builder.custom import ConstantColumn
Gursheen Anand4ee16372023-06-08 13:15:23 +053011from frappe.query_builder.functions import Abs, Sum
Chillar Anand915b3432021-09-02 16:44:59 +053012from frappe.utils import (
13 add_days,
14 add_months,
15 cint,
ruthra kumar0cdd6432023-10-11 14:42:23 +053016 comma_and,
Chillar Anand915b3432021-09-02 16:44:59 +053017 flt,
18 fmt_money,
19 formatdate,
20 get_last_day,
21 get_link_to_form,
22 getdate,
23 nowdate,
GangaManojd24cfff2021-10-28 20:06:48 +053024 today,
Chillar Anand915b3432021-09-02 16:44:59 +053025)
Chillar Anand915b3432021-09-02 16:44:59 +053026
27import erpnext
28from erpnext.accounts.doctype.accounting_dimension.accounting_dimension import (
29 get_accounting_dimensions,
30)
31from erpnext.accounts.doctype.pricing_rule.utils import (
32 apply_pricing_rule_for_free_items,
33 apply_pricing_rule_on_transaction,
34 get_applied_pricing_rules,
35)
Deepesh Garg492ea3b2023-08-08 11:39:44 +053036from erpnext.accounts.general_ledger import get_round_off_account_and_cost_center
Chillar Anand915b3432021-09-02 16:44:59 +053037from erpnext.accounts.party import (
38 get_party_account,
39 get_party_account_currency,
Deepesh Garga7f15a02021-12-12 21:09:11 +053040 get_party_gle_currency,
Chillar Anand915b3432021-09-02 16:44:59 +053041 validate_party_frozen_disabled,
42)
ruthra kumar1ea1bfe2023-07-26 16:19:38 +053043from erpnext.accounts.utils import (
44 create_gain_loss_journal,
45 get_account_currency,
46 get_fiscal_years,
47 validate_fiscal_year,
48)
Chillar Anand915b3432021-09-02 16:44:59 +053049from erpnext.buying.utils import update_last_purchase_rate
50from erpnext.controllers.print_settings import (
51 set_print_templates_for_item_table,
52 set_print_templates_for_taxes,
53)
54from erpnext.controllers.sales_and_purchase_return import validate_return
55from erpnext.exceptions import InvalidCurrency
56from erpnext.setup.utils import get_exchange_rate
Ankush Menat10583eb2022-06-17 12:13:27 +053057from erpnext.stock.doctype.item.item import get_uom_conv_factor
Marica3dee5272020-06-23 10:33:47 +053058from erpnext.stock.doctype.packed_item.packed_item import make_packing_list
Chillar Anand915b3432021-09-02 16:44:59 +053059from erpnext.stock.get_item_details import (
60 _get_item_tax_template,
61 get_conversion_factor,
62 get_item_details,
63 get_item_tax_map,
64 get_item_warehouse,
65)
Sagar Vora4205f562023-07-24 18:37:36 +053066from erpnext.utilities.regional import temporary_flag
Chillar Anand915b3432021-09-02 16:44:59 +053067from erpnext.utilities.transaction_base import TransactionBase
68
Nabin Hait1d218422015-07-17 15:19:02 +053069
Ankush Menat494bd9e2022-03-28 18:52:46 +053070class AccountMissingError(frappe.ValidationError):
71 pass
marination53b1a9a2020-11-03 15:45:25 +053072
Ankush Menat494bd9e2022-03-28 18:52:46 +053073
Maricab9f5a1c2023-11-27 09:05:22 +053074class InvalidQtyError(frappe.ValidationError):
75 pass
76
77
Ankush Menat494bd9e2022-03-28 18:52:46 +053078force_item_fields = (
79 "item_group",
80 "brand",
81 "stock_uom",
82 "is_fixed_asset",
83 "item_tax_rate",
84 "pricing_rules",
85 "weight_per_unit",
86 "weight_uom",
87 "total_weight",
88)
89
Doridel Cahanap6f06cc22018-05-17 16:28:58 +080090
Nabin Haitbf495c92013-01-30 12:49:08 +053091class AccountsController(TransactionBase):
Nabin Hait7eba1a32017-10-02 15:59:27 +053092 def __init__(self, *args, **kwargs):
93 super(AccountsController, self).__init__(*args, **kwargs)
Anand Doshi979326b2015-09-11 16:22:37 +053094
prssanna71e5b602020-10-29 14:19:34 +053095 def get_print_settings(self):
96 print_setting_fields = []
Ankush Menat494bd9e2022-03-28 18:52:46 +053097 items_field = self.meta.get_field("items")
prssanna71e5b602020-10-29 14:19:34 +053098
Ankush Menat494bd9e2022-03-28 18:52:46 +053099 if items_field and items_field.fieldtype == "Table":
100 print_setting_fields += ["compact_item_print", "print_uom_after_quantity"]
prssanna71e5b602020-10-29 14:19:34 +0530101
Ankush Menat494bd9e2022-03-28 18:52:46 +0530102 taxes_field = self.meta.get_field("taxes")
103 if taxes_field and taxes_field.fieldtype == "Table":
104 print_setting_fields += ["print_taxes_with_zero_amount"]
prssanna71e5b602020-10-29 14:19:34 +0530105
106 return print_setting_fields
107
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530108 @property
109 def company_currency(self):
110 if not hasattr(self, "__company_currency"):
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530111 self.__company_currency = erpnext.get_company_currency(self.company)
Anand Doshi979326b2015-09-11 16:22:37 +0530112
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530113 return self.__company_currency
Anand Doshi979326b2015-09-11 16:22:37 +0530114
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530115 def onload(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530116 self.set_onload(
117 "make_payment_via_journal_entry",
118 frappe.db.get_single_value("Accounts Settings", "make_payment_via_journal_entry"),
119 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530120
tundee52bb822017-09-25 09:02:23 +0100121 if self.is_new():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530122 relevant_docs = (
123 "Quotation",
124 "Purchase Order",
125 "Sales Order",
126 "Purchase Invoice",
127 "Sales Invoice",
128 )
tundee52bb822017-09-25 09:02:23 +0100129 if self.doctype in relevant_docs:
130 self.set_payment_schedule()
Rohit Waghchaure7d529892016-10-06 14:35:04 +0530131
tundebabzyad08d4c2018-05-16 07:01:41 +0100132 def ensure_supplier_is_not_blocked(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530133 is_supplier_payment = self.doctype == "Payment Entry" and self.party_type == "Supplier"
134 is_buying_invoice = self.doctype in ["Purchase Invoice", "Purchase Order"]
tundebabzyad08d4c2018-05-16 07:01:41 +0100135 supplier = None
136 supplier_name = None
137
138 if is_buying_invoice or is_supplier_payment:
139 supplier_name = self.supplier if is_buying_invoice else self.party
Ankush Menat494bd9e2022-03-28 18:52:46 +0530140 supplier = frappe.get_doc("Supplier", supplier_name)
tundebabzyad08d4c2018-05-16 07:01:41 +0100141
142 if supplier and supplier_name and supplier.on_hold:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530143 if (is_buying_invoice and supplier.hold_type in ["All", "Invoices"]) or (
144 is_supplier_payment and supplier.hold_type in ["All", "Payments"]
145 ):
tundebabzyad08d4c2018-05-16 07:01:41 +0100146 if not supplier.release_date or getdate(nowdate()) <= supplier.release_date:
147 frappe.msgprint(
Ankush Menat494bd9e2022-03-28 18:52:46 +0530148 _("{0} is blocked so this transaction cannot proceed").format(supplier_name),
149 raise_exception=1,
150 )
tundebabzyad08d4c2018-05-16 07:01:41 +0100151
Saurabh6f753182013-03-20 12:55:28 +0530152 def validate(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530153 if not self.get("is_return") and not self.get("is_debit_note"):
Deepesh Gargd301d262019-07-31 15:58:19 +0530154 self.validate_qty_is_not_zero()
155
nabinhait23cce732014-07-03 12:25:06 +0530156 if self.get("_action") and self._action != "update_after_submit":
Nabin Hait704a4532014-06-05 16:55:31 +0530157 self.set_missing_values(for_validate=True)
tunde62af5c52017-09-22 15:16:38 +0100158
tundebabzyad08d4c2018-05-16 07:01:41 +0100159 self.ensure_supplier_is_not_blocked()
160
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530161 self.validate_date_with_fiscal_year()
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530162 self.validate_party_accounts()
163
Deepesh Gargb4be2922021-01-28 13:09:56 +0530164 self.validate_inter_company_reference()
165
Ankush Menat3714e362022-05-16 18:09:14 +0530166 self.disable_pricing_rule_on_internal_transfer()
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530167 self.disable_tax_included_prices_for_internal_transfer()
Deepesh Gargb4be2922021-01-28 13:09:56 +0530168 self.set_incoming_rate()
Deepesh Garg25889702023-12-12 15:18:54 +0530169 self.init_internal_values()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530170
Anand Doshi3543f302013-05-24 19:25:01 +0530171 if self.meta.get_field("currency"):
Anand Doshi923d41d2013-05-28 17:23:36 +0530172 self.calculate_taxes_and_totals()
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530173
Nabin Hait1d218422015-07-17 15:19:02 +0530174 if not self.meta.get_field("is_return") or not self.is_return:
175 self.validate_value("base_grand_total", ">=", 0)
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530176
Nabin Hait3cf67a42015-07-24 13:26:36 +0530177 validate_return(self)
Anand Doshid2946502014-04-08 20:10:03 +0530178
tunde62af5c52017-09-22 15:16:38 +0100179 self.validate_all_documents_schedule()
Anand Doshid2946502014-04-08 20:10:03 +0530180
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530181 if self.meta.get_field("taxes_and_charges"):
182 self.validate_enabled_taxes_and_charges()
Nabin Haita2426fc2018-01-15 17:45:46 +0530183 self.validate_tax_account_company()
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530184
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +0530185 self.validate_party()
Nabin Hait895029d2015-08-20 14:55:39 +0530186 self.validate_currency()
Deepesh Garg80c85dd2021-08-12 15:39:07 +0530187 self.validate_party_account_currency()
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530188
Ankush Menat494bd9e2022-03-28 18:52:46 +0530189 if self.doctype in ["Purchase Invoice", "Sales Invoice"]:
ruthra kumar0cdd6432023-10-11 14:42:23 +0530190 if invalid_advances := [
191 x for x in self.advances if not x.reference_type or not x.reference_name
192 ]:
193 frappe.throw(
194 _(
195 "Rows: {0} in {1} section are Invalid. Reference Name should point to a valid Payment Entry or Journal Entry."
196 ).format(
197 frappe.bold(comma_and([x.idx for x in invalid_advances])), frappe.bold(_("Advance Payments"))
198 )
199 )
200
Ankush Menat494bd9e2022-03-28 18:52:46 +0530201 pos_check_field = "is_pos" if self.doctype == "Sales Invoice" else "is_paid"
Nabin Hait4a994d42019-04-25 17:47:26 +0530202 if cint(self.allocate_advances_automatically) and not cint(self.get(pos_check_field)):
Nabin Hait041a5c22018-08-01 18:07:39 +0530203 self.set_advances()
204
Saqiba20999c2021-07-12 14:33:23 +0530205 self.set_advance_gain_or_loss()
206
Nabin Hait041a5c22018-08-01 18:07:39 +0530207 if self.is_return:
208 self.validate_qty()
Nabin Haitacdd5082019-12-04 15:30:01 +0530209 else:
210 self.validate_deferred_start_and_end_date()
rohitwaghchaure70489252018-06-11 12:02:14 +0530211
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530212 self.validate_deferred_income_expense_account()
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530213 self.set_inter_company_account()
214
Ankush Menat494bd9e2022-03-28 18:52:46 +0530215 if self.doctype == "Purchase Invoice":
Deepesh Garg7f06c8c2021-11-26 10:27:57 +0530216 self.calculate_paid_amount()
217 # apply tax withholding only if checked and applicable
218 self.set_tax_withholding()
219
Dany Robert9bc59522023-08-26 18:14:40 +0530220 with temporary_flag("company", self.company):
221 validate_regional(self)
222 validate_einvoice_fields(self)
Saqib Ansaric5782b02022-01-27 20:09:56 +0530223
Deepesh Gargb741ae12022-12-02 17:14:06 +0530224 if self.doctype != "Material Request" and not self.ignore_pricing_rule:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530225 apply_pricing_rule_on_transaction(self)
Gauravf1e28e02019-02-13 16:46:24 +0530226
RitvikSardana03f0abf2023-09-19 13:08:17 +0530227 self.set_total_in_words()
228
Deepesh Garg25889702023-12-12 15:18:54 +0530229 def init_internal_values(self):
230 # init all the internal values as 0 on sa
231 if self.docstatus.is_draft():
232 # TODO: Add all such pending values here
233 fields = ["billed_amt", "delivered_qty"]
234 for item in self.get("items"):
235 for field in fields:
236 if hasattr(item, field):
237 item.set(field, 0)
238
Saqib Ansaric5782b02022-01-27 20:09:56 +0530239 def before_cancel(self):
240 validate_einvoice_fields(self)
241
ruthra kumar42df0d32023-08-28 17:36:12 +0530242 def _remove_references_in_unreconcile(self):
ruthra kumar9a1588f2023-08-30 20:50:16 +0530243 upe = frappe.qb.DocType("Unreconcile Payment Entries")
ruthra kumar42df0d32023-08-28 17:36:12 +0530244 rows = (
245 frappe.qb.from_(upe)
246 .select(upe.name, upe.parent)
247 .where((upe.reference_doctype == self.doctype) & (upe.reference_name == self.name))
248 .run(as_dict=True)
249 )
250
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530251 if rows:
252 references_map = frappe._dict()
253 for x in rows:
254 references_map.setdefault(x.parent, []).append(x.name)
ruthra kumar42df0d32023-08-28 17:36:12 +0530255
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530256 for doc, rows in references_map.items():
ruthra kumar74f9e342023-11-21 16:51:06 +0530257 unreconcile_doc = frappe.get_doc("Unreconcile Payment", doc)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530258 for row in rows:
259 unreconcile_doc.remove(unreconcile_doc.get("allocations", {"name": row})[0])
ruthra kumar42df0d32023-08-28 17:36:12 +0530260
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530261 unreconcile_doc.flags.ignore_validate_update_after_submit = True
262 unreconcile_doc.flags.ignore_links = True
263 unreconcile_doc.save(ignore_permissions=True)
264
265 # delete docs upon parent doc deletion
ruthra kumar74f9e342023-11-21 16:51:06 +0530266 unreconcile_docs = frappe.db.get_all("Unreconcile Payment", filters={"voucher_no": self.name})
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530267 for x in unreconcile_docs:
ruthra kumar74f9e342023-11-21 16:51:06 +0530268 _doc = frappe.get_doc("Unreconcile Payment", x.name)
ruthra kumar6bbe47c2023-08-28 17:49:09 +0530269 if _doc.docstatus == 1:
270 _doc.cancel()
271 _doc.delete()
ruthra kumar42df0d32023-08-28 17:36:12 +0530272
ruthra kumared7f67b2023-09-26 14:23:21 +0530273 def _remove_references_in_repost_doctypes(self):
274 repost_doctypes = ["Repost Payment Ledger Items", "Repost Accounting Ledger Items"]
ruthra kumarc722f282023-02-19 12:09:10 +0530275
ruthra kumared7f67b2023-09-26 14:23:21 +0530276 for _doctype in repost_doctypes:
277 dt = frappe.qb.DocType(_doctype)
278 rows = (
279 frappe.qb.from_(dt)
280 .select(dt.name, dt.parent, dt.parenttype)
281 .where((dt.voucher_type == self.doctype) & (dt.voucher_no == self.name))
282 .run(as_dict=True)
283 )
284
285 if rows:
286 references_map = frappe._dict()
287 for x in rows:
288 references_map.setdefault((x.parenttype, x.parent), []).append(x.name)
289
290 for doc, rows in references_map.items():
291 repost_doc = frappe.get_doc(doc[0], doc[1])
292
293 for row in rows:
294 if _doctype == "Repost Payment Ledger Items":
295 repost_doc.remove(repost_doc.get("repost_vouchers", {"name": row})[0])
296 else:
297 repost_doc.remove(repost_doc.get("vouchers", {"name": row})[0])
298
299 repost_doc.flags.ignore_validate_update_after_submit = True
300 repost_doc.flags.ignore_links = True
301 repost_doc.save(ignore_permissions=True)
302
303 def on_trash(self):
304 self._remove_references_in_repost_doctypes()
ruthra kumar42df0d32023-08-28 17:36:12 +0530305 self._remove_references_in_unreconcile()
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530306 self.remove_serial_and_batch_bundle()
ruthra kumarfbdfb812023-08-28 16:27:29 +0530307
Saqib8e556772021-01-28 12:26:45 +0530308 # delete sl and gl entries on deletion of transaction
Ankush Menat494bd9e2022-03-28 18:52:46 +0530309 if frappe.db.get_single_value("Accounts Settings", "delete_linked_ledger_entries"):
ruthra kumar70313df2022-09-08 18:53:30 +0530310 ple = frappe.qb.DocType("Payment Ledger Entry")
311 frappe.qb.from_(ple).delete().where(
312 (ple.voucher_type == self.doctype) & (ple.voucher_no == self.name)
313 ).run()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530314 frappe.db.sql(
315 "delete from `tabGL Entry` where voucher_type=%s and voucher_no=%s", (self.doctype, self.name)
316 )
317 frappe.db.sql(
318 "delete from `tabStock Ledger Entry` where voucher_type=%s and voucher_no=%s",
319 (self.doctype, self.name),
320 )
Nabin Hait0551f7b2017-11-21 19:58:16 +0530321
rohitwaghchaure89326bd2023-12-10 11:05:58 +0530322 def remove_serial_and_batch_bundle(self):
323 bundles = frappe.get_all(
324 "Serial and Batch Bundle",
325 filters={"voucher_type": self.doctype, "voucher_no": self.name, "docstatus": ("!=", 1)},
326 )
327
328 for bundle in bundles:
329 frappe.delete_doc("Serial and Batch Bundle", bundle.name)
330
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530331 def validate_deferred_income_expense_account(self):
332 field_map = {
333 "Sales Invoice": "deferred_revenue_account",
334 "Purchase Invoice": "deferred_expense_account",
335 }
336
337 for item in self.get("items"):
338 if item.get("enable_deferred_revenue") or item.get("enable_deferred_expense"):
339 if not item.get(field_map.get(self.doctype)):
Daizy Modi4efc9472022-11-07 09:21:03 +0530340 default_deferred_account = frappe.get_cached_value(
Deepesh Garg9bf5f762022-04-06 17:33:46 +0530341 "Company", self.company, "default_" + field_map.get(self.doctype)
342 )
343 if not default_deferred_account:
344 frappe.throw(
345 _(
346 "Row #{0}: Please update deferred revenue/expense account in item row or default account in company master"
347 ).format(item.idx)
348 )
349 else:
350 item.set(field_map.get(self.doctype), default_deferred_account)
351
Deepesh Gargfa152212022-11-28 19:22:35 +0530352 def validate_auto_repeat_subscription_dates(self):
Deepesh Garg6a47fb62022-11-28 22:47:44 +0530353 if (
354 self.get("from_date")
355 and self.get("to_date")
356 and getdate(self.from_date) > getdate(self.to_date)
357 ):
Deepesh Gargfa152212022-11-28 19:22:35 +0530358 frappe.throw(_("To Date cannot be before From Date"), title=_("Invalid Auto Repeat Date"))
359
Nabin Haitacdd5082019-12-04 15:30:01 +0530360 def validate_deferred_start_and_end_date(self):
361 for d in self.items:
362 if d.get("enable_deferred_revenue") or d.get("enable_deferred_expense"):
363 if not (d.service_start_date and d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530364 frappe.throw(
365 _("Row #{0}: Service Start and End Date is required for deferred accounting").format(d.idx)
366 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530367 elif getdate(d.service_start_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530368 frappe.throw(
369 _("Row #{0}: Service Start Date cannot be greater than Service End Date").format(d.idx)
370 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530371 elif getdate(self.posting_date) > getdate(d.service_end_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530372 frappe.throw(
373 _("Row #{0}: Service End Date cannot be before Invoice Posting Date").format(d.idx)
374 )
Nabin Haitacdd5082019-12-04 15:30:01 +0530375
tunde62af5c52017-09-22 15:16:38 +0100376 def validate_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530377 self.validate_payment_schedule_dates()
378 self.set_due_date()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530379 self.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +0530380 if not self.get("ignore_default_payment_terms_template"):
Deepesh Garg5c758942023-04-16 17:11:24 +0530381 self.validate_payment_schedule_amount()
Deepesh Gargbd709f82021-08-23 19:05:52 +0530382 self.validate_due_date()
tunde62af5c52017-09-22 15:16:38 +0100383 self.validate_advance_entries()
384
385 def validate_non_invoice_documents_schedule(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +0530386 self.set_payment_schedule()
Nabin Hait2f9f4f92017-12-20 12:24:59 +0530387 self.validate_payment_schedule_dates()
Nabin Hait0551f7b2017-11-21 19:58:16 +0530388 self.validate_payment_schedule_amount()
tunde62af5c52017-09-22 15:16:38 +0100389
390 def validate_all_documents_schedule(self):
391 if self.doctype in ("Sales Invoice", "Purchase Invoice") and not self.is_return:
392 self.validate_invoice_documents_schedule()
393 elif self.doctype in ("Quotation", "Purchase Order", "Sales Order"):
394 self.validate_non_invoice_documents_schedule()
395
prssanna71e5b602020-10-29 14:19:34 +0530396 def before_print(self, settings=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530397 if self.doctype in [
398 "Purchase Order",
399 "Sales Order",
400 "Sales Invoice",
401 "Purchase Invoice",
402 "Supplier Quotation",
403 "Purchase Receipt",
404 "Delivery Note",
405 "Quotation",
406 ]:
KanchanChauhan49a50fe2016-11-18 13:57:53 +0530407 if self.get("group_same_items"):
408 self.group_similar_items()
409
Zarrar5be6d192018-11-08 12:16:26 +0530410 df = self.meta.get_field("discount_amount")
411 if self.get("discount_amount") and hasattr(self, "taxes") and not len(self.taxes):
412 df.set("print_hide", 0)
413 self.discount_amount = -self.discount_amount
414 else:
415 df.set("print_hide", 1)
416
prssanna71e5b602020-10-29 14:19:34 +0530417 set_print_templates_for_item_table(self, settings)
418 set_print_templates_for_taxes(self, settings)
419
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530420 def calculate_paid_amount(self):
Saurabh43520f92016-03-21 18:32:48 +0530421 if hasattr(self, "is_pos") or hasattr(self, "is_paid"):
422 is_paid = self.get("is_pos") or self.get("is_paid")
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530423
424 if is_paid:
425 if not self.cash_bank_account:
426 # show message that the amount is not paid
Ankush Menat494bd9e2022-03-28 18:52:46 +0530427 frappe.throw(
428 _("Note: Payment Entry will not be created since 'Cash or Bank Account' was not specified")
429 )
Marica23d7b092019-09-25 17:17:36 +0530430
Mangesh-Khairnar7bcb24e2019-09-11 10:49:33 +0530431 if cint(self.is_return) and self.grand_total > self.paid_amount:
432 self.paid_amount = flt(flt(self.grand_total), self.precision("paid_amount"))
433
434 elif not flt(self.paid_amount) and flt(self.outstanding_amount) > 0:
435 self.paid_amount = flt(flt(self.outstanding_amount), self.precision("paid_amount"))
436
Ankush Menat494bd9e2022-03-28 18:52:46 +0530437 self.base_paid_amount = flt(
438 self.paid_amount * self.conversion_rate, self.precision("base_paid_amount")
439 )
Saurabh43520f92016-03-21 18:32:48 +0530440
Anand Doshiabc10032013-06-14 17:44:03 +0530441 def set_missing_values(self, for_validate=False):
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530442 if frappe.flags.in_test:
tunde62af5c52017-09-22 15:16:38 +0100443 for fieldname in ["posting_date", "transaction_date"]:
Rohit Waghchaure5d97d892016-05-12 12:58:29 +0530444 if self.meta.get_field(fieldname) and not self.get(fieldname):
445 self.set(fieldname, today())
446 break
Anand Doshid2946502014-04-08 20:10:03 +0530447
Nabin Hait3237c752015-02-17 11:11:11 +0530448 def calculate_taxes_and_totals(self):
Nabin Haitfe81da22015-02-18 12:23:18 +0530449 from erpnext.controllers.taxes_and_totals import calculate_taxes_and_totals
Ankush Menat494bd9e2022-03-28 18:52:46 +0530450
Nabin Haitfe81da22015-02-18 12:23:18 +0530451 calculate_taxes_and_totals(self)
Nabin Hait3237c752015-02-17 11:11:11 +0530452
Raffael Meyere10ab162021-11-30 13:24:18 +0100453 if self.doctype in (
Ankush Menat494bd9e2022-03-28 18:52:46 +0530454 "Sales Order",
455 "Delivery Note",
456 "Sales Invoice",
457 "POS Invoice",
Raffael Meyere10ab162021-11-30 13:24:18 +0100458 ):
Nabin Hait3237c752015-02-17 11:11:11 +0530459 self.calculate_commission()
460 self.calculate_contribution()
461
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530462 def validate_date_with_fiscal_year(self):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +0800463 if self.meta.get_field("fiscal_year"):
Rohan Bansal1e3a3b22021-05-26 15:18:10 +0530464 date_field = None
Nabin Haitcfecd2b2013-07-11 17:49:18 +0530465 if self.meta.get_field("posting_date"):
466 date_field = "posting_date"
467 elif self.meta.get_field("transaction_date"):
468 date_field = "transaction_date"
Anand Doshid2946502014-04-08 20:10:03 +0530469
Rushabh Mehtaf2227d02014-03-31 23:37:40 +0530470 if date_field and self.get(date_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530471 validate_fiscal_year(
472 self.get(date_field), self.fiscal_year, self.company, self.meta.get_label(date_field), self
473 )
Anand Doshid2946502014-04-08 20:10:03 +0530474
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530475 def validate_party_accounts(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530476 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530477 return
478
Ankush Menat494bd9e2022-03-28 18:52:46 +0530479 if self.doctype == "Sales Invoice":
480 party_account_field = "debit_to"
481 item_field = "income_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530482 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530483 party_account_field = "credit_to"
484 item_field = "expense_account"
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530485
Ankush Menat494bd9e2022-03-28 18:52:46 +0530486 for item in self.get("items"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530487 if item.get(item_field) == self.get(party_account_field):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530488 frappe.throw(
489 _("Row {0}: {1} {2} cannot be same as {3} (Party Account) {4}").format(
490 item.idx,
491 frappe.bold(frappe.unscrub(item_field)),
492 item.get(item_field),
493 frappe.bold(frappe.unscrub(party_account_field)),
494 self.get(party_account_field),
495 )
496 )
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530497
Deepesh Gargb4be2922021-01-28 13:09:56 +0530498 def validate_inter_company_reference(self):
Rohit Waghchaure38aaba52023-05-13 13:00:05 +0530499 if self.get("is_return"):
500 return
501
Rohit Waghchaureb4a102d2022-09-06 16:22:00 +0530502 if self.doctype not in ("Purchase Invoice", "Purchase Receipt"):
Deepesh Gargb4be2922021-01-28 13:09:56 +0530503 return
504
505 if self.is_internal_transfer():
Ankush Menat494bd9e2022-03-28 18:52:46 +0530506 if not (
507 self.get("inter_company_reference")
508 or self.get("inter_company_invoice_reference")
509 or self.get("inter_company_order_reference")
Deepesh Garg906ad102023-01-15 17:32:57 +0530510 ) and not self.get("is_return"):
Deepesh Garg4c8d15b2021-04-26 15:24:34 +0530511 msg = _("Internal Sale or Delivery Reference missing.")
Deepesh Gargb4be2922021-01-28 13:09:56 +0530512 msg += _("Please create purchase from internal sale or delivery document itself")
513 frappe.throw(msg, title=_("Internal Sales Reference Missing"))
514
Rohit Waghchaure19911b42023-04-21 16:49:48 +0530515 label = "Delivery Note Item" if self.doctype == "Purchase Receipt" else "Sales Invoice Item"
516
517 field = frappe.scrub(label)
518
519 for row in self.get("items"):
520 if not row.get(field):
521 msg = f"At Row {row.idx}: The field {bold(label)} is mandatory for internal transfer"
522 frappe.throw(_(msg), title=_("Internal Transfer Reference Missing"))
523
Ankush Menat3714e362022-05-16 18:09:14 +0530524 def disable_pricing_rule_on_internal_transfer(self):
525 if not self.get("ignore_pricing_rule") and self.is_internal_transfer():
526 self.ignore_pricing_rule = 1
527 frappe.msgprint(
528 _("Disabled pricing rules since this {} is an internal transfer").format(self.doctype),
529 alert=1,
530 )
531
Deepesh Garg8d30ebb2022-11-05 20:51:15 +0530532 def disable_tax_included_prices_for_internal_transfer(self):
533 if self.is_internal_transfer():
534 tax_updated = False
535 for tax in self.get("taxes"):
536 if tax.get("included_in_print_rate"):
537 tax.included_in_print_rate = 0
538 tax_updated = True
539
540 if tax_updated:
541 frappe.msgprint(
542 _("Disabled tax included prices since this {} is an internal transfer").format(self.doctype),
543 alert=1,
544 )
545
Nabin Haite9daefe2014-08-27 16:46:33 +0530546 def validate_due_date(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530547 if self.get("is_pos"):
548 return
rohitwaghchaureea943c62018-07-06 12:28:58 +0530549
Nabin Haite9daefe2014-08-27 16:46:33 +0530550 from erpnext.accounts.party import validate_due_date
Ankush Menat494bd9e2022-03-28 18:52:46 +0530551
Nabin Haite9daefe2014-08-27 16:46:33 +0530552 if self.doctype == "Sales Invoice":
Nabin Hait04d244a2015-07-22 17:47:49 +0530553 if not self.due_date:
554 frappe.throw(_("Due Date is mandatory"))
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530555
Ankush Menat494bd9e2022-03-28 18:52:46 +0530556 validate_due_date(
557 self.posting_date,
558 self.due_date,
559 "Customer",
560 self.customer,
561 self.company,
562 self.payment_terms_template,
563 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530564 elif self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +0530565 validate_due_date(
566 self.bill_date or self.posting_date,
567 self.due_date,
568 "Supplier",
569 self.supplier,
570 self.company,
571 self.bill_date,
572 self.payment_terms_template,
573 )
Nabin Haite9daefe2014-08-27 16:46:33 +0530574
Nabin Hait096d3632013-10-17 17:01:14 +0530575 def set_price_list_currency(self, buying_or_selling):
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530576 if self.meta.get_field("posting_date"):
Nabin Hait288a18e2016-12-08 15:36:23 +0530577 transaction_date = self.posting_date
Nabin Hait1cc55fb2016-12-08 14:09:23 +0530578 else:
Nabin Hait288a18e2016-12-08 15:36:23 +0530579 transaction_date = self.transaction_date
Rushabh Mehta66958302017-01-16 16:57:53 +0530580
Rushabh Mehta4a404e92013-08-09 18:11:35 +0530581 if self.meta.get_field("currency"):
Nabin Hait7a75e102013-09-17 10:21:20 +0530582 # price list part
Shreya3f778522018-05-15 16:59:20 +0530583 if buying_or_selling.lower() == "selling":
584 fieldname = "selling_price_list"
585 args = "for_selling"
586 else:
587 fieldname = "buying_price_list"
588 args = "for_buying"
589
Anand Doshif78d1ae2014-03-28 13:55:00 +0530590 if self.meta.get_field(fieldname) and self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530591 self.price_list_currency = frappe.db.get_value("Price List", self.get(fieldname), "currency")
Anand Doshid2946502014-04-08 20:10:03 +0530592
Nabin Hait6e439a52015-08-28 19:24:22 +0530593 if self.price_list_currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530594 self.plc_conversion_rate = 1.0
Nabin Hait11f41952013-09-24 14:36:55 +0530595
Anand Doshif78d1ae2014-03-28 13:55:00 +0530596 elif not self.plc_conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530597 self.plc_conversion_rate = get_exchange_rate(
598 self.price_list_currency, self.company_currency, transaction_date, args
599 )
Anand Doshid2946502014-04-08 20:10:03 +0530600
Nabin Hait7a75e102013-09-17 10:21:20 +0530601 # currency
Anand Doshif78d1ae2014-03-28 13:55:00 +0530602 if not self.currency:
603 self.currency = self.price_list_currency
604 self.conversion_rate = self.plc_conversion_rate
Nabin Hait6e439a52015-08-28 19:24:22 +0530605 elif self.currency == self.company_currency:
Anand Doshif78d1ae2014-03-28 13:55:00 +0530606 self.conversion_rate = 1.0
607 elif not self.conversion_rate:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530608 self.conversion_rate = get_exchange_rate(
609 self.currency, self.company_currency, transaction_date, args
610 )
Nabin Hait7a75e102013-09-17 10:21:20 +0530611
ruthra kumar08315522023-10-03 09:53:41 +0530612 if (
613 self.currency
614 and buying_or_selling == "Buying"
615 and frappe.db.get_single_value("Buying Settings", "use_transaction_date_exchange_rate")
616 and self.doctype == "Purchase Invoice"
617 ):
618 self.use_transaction_date_exchange_rate = True
619 self.conversion_rate = get_exchange_rate(
620 self.currency, self.company_currency, transaction_date, args
621 )
622
Nabin Haitcccc45e2016-10-05 17:15:43 +0530623 def set_missing_item_details(self, for_validate=False):
Anand Doshi3543f302013-05-24 19:25:01 +0530624 """set missing item values"""
Nabin Haitf37d43d2017-07-18 12:14:42 +0530625 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530626
Nabin Haitdd38a262014-12-26 13:15:21 +0530627 if hasattr(self, "items"):
Nabin Hait444f9562014-06-20 15:59:49 +0530628 parent_dict = {}
Pratik Vyasf7daab72014-04-10 17:53:30 +0530629 for fieldname in self.meta.get_valid_columns():
630 parent_dict[fieldname] = self.get(fieldname)
631
mbauskara52472c2016-03-05 15:10:25 +0530632 if self.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
633 document_type = "{} Item".format(self.doctype)
mbauskarc97becb2016-01-18 16:28:21 +0530634 parent_dict.update({"document_type": document_type})
635
Nabin Hait34c551d2019-07-03 10:34:31 +0530636 # party_name field used for customer in quotation
Ankush Menat494bd9e2022-03-28 18:52:46 +0530637 if (
638 self.doctype == "Quotation"
639 and self.quotation_to == "Customer"
640 and parent_dict.get("party_name")
641 ):
Nabin Hait34c551d2019-07-03 10:34:31 +0530642 parent_dict.update({"customer": parent_dict.get("party_name")})
643
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530644 self.pricing_rules = []
Deepesh Garg4c61ee32023-04-02 09:35:27 +0530645
Nabin Haitdd38a262014-12-26 13:15:21 +0530646 for item in self.get("items"):
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530647 if item.get("item_code"):
Nabin Hait444f9562014-06-20 15:59:49 +0530648 args = parent_dict.copy()
649 args.update(item.as_dict())
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530650
Nabin Hait34d28222016-01-19 15:45:49 +0530651 args["doctype"] = self.doctype
652 args["name"] = self.name
Smit Vorab206b052023-11-23 15:10:47 +0530653 args["child_doctype"] = item.doctype
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530654 args["child_docname"] = item.name
Ankush Menat494bd9e2022-03-28 18:52:46 +0530655 args["ignore_pricing_rule"] = (
656 self.ignore_pricing_rule if hasattr(self, "ignore_pricing_rule") else 0
657 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530658
Nabin Haite2f054c2015-03-09 14:54:37 +0530659 if not args.get("transaction_date"):
660 args["transaction_date"] = args.get("posting_date")
Anand Doshi2b2b6392015-03-20 14:18:09 +0530661
662 if self.get("is_subcontracted"):
663 args["is_subcontracted"] = self.is_subcontracted
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530664
Deepesh Garga7051cb2023-04-14 09:59:42 +0530665 ret = get_item_details(args, self, for_validate=True, overwrite_warehouse=False)
Rohit Waghchaure8bfe3302019-03-18 14:34:19 +0530666
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530667 for fieldname, value in ret.items():
Anand Doshi602e8252015-11-16 19:05:46 +0530668 if item.meta.get_field(fieldname) and value is not None:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530669 if item.get(fieldname) is None or fieldname in force_item_fields:
Rushabh Mehtaf14b8092014-04-03 14:30:42 +0530670 item.set(fieldname, value)
Anand Doshid2946502014-04-08 20:10:03 +0530671
Ankush Menat494bd9e2022-03-28 18:52:46 +0530672 elif fieldname in ["cost_center", "conversion_factor"] and not item.get(fieldname):
Anand Doshi602e8252015-11-16 19:05:46 +0530673 item.set(fieldname, value)
674
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530675 elif fieldname == "serial_no":
Alchez9155e402018-07-09 16:57:42 +0530676 # Ensure that serial numbers are matched against Stock UOM
677 item_conversion_factor = item.get("conversion_factor") or 1.0
678 item_qty = abs(item.get("qty")) * item_conversion_factor
Alchez8f2a0f32018-07-06 14:36:52 +0530679
Ankush Menat494bd9e2022-03-28 18:52:46 +0530680 if item_qty != len(get_serial_nos(item.get("serial_no"))):
Rohit Waghchauredc981dc2017-04-03 14:17:08 +0530681 item.set(fieldname, value)
Nabin Haita74468b2014-12-30 18:33:52 +0530682
Saqib Ansariab36b272022-02-09 10:10:17 +0530683 elif (
684 ret.get("pricing_rule_removed")
685 and value is not None
686 and fieldname
687 in [
688 "discount_percentage",
689 "discount_amount",
690 "rate",
691 "margin_rate_or_amount",
692 "margin_type",
693 "remove_free_item",
694 ]
695 ):
Saqib Ansarib8c41e32022-01-20 13:06:08 +0530696 # reset pricing rule fields if pricing_rule_removed
697 item.set(fieldname, value)
698
Ankush Menat494bd9e2022-03-28 18:52:46 +0530699 if self.doctype in ["Purchase Invoice", "Sales Invoice"] and item.meta.get_field(
700 "is_fixed_asset"
701 ):
702 item.set("is_fixed_asset", ret.get("is_fixed_asset", 0))
Rohit Waghchauref6f503a2018-12-19 15:06:44 +0530703
Deepesh Garga60c3082021-05-11 16:38:33 +0530704 # Double check for cost center
705 # Items add via promotional scheme may not have cost center set
Ankush Menat494bd9e2022-03-28 18:52:46 +0530706 if hasattr(item, "cost_center") and not item.get("cost_center"):
707 item.set(
708 "cost_center", self.get("cost_center") or erpnext.get_default_cost_center(self.company)
709 )
Deepesh Garga60c3082021-05-11 16:38:33 +0530710
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530711 if ret.get("pricing_rules"):
712 self.apply_pricing_rule_on_items(item, ret)
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530713 self.set_pricing_rule_details(item, ret)
Ankush Menat10583eb2022-06-17 12:13:27 +0530714 else:
715 # Transactions line item without item code
716
717 uom = item.get("uom")
718 stock_uom = item.get("stock_uom")
719 if bool(uom) != bool(stock_uom): # xor
720 item.stock_uom = item.uom = uom or stock_uom
721
Deepesh Garg61751832022-12-29 10:41:36 +0530722 # UOM cannot be zero so substitute as 1
723 item.conversion_factor = (
724 get_uom_conv_factor(item.get("uom"), item.get("stock_uom"))
725 or item.get("conversion_factor")
726 or 1
727 )
Rushabh Mehtab46069d2016-01-15 16:59:26 +0530728
Nabin Hait14aa9c52016-04-18 15:54:01 +0530729 if self.doctype == "Purchase Invoice":
Nabin Haitcccc45e2016-10-05 17:15:43 +0530730 self.set_expense_account(for_validate)
Nabin Haita3dd72a2014-05-28 12:49:20 +0530731
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530732 def apply_pricing_rule_on_items(self, item, pricing_rule_args):
733 if not pricing_rule_args.get("validate_applied_rule", 0):
734 # if user changed the discount percentage then set user's discount percentage ?
Ankush Menat494bd9e2022-03-28 18:52:46 +0530735 if pricing_rule_args.get("price_or_product_discount") == "Price":
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530736 item.set("pricing_rules", pricing_rule_args.get("pricing_rules"))
Rohit Waghchauref5bd3fa2022-09-16 15:23:10 +0530737 if pricing_rule_args.get("apply_rule_on_other_items"):
738 other_items = json.loads(pricing_rule_args.get("apply_rule_on_other_items"))
739 if other_items and item.item_code not in other_items:
740 return
741
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530742 item.set("discount_percentage", pricing_rule_args.get("discount_percentage"))
743 item.set("discount_amount", pricing_rule_args.get("discount_amount"))
744 if pricing_rule_args.get("pricing_rule_for") == "Rate":
745 item.set("price_list_rate", pricing_rule_args.get("price_list_rate"))
746
747 if item.get("price_list_rate"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530748 item.rate = flt(
749 item.price_list_rate * (1.0 - (flt(item.discount_percentage) / 100.0)),
750 item.precision("rate"),
751 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530752
Ankush Menat494bd9e2022-03-28 18:52:46 +0530753 if item.get("discount_amount"):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530754 item.rate = item.price_list_rate - item.discount_amount
755
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530756 if item.get("apply_discount_on_discounted_rate") and pricing_rule_args.get("rate"):
757 item.rate = pricing_rule_args.get("rate")
758
Ankush Menat494bd9e2022-03-28 18:52:46 +0530759 elif pricing_rule_args.get("free_item_data"):
760 apply_pricing_rule_for_free_items(self, pricing_rule_args.get("free_item_data"))
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530761
762 elif pricing_rule_args.get("validate_applied_rule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530763 for pricing_rule in get_applied_pricing_rules(item.get("pricing_rules")):
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530764 pricing_rule_doc = frappe.get_cached_doc("Pricing Rule", pricing_rule)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530765 for field in ["discount_percentage", "discount_amount", "rate"]:
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530766 if item.get(field) < pricing_rule_doc.get(field):
767 title = get_link_to_form("Pricing Rule", pricing_rule)
768
Ankush Menat494bd9e2022-03-28 18:52:46 +0530769 frappe.msgprint(
770 _("Row {0}: user has not applied the rule {1} on the item {2}").format(
771 item.idx, frappe.bold(title), frappe.bold(item.item_code)
772 )
773 )
rohitwaghchaurea85ddf22019-11-19 18:47:48 +0530774
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530775 def set_pricing_rule_details(self, item_row, args):
776 pricing_rules = get_applied_pricing_rules(args.get("pricing_rules"))
Ankush Menat494bd9e2022-03-28 18:52:46 +0530777 if not pricing_rules:
778 return
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530779
780 for pricing_rule in pricing_rules:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530781 self.append(
782 "pricing_rules",
783 {
784 "pricing_rule": pricing_rule,
785 "item_code": item_row.item_code,
786 "child_docname": item_row.name,
787 "rule_applied": True,
788 },
789 )
Rohit Waghchaurea248dfb2020-07-16 17:27:26 +0530790
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530791 def set_taxes(self):
792 if not self.meta.get_field("taxes"):
Anand Doshi3543f302013-05-24 19:25:01 +0530793 return
Anand Doshid2946502014-04-08 20:10:03 +0530794
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530795 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530796
rohitwaghchaure57914f12018-04-24 19:19:47 +0530797 if (self.is_new() or self.is_pos_profile_changed()) and not self.get("taxes"):
rohitwaghchaure505661b2017-12-11 14:52:28 +0530798 if self.company and not self.get("taxes_and_charges"):
Anand Doshi3543f302013-05-24 19:25:01 +0530799 # get the default tax master
Ankush Menat494bd9e2022-03-28 18:52:46 +0530800 self.taxes_and_charges = frappe.db.get_value(
801 tax_master_doctype, {"is_default": 1, "company": self.company}
802 )
Anand Doshid2946502014-04-08 20:10:03 +0530803
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530804 self.append_taxes_from_master(tax_master_doctype)
Anand Doshid2946502014-04-08 20:10:03 +0530805
rohitwaghchaure57914f12018-04-24 19:19:47 +0530806 def is_pos_profile_changed(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530807 if (
808 self.doctype == "Sales Invoice"
809 and self.is_pos
810 and self.pos_profile != frappe.db.get_value("Sales Invoice", self.name, "pos_profile")
811 ):
rohitwaghchaure57914f12018-04-24 19:19:47 +0530812 return True
813
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530814 def append_taxes_from_master(self, tax_master_doctype=None):
815 if self.get("taxes_and_charges"):
Anand Doshi99100a42013-07-04 17:13:53 +0530816 if not tax_master_doctype:
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530817 tax_master_doctype = self.meta.get_field("taxes_and_charges").options
Anand Doshid2946502014-04-08 20:10:03 +0530818
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530819 self.extend("taxes", get_taxes_and_charges(tax_master_doctype, self.get("taxes_and_charges")))
Akhilesh Darjee4cdb7992014-01-30 13:56:57 +0530820
Anand Doshiac32bad2014-04-18 01:30:14 +0530821 def set_other_charges(self):
Nabin Haite7d15362014-12-25 16:01:55 +0530822 self.set("taxes", [])
Nabin Haitffc7f3f2015-05-12 15:07:02 +0530823 self.set_taxes()
Anand Doshid2946502014-04-08 20:10:03 +0530824
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530825 def validate_enabled_taxes_and_charges(self):
826 taxes_and_charges_doctype = self.meta.get_options("taxes_and_charges")
Shariq Ansari21c11412023-08-17 12:14:13 +0530827 if self.taxes_and_charges and frappe.get_cached_value(
828 taxes_and_charges_doctype, self.taxes_and_charges, "disabled"
829 ):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530830 frappe.throw(
831 _("{0} '{1}' is disabled").format(taxes_and_charges_doctype, self.taxes_and_charges)
832 )
ankitjavalkarwork6c29d872014-10-06 13:20:53 +0530833
Nabin Haita2426fc2018-01-15 17:45:46 +0530834 def validate_tax_account_company(self):
835 for d in self.get("taxes"):
836 if d.account_head:
Daizy Modi4efc9472022-11-07 09:21:03 +0530837 tax_account_company = frappe.get_cached_value("Account", d.account_head, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +0530838 if tax_account_company != self.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530839 frappe.throw(
840 _("Row #{0}: Account {1} does not belong to company {2}").format(
841 d.idx, d.account_head, self.company
842 )
843 )
Nabin Haita2426fc2018-01-15 17:45:46 +0530844
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530845 def get_gl_dict(self, args, account_currency=None, item=None):
Nabin Hait2df4d542013-01-29 11:34:39 +0530846 """this method populates the common properties of a gl entry record"""
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530847
Ankush Menat494bd9e2022-03-28 18:52:46 +0530848 posting_date = args.get("posting_date") or self.get("posting_date")
Rohit Waghchaureaa7b4342018-05-11 01:56:05 +0530849 fiscal_years = get_fiscal_years(posting_date, company=self.company)
Nabin Hait2ed0b592016-03-29 13:14:17 +0530850 if len(fiscal_years) > 1:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530851 frappe.throw(
852 _("Multiple fiscal years exist for the date {0}. Please set company in Fiscal Year").format(
853 formatdate(posting_date)
854 )
855 )
Nabin Hait2ed0b592016-03-29 13:14:17 +0530856 else:
857 fiscal_year = fiscal_years[0][0]
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +0530858
Ankush Menat494bd9e2022-03-28 18:52:46 +0530859 gl_dict = frappe._dict(
860 {
861 "company": self.company,
862 "posting_date": posting_date,
863 "fiscal_year": fiscal_year,
864 "voucher_type": self.doctype,
865 "voucher_no": self.name,
866 "remarks": self.get("remarks") or self.get("remark"),
867 "debit": 0,
868 "credit": 0,
869 "debit_in_account_currency": 0,
870 "credit_in_account_currency": 0,
871 "is_opening": self.get("is_opening") or "No",
872 "party_type": None,
873 "party": None,
874 "project": self.get("project"),
875 "post_net_value": args.get("post_net_value"),
Deepesh Gargda6bc1a2023-06-23 20:57:51 +0530876 "voucher_detail_no": args.get("voucher_detail_no"),
Ankush Menat494bd9e2022-03-28 18:52:46 +0530877 }
878 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530879
Sagar Vora4205f562023-07-24 18:37:36 +0530880 with temporary_flag("company", self.company):
881 update_gl_dict_with_regional_fields(self, gl_dict)
882
deepeshgarg007d83cf652019-05-12 18:34:23 +0530883 accounting_dimensions = get_accounting_dimensions()
884 dimension_dict = frappe._dict()
885
886 for dimension in accounting_dimensions:
887 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530888 if item and item.get(dimension):
889 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530890
891 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530892 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530893
Nabin Hait895029d2015-08-20 14:55:39 +0530894 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530895 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530896
Ankush Menat494bd9e2022-03-28 18:52:46 +0530897 if gl_dict.account and self.doctype not in [
898 "Journal Entry",
899 "Period Closing Voucher",
900 "Payment Entry",
901 "Purchase Receipt",
902 "Purchase Invoice",
903 "Stock Entry",
904 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530905 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530906
Ankush Menat494bd9e2022-03-28 18:52:46 +0530907 if gl_dict.account and self.doctype not in [
908 "Journal Entry",
909 "Period Closing Voucher",
910 "Payment Entry",
911 ]:
912 set_balance_in_account_currency(
913 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
914 )
Anand Doshi979326b2015-09-11 16:22:37 +0530915
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530916 # Update details in transaction currency
917 gl_dict.update(
918 {
919 "transaction_currency": self.get("currency") or self.company_currency,
920 "transaction_exchange_rate": self.get("conversion_rate", 1),
921 "debit_in_transaction_currency": self.get_value_in_transaction_currency(
922 account_currency, args, "debit"
923 ),
924 "credit_in_transaction_currency": self.get_value_in_transaction_currency(
925 account_currency, args, "credit"
926 ),
927 }
928 )
929
Nabin Haitc561a492015-08-19 19:22:34 +0530930 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530931
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530932 def get_value_in_transaction_currency(self, account_currency, args, field):
933 if account_currency == self.get("currency"):
934 return args.get(field + "_in_account_currency")
935 else:
936 return flt(args.get(field, 0) / self.get("conversion_rate", 1))
937
Anurag Mishrae657fe82018-11-26 15:19:17 +0530938 def validate_qty_is_not_zero(self):
Maricab9f5a1c2023-11-27 09:05:22 +0530939 if self.doctype == "Purchase Receipt":
940 return
941
942 for item in self.items:
943 if not flt(item.qty):
944 frappe.throw(
945 msg=_("Row #{0}: Item quantity cannot be zero").format(item.idx),
946 title=_("Invalid Quantity"),
947 exc=InvalidQtyError,
948 )
Anurag Mishrae657fe82018-11-26 15:19:17 +0530949
Nabin Hait895029d2015-08-20 14:55:39 +0530950 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +0530951 valid_currency = [self.company_currency]
952 if self.get("currency") and self.currency != self.company_currency:
953 valid_currency.append(self.currency)
954
Nabin Hait895029d2015-08-20 14:55:39 +0530955 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530956 frappe.throw(
957 _("Account {0} is invalid. Account Currency must be {1}").format(
958 account, (" " + _("or") + " ").join(valid_currency)
959 )
960 )
Anand Doshi979326b2015-09-11 16:22:37 +0530961
Anand Doshi613cb6a2013-02-06 17:33:46 +0530962 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +0530963 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
964
Ankush Menat494bd9e2022-03-28 18:52:46 +0530965 frappe.db.sql(
966 """delete from `tab%s` where parentfield=%s and parent = %s
967 and allocated_amount = 0"""
968 % (childtype, "%s", "%s"),
969 (parentfield, self.name),
970 )
Anand Doshid2946502014-04-08 20:10:03 +0530971
Walstan Baptistad6360752021-03-31 12:30:32 +0530972 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530973 def apply_shipping_rule(self):
974 if self.shipping_rule:
975 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
976 shipping_rule.apply(self)
977 self.calculate_taxes_and_totals()
978
979 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530980 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530981
982 # shipping address fields can be `shipping_address_name` or `shipping_address`
983 # try getting value from both
984
Ankush Menat494bd9e2022-03-28 18:52:46 +0530985 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530986 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +0530987 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530988 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +0530989 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530990
991 return {}
992
Walstan Baptistad6360752021-03-31 12:30:32 +0530993 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +0530994 def set_advances(self):
995 """Returns list of advances against Account, Party, Reference"""
996
Deepesh Gargfd3fb642023-04-05 12:02:44 +0530997 res = self.get_advance_entries(
998 include_unallocated=not cint(self.get("only_include_allocated_payments"))
999 )
Nabin Hait041a5c22018-08-01 18:07:39 +05301000
1001 self.set("advances", [])
1002 advance_allocated = 0
1003 for d in res:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301004 if self.get("party_account_currency") == self.company_currency:
1005 amount = self.get("base_rounded_total") or self.base_grand_total
Nabin Hait041a5c22018-08-01 18:07:39 +05301006 else:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301007 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg181df2f2022-11-04 15:49:37 +05301008 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +05301009 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +05301010
Saqiba20999c2021-07-12 14:33:23 +05301011 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +05301012 "doctype": self.doctype + " Advance",
1013 "reference_type": d.reference_type,
1014 "reference_name": d.reference_name,
1015 "reference_row": d.reference_row,
1016 "remarks": d.remarks,
1017 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +05301018 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301019 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +05301020 }
Gursheen Anand74619262023-06-02 17:13:51 +05301021 if d.get("paid_from"):
1022 advance_row["account"] = d.paid_from
1023 if d.get("paid_to"):
1024 advance_row["account"] = d.paid_to
Saqiba20999c2021-07-12 14:33:23 +05301025
1026 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +05301027
Nabin Hait28a05282016-06-27 17:41:39 +05301028 def get_advance_entries(self, include_unallocated=True):
1029 if self.doctype == "Sales Invoice":
Nabin Hait28a05282016-06-27 17:41:39 +05301030 party_type = "Customer"
1031 party = self.customer
1032 amount_field = "credit_in_account_currency"
1033 order_field = "sales_order"
1034 order_doctype = "Sales Order"
1035 else:
Nabin Hait28a05282016-06-27 17:41:39 +05301036 party_type = "Supplier"
1037 party = self.supplier
1038 amount_field = "debit_in_account_currency"
1039 order_field = "purchase_order"
1040 order_doctype = "Purchase Order"
Deepesh Garg92f845c2023-06-21 12:21:19 +05301041
1042 party_account = get_party_account(
1043 party_type, party=party, company=self.company, include_advance=True
1044 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301045
Ankush Menat494bd9e2022-03-28 18:52:46 +05301046 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 +05301047
Ankush Menat494bd9e2022-03-28 18:52:46 +05301048 journal_entries = get_advance_journal_entries(
1049 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
1050 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301051
Smit Vora3e282bf2023-09-19 20:47:21 +05301052 payment_entries = get_advance_payment_entries_for_regional(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301053 party_type, party, party_account, order_doctype, order_list, include_unallocated
1054 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301055
Nabin Hait28a05282016-06-27 17:41:39 +05301056 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301057
Nabin Hait28a05282016-06-27 17:41:39 +05301058 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +05301059
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301060 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301061 is_inclusive = cint(
1062 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
1063 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301064
1065 if is_inclusive:
1066 is_inclusive = 0
1067 if self.get("taxes", filters={"included_in_print_rate": 1}):
1068 is_inclusive = 1
1069
1070 return is_inclusive
1071
Anand Baburajan491a50a2023-06-13 19:42:56 +05301072 def should_show_taxes_as_table_in_print(self):
1073 return cint(frappe.db.get_single_value("Accounts Settings", "show_taxes_as_table_in_print"))
1074
Nabin Hait28a05282016-06-27 17:41:39 +05301075 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +05301076 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301077 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 +05301078
Ankush Menat494bd9e2022-03-28 18:52:46 +05301079 if not order_list:
1080 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301081
Nabin Hait28a05282016-06-27 17:41:39 +05301082 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301083
Nabin Hait28a05282016-06-27 17:41:39 +05301084 if advance_entries:
1085 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
1086 for d in advance_entries:
1087 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301088 frappe.msgprint(
1089 _(
1090 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
1091 ).format(d.reference_name, d.against_order)
1092 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301093
Saqiba20999c2021-07-12 14:33:23 +05301094 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301095 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301096 return
1097
Ankush Menat494bd9e2022-03-28 18:52:46 +05301098 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301099 party_account = self.credit_to if is_purchase_invoice else self.debit_to
1100 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +05301101 return
1102
1103 for d in self.get("advances"):
1104 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +05301105 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +05301106
1107 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
1108 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
1109 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
1110
1111 d.exchange_gain_loss = difference
1112
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301113 def make_precision_loss_gl_entry(self, gl_entries):
1114 round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(
1115 self.company, "Purchase Invoice", self.name, self.use_company_roundoff_cost_center
1116 )
1117
1118 precision_loss = self.get("base_net_total") - flt(
1119 self.get("net_total") * self.conversion_rate, self.precision("net_total")
1120 )
1121
1122 credit_or_debit = "credit" if self.doctype == "Purchase Invoice" else "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301123 against_type = "Supplier" if self.doctype == "Purchase Invoice" else "Customer"
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301124 against = self.supplier if self.doctype == "Purchase Invoice" else self.customer
1125
1126 if precision_loss:
1127 gl_entries.append(
1128 self.get_gl_dict(
1129 {
1130 "account": round_off_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301131 "against_type": against_type,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301132 "against": against,
Gursheen Anand09439332023-11-08 12:57:00 +05301133 "against_link": against,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301134 credit_or_debit: precision_loss,
1135 "cost_center": round_off_cost_center
1136 if self.use_company_roundoff_cost_center
1137 else self.cost_center or round_off_cost_center,
1138 "remarks": _("Net total calculation precision loss"),
1139 }
1140 )
1141 )
1142
ruthra kumar79c6f012023-09-01 14:57:12 +05301143 def gain_loss_journal_already_booked(
1144 self,
1145 gain_loss_account,
1146 exc_gain_loss,
1147 ref2_dt,
1148 ref2_dn,
1149 ref2_detail_no,
1150 ) -> bool:
1151 """
1152 Check if gain/loss is booked
1153 """
1154 if res := frappe.db.get_all(
1155 "Journal Entry Account",
1156 filters={
1157 "docstatus": 1,
1158 "account": gain_loss_account,
1159 "reference_type": ref2_dt, # this will be Journal Entry
1160 "reference_name": ref2_dn,
1161 "reference_detail_no": ref2_detail_no,
1162 },
1163 pluck="parent",
1164 ):
1165 # deduplicate
1166 res = list({x for x in res})
1167 if exc_vouchers := frappe.db.get_all(
1168 "Journal Entry",
1169 filters={"name": ["in", res], "voucher_type": "Exchange Gain Or Loss"},
1170 fields=["voucher_type", "total_debit", "total_credit"],
1171 ):
1172 booked_voucher = exc_vouchers[0]
1173 if (
1174 booked_voucher.total_debit == exc_gain_loss
1175 and booked_voucher.total_credit == exc_gain_loss
1176 and booked_voucher.voucher_type == "Exchange Gain Or Loss"
1177 ):
1178 return True
1179 return False
1180
ruthra kumar66286322023-07-25 10:30:08 +05301181 def make_exchange_gain_loss_journal(self, args: dict = None) -> None:
ruthra kumar81cd7872023-04-27 09:46:54 +05301182 """
1183 Make Exchange Gain/Loss journal for Invoices and Payments
1184 """
ruthra kumarcd42b262023-07-10 15:28:10 +05301185 # Cancelling existing exchange gain/loss journals is handled during the `on_cancel` event.
1186 # see accounts/utils.py:cancel_exchange_gain_loss_journal()
ruthra kumar81cd7872023-04-27 09:46:54 +05301187 if self.docstatus == 1:
ruthra kumar7b516f82023-06-26 17:34:28 +05301188 if self.get("doctype") == "Journal Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301189 # 'args' is populated with exchange gain/loss account and the amount to be booked.
1190 # These are generated by Sales/Purchase Invoice during reconciliation and advance allocation.
ruthra kumarc0b3b062023-07-25 10:51:58 +05301191 # and below logic is only for such scenarios
ruthra kumar7b516f82023-06-26 17:34:28 +05301192 if args:
1193 for arg in args:
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301194 # Advance section uses `exchange_gain_loss` and reconciliation uses `difference_amount`
1195 if (
1196 arg.get("difference_amount", 0) != 0 or arg.get("exchange_gain_loss", 0) != 0
1197 ) and arg.get("difference_account"):
ruthra kumar7b516f82023-06-26 17:34:28 +05301198
ruthra kumaree3ce822023-06-26 21:43:20 +05301199 party_account = arg.get("account")
ruthra kumarc0b3b062023-07-25 10:51:58 +05301200 gain_loss_account = arg.get("difference_account")
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301201 difference_amount = arg.get("difference_amount") or arg.get("exchange_gain_loss")
1202 if difference_amount > 0:
ruthra kumar05672432023-07-12 06:14:17 +05301203 dr_or_cr = "debit" if arg.get("party_type") == "Customer" else "credit"
1204 else:
1205 dr_or_cr = "credit" if arg.get("party_type") == "Customer" else "debit"
ruthra kumar7b516f82023-06-26 17:34:28 +05301206
1207 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1208
ruthra kumar79c6f012023-09-01 14:57:12 +05301209 if not self.gain_loss_journal_already_booked(
ruthra kumarc0b3b062023-07-25 10:51:58 +05301210 gain_loss_account,
1211 difference_amount,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301212 self.doctype,
1213 self.name,
ruthra kumar79c6f012023-09-01 14:57:12 +05301214 arg.get("referenced_row"),
1215 ):
ruthra kumar7e600a62023-10-22 20:26:45 +05301216 posting_date = arg.get("difference_posting_date") or frappe.db.get_value(
1217 arg.voucher_type, arg.voucher_no, "posting_date"
1218 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301219 je = create_gain_loss_journal(
1220 self.company,
ruthra kumarf7865da2023-09-04 20:38:10 +05301221 posting_date,
ruthra kumar79c6f012023-09-01 14:57:12 +05301222 arg.get("party_type"),
1223 arg.get("party"),
1224 party_account,
1225 gain_loss_account,
1226 difference_amount,
1227 dr_or_cr,
1228 reverse_dr_or_cr,
1229 arg.get("against_voucher_type"),
1230 arg.get("against_voucher"),
1231 arg.get("idx"),
1232 self.doctype,
1233 self.name,
1234 arg.get("referenced_row"),
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301235 arg.get("cost_center"),
ruthra kumaracc73222023-07-27 07:52:01 +05301236 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301237 frappe.msgprint(
1238 _("Exchange Gain/Loss amount has been booked through {0}").format(
1239 get_link_to_form("Journal Entry", je)
1240 )
1241 )
ruthra kumar7b516f82023-06-26 17:34:28 +05301242
ruthra kumar81cd7872023-04-27 09:46:54 +05301243 if self.get("doctype") == "Payment Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301244 # For Payment Entry, exchange_gain_loss field in the `references` table is the trigger for journal creation
ruthra kumar81cd7872023-04-27 09:46:54 +05301245 gain_loss_to_book = [x for x in self.references if x.exchange_gain_loss != 0]
1246 booked = []
1247 if gain_loss_to_book:
1248 vtypes = [x.reference_doctype for x in gain_loss_to_book]
1249 vnames = [x.reference_name for x in gain_loss_to_book]
1250 je = qb.DocType("Journal Entry")
1251 jea = qb.DocType("Journal Entry Account")
1252 parents = (
1253 qb.from_(jea)
1254 .select(jea.parent)
1255 .where(
1256 (jea.reference_type == "Payment Entry")
1257 & (jea.reference_name == self.name)
1258 & (jea.docstatus == 1)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301259 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301260 .run()
Saqiba20999c2021-07-12 14:33:23 +05301261 )
1262
ruthra kumar81cd7872023-04-27 09:46:54 +05301263 booked = []
1264 if parents:
1265 booked = (
1266 qb.from_(je)
1267 .inner_join(jea)
1268 .on(je.name == jea.parent)
1269 .select(jea.reference_type, jea.reference_name, jea.reference_detail_no)
1270 .where(
1271 (je.docstatus == 1)
1272 & (je.name.isin(parents))
1273 & (je.voucher_type == "Exchange Gain or Loss")
1274 )
1275 .run()
1276 )
Saqiba20999c2021-07-12 14:33:23 +05301277
ruthra kumar81cd7872023-04-27 09:46:54 +05301278 for d in gain_loss_to_book:
ruthra kumarc0b3b062023-07-25 10:51:58 +05301279 # Filter out References for which Gain/Loss is already booked
ruthra kumar81cd7872023-04-27 09:46:54 +05301280 if d.exchange_gain_loss and (
1281 (d.reference_doctype, d.reference_name, str(d.idx)) not in booked
1282 ):
ruthra kumar81cd7872023-04-27 09:46:54 +05301283 if self.payment_type == "Receive":
1284 party_account = self.paid_from
1285 elif self.payment_type == "Pay":
1286 party_account = self.paid_to
1287
ruthra kumar81cd7872023-04-27 09:46:54 +05301288 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
ruthra kumar34b5e842023-06-16 14:07:44 +05301289
1290 if d.reference_doctype == "Purchase Invoice":
1291 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1292
ruthra kumar81cd7872023-04-27 09:46:54 +05301293 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1294
1295 gain_loss_account = frappe.get_cached_value(
1296 "Company", self.company, "exchange_gain_loss_account"
1297 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301298
ruthra kumaracc73222023-07-27 07:52:01 +05301299 je = create_gain_loss_journal(
ruthra kumar1ea1bfe2023-07-26 16:19:38 +05301300 self.company,
ruthra kumar7e600a62023-10-22 20:26:45 +05301301 args.get("difference_posting_date") if args else self.posting_date,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301302 self.party_type,
1303 self.party,
1304 party_account,
1305 gain_loss_account,
1306 d.exchange_gain_loss,
1307 dr_or_cr,
1308 reverse_dr_or_cr,
1309 d.reference_doctype,
1310 d.reference_name,
1311 d.idx,
1312 self.doctype,
1313 self.name,
1314 d.idx,
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301315 self.cost_center,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301316 )
ruthra kumaracc73222023-07-27 07:52:01 +05301317 frappe.msgprint(
1318 _("Exchange Gain/Loss amount has been booked through {0}").format(
1319 get_link_to_form("Journal Entry", je)
1320 )
1321 )
Saqiba20999c2021-07-12 14:33:23 +05301322
Deepesh Garg016ed952023-06-20 13:22:32 +05301323 def update_against_document_in_jv(self):
Nabin Hait28a05282016-06-27 17:41:39 +05301324 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301325 Links invoice and advance voucher:
1326 1. cancel advance voucher
1327 2. split into multiple rows if partially adjusted, assign against voucher
1328 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +05301329 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301330
Nabin Hait28a05282016-06-27 17:41:39 +05301331 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301332 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +05301333 party = self.customer
1334 party_account = self.debit_to
1335 dr_or_cr = "credit_in_account_currency"
1336 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301337 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +05301338 party = self.supplier
1339 party_account = self.credit_to
1340 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +05301341
Nabin Hait28a05282016-06-27 17:41:39 +05301342 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +05301343 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +05301344 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301345 args = frappe._dict(
1346 {
1347 "voucher_type": d.reference_type,
1348 "voucher_no": d.reference_name,
1349 "voucher_detail_no": d.reference_row,
1350 "against_voucher_type": self.doctype,
1351 "against_voucher": self.name,
1352 "account": party_account,
1353 "party_type": party_type,
1354 "party": party,
1355 "is_advance": "Yes",
1356 "dr_or_cr": dr_or_cr,
1357 "unadjusted_amount": flt(d.advance_amount),
1358 "allocated_amount": flt(d.allocated_amount),
1359 "precision": d.precision("advance_amount"),
1360 "exchange_rate": (
1361 self.conversion_rate if self.party_account_currency != self.company_currency else 1
1362 ),
1363 "grand_total": (
1364 self.base_grand_total
1365 if self.party_account_currency == self.company_currency
1366 else self.grand_total
1367 ),
1368 "outstanding_amount": self.outstanding_amount,
Daizy Modi4efc9472022-11-07 09:21:03 +05301369 "difference_account": frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301370 "Company", self.company, "exchange_gain_loss_account"
1371 ),
1372 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
1373 }
1374 )
Nabin Hait28a05282016-06-27 17:41:39 +05301375 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301376
Nabin Hait28a05282016-06-27 17:41:39 +05301377 if lst:
1378 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +05301379
Deepesh Garg016ed952023-06-20 13:22:32 +05301380 reconcile_against_document(lst)
Anand Doshid2946502014-04-08 20:10:03 +05301381
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301382 def on_cancel(self):
ruthra kumar81cd7872023-04-27 09:46:54 +05301383 from erpnext.accounts.utils import (
1384 cancel_exchange_gain_loss_journal,
1385 unlink_ref_doc_from_payment_entries,
1386 )
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301387
ruthra kumar6e18bb62023-07-11 12:21:10 +05301388 if self.doctype in ["Sales Invoice", "Purchase Invoice", "Payment Entry", "Journal Entry"]:
ruthra kumar81cd7872023-04-27 09:46:54 +05301389 # Cancel Exchange Gain/Loss Journal before unlinking
1390 cancel_exchange_gain_loss_journal(self)
1391
Ankush Menat494bd9e2022-03-28 18:52:46 +05301392 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301393 unlink_ref_doc_from_payment_entries(self)
1394
1395 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301396 if frappe.db.get_single_value(
1397 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1398 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301399 unlink_ref_doc_from_payment_entries(self)
1400
GangaManoj8396f242021-09-20 19:01:46 +05301401 if self.doctype == "Sales Order":
1402 self.unlink_ref_doc_from_po()
1403
1404 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301405 so_items = []
1406 for item in self.items:
1407 so_items.append(item.name)
1408
Ankush Menat494bd9e2022-03-28 18:52:46 +05301409 linked_po = list(
1410 set(
1411 frappe.get_all(
1412 "Purchase Order Item",
1413 filters={
1414 "sales_order": self.name,
1415 "sales_order_item": ["in", so_items],
1416 "docstatus": ["<", 2],
1417 },
1418 pluck="parent",
1419 )
1420 )
1421 )
GangaManoj8396f242021-09-20 19:01:46 +05301422
GangaManoj8396f242021-09-20 19:01:46 +05301423 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301424 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301425 "Purchase Order Item",
1426 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1427 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301428 )
GangaManoj8396f242021-09-20 19:01:46 +05301429
1430 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1431
Deepesh Gargd18dde72020-11-29 21:40:04 +05301432 def get_tax_map(self):
1433 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301434 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301435 tax_map.setdefault(tax.account_head, 0.0)
1436 tax_map[tax.account_head] += tax.tax_amount
1437
1438 return tax_map
1439
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301440 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1441 amount = item.net_amount
1442 base_amount = item.base_net_amount
1443
Ankush Menat494bd9e2022-03-28 18:52:46 +05301444 if (
1445 enable_discount_accounting
1446 and self.get("discount_amount")
1447 and self.get("additional_discount_account")
1448 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301449 amount = item.amount
1450 base_amount = item.base_amount
1451
1452 return amount, base_amount
1453
1454 def get_tax_amounts(self, tax, enable_discount_accounting):
1455 amount = tax.tax_amount_after_discount_amount
1456 base_amount = tax.base_tax_amount_after_discount_amount
1457
Ankush Menat494bd9e2022-03-28 18:52:46 +05301458 if (
1459 enable_discount_accounting
1460 and self.get("discount_amount")
1461 and self.get("additional_discount_account")
1462 and self.get("apply_discount_on") == "Grand Total"
1463 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301464 amount = tax.tax_amount
1465 base_amount = tax.base_tax_amount
1466
1467 return amount, base_amount
1468
GangaManoj8f7b0a12021-07-13 03:01:02 +05301469 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301470 if self.doctype == "Purchase Invoice":
1471 enable_discount_accounting = cint(
1472 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1473 )
1474 elif self.doctype == "Sales Invoice":
1475 enable_discount_accounting = cint(
1476 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1477 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301478
Deepesh Garg3b159662022-08-21 17:51:05 +05301479 if self.doctype == "Purchase Invoice":
1480 dr_or_cr = "credit"
1481 rev_dr_cr = "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301482 against_type = "Supplier"
Deepesh Garg3b159662022-08-21 17:51:05 +05301483 supplier_or_customer = self.supplier
1484
1485 else:
1486 dr_or_cr = "debit"
1487 rev_dr_cr = "credit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301488 against_type = "Customer"
Deepesh Garg3b159662022-08-21 17:51:05 +05301489 supplier_or_customer = self.customer
1490
GangaManoj8f7b0a12021-07-13 03:01:02 +05301491 if enable_discount_accounting:
1492 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301493 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301494 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301495 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301496 income_or_expense_account = (
1497 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301498 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301499 else item.deferred_expense_account
1500 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301501 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301502 income_or_expense_account = (
1503 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301504 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301505 else item.deferred_revenue_account
1506 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301507
1508 account_currency = get_account_currency(item.discount_account)
1509 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301510 self.get_gl_dict(
1511 {
1512 "account": item.discount_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301513 "against_type": against_type,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301514 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301515 "against_link": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301516 dr_or_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301517 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1518 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301519 dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301520 "cost_center": item.cost_center,
1521 "project": item.project,
1522 },
1523 account_currency,
1524 item=item,
1525 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301526 )
1527
1528 account_currency = get_account_currency(income_or_expense_account)
1529 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301530 self.get_gl_dict(
1531 {
1532 "account": income_or_expense_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301533 "against_type": against_type,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301534 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301535 "against_link": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301536 rev_dr_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301537 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1538 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301539 rev_dr_cr
1540 + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301541 "cost_center": item.cost_center,
1542 "project": item.project or self.project,
1543 },
1544 account_currency,
1545 item=item,
1546 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301547 )
GangaManoj857501c2021-07-15 22:03:46 +05301548
Deepesh Garg3b159662022-08-21 17:51:05 +05301549 if (
Deepesh Gargae3dce02022-08-22 08:57:58 +05301550 (enable_discount_accounting or self.get("is_cash_or_non_trade_discount"))
Deepesh Garg3b159662022-08-21 17:51:05 +05301551 and self.get("additional_discount_account")
1552 and self.get("discount_amount")
1553 ):
1554 gl_entries.append(
1555 self.get_gl_dict(
1556 {
1557 "account": self.additional_discount_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301558 "against_type": against_type,
Deepesh Garg3b159662022-08-21 17:51:05 +05301559 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301560 "against_link": supplier_or_customer,
Gursheen Anand112cfe62023-08-31 17:08:51 +05301561 dr_or_cr: self.base_discount_amount,
vr-greycube4ada5a42023-09-27 10:38:32 +05301562 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
Deepesh Garg3b159662022-08-21 17:51:05 +05301563 },
1564 item=self,
Ankush Menat4551d7d2021-08-19 13:41:10 +05301565 )
Deepesh Garg3b159662022-08-21 17:51:05 +05301566 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301567
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301568 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on):
Nabin Hait868766d2019-07-15 18:02:58 +05301569 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301570
Nabin Hait868766d2019-07-15 18:02:58 +05301571 item_allowance = {}
1572 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301573
Ankush Menat494bd9e2022-03-28 18:52:46 +05301574 role_allowed_to_over_bill = frappe.db.get_single_value(
1575 "Accounts Settings", "role_allowed_to_over_bill"
1576 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301577 user_roles = frappe.get_roles()
1578
Ankush Menat43bf82b2021-09-20 16:31:20 +05301579 total_overbilled_amt = 0.0
1580
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301581 reference_names = [d.get(item_ref_dn) for d in self.get("items") if d.get(item_ref_dn)]
1582 reference_details = self.get_billing_reference_details(
1583 reference_names, ref_dt + " Item", based_on
1584 )
1585
Nabin Hait4b8185d2014-12-25 18:19:39 +05301586 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301587 if not item.get(item_ref_dn):
1588 continue
Anand Doshid2946502014-04-08 20:10:03 +05301589
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301590 ref_amt = flt(reference_details.get(item.get(item_ref_dn)), self.precision(based_on, item))
1591
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301592 if not ref_amt:
1593 frappe.msgprint(
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301594 _("System will not check over billing since amount for Item {0} in {1} is zero").format(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301595 item.item_code, ref_dt
1596 ),
1597 title=_("Warning"),
1598 indicator="orange",
1599 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301600 continue
Anand Doshid2946502014-04-08 20:10:03 +05301601
Saqib9c913c92021-11-26 12:00:13 +05301602 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301603
Ankush Menat494bd9e2022-03-28 18:52:46 +05301604 total_billed_amt = flt(
1605 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1606 )
Anand Doshid2946502014-04-08 20:10:03 +05301607
Ankush Menat494bd9e2022-03-28 18:52:46 +05301608 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1609 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1610 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301611
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301612 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301613
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301614 if total_billed_amt < 0 and max_allowed_amt < 0:
1615 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1616 total_billed_amt = abs(total_billed_amt)
1617 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301618
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301619 overbill_amt = total_billed_amt - max_allowed_amt
1620 total_overbilled_amt += overbill_amt
1621
1622 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1623 if self.doctype != "Purchase Invoice":
1624 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301625 elif not cint(
1626 frappe.db.get_single_value(
1627 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1628 )
1629 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301630 self.throw_overbill_exception(item, max_allowed_amt)
1631
1632 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301633 frappe.msgprint(
1634 _("Overbilling of {} ignored because you have {} role.").format(
1635 total_overbilled_amt, role_allowed_to_over_bill
1636 ),
1637 indicator="orange",
1638 alert=True,
1639 )
Afshan53fefd72021-06-24 10:09:02 +05301640
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301641 def get_billing_reference_details(self, reference_names, reference_doctype, based_on):
1642 return frappe._dict(
1643 frappe.get_all(
1644 reference_doctype,
1645 filters={"name": ("in", reference_names)},
1646 fields=["name", based_on],
1647 as_list=1,
1648 )
1649 )
1650
Saqib9c913c92021-11-26 12:00:13 +05301651 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301652 """
1653 Returns Sum of Amount of
1654 Sales/Purchase Invoice Items
1655 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1656 that are submitted OR not submitted but are under current invoice
1657 """
Saqib9c913c92021-11-26 12:00:13 +05301658
1659 from frappe.query_builder import Criterion
1660 from frappe.query_builder.functions import Sum
1661
1662 item_doctype = frappe.qb.DocType(item.doctype)
1663 based_on_field = frappe.qb.Field(based_on)
1664 join_field = frappe.qb.Field(item_ref_dn)
1665
1666 result = (
1667 frappe.qb.from_(item_doctype)
1668 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301669 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301670 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301671 Criterion.any(
1672 [ # select all items from other invoices OR current invoices
1673 Criterion.all(
1674 [ # for selecting items from other invoices
1675 item_doctype.docstatus == 1,
1676 item_doctype.parent != self.name,
1677 ]
1678 ),
1679 Criterion.all(
1680 [ # for selecting items from current invoice, that are linked to same reference
1681 item_doctype.docstatus == 0,
1682 item_doctype.parent == self.name,
1683 item_doctype.name != item.name,
1684 ]
1685 ),
1686 ]
1687 )
Saqib9c913c92021-11-26 12:00:13 +05301688 )
1689 ).run()
1690
1691 return result[0][0] if result else 0
1692
Afshan53fefd72021-06-24 10:09:02 +05301693 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301694 frappe.throw(
1695 _(
1696 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1697 ).format(item.item_code, item.idx, max_allowed_amt)
1698 )
Anand Doshid2946502014-04-08 20:10:03 +05301699
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301700 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301701 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301702
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301703 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301704
Nabin Haita36adbd2013-08-02 14:50:12 +05301705 def get_stock_items(self):
1706 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301707 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301708 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301709 stock_items = frappe.db.get_values(
1710 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1711 )
Anand Doshid2946502014-04-08 20:10:03 +05301712
Nabin Haita36adbd2013-08-02 14:50:12 +05301713 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301714
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301715 def set_total_advance_paid(self):
ruthra kumar44870652022-11-01 10:11:38 +05301716 ple = frappe.qb.DocType("Payment Ledger Entry")
1717 party = self.customer if self.doctype == "Sales Order" else self.supplier
1718 advance = (
1719 frappe.qb.from_(ple)
ruthra kumarbf76b852022-11-22 12:16:11 +05301720 .select(ple.account_currency, Abs(Sum(ple.amount_in_account_currency)).as_("amount"))
ruthra kumar44870652022-11-01 10:11:38 +05301721 .where(
1722 (ple.against_voucher_type == self.doctype)
1723 & (ple.against_voucher_no == self.name)
1724 & (ple.party == party)
ruthra kumarbf76b852022-11-22 12:16:11 +05301725 & (ple.docstatus == 1)
ruthra kumar44870652022-11-01 10:11:38 +05301726 & (ple.company == self.company)
1727 )
1728 .run(as_dict=True)
1729 )
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301730
Nabin Haitb2206d12016-01-27 15:43:12 +05301731 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301732 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301733
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301734 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301735 formatted_advance_paid = fmt_money(
1736 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1737 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301738
Ankush Menat494bd9e2022-03-28 18:52:46 +05301739 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301740
1741 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301742 order_total = self.get("rounded_total") or self.grand_total
1743 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301744 else:
finbyz5efc7972019-01-05 11:12:11 +05301745 order_total = self.get("base_rounded_total") or self.base_grand_total
1746 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301747
Ankush Menat494bd9e2022-03-28 18:52:46 +05301748 formatted_order_total = fmt_money(
1749 order_total, precision=self.precision(precision), currency=advance.account_currency
1750 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301751
Nabin Hait9db1b222016-06-30 12:37:53 +05301752 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301753 frappe.throw(
1754 _(
1755 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1756 ).format(formatted_advance_paid, self.name, formatted_order_total)
1757 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301758
Nabin Hait13093b42016-06-29 18:04:37 +05301759 frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid)
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301760
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301761 @property
1762 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301763 if not hasattr(self, "_abbr"):
Daizy Modi4efc9472022-11-07 09:21:03 +05301764 self._abbr = frappe.get_cached_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301765
1766 return self._abbr
1767
marination4be5b5c2020-10-08 19:08:27 +05301768 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301769 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301770 db_or_cr = (
1771 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1772 )
marination4be5b5c2020-10-08 19:08:27 +05301773 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1774
1775 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1776 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1777
Ankush Menat494bd9e2022-03-28 18:52:46 +05301778 message = _("{0} Account not found against Customer {1}.").format(
1779 db_or_cr, frappe.bold(party) or ""
1780 )
marination4be5b5c2020-10-08 19:08:27 +05301781 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301782 message += (
1783 "<br><ul><li>"
1784 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1785 + "</li>"
1786 )
1787 message += (
1788 "<li>"
1789 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1790 + "</li></ul>"
1791 )
marination4be5b5c2020-10-08 19:08:27 +05301792
marination53b1a9a2020-11-03 15:45:25 +05301793 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301794
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301795 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301796 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301797 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301798
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301799 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301800 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301801 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301802 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301803
Ankush Menat494bd9e2022-03-28 18:52:46 +05301804 elif self.doctype in (
1805 "Supplier Quotation",
1806 "Purchase Order",
1807 "Purchase Receipt",
1808 "Purchase Invoice",
1809 ):
1810 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301811
1812 elif self.meta.get_field("customer"):
1813 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301814
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301815 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301816 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301817
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301818 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301819
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301820 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301821
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301822 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301823 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301824 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301825 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301826 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301827
Ankush Menat494bd9e2022-03-28 18:52:46 +05301828 if (
1829 party_account_currency
1830 and party_account_currency != self.company_currency
1831 and self.currency != party_account_currency
1832 ):
Gursheen Anand112cfe62023-08-31 17:08:51 +05301833
Ankush Menat494bd9e2022-03-28 18:52:46 +05301834 frappe.throw(
1835 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1836 party_type, party, party_account_currency
1837 ),
1838 InvalidCurrency,
1839 )
Anand Doshi979326b2015-09-11 16:22:37 +05301840
shreyas29b565f2016-01-25 17:30:49 +05301841 # Note: not validating with gle account because we don't have the account
1842 # at quotation / sales order level and we shouldn't stop someone
1843 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301844
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301845 def validate_party_account_currency(self):
Deepesh Garg33d97672022-05-12 16:40:29 +05301846 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301847 return
1848
Deepesh Garg33d97672022-05-12 16:40:29 +05301849 if self.is_opening == "Yes":
Deepesh Garg60915e82021-08-21 23:05:48 +05301850 return
1851
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301852 party_type, party = self.get_party()
1853 party_gle_currency = get_party_gle_currency(party_type, party, self.company)
Deepesh Garg33d97672022-05-12 16:40:29 +05301854 party_account = (
1855 self.get("debit_to") if self.doctype == "Sales Invoice" else self.get("credit_to")
1856 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301857 party_account_currency = get_account_currency(party_account)
Deepesh Garge04e67c2022-07-11 19:25:18 +05301858 allow_multi_currency_invoices_against_single_party_account = frappe.db.get_singles_value(
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301859 "Accounts Settings", "allow_multi_currency_invoices_against_single_party_account"
1860 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301861
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301862 if (
1863 not party_gle_currency
1864 and (party_account_currency != self.currency)
1865 and not allow_multi_currency_invoices_against_single_party_account
1866 ):
Deepesh Garg33d97672022-05-12 16:40:29 +05301867 frappe.throw(
Devin Slauenwhite3a1c9232022-06-02 14:15:50 -04001868 _("Party Account {0} currency ({1}) and document currency ({2}) should be same").format(
Devin Slauenwhiteb061ea42022-06-02 14:23:54 -04001869 frappe.bold(party_account), party_account_currency, self.currency
Deepesh Garg33d97672022-05-12 16:40:29 +05301870 )
1871 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301872
Nabin Hait297d74a2016-11-23 15:58:51 +05301873 def delink_advance_entries(self, linked_doc_name):
1874 total_allocated_amount = 0
1875 for adv in self.advances:
1876 consider_for_total_advance = True
1877 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301878 frappe.db.sql(
1879 """delete from `tab{0} Advance`
1880 where name = %s""".format(
1881 self.doctype
1882 ),
1883 adv.name,
1884 )
Nabin Hait297d74a2016-11-23 15:58:51 +05301885 consider_for_total_advance = False
1886
1887 if consider_for_total_advance:
1888 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
1889
Ankush Menat494bd9e2022-03-28 18:52:46 +05301890 frappe.db.set_value(
1891 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
1892 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05301893
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301894 def group_similar_items(self):
1895 group_item_qty = {}
1896 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05301897 # to update serial number in print
1898 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301899
1900 for item in self.items:
1901 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
1902 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
1903
1904 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301905 for item in self.items:
1906 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05301907 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301908 item.qty = group_item_qty[item.item_code]
1909 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05301910
1911 if item.qty:
1912 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
1913 else:
1914 item.rate = 0
1915
Shreya Shah785f1aa2018-10-11 10:14:25 +05301916 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301917 del group_item_qty[item.item_code]
1918 else:
1919 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301920 for item in duplicate_list:
1921 self.remove(item)
1922
tunde32aa7c12017-09-07 06:52:15 +01001923 def set_payment_schedule(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301924 if self.doctype == "Sales Invoice" and self.is_pos:
1925 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05301926 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301927
Ankush Menat494bd9e2022-03-28 18:52:46 +05301928 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301929 if not party_account_currency:
1930 party_type, party = self.get_party()
1931
1932 if party_type and party:
1933 party_account_currency = get_party_account_currency(party_type, party, self.company)
1934
rohitwaghchaureda941af2018-01-17 16:23:04 +05301935 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01001936 date = self.get("due_date")
1937 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05301938
Saqib Ansarid552fe62021-04-23 14:46:52 +05301939 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1940 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg5c758942023-04-16 17:11:24 +05301941 automatically_fetch_payment_terms = 0
Deepesh Garg26210162020-08-11 16:06:13 +05301942
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301943 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301944 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301945 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301946 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05301947 automatically_fetch_payment_terms = cint(
1948 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
1949 )
tunde96b8f222017-09-08 15:35:59 +01001950
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301951 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301952 if party_account_currency == self.company_currency:
1953 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301954 grand_total = flt(
1955 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
1956 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05301957 else:
1958 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301959 base_grand_total = flt(
1960 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
1961 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301962
Nabin Hait0551f7b2017-11-21 19:58:16 +05301963 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301964 if (
1965 self.doctype in ["Sales Invoice", "Purchase Invoice"]
1966 and automatically_fetch_payment_terms
1967 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
1968 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301969 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301970 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301971 self.ignore_default_payment_terms_template = 1
1972 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301973 data = get_payment_terms(
1974 self.payment_terms_template, posting_date, grand_total, base_grand_total
1975 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05301976 for item in data:
1977 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05301978 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301979 data = dict(
1980 due_date=due_date,
1981 invoice_portion=100,
1982 payment_amount=grand_total,
1983 base_payment_amount=base_grand_total,
1984 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05301985 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301986
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05301987 allocate_payment_based_on_payment_terms = frappe.db.get_value(
1988 "Payment Terms Template", self.payment_terms_template, "allocate_payment_based_on_payment_terms"
1989 )
1990
Deepesh Gargf7b50f22023-04-25 19:18:45 +05301991 if not (
1992 automatically_fetch_payment_terms
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05301993 and allocate_payment_based_on_payment_terms
Deepesh Gargf7b50f22023-04-25 19:18:45 +05301994 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
1995 ):
Deepesh Garg5c758942023-04-16 17:11:24 +05301996 for d in self.get("payment_schedule"):
1997 if d.invoice_portion:
1998 d.payment_amount = flt(
1999 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
2000 )
2001 d.base_payment_amount = flt(
2002 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
2003 )
2004 d.outstanding = d.payment_amount
2005 elif not d.invoice_portion:
2006 d.base_payment_amount = flt(
2007 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
2008 )
ruthra kumar0da6c162023-05-16 18:57:42 +05302009 else:
2010 self.fetch_payment_terms_from_order(po_or_so, doctype)
2011 self.ignore_default_payment_terms_template = 1
tunde43870aa2017-08-18 11:59:30 +01002012
GangaManoj4323f4b2021-07-22 05:57:42 +05302013 def get_order_details(self):
2014 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302015 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302016 po_or_so_doctype = "Sales Order"
2017 po_or_so_doctype_name = "sales_order"
2018
tunde43870aa2017-08-18 11:59:30 +01002019 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302020 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302021 po_or_so_doctype = "Purchase Order"
2022 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05302023
GangaManoj4323f4b2021-07-22 05:57:42 +05302024 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
2025
GangaManojc7c90242021-07-29 19:18:35 +05302026 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302027 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05302028 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302029 return True
2030 elif self.linked_order_has_payment_schedule(po_or_so):
2031 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05302032
GangaManoj4323f4b2021-07-22 05:57:42 +05302033 return False
2034
2035 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302036 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05302037 if item.get(fieldname) != po_or_so:
2038 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05302039
GangaManoj4323f4b2021-07-22 05:57:42 +05302040 return True
2041
GangaManojc7c90242021-07-29 19:18:35 +05302042 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302043 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05302044
2045 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302046 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05302047
2048 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
2049 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302050 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05302051 """
2052 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
2053
2054 self.payment_schedule = []
2055 self.payment_terms_template = po_or_so.payment_terms_template
2056
2057 for schedule in po_or_so.payment_schedule:
2058 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302059 "payment_term": schedule.payment_term,
2060 "due_date": schedule.due_date,
2061 "invoice_portion": schedule.invoice_portion,
2062 "mode_of_payment": schedule.mode_of_payment,
2063 "description": schedule.description,
Deepesh Garg5c758942023-04-16 17:11:24 +05302064 "payment_amount": schedule.payment_amount,
2065 "base_payment_amount": schedule.base_payment_amount,
2066 "outstanding": schedule.outstanding,
2067 "paid_amount": schedule.paid_amount,
GangaManoj4323f4b2021-07-22 05:57:42 +05302068 }
GangaManoj5b33e752021-08-05 21:50:09 +05302069
Ankush Menat494bd9e2022-03-28 18:52:46 +05302070 if schedule.discount_type == "Percentage":
2071 payment_schedule["discount_type"] = schedule.discount_type
2072 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05302073
ruthra kumar9bd56b02022-02-01 14:14:04 +05302074 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302075 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05302076
GangaManoj4323f4b2021-07-22 05:57:42 +05302077 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01002078
tundebe1b8712017-08-19 08:21:44 +01002079 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05302080 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
2081 if due_dates:
2082 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01002083
2084 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01002085 dates = []
tunde9bed2de2017-09-25 10:19:35 +01002086 li = []
tunde43870aa2017-08-18 11:59:30 +01002087
Ankush Menat494bd9e2022-03-28 18:52:46 +05302088 if self.doctype == "Sales Invoice" and self.is_pos:
2089 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302090
tunde43870aa2017-08-18 11:59:30 +01002091 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302092 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302093 frappe.throw(
2094 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
2095 )
tunde77ecacc2017-09-22 23:12:55 +01002096 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03002097 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01002098 dates.append(d.due_date)
2099
2100 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302101 duplicates = "<br>" + "<br>".join(li)
2102 frappe.throw(
2103 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
2104 )
tunde43870aa2017-08-18 11:59:30 +01002105
tunde62af5c52017-09-22 15:16:38 +01002106 def validate_payment_schedule_amount(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302107 if self.doctype == "Sales Invoice" and self.is_pos:
2108 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302109
Ankush Menat494bd9e2022-03-28 18:52:46 +05302110 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302111 if not party_account_currency:
2112 party_type, party = self.get_party()
2113
2114 if party_type and party:
2115 party_account_currency = get_party_account_currency(party_type, party, self.company)
2116
Nabin Hait0551f7b2017-11-21 19:58:16 +05302117 if self.get("payment_schedule"):
2118 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05302119 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05302120 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05302121 total += flt(d.payment_amount, d.precision("payment_amount"))
2122 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01002123
Saqib Ansarid552fe62021-04-23 14:46:52 +05302124 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2125 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302126
Nabin Haite591c852017-12-21 11:46:30 +05302127 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302128 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05302129 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05302130
2131 if self.get("total_advance"):
2132 if party_account_currency == self.company_currency:
2133 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302134 grand_total = flt(
2135 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2136 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302137 else:
2138 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302139 base_grand_total = flt(
2140 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2141 )
Deepesh Garg9c170522021-10-25 20:06:24 +05302142
Ankush Menat494bd9e2022-03-28 18:52:46 +05302143 if (
2144 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
2145 > 0.1
2146 or flt(base_total, self.precision("base_grand_total"))
2147 - flt(base_grand_total, self.precision("base_grand_total"))
2148 > 0.1
2149 ):
2150 frappe.throw(
2151 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
2152 )
tunde43870aa2017-08-18 11:59:30 +01002153
Nabin Hait877e1bb2017-11-17 12:27:43 +05302154 def is_rounded_total_disabled(self):
2155 if self.meta.get_field("disable_rounded_total"):
2156 return self.disable_rounded_total
2157 else:
2158 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
2159
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302160 def set_inter_company_account(self):
2161 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302162 Set intercompany account for inter warehouse transactions
2163 This account will be used in case billing company and internal customer's
2164 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302165 """
2166
2167 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Daizy Modi4efc9472022-11-07 09:21:03 +05302168 unrealized_profit_loss_account = frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302169 "Company", self.company, "unrealized_profit_loss_account"
2170 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302171
2172 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302173 msg = _(
2174 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
2175 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302176 frappe.throw(msg)
2177
2178 self.unrealized_profit_loss_account = unrealized_profit_loss_account
2179
2180 def is_internal_transfer(self):
2181 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302182 It will an internal transfer if its an internal customer and representation
2183 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302184 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302185 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
2186 internal_party_field = "is_internal_customer"
2187 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
2188 internal_party_field = "is_internal_supplier"
Ankush Menat3714e362022-05-16 18:09:14 +05302189 else:
2190 return False
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302191
2192 if self.get(internal_party_field) and (self.represents_company == self.company):
2193 return True
2194
2195 return False
2196
Saqib Ansari977b09b2021-08-19 17:57:30 +05302197 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302198 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05302199 if not is_invoice:
2200 return
2201
Ankush Menat494bd9e2022-03-28 18:52:46 +05302202 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05302203 party_link = self.get_common_party_link()
2204 if party_link and self.outstanding_amount:
2205 self.create_advance_and_reconcile(party_link)
2206
2207 def get_common_party_link(self):
2208 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05302209 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302210 doctype="Party Link",
2211 filters={"secondary_role": party_type, "secondary_party": party},
2212 fieldname=["primary_role", "primary_party"],
2213 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05302214 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302215
2216 def create_advance_and_reconcile(self, party_link):
2217 secondary_party_type, secondary_party = self.get_party()
2218 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
2219
2220 primary_account = get_party_account(primary_party_type, primary_party, self.company)
2221 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
2222
Ankush Menat494bd9e2022-03-28 18:52:46 +05302223 jv = frappe.new_doc("Journal Entry")
2224 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302225 jv.posting_date = self.posting_date
2226 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05302227 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302228
2229 reconcilation_entry = frappe._dict()
2230 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05302231
2232 reconcilation_entry.account = secondary_account
2233 reconcilation_entry.party_type = secondary_party_type
2234 reconcilation_entry.party = secondary_party
2235 reconcilation_entry.reference_type = self.doctype
2236 reconcilation_entry.reference_name = self.name
Deepesh Gargf88431a2023-04-25 20:54:22 +05302237 reconcilation_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(
2238 self.company
2239 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302240
2241 advance_entry.account = primary_account
2242 advance_entry.party_type = primary_party_type
2243 advance_entry.party = primary_party
Deepesh Gargf88431a2023-04-25 20:54:22 +05302244 advance_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(self.company)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302245 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302246
Ankush Menat494bd9e2022-03-28 18:52:46 +05302247 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05302248 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
2249 advance_entry.debit_in_account_currency = self.outstanding_amount
2250 else:
2251 advance_entry.credit_in_account_currency = self.outstanding_amount
2252 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
2253
Ankush Menat494bd9e2022-03-28 18:52:46 +05302254 jv.append("accounts", reconcilation_entry)
2255 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302256
2257 jv.save()
2258 jv.submit()
2259
Deepesh Gargd05d1532022-06-14 12:50:49 +05302260 def check_conversion_rate(self):
2261 default_currency = erpnext.get_company_currency(self.company)
2262 if not default_currency:
2263 throw(_("Please enter default currency in Company Master"))
2264 if (
2265 (self.currency == default_currency and flt(self.conversion_rate) != 1.00)
2266 or not self.conversion_rate
2267 or (self.currency != default_currency and flt(self.conversion_rate) == 1.00)
2268 ):
2269 throw(_("Conversion rate cannot be 0 or 1"))
2270
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002271 def check_finance_books(self, item, asset):
Nabin Haitfefe9502022-09-09 14:40:36 +05302272 if (
2273 len(asset.finance_books) > 1
2274 and not item.get("finance_book")
2275 and not self.get("finance_book")
2276 and asset.finance_books[0].finance_book
2277 ):
2278 frappe.throw(
2279 _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx)
2280 )
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002281
Gursheen Anand68effd92023-09-21 17:28:07 +05302282 def check_if_fields_updated(self, fields_to_check, child_tables):
2283 # Check if any field affecting accounting entry is altered
2284 doc_before_update = self.get_doc_before_save()
2285 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
2286
2287 # Check if opening entry check updated
2288 needs_repost = doc_before_update.get("is_opening") != self.is_opening
2289
2290 if not needs_repost:
2291 # Parent Level Accounts excluding party account
2292 fields_to_check += accounting_dimensions
2293 for field in fields_to_check:
2294 if doc_before_update.get(field) != self.get(field):
2295 needs_repost = 1
2296 break
2297
2298 if not needs_repost:
2299 # Check for child tables
2300 for table in child_tables:
2301 needs_repost = check_if_child_table_updated(
2302 doc_before_update.get(table), self.get(table), child_tables[table]
2303 )
2304 if needs_repost:
2305 break
2306
2307 return needs_repost
2308
2309 @frappe.whitelist()
2310 def repost_accounting_entries(self):
2311 if self.repost_required:
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302312 repost_ledger = frappe.new_doc("Repost Accounting Ledger")
2313 repost_ledger.company = self.company
2314 repost_ledger.append("vouchers", {"voucher_type": self.doctype, "voucher_no": self.name})
Gursheen Kaur Anand1b808e12023-11-02 14:01:26 +05302315 repost_ledger.flags.ignore_permissions = True
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302316 repost_ledger.insert()
2317 repost_ledger.submit()
Gursheen Anand68effd92023-09-21 17:28:07 +05302318 self.db_set("repost_required", 0)
2319 else:
2320 frappe.throw(_("No updates pending for reposting"))
2321
Ankush Menat494bd9e2022-03-28 18:52:46 +05302322
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05302323@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05302324def get_tax_rate(account_head):
Daizy Modi4efc9472022-11-07 09:21:03 +05302325 return frappe.get_cached_value(
2326 "Account", account_head, ["tax_rate", "account_name"], as_dict=True
2327 )
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05302328
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002329
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302330@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05302331def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302332 if not company:
2333 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05302334
Nabin Haita2426fc2018-01-15 17:45:46 +05302335 if tax_template and company:
Daizy Modi4efc9472022-11-07 09:21:03 +05302336 tax_template_company = frappe.get_cached_value(master_doctype, tax_template, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +05302337 if tax_template_company == company:
2338 return
2339
2340 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05302341
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302342 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302343 "taxes_and_charges": default_tax,
2344 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302345 }
Nabin Hait6b039142014-05-02 15:45:10 +05302346
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002347
Nabin Hait6b039142014-05-02 15:45:10 +05302348@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302349def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05302350 if not master_name:
2351 return
Ankush Menat77dcdff2022-06-01 22:01:07 +05302352 from frappe.model import child_table_fields, default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05302353
Nabin Hait6b039142014-05-02 15:45:10 +05302354 tax_master = frappe.get_doc(master_doctype, master_name)
2355
2356 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302357 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05302358 tax = tax.as_dict()
2359
Ankush Menat77dcdff2022-06-01 22:01:07 +05302360 for fieldname in default_fields + child_table_fields:
Nabin Hait6b039142014-05-02 15:45:10 +05302361 if fieldname in tax:
2362 del tax[fieldname]
2363
2364 taxes_and_charges.append(tax)
2365
2366 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302367
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002368
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302369def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
2370 """common validation for currency and price list currency"""
2371
Ankush Menat494bd9e2022-03-28 18:52:46 +05302372 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302373
2374 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05302375 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302376 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
2377 conversion_rate_label, currency, company_currency
2378 )
Saqib60212ff2020-10-26 11:17:04 +05302379 )
Nabin Hait613d0812015-02-23 11:58:15 +05302380
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002381
Nabin Hait613d0812015-02-23 11:58:15 +05302382def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302383 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
2384 frappe.throw(
2385 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
2386 )
2387 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05302388 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002389 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302390 _(
2391 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
2392 )
2393 )
Nabin Hait613d0812015-02-23 11:58:15 +05302394 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302395 frappe.throw(
2396 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
2397 )
Nabin Hait613d0812015-02-23 11:58:15 +05302398 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302399 frappe.throw(
2400 _("Cannot refer row number greater than or equal to current row number for this Charge type")
2401 )
Nabin Hait613d0812015-02-23 11:58:15 +05302402
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302403 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05302404 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302405
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002406
Ankush Menat494bd9e2022-03-28 18:52:46 +05302407def validate_account_head(idx, account, company, context=""):
2408 account_company = frappe.get_cached_value("Account", account, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302409
Deepesh Garg5a2b5712022-02-18 20:05:49 +05302410 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302411 frappe.throw(
2412 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
2413 idx, frappe.bold(account), frappe.bold(company), context
2414 ),
2415 title=_("Invalid Account"),
2416 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302417
2418
2419def validate_cost_center(tax, doc):
2420 if not tax.cost_center:
2421 return
2422
Ankush Menat494bd9e2022-03-28 18:52:46 +05302423 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302424
2425 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302426 frappe.throw(
2427 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
2428 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
2429 ),
2430 title=_("Invalid Cost Center"),
2431 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302432
2433
Nabin Hait613d0812015-02-23 11:58:15 +05302434def validate_inclusive_tax(tax, doc):
2435 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302436 throw(
2437 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
2438 tax.idx, row_range
2439 )
2440 )
Nabin Hait613d0812015-02-23 11:58:15 +05302441
2442 if cint(getattr(tax, "included_in_print_rate", None)):
2443 if tax.charge_type == "Actual":
2444 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05302445 throw(
2446 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
2447 tax.idx
2448 )
2449 )
2450 elif tax.charge_type == "On Previous Row Amount" and not cint(
2451 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
2452 ):
Nabin Hait613d0812015-02-23 11:58:15 +05302453 # referred row should also be inclusive
2454 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302455 elif tax.charge_type == "On Previous Row Total" and not all(
2456 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
2457 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05302458 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05302459 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05302460 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05302461 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302462
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302463
Ankush Menat494bd9e2022-03-28 18:52:46 +05302464def set_balance_in_account_currency(
2465 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
2466):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002467 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302468 frappe.throw(
2469 _("Account: {0} with currency: {1} can not be selected").format(
2470 gl_dict.account, account_currency
2471 )
2472 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002473
Ankush Menat494bd9e2022-03-28 18:52:46 +05302474 gl_dict["account_currency"] = (
2475 company_currency if account_currency == company_currency else account_currency
2476 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302477
2478 # set debit/credit in account currency if not provided
2479 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302480 gl_dict.debit_in_account_currency = (
2481 gl_dict.debit
2482 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302483 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302484 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302485
2486 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302487 gl_dict.credit_in_account_currency = (
2488 gl_dict.credit
2489 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302490 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302491 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302492
2493
Ankush Menat494bd9e2022-03-28 18:52:46 +05302494def get_advance_journal_entries(
2495 party_type,
2496 party,
2497 party_account,
2498 amount_field,
2499 order_doctype,
2500 order_list,
2501 include_unallocated=True,
2502):
Gursheen Anand4ee16372023-06-08 13:15:23 +05302503 journal_entry = frappe.qb.DocType("Journal Entry")
2504 journal_acc = frappe.qb.DocType("Journal Entry Account")
2505 q = (
2506 frappe.qb.from_(journal_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302507 .inner_join(journal_acc)
2508 .on(journal_entry.name == journal_acc.parent)
2509 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302510 ConstantColumn("Journal Entry").as_("reference_type"),
2511 (journal_entry.name).as_("reference_name"),
2512 (journal_entry.remark).as_("remarks"),
Deepesh Garg3aead052023-06-22 11:41:43 +05302513 (journal_acc[amount_field]).as_("amount"),
Gursheen Anand4ee16372023-06-08 13:15:23 +05302514 (journal_acc.name).as_("reference_row"),
2515 (journal_acc.reference_name).as_("against_order"),
2516 (journal_acc.exchange_rate),
Gursheen Anand74619262023-06-02 17:13:51 +05302517 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302518 .where(
2519 journal_acc.account.isin(party_account)
2520 & (journal_acc.party_type == party_type)
2521 & (journal_acc.party == party)
2522 & (journal_acc.is_advance == "Yes")
2523 & (journal_entry.docstatus == 1)
2524 )
2525 )
Gursheen Anand74619262023-06-02 17:13:51 +05302526 if party_type == "Customer":
2527 q = q.where(journal_acc.credit_in_account_currency > 0)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302528
Gursheen Anand4ee16372023-06-08 13:15:23 +05302529 else:
2530 q = q.where(journal_acc.debit_in_account_currency > 0)
2531
Deepesh Garg3aead052023-06-22 11:41:43 +05302532 if include_unallocated:
2533 q = q.where((journal_acc.reference_name.isnull()) | (journal_acc.reference_name == ""))
2534
Nabin Hait1991c7b2016-06-27 20:09:05 +05302535 if order_list:
Deepesh Garg3aead052023-06-22 11:41:43 +05302536 q = q.where(
Deepesh Garg6d121ae2023-06-22 13:03:09 +05302537 (journal_acc.reference_type == order_doctype) & ((journal_acc.reference_type).isin(order_list))
Deepesh Garg3aead052023-06-22 11:41:43 +05302538 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302539
Gursheen Anand74619262023-06-02 17:13:51 +05302540 q = q.orderby(journal_entry.posting_date)
Rushabh Mehta66958302017-01-16 16:57:53 +05302541
Gursheen Anand74619262023-06-02 17:13:51 +05302542 journal_entries = q.run(as_dict=True)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302543 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302544
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002545
Smit Vora3e282bf2023-09-19 20:47:21 +05302546@erpnext.allow_regional
2547def get_advance_payment_entries_for_regional(*args, **kwargs):
2548 return get_advance_payment_entries(*args, **kwargs)
2549
2550
Ankush Menat494bd9e2022-03-28 18:52:46 +05302551def get_advance_payment_entries(
2552 party_type,
2553 party,
2554 party_account,
2555 order_doctype,
2556 order_list=None,
2557 include_unallocated=True,
2558 against_all_orders=False,
2559 limit=None,
2560 condition=None,
2561):
Gursheen Anand74619262023-06-02 17:13:51 +05302562
Deepesh Garg92f845c2023-06-21 12:21:19 +05302563 payment_entries = []
2564 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand74619262023-06-02 17:13:51 +05302565
Deepesh Garg92f845c2023-06-21 12:21:19 +05302566 if order_list or against_all_orders:
2567 q = get_common_query(
2568 party_type,
2569 party,
2570 party_account,
2571 limit,
2572 condition,
2573 )
2574 payment_ref = frappe.qb.DocType("Payment Entry Reference")
Gursheen Anand74619262023-06-02 17:13:51 +05302575
Deepesh Garg92f845c2023-06-21 12:21:19 +05302576 q = q.inner_join(payment_ref).on(payment_entry.name == payment_ref.parent)
2577 q = q.select(
2578 (payment_ref.allocated_amount).as_("amount"),
2579 (payment_ref.name).as_("reference_row"),
2580 (payment_ref.reference_name).as_("against_order"),
Deepesh Garg92f845c2023-06-21 12:21:19 +05302581 )
2582
Deepesh Garg3aead052023-06-22 11:41:43 +05302583 q = q.where(payment_ref.reference_doctype == order_doctype)
Deepesh Garg92f845c2023-06-21 12:21:19 +05302584 if order_list:
2585 q = q.where(payment_ref.reference_name.isin(order_list))
2586
2587 allocated = list(q.run(as_dict=True))
2588 payment_entries += allocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302589 if include_unallocated:
2590 q = get_common_query(
2591 party_type,
2592 party,
2593 party_account,
2594 limit,
2595 condition,
2596 )
2597 q = q.select((payment_entry.unallocated_amount).as_("amount"))
2598 q = q.where(payment_entry.unallocated_amount > 0)
2599
2600 unallocated = list(q.run(as_dict=True))
2601 payment_entries += unallocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302602 return payment_entries
Gursheen Anand74619262023-06-02 17:13:51 +05302603
Saqiba20999c2021-07-12 14:33:23 +05302604
Deepesh Garg92f845c2023-06-21 12:21:19 +05302605def get_common_query(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302606 party_type,
2607 party,
2608 party_account,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302609 limit,
2610 condition,
2611):
RitvikSardanad2f03c82023-09-05 12:00:54 +05302612 account_type = frappe.db.get_value("Party Type", party_type, "account_type")
2613 payment_type = "Receive" if account_type == "Receivable" else "Pay"
Gursheen Anand4ee16372023-06-08 13:15:23 +05302614 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand4ee16372023-06-08 13:15:23 +05302615
2616 q = (
2617 frappe.qb.from_(payment_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302618 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302619 ConstantColumn("Payment Entry").as_("reference_type"),
2620 (payment_entry.name).as_("reference_name"),
Gursheen Anand74619262023-06-02 17:13:51 +05302621 payment_entry.posting_date,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302622 (payment_entry.remarks).as_("remarks"),
Ankush Menat494bd9e2022-03-28 18:52:46 +05302623 )
Gursheen Anand74619262023-06-02 17:13:51 +05302624 .where(payment_entry.payment_type == payment_type)
2625 .where(payment_entry.party_type == party_type)
2626 .where(payment_entry.party == party)
2627 .where(payment_entry.docstatus == 1)
2628 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302629
RitvikSardanad2f03c82023-09-05 12:00:54 +05302630 if payment_type == "Receive":
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302631 q = q.select((payment_entry.paid_from_account_currency).as_("currency"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302632 q = q.select(payment_entry.paid_from)
2633 q = q.where(payment_entry.paid_from.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302634 else:
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302635 q = q.select((payment_entry.paid_to_account_currency).as_("currency"))
Gursheen Anand74619262023-06-02 17:13:51 +05302636 q = q.select(payment_entry.paid_to)
Gursheen Anand4ee16372023-06-08 13:15:23 +05302637 q = q.where(payment_entry.paid_to.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302638
2639 if payment_type == "Receive":
Deepesh Garg92f845c2023-06-21 12:21:19 +05302640 q = q.select((payment_entry.source_exchange_rate).as_("exchange_rate"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302641 else:
Deepesh Garg92f845c2023-06-21 12:21:19 +05302642 q = q.select((payment_entry.target_exchange_rate).as_("exchange_rate"))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302643
Deepesh Garg92f845c2023-06-21 12:21:19 +05302644 if condition:
ruthra kumar86bac2c2023-07-04 09:02:05 +05302645 if condition.get("name", None):
2646 q = q.where(payment_entry.name.like(f"%{condition.get('name')}%"))
2647
Deepesh Garg92f845c2023-06-21 12:21:19 +05302648 q = q.where(payment_entry.company == condition["company"])
2649 q = (
2650 q.where(payment_entry.posting_date >= condition["from_payment_date"])
2651 if condition.get("from_payment_date")
2652 else q
Gursheen Anand74619262023-06-02 17:13:51 +05302653 )
Deepesh Garg92f845c2023-06-21 12:21:19 +05302654 q = (
2655 q.where(payment_entry.posting_date <= condition["to_payment_date"])
2656 if condition.get("to_payment_date")
2657 else q
2658 )
2659 if condition.get("get_payments") == True:
2660 q = (
2661 q.where(payment_entry.cost_center == condition["cost_center"])
2662 if condition.get("cost_center")
2663 else q
2664 )
2665 q = (
2666 q.where(payment_entry.unallocated_amount >= condition["minimum_payment_amount"])
2667 if condition.get("minimum_payment_amount")
2668 else q
2669 )
2670 q = (
2671 q.where(payment_entry.unallocated_amount <= condition["maximum_payment_amount"])
2672 if condition.get("maximum_payment_amount")
2673 else q
2674 )
2675 else:
2676 q = (
2677 q.where(payment_entry.total_debit >= condition["minimum_payment_amount"])
2678 if condition.get("minimum_payment_amount")
2679 else q
2680 )
2681 q = (
2682 q.where(payment_entry.total_debit <= condition["maximum_payment_amount"])
2683 if condition.get("maximum_payment_amount")
2684 else q
2685 )
Gursheen Anand74619262023-06-02 17:13:51 +05302686
2687 q = q.orderby(payment_entry.posting_date)
2688 q = q.limit(limit) if limit else q
Deepesh Garg92f845c2023-06-21 12:21:19 +05302689
Gursheen Anand74619262023-06-02 17:13:51 +05302690 return q
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302691
Ankush Menat494bd9e2022-03-28 18:52:46 +05302692
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302693def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302694 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302695 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302696 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302697 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302698 invoice = frappe.qb.DocType(doctype)
2699
2700 consider_base_amount = invoice.party_account_currency != invoice.currency
2701 payment_amount = (
2702 frappe.qb.terms.Case()
2703 .when(consider_base_amount, payment_schedule.base_payment_amount)
2704 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302705 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002706
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302707 payable_amount = (
2708 frappe.qb.from_(payment_schedule)
2709 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302710 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302711 )
2712
2713 total = (
2714 frappe.qb.terms.Case()
2715 .when(invoice.disable_rounded_total, invoice.grand_total)
2716 .else_(invoice.rounded_total)
2717 )
2718
2719 base_total = (
2720 frappe.qb.terms.Case()
2721 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2722 .else_(invoice.base_rounded_total)
2723 )
2724
Ankush Menat494bd9e2022-03-28 18:52:46 +05302725 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302726
2727 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2728
2729 conditions = (
2730 (invoice.docstatus == 1)
2731 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302732 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302733 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302734 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302735 if doctype == "Sales Invoice"
2736 else is_overdue
2737 )
2738 )
2739
Pruthvi Patel0799f372021-11-12 12:56:29 +05302740 status = (
2741 frappe.qb.terms.Case()
2742 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2743 .else_("Overdue")
2744 )
2745
2746 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302747
2748
Nabin Hait92759692017-08-15 08:23:51 +05302749@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302750def get_payment_terms(
2751 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2752):
Nabin Hait92759692017-08-15 08:23:51 +05302753 if not terms_template:
2754 return
2755
2756 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2757
2758 schedule = []
tundefb144302017-08-19 15:01:40 +01002759 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302760 term_details = get_payment_term_details(
2761 d, posting_date, grand_total, base_grand_total, bill_date
2762 )
Nabin Hait92759692017-08-15 08:23:51 +05302763 schedule.append(term_details)
2764
2765 return schedule
2766
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002767
Nabin Hait92759692017-08-15 08:23:51 +05302768@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302769def get_payment_term_details(
2770 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2771):
Nabin Hait92759692017-08-15 08:23:51 +05302772 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302773 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302774 term = frappe.get_doc("Payment Term", term)
2775 else:
2776 term_details.payment_term = term.payment_term
2777 term_details.description = term.description
2778 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302779 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302780 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302781 term_details.discount_type = term.discount_type
2782 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302783 term_details.outstanding = term_details.payment_amount
2784 term_details.mode_of_payment = term.mode_of_payment
2785
Shreya Shah3a9eec22018-02-16 13:05:21 +05302786 if bill_date:
2787 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302788 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302789 elif posting_date:
2790 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302791 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302792
2793 if getdate(term_details.due_date) < getdate(posting_date):
2794 term_details.due_date = posting_date
2795
Nabin Hait92759692017-08-15 08:23:51 +05302796 return term_details
2797
Ankush Menat494bd9e2022-03-28 18:52:46 +05302798
Shreya Shah3a9eec22018-02-16 13:05:21 +05302799def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302800 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302801 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302802 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302803 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302804 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302805 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302806 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302807 due_date = get_last_day(add_months(date, term.credit_months))
tunde96b8f222017-09-08 15:35:59 +01002808 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002809
Ankush Menat494bd9e2022-03-28 18:52:46 +05302810
Saqib0586b7d2021-03-31 15:03:53 +05302811def get_discount_date(term, posting_date=None, bill_date=None):
2812 discount_validity = None
2813 date = bill_date or posting_date
2814 if term.discount_validity_based_on == "Day(s) after invoice date":
2815 discount_validity = add_days(date, term.discount_validity)
2816 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2817 discount_validity = add_days(get_last_day(date), term.discount_validity)
2818 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302819 discount_validity = get_last_day(add_months(date, term.discount_validity))
Saqib0586b7d2021-03-31 15:03:53 +05302820 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002821
Ankush Menat494bd9e2022-03-28 18:52:46 +05302822
tundebabzyad08d4c2018-05-16 07:01:41 +01002823def get_supplier_block_status(party_name):
2824 """
2825 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2826 a `Supplier`
2827 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302828 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002829 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302830 "on_hold": supplier.on_hold,
2831 "release_date": supplier.release_date,
2832 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002833 }
2834 return info
2835
Ankush Menat494bd9e2022-03-28 18:52:46 +05302836
marination698d9832020-08-19 14:59:46 +05302837def set_child_tax_template_and_map(item, child_item, parent_doc):
2838 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302839 "item_code": item.item_code,
2840 "posting_date": parent_doc.transaction_date,
2841 "tax_category": parent_doc.get("tax_category"),
2842 "company": parent_doc.get("company"),
2843 }
marination698d9832020-08-19 14:59:46 +05302844
2845 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2846 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302847 child_item.item_tax_rate = get_item_tax_map(
2848 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2849 )
2850
marination698d9832020-08-19 14:59:46 +05302851
Afshanb3bbebd2021-08-09 14:39:32 +05302852def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302853 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2854 "Accounts Settings", "add_taxes_from_item_tax_template"
2855 )
Marica3b1be2b2020-10-22 17:04:31 +05302856
2857 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2858 tax_map = json.loads(child_item.get("item_tax_rate"))
2859 for tax_type in tax_map:
2860 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302861 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302862 # add new row for tax head only if missing
2863 found = any(tax.account_head == tax_type for tax in taxes)
2864 if not found:
2865 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302866 tax_row.update(
2867 {
2868 "description": str(tax_type).split(" - ")[0],
2869 "charge_type": "On Net Total",
2870 "account_head": tax_type,
2871 "rate": tax_rate,
2872 }
2873 )
Marica3b1be2b2020-10-22 17:04:31 +05302874 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302875 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302876 if db_insert:
2877 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302878
Ankush Menat494bd9e2022-03-28 18:52:46 +05302879
2880def set_order_defaults(
2881 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2882):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002883 """
pateljannat637ddff2021-02-09 16:17:30 +05302884 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002885 """
Saqib438e0432020-04-03 10:02:56 +05302886 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
Ankush Menat686685b2023-05-31 12:50:14 +05302887 child_item = frappe.new_doc(child_doctype, parent_doc=p_doc, parentfield=child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302888 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05302889
pateljannat637ddff2021-02-09 16:17:30 +05302890 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05302891 child_item.update({field: item.get(field)})
2892
pateljannat637ddff2021-02-09 16:17:30 +05302893 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05302894 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05302895 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05302896 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13002897 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302898 conversion_factor = flt(
2899 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
2900 )
2901 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05302902
pateljannat637ddff2021-02-09 16:17:30 +05302903 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05302904 # Initialized value will update in parent validation
2905 child_item.base_rate = 1
2906 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05302907 if child_doctype == "Sales Order Item":
2908 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
2909 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302910 frappe.throw(
2911 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
2912 frappe.bold("default warehouse"), frappe.bold(item.item_code)
2913 )
2914 )
marination0673f552021-03-31 01:38:22 +05302915
marination698d9832020-08-19 14:59:46 +05302916 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05302917 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002918 return child_item
2919
Ankush Menat494bd9e2022-03-28 18:52:46 +05302920
marination0673f552021-03-31 01:38:22 +05302921def validate_child_on_delete(row, parent):
2922 """Check if partially transacted item (row) is being deleted."""
2923 if parent.doctype == "Sales Order":
2924 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302925 frappe.throw(
2926 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
2927 row.idx, row.item_code
2928 )
2929 )
marination0673f552021-03-31 01:38:22 +05302930 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302931 frappe.throw(
2932 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
2933 row.idx, row.item_code
2934 )
2935 )
marination0673f552021-03-31 01:38:22 +05302936 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302937 frappe.throw(
2938 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
2939 row.idx, row.item_code
2940 )
2941 )
marination0673f552021-03-31 01:38:22 +05302942
2943 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302944 frappe.throw(
2945 _("Row #{0}: Cannot delete item {1} which has already been received").format(
2946 row.idx, row.item_code
2947 )
2948 )
marination0673f552021-03-31 01:38:22 +05302949
2950 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302951 frappe.throw(
2952 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
2953 row.idx, row.item_code
2954 )
2955 )
2956
marination0673f552021-03-31 01:38:22 +05302957
2958def update_bin_on_delete(row, doctype):
2959 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05302960 from erpnext.stock.stock_balance import (
2961 get_indented_qty,
2962 get_ordered_qty,
2963 get_reserved_qty,
2964 update_bin_qty,
2965 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05302966
marination0673f552021-03-31 01:38:22 +05302967 qty_dict = {}
2968
2969 if doctype == "Sales Order":
2970 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
2971 else:
2972 if row.material_request_item:
2973 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
2974
2975 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
2976
Deepesh Garga61790c2022-02-22 20:58:10 +05302977 if row.warehouse:
2978 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05302979
Ankush Menat494bd9e2022-03-28 18:52:46 +05302980
Ankush Menatdd11f262022-06-27 15:55:08 +05302981def validate_and_delete_children(parent, data) -> bool:
Saqib0ad74492019-12-24 16:42:30 +05302982 deleted_children = []
2983 updated_item_names = [d.get("docname") for d in data]
2984 for item in parent.items:
2985 if item.name not in updated_item_names:
2986 deleted_children.append(item)
2987
2988 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05302989 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05302990 d.cancel()
2991 d.delete()
marination0673f552021-03-31 01:38:22 +05302992
Gursheen Kaur Anand9087e142023-12-02 19:53:00 +05302993 if parent.doctype == "Purchase Order":
2994 parent.update_ordered_qty_in_so_for_removed_items(deleted_children)
2995
marination0673f552021-03-31 01:38:22 +05302996 # need to update ordered qty in Material Request first
2997 # bin uses Material Request Items to recalculate & update
2998 parent.update_prevdoc_status()
2999
3000 for d in deleted_children:
3001 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003002
Ankush Menatdd11f262022-06-27 15:55:08 +05303003 return bool(deleted_children)
3004
Rohan Bansala93b5142021-04-06 17:10:52 +05303005
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003006@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003007def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303008 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303009 try:
3010 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05303011 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303012 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05303013
Ankush Menat494bd9e2022-03-28 18:52:46 +05303014 frappe.throw(
3015 _("You do not have permissions to {} items in a {}.").format(
3016 actions[perm_type], parent_doctype
3017 ),
3018 title=_("Insufficient Permissions"),
3019 )
marination665c27a2020-09-15 12:04:38 +05303020
Saqib6db92fb2020-09-14 19:54:17 +05303021 def validate_workflow_conditions(doc):
3022 workflow = get_workflow_name(doc.doctype)
3023 if not workflow:
3024 return
3025
3026 workflow_doc = frappe.get_doc("Workflow", workflow)
3027 current_state = doc.get(workflow_doc.workflow_state_field)
3028 roles = frappe.get_roles()
3029
3030 transitions = []
3031 for transition in workflow_doc.transitions:
3032 if transition.next_state == current_state and transition.allowed in roles:
3033 if not is_transition_condition_satisfied(transition, doc):
3034 continue
3035 transitions.append(transition.as_dict())
3036
3037 if not transitions:
Saqib18318932020-09-23 13:01:49 +05303038 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05303039 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
3040 get_link_to_form("Workflow", workflow)
3041 ),
3042 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05303043 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303044
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303045 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05303046 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303047 return set_order_defaults(
3048 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
3049 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303050
marination0c915432022-05-10 18:04:02 +05303051 def validate_quantity(child_item, new_data):
3052 if not flt(new_data.get("qty")):
3053 frappe.throw(
3054 _("Row # {0}: Quantity for Item {1} cannot be zero").format(
3055 new_data.get("idx"), frappe.bold(new_data.get("item_code"))
3056 ),
3057 title=_("Invalid Qty"),
3058 )
3059
3060 if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303061 frappe.throw(_("Cannot set quantity less than delivered quantity"))
3062
marination0c915432022-05-10 18:04:02 +05303063 if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt(
3064 child_item.received_qty
3065 ):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303066 frappe.throw(_("Cannot set quantity less than received quantity"))
3067
Ankush Menatdd11f262022-06-27 15:55:08 +05303068 def should_update_supplied_items(doc) -> bool:
3069 """Subcontracted PO can allow following changes *after submit*:
3070
3071 1. Change rate of subcontracting - regardless of other changes.
3072 2. Change qty and/or add new items and/or remove items
3073 Exception: Transfer/Consumption is already made, qty change not allowed.
3074 """
3075
3076 supplied_items_processed = any(
3077 item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items
3078 )
3079
3080 update_supplied_items = (
3081 any_qty_changed or items_added_or_removed or any_conversion_factor_changed
3082 )
3083 if update_supplied_items and supplied_items_processed:
3084 frappe.throw(_("Item qty can not be updated as raw materials are already processed."))
3085
3086 return update_supplied_items
3087
s-aga-r9588bb72023-08-21 22:23:57 +05303088 def validate_fg_item_for_subcontracting(new_data, is_new):
3089 if is_new:
3090 if not new_data.get("fg_item"):
3091 frappe.throw(
3092 _("Finished Good Item is not specified for service item {0}").format(new_data["item_code"])
3093 )
3094 else:
3095 is_sub_contracted_item, default_bom = frappe.db.get_value(
3096 "Item", new_data["fg_item"], ["is_sub_contracted_item", "default_bom"]
3097 )
3098
3099 if not is_sub_contracted_item:
3100 frappe.throw(
3101 _("Finished Good Item {0} must be a sub-contracted item").format(new_data["fg_item"])
3102 )
3103 elif not default_bom:
3104 frappe.throw(_("Default BOM not found for FG Item {0}").format(new_data["fg_item"]))
3105
3106 if not new_data.get("fg_item_qty"):
3107 frappe.throw(_("Finished Good Item {0} Qty can not be zero").format(new_data["fg_item"]))
3108
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003109 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003110
Ankush Menatdd11f262022-06-27 15:55:08 +05303111 any_qty_changed = False # updated to true if any item's qty changes
3112 items_added_or_removed = False # updated to true if any new item is added or removed
3113 any_conversion_factor_changed = False
3114
Ankush Menat494bd9e2022-03-28 18:52:46 +05303115 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303116 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05303117
Ankush Menat494bd9e2022-03-28 18:52:46 +05303118 check_doc_permissions(parent, "write")
Ankush Menatdd11f262022-06-27 15:55:08 +05303119 _removed_items = validate_and_delete_children(parent, data)
3120 items_added_or_removed |= _removed_items
Saqib0ad74492019-12-24 16:42:30 +05303121
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003122 for d in data:
3123 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05303124
3125 if not d.get("item_code"):
3126 # ignore empty rows
3127 continue
3128
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003129 if not d.get("docname"):
3130 new_child_flag = True
Ankush Menatdd11f262022-06-27 15:55:08 +05303131 items_added_or_removed = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05303132 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303133 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003134 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303135 check_doc_permissions(parent, "write")
3136 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303137
Saqib Ansaric579b082020-05-29 22:21:50 +05303138 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
3139 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
s-aga-r9588bb72023-08-21 22:23:57 +05303140 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 +05303141 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
3142 d.get("conversion_factor")
3143 )
Saqib61314242020-09-15 11:14:31 +05303144 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05303145
Ankush Menat494bd9e2022-03-28 18:52:46 +05303146 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05303147 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303148 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05303149 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303150
3151 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05303152 qty_unchanged = prev_qty == new_qty
s-aga-r9588bb72023-08-21 22:23:57 +05303153 fg_qty_unchanged = prev_fg_qty == new_fg_qty
Saqib61314242020-09-15 11:14:31 +05303154 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05303155 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menatdd11f262022-06-27 15:55:08 +05303156 any_conversion_factor_changed |= not conversion_factor_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303157 date_unchanged = (
3158 prev_date == getdate(new_date) if prev_date and new_date else False
3159 ) # in case of delivery note etc
3160 if (
3161 rate_unchanged
3162 and qty_unchanged
s-aga-r9588bb72023-08-21 22:23:57 +05303163 and fg_qty_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303164 and conversion_factor_unchanged
3165 and uom_unchanged
3166 and date_unchanged
3167 ):
Saqibdd374ff2020-02-27 12:51:31 +05303168 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003169
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303170 validate_quantity(child_item, d)
Ankush Menatdd11f262022-06-27 15:55:08 +05303171 if flt(child_item.get("qty")) != flt(d.get("qty")):
3172 any_qty_changed = True
deepeshgarg00777cde832018-12-27 15:56:51 +05303173
s-aga-r9588bb72023-08-21 22:23:57 +05303174 if (
3175 parent.doctype == "Purchase Order"
3176 and parent.is_subcontracted
3177 and not parent.is_old_subcontracting_flow
3178 ):
3179 validate_fg_item_for_subcontracting(d, new_child_flag)
3180 child_item.fg_item_qty = flt(d["fg_item_qty"])
3181
3182 if new_child_flag:
3183 child_item.fg_item = d["fg_item"]
3184
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003185 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05303186 rate_precision = child_item.precision("rate") or 2
3187 conv_fac_precision = child_item.precision("conversion_factor") or 2
3188 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003189
Maricab9f5a1c2023-11-27 09:05:22 +05303190 # Amount cannot be lesser than billed amount, except for negative amounts
3191 row_rate = flt(d.get("rate"), rate_precision)
3192 amount_below_billed_amt = flt(child_item.billed_amt, rate_precision) > flt(
3193 row_rate * flt(d.get("qty"), qty_precision), rate_precision
3194 )
3195 if amount_below_billed_amt and row_rate > 0.0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303196 frappe.throw(
3197 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
3198 child_item.idx, child_item.item_code
3199 )
3200 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003201 else:
Maricab9f5a1c2023-11-27 09:05:22 +05303202 child_item.rate = row_rate
marinationf9c4b202020-06-12 15:49:53 +05303203
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303204 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05303205 if child_item.stock_uom == child_item.uom:
3206 child_item.conversion_factor = 1
3207 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303208 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05303209
Saqib61314242020-09-15 11:14:31 +05303210 if d.get("uom"):
3211 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303212 conversion_factor = flt(
3213 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
3214 )
3215 child_item.conversion_factor = (
3216 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
3217 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303218
Ankush Menat494bd9e2022-03-28 18:52:46 +05303219 if d.get("delivery_date") and parent_doctype == "Sales Order":
3220 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05303221
Ankush Menat494bd9e2022-03-28 18:52:46 +05303222 if d.get("schedule_date") and parent_doctype == "Purchase Order":
3223 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303224
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303225 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05303226 if flt(child_item.rate) > flt(child_item.price_list_rate):
3227 # if rate is greater than price_list_rate, set margin
3228 # or set discount
3229 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05303230
3231 if parent_doctype in sales_doctypes:
3232 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303233 child_item.margin_rate_or_amount = flt(
3234 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
3235 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05303236 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05303237 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303238 child_item.discount_percentage = flt(
3239 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
3240 child_item.precision("discount_percentage"),
3241 )
3242 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05303243
3244 if parent_doctype in sales_doctypes:
3245 child_item.margin_type = ""
3246 child_item.margin_rate_or_amount = 0
3247 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303248
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003249 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003250 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05303251 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303252 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003253 child_item.insert()
3254 else:
3255 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003256
Rushabh Mehtafafbb022018-12-24 22:09:15 +05303257 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303258 parent.flags.ignore_validate_update_after_submit = True
3259 parent.set_qty_as_per_stock_uom()
3260 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05303261 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05303262 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05303263 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05303264 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303265 frappe.get_doc("Authorization Control").validate_approving_authority(
3266 parent.doctype, parent.company, parent.base_grand_total
3267 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003268
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303269 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303270 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303271 parent.validate_minimum_order_qty()
3272 parent.validate_budget()
3273 if parent.is_against_so():
3274 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05303275 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303276 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05303277
3278 # reset index of child table
3279 for idx, row in enumerate(parent.get(child_docname), start=1):
3280 row.idx = idx
3281
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303282 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05303283
Ankush Menat494bd9e2022-03-28 18:52:46 +05303284 if parent_doctype == "Purchase Order":
3285 update_last_purchase_rate(parent, is_submit=1)
s-aga-r68f5dd32023-12-01 14:45:01 +05303286
3287 if any_qty_changed or items_added_or_removed or any_conversion_factor_changed:
3288 parent.update_prevdoc_status()
3289
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303290 parent.update_requested_qty()
3291 parent.update_ordered_qty()
3292 parent.update_ordered_and_reserved_qty()
3293 parent.update_receiving_percentage()
s-aga-rb9b17172023-08-22 16:53:54 +05303294
3295 if parent.is_subcontracted:
3296 if parent.is_old_subcontracting_flow:
3297 if should_update_supplied_items(parent):
3298 parent.update_reserved_qty_for_subcontract()
3299 parent.create_raw_materials_supplied()
3300 parent.save()
3301 else:
3302 if not parent.can_update_items():
3303 frappe.throw(
3304 _(
3305 "Items cannot be updated as Subcontracting Order is created against the Purchase Order {0}."
3306 ).format(frappe.bold(parent.name))
3307 )
Ankush Menatc84e11a2022-06-01 12:55:10 +05303308 else: # Sales Order
3309 parent.validate_warehouse()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303310 parent.update_reserved_qty()
3311 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303312 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303313 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05303314
Saqib6db92fb2020-09-14 19:54:17 +05303315 parent.reload()
3316 validate_workflow_conditions(parent)
3317
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303318 parent.update_blanket_order()
3319 parent.update_billing_percentage()
3320 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05303321
s-aga-rac24d772023-04-05 19:48:15 +05303322 # Cancel and Recreate Stock Reservation Entries.
s-aga-r38e93672023-04-02 21:24:59 +05303323 if parent_doctype == "Sales Order":
3324 from erpnext.stock.doctype.stock_reservation_entry.stock_reservation_entry import (
3325 cancel_stock_reservation_entries,
3326 has_reserved_stock,
s-aga-r38e93672023-04-02 21:24:59 +05303327 )
3328
3329 if has_reserved_stock(parent.doctype, parent.name):
3330 cancel_stock_reservation_entries(parent.doctype, parent.name)
s-aga-r2d8363a2023-09-02 11:02:24 +05303331
3332 if parent.per_picked == 0:
3333 parent.create_stock_reservation_entries()
s-aga-r38e93672023-04-02 21:24:59 +05303334
Ankush Menat494bd9e2022-03-28 18:52:46 +05303335
Gursheen Anand68effd92023-09-21 17:28:07 +05303336def check_if_child_table_updated(
3337 child_table_before_update, child_table_after_update, fields_to_check
3338):
3339 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
3340 # Check if any field affecting accounting entry is altered
3341 for index, item in enumerate(child_table_after_update):
3342 for field in fields_to_check:
3343 if child_table_before_update[index].get(field) != item.get(field):
3344 return True
3345
3346 for dimension in accounting_dimensions:
3347 if child_table_before_update[index].get(dimension) != item.get(dimension):
3348 return True
3349
3350 return False
3351
3352
Gursheen Ananda06017c2023-06-12 15:24:53 +05303353@erpnext.allow_regional
3354def validate_regional(doc):
3355 pass
3356
3357
3358@erpnext.allow_regional
3359def validate_einvoice_fields(doc):
3360 pass
3361
3362
3363@erpnext.allow_regional
3364def update_gl_dict_with_regional_fields(doc, gl_dict):
3365 pass