blob: febad180589f70f4557da73af3e11fccb8a00602 [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"),
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530877 "voucher_subtype": self.get_voucher_subtype(),
Ankush Menat494bd9e2022-03-28 18:52:46 +0530878 }
879 )
deepeshgarg007d83cf652019-05-12 18:34:23 +0530880
Sagar Vora4205f562023-07-24 18:37:36 +0530881 with temporary_flag("company", self.company):
882 update_gl_dict_with_regional_fields(self, gl_dict)
883
deepeshgarg007d83cf652019-05-12 18:34:23 +0530884 accounting_dimensions = get_accounting_dimensions()
885 dimension_dict = frappe._dict()
886
887 for dimension in accounting_dimensions:
888 dimension_dict[dimension] = self.get(dimension)
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530889 if item and item.get(dimension):
890 dimension_dict[dimension] = item.get(dimension)
deepeshgarg007d83cf652019-05-12 18:34:23 +0530891
892 gl_dict.update(dimension_dict)
Nabin Hait2df4d542013-01-29 11:34:39 +0530893 gl_dict.update(args)
Anand Doshi979326b2015-09-11 16:22:37 +0530894
Nabin Hait895029d2015-08-20 14:55:39 +0530895 if not account_currency:
Anand Doshicd0989e2015-09-28 13:31:17 +0530896 account_currency = get_account_currency(gl_dict.account)
Anand Doshi979326b2015-09-11 16:22:37 +0530897
Ankush Menat494bd9e2022-03-28 18:52:46 +0530898 if gl_dict.account and self.doctype not in [
899 "Journal Entry",
900 "Period Closing Voucher",
901 "Payment Entry",
902 "Purchase Receipt",
903 "Purchase Invoice",
904 "Stock Entry",
905 ]:
Anand Doshibe6cfdd2015-09-17 21:07:04 +0530906 self.validate_account_currency(gl_dict.account, account_currency)
Deepesh Garg7c300852020-12-26 20:14:51 +0530907
Ankush Menat494bd9e2022-03-28 18:52:46 +0530908 if gl_dict.account and self.doctype not in [
909 "Journal Entry",
910 "Period Closing Voucher",
911 "Payment Entry",
912 ]:
913 set_balance_in_account_currency(
914 gl_dict, account_currency, self.get("conversion_rate"), self.company_currency
915 )
Anand Doshi979326b2015-09-11 16:22:37 +0530916
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530917 # Update details in transaction currency
918 gl_dict.update(
919 {
920 "transaction_currency": self.get("currency") or self.company_currency,
921 "transaction_exchange_rate": self.get("conversion_rate", 1),
922 "debit_in_transaction_currency": self.get_value_in_transaction_currency(
923 account_currency, args, "debit"
924 ),
925 "credit_in_transaction_currency": self.get_value_in_transaction_currency(
926 account_currency, args, "credit"
927 ),
928 }
929 )
930
Nabin Haitc561a492015-08-19 19:22:34 +0530931 return gl_dict
Anand Doshi979326b2015-09-11 16:22:37 +0530932
Gursheen Kaur Anand47f7b652023-12-24 16:13:31 +0530933 def get_voucher_subtype(self):
934 voucher_subtypes = {
935 "Journal Entry": "voucher_type",
936 "Payment Entry": "payment_type",
937 "Stock Entry": "stock_entry_type",
938 "Asset Capitalization": "entry_type",
939 }
940 if self.doctype in voucher_subtypes:
941 return self.get(voucher_subtypes[self.doctype])
942 elif self.doctype == "Purchase Receipt" and self.is_return:
943 return "Purchase Return"
944 elif self.doctype == "Delivery Note" and self.is_return:
945 return "Sales Return"
946 elif (self.doctype == "Sales Invoice" and self.is_return) or self.doctype == "Purchase Invoice":
947 return "Credit Note"
948 elif (self.doctype == "Purchase Invoice" and self.is_return) or self.doctype == "Sales Invoice":
949 return "Debit Note"
950 return self.doctype
951
Deepesh Garg35be3ac2023-08-17 11:31:40 +0530952 def get_value_in_transaction_currency(self, account_currency, args, field):
953 if account_currency == self.get("currency"):
954 return args.get(field + "_in_account_currency")
955 else:
956 return flt(args.get(field, 0) / self.get("conversion_rate", 1))
957
Anurag Mishrae657fe82018-11-26 15:19:17 +0530958 def validate_qty_is_not_zero(self):
Maricab9f5a1c2023-11-27 09:05:22 +0530959 if self.doctype == "Purchase Receipt":
960 return
961
962 for item in self.items:
963 if not flt(item.qty):
964 frappe.throw(
965 msg=_("Row #{0}: Item quantity cannot be zero").format(item.idx),
966 title=_("Invalid Quantity"),
967 exc=InvalidQtyError,
968 )
Anurag Mishrae657fe82018-11-26 15:19:17 +0530969
Nabin Hait895029d2015-08-20 14:55:39 +0530970 def validate_account_currency(self, account, account_currency=None):
Nabin Hait6e439a52015-08-28 19:24:22 +0530971 valid_currency = [self.company_currency]
972 if self.get("currency") and self.currency != self.company_currency:
973 valid_currency.append(self.currency)
974
Nabin Hait895029d2015-08-20 14:55:39 +0530975 if account_currency not in valid_currency:
Ankush Menat494bd9e2022-03-28 18:52:46 +0530976 frappe.throw(
977 _("Account {0} is invalid. Account Currency must be {1}").format(
978 account, (" " + _("or") + " ").join(valid_currency)
979 )
980 )
Anand Doshi979326b2015-09-11 16:22:37 +0530981
Anand Doshi613cb6a2013-02-06 17:33:46 +0530982 def clear_unallocated_advances(self, childtype, parentfield):
Rushabh Mehtaf191f852014-04-02 18:09:34 +0530983 self.set(parentfield, self.get(parentfield, {"allocated_amount": ["not in", [0, None, ""]]}))
984
Ankush Menat494bd9e2022-03-28 18:52:46 +0530985 frappe.db.sql(
986 """delete from `tab%s` where parentfield=%s and parent = %s
987 and allocated_amount = 0"""
988 % (childtype, "%s", "%s"),
989 (parentfield, self.name),
990 )
Anand Doshid2946502014-04-08 20:10:03 +0530991
Walstan Baptistad6360752021-03-31 12:30:32 +0530992 @frappe.whitelist()
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530993 def apply_shipping_rule(self):
994 if self.shipping_rule:
995 shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
996 shipping_rule.apply(self)
997 self.calculate_taxes_and_totals()
998
999 def get_shipping_address(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301000 """Returns Address object from shipping address fields if present"""
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301001
1002 # shipping address fields can be `shipping_address_name` or `shipping_address`
1003 # try getting value from both
1004
Ankush Menat494bd9e2022-03-28 18:52:46 +05301005 for fieldname in ("shipping_address_name", "shipping_address"):
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301006 shipping_field = self.meta.get_field(fieldname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301007 if shipping_field and shipping_field.fieldtype == "Link":
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301008 if self.get(fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301009 return frappe.get_doc("Address", self.get(fieldname))
Rushabh Mehta30dc9a12017-11-17 14:31:09 +05301010
1011 return {}
1012
Walstan Baptistad6360752021-03-31 12:30:32 +05301013 @frappe.whitelist()
Nabin Hait041a5c22018-08-01 18:07:39 +05301014 def set_advances(self):
1015 """Returns list of advances against Account, Party, Reference"""
1016
Deepesh Gargfd3fb642023-04-05 12:02:44 +05301017 res = self.get_advance_entries(
1018 include_unallocated=not cint(self.get("only_include_allocated_payments"))
1019 )
Nabin Hait041a5c22018-08-01 18:07:39 +05301020
1021 self.set("advances", [])
1022 advance_allocated = 0
1023 for d in res:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301024 if self.get("party_account_currency") == self.company_currency:
1025 amount = self.get("base_rounded_total") or self.base_grand_total
Nabin Hait041a5c22018-08-01 18:07:39 +05301026 else:
Deepesh Garg181df2f2022-11-04 15:49:37 +05301027 amount = self.get("rounded_total") or self.grand_total
Deepesh Garg181df2f2022-11-04 15:49:37 +05301028 allocated_amount = min(amount - advance_allocated, d.amount)
Nabin Hait041a5c22018-08-01 18:07:39 +05301029 advance_allocated += flt(allocated_amount)
Rushabh Mehta708e47a2018-08-08 16:37:31 +05301030
Saqiba20999c2021-07-12 14:33:23 +05301031 advance_row = {
Nabin Hait041a5c22018-08-01 18:07:39 +05301032 "doctype": self.doctype + " Advance",
1033 "reference_type": d.reference_type,
1034 "reference_name": d.reference_name,
1035 "reference_row": d.reference_row,
1036 "remarks": d.remarks,
1037 "advance_amount": flt(d.amount),
Saqiba20999c2021-07-12 14:33:23 +05301038 "allocated_amount": allocated_amount,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301039 "ref_exchange_rate": flt(d.exchange_rate), # exchange_rate of advance entry
Saqiba20999c2021-07-12 14:33:23 +05301040 }
Gursheen Anand74619262023-06-02 17:13:51 +05301041 if d.get("paid_from"):
1042 advance_row["account"] = d.paid_from
1043 if d.get("paid_to"):
1044 advance_row["account"] = d.paid_to
Saqiba20999c2021-07-12 14:33:23 +05301045
1046 self.append("advances", advance_row)
Nabin Hait041a5c22018-08-01 18:07:39 +05301047
Nabin Hait28a05282016-06-27 17:41:39 +05301048 def get_advance_entries(self, include_unallocated=True):
1049 if self.doctype == "Sales Invoice":
Nabin Hait28a05282016-06-27 17:41:39 +05301050 party_type = "Customer"
1051 party = self.customer
1052 amount_field = "credit_in_account_currency"
1053 order_field = "sales_order"
1054 order_doctype = "Sales Order"
1055 else:
Nabin Hait28a05282016-06-27 17:41:39 +05301056 party_type = "Supplier"
1057 party = self.supplier
1058 amount_field = "debit_in_account_currency"
1059 order_field = "purchase_order"
1060 order_doctype = "Purchase Order"
Deepesh Garg92f845c2023-06-21 12:21:19 +05301061
1062 party_account = get_party_account(
1063 party_type, party=party, company=self.company, include_advance=True
1064 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301065
Ankush Menat494bd9e2022-03-28 18:52:46 +05301066 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 +05301067
Ankush Menat494bd9e2022-03-28 18:52:46 +05301068 journal_entries = get_advance_journal_entries(
1069 party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated
1070 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301071
Smit Vora3e282bf2023-09-19 20:47:21 +05301072 payment_entries = get_advance_payment_entries_for_regional(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301073 party_type, party, party_account, order_doctype, order_list, include_unallocated
1074 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301075
Nabin Hait28a05282016-06-27 17:41:39 +05301076 res = journal_entries + payment_entries
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301077
Nabin Hait28a05282016-06-27 17:41:39 +05301078 return res
Nabin Hait48f5fa62014-09-18 15:03:54 +05301079
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301080 def is_inclusive_tax(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301081 is_inclusive = cint(
1082 frappe.db.get_single_value("Accounts Settings", "show_inclusive_tax_in_print")
1083 )
rohitwaghchaurebf4c1142018-01-08 15:20:15 +05301084
1085 if is_inclusive:
1086 is_inclusive = 0
1087 if self.get("taxes", filters={"included_in_print_rate": 1}):
1088 is_inclusive = 1
1089
1090 return is_inclusive
1091
Anand Baburajan491a50a2023-06-13 19:42:56 +05301092 def should_show_taxes_as_table_in_print(self):
1093 return cint(frappe.db.get_single_value("Accounts Settings", "show_taxes_as_table_in_print"))
1094
Nabin Hait28a05282016-06-27 17:41:39 +05301095 def validate_advance_entries(self):
Nabin Hait05aefbb2016-06-28 19:42:19 +05301096 order_field = "sales_order" if self.doctype == "Sales Invoice" else "purchase_order"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301097 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 +05301098
Ankush Menat494bd9e2022-03-28 18:52:46 +05301099 if not order_list:
1100 return
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301101
Nabin Hait28a05282016-06-27 17:41:39 +05301102 advance_entries = self.get_advance_entries(include_unallocated=False)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301103
Nabin Hait28a05282016-06-27 17:41:39 +05301104 if advance_entries:
1105 advance_entries_against_si = [d.reference_name for d in self.get("advances")]
1106 for d in advance_entries:
1107 if not advance_entries_against_si or d.reference_name not in advance_entries_against_si:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301108 frappe.msgprint(
1109 _(
1110 "Payment Entry {0} is linked against Order {1}, check if it should be pulled as advance in this invoice."
1111 ).format(d.reference_name, d.against_order)
1112 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301113
Saqiba20999c2021-07-12 14:33:23 +05301114 def set_advance_gain_or_loss(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301115 if self.get("conversion_rate") == 1 or not self.get("advances"):
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301116 return
1117
Ankush Menat494bd9e2022-03-28 18:52:46 +05301118 is_purchase_invoice = self.doctype == "Purchase Invoice"
Saqib Ansari64efe8b2021-09-26 15:46:13 +05301119 party_account = self.credit_to if is_purchase_invoice else self.debit_to
1120 if get_account_currency(party_account) != self.currency:
Saqiba20999c2021-07-12 14:33:23 +05301121 return
1122
1123 for d in self.get("advances"):
1124 advance_exchange_rate = d.ref_exchange_rate
Ankush Menat494bd9e2022-03-28 18:52:46 +05301125 if d.allocated_amount and self.conversion_rate != advance_exchange_rate:
Saqiba20999c2021-07-12 14:33:23 +05301126
1127 base_allocated_amount_in_ref_rate = advance_exchange_rate * d.allocated_amount
1128 base_allocated_amount_in_inv_rate = self.conversion_rate * d.allocated_amount
1129 difference = base_allocated_amount_in_ref_rate - base_allocated_amount_in_inv_rate
1130
1131 d.exchange_gain_loss = difference
1132
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301133 def make_precision_loss_gl_entry(self, gl_entries):
1134 round_off_account, round_off_cost_center = get_round_off_account_and_cost_center(
1135 self.company, "Purchase Invoice", self.name, self.use_company_roundoff_cost_center
1136 )
1137
1138 precision_loss = self.get("base_net_total") - flt(
1139 self.get("net_total") * self.conversion_rate, self.precision("net_total")
1140 )
1141
1142 credit_or_debit = "credit" if self.doctype == "Purchase Invoice" else "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301143 against_type = "Supplier" if self.doctype == "Purchase Invoice" else "Customer"
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301144 against = self.supplier if self.doctype == "Purchase Invoice" else self.customer
1145
1146 if precision_loss:
1147 gl_entries.append(
1148 self.get_gl_dict(
1149 {
1150 "account": round_off_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301151 "against_type": against_type,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301152 "against": against,
Gursheen Anand09439332023-11-08 12:57:00 +05301153 "against_link": against,
Deepesh Garg492ea3b2023-08-08 11:39:44 +05301154 credit_or_debit: precision_loss,
1155 "cost_center": round_off_cost_center
1156 if self.use_company_roundoff_cost_center
1157 else self.cost_center or round_off_cost_center,
1158 "remarks": _("Net total calculation precision loss"),
1159 }
1160 )
1161 )
1162
ruthra kumar79c6f012023-09-01 14:57:12 +05301163 def gain_loss_journal_already_booked(
1164 self,
1165 gain_loss_account,
1166 exc_gain_loss,
1167 ref2_dt,
1168 ref2_dn,
1169 ref2_detail_no,
1170 ) -> bool:
1171 """
1172 Check if gain/loss is booked
1173 """
1174 if res := frappe.db.get_all(
1175 "Journal Entry Account",
1176 filters={
1177 "docstatus": 1,
1178 "account": gain_loss_account,
1179 "reference_type": ref2_dt, # this will be Journal Entry
1180 "reference_name": ref2_dn,
1181 "reference_detail_no": ref2_detail_no,
1182 },
1183 pluck="parent",
1184 ):
1185 # deduplicate
1186 res = list({x for x in res})
1187 if exc_vouchers := frappe.db.get_all(
1188 "Journal Entry",
1189 filters={"name": ["in", res], "voucher_type": "Exchange Gain Or Loss"},
1190 fields=["voucher_type", "total_debit", "total_credit"],
1191 ):
1192 booked_voucher = exc_vouchers[0]
1193 if (
1194 booked_voucher.total_debit == exc_gain_loss
1195 and booked_voucher.total_credit == exc_gain_loss
1196 and booked_voucher.voucher_type == "Exchange Gain Or Loss"
1197 ):
1198 return True
1199 return False
1200
ruthra kumar66286322023-07-25 10:30:08 +05301201 def make_exchange_gain_loss_journal(self, args: dict = None) -> None:
ruthra kumar81cd7872023-04-27 09:46:54 +05301202 """
1203 Make Exchange Gain/Loss journal for Invoices and Payments
1204 """
ruthra kumarcd42b262023-07-10 15:28:10 +05301205 # Cancelling existing exchange gain/loss journals is handled during the `on_cancel` event.
1206 # see accounts/utils.py:cancel_exchange_gain_loss_journal()
ruthra kumar81cd7872023-04-27 09:46:54 +05301207 if self.docstatus == 1:
ruthra kumar7b516f82023-06-26 17:34:28 +05301208 if self.get("doctype") == "Journal Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301209 # 'args' is populated with exchange gain/loss account and the amount to be booked.
1210 # These are generated by Sales/Purchase Invoice during reconciliation and advance allocation.
ruthra kumarc0b3b062023-07-25 10:51:58 +05301211 # and below logic is only for such scenarios
ruthra kumar7b516f82023-06-26 17:34:28 +05301212 if args:
1213 for arg in args:
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301214 # Advance section uses `exchange_gain_loss` and reconciliation uses `difference_amount`
1215 if (
1216 arg.get("difference_amount", 0) != 0 or arg.get("exchange_gain_loss", 0) != 0
1217 ) and arg.get("difference_account"):
ruthra kumar7b516f82023-06-26 17:34:28 +05301218
ruthra kumaree3ce822023-06-26 21:43:20 +05301219 party_account = arg.get("account")
ruthra kumarc0b3b062023-07-25 10:51:58 +05301220 gain_loss_account = arg.get("difference_account")
ruthra kumarf4a65cc2023-07-14 16:51:42 +05301221 difference_amount = arg.get("difference_amount") or arg.get("exchange_gain_loss")
1222 if difference_amount > 0:
ruthra kumar05672432023-07-12 06:14:17 +05301223 dr_or_cr = "debit" if arg.get("party_type") == "Customer" else "credit"
1224 else:
1225 dr_or_cr = "credit" if arg.get("party_type") == "Customer" else "debit"
ruthra kumar7b516f82023-06-26 17:34:28 +05301226
1227 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1228
ruthra kumar79c6f012023-09-01 14:57:12 +05301229 if not self.gain_loss_journal_already_booked(
ruthra kumarc0b3b062023-07-25 10:51:58 +05301230 gain_loss_account,
1231 difference_amount,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301232 self.doctype,
1233 self.name,
ruthra kumar79c6f012023-09-01 14:57:12 +05301234 arg.get("referenced_row"),
1235 ):
ruthra kumar7e600a62023-10-22 20:26:45 +05301236 posting_date = arg.get("difference_posting_date") or frappe.db.get_value(
1237 arg.voucher_type, arg.voucher_no, "posting_date"
1238 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301239 je = create_gain_loss_journal(
1240 self.company,
ruthra kumarf7865da2023-09-04 20:38:10 +05301241 posting_date,
ruthra kumar79c6f012023-09-01 14:57:12 +05301242 arg.get("party_type"),
1243 arg.get("party"),
1244 party_account,
1245 gain_loss_account,
1246 difference_amount,
1247 dr_or_cr,
1248 reverse_dr_or_cr,
1249 arg.get("against_voucher_type"),
1250 arg.get("against_voucher"),
1251 arg.get("idx"),
1252 self.doctype,
1253 self.name,
1254 arg.get("referenced_row"),
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301255 arg.get("cost_center"),
ruthra kumaracc73222023-07-27 07:52:01 +05301256 )
ruthra kumar79c6f012023-09-01 14:57:12 +05301257 frappe.msgprint(
1258 _("Exchange Gain/Loss amount has been booked through {0}").format(
1259 get_link_to_form("Journal Entry", je)
1260 )
1261 )
ruthra kumar7b516f82023-06-26 17:34:28 +05301262
ruthra kumar81cd7872023-04-27 09:46:54 +05301263 if self.get("doctype") == "Payment Entry":
ruthra kumarcd42b262023-07-10 15:28:10 +05301264 # For Payment Entry, exchange_gain_loss field in the `references` table is the trigger for journal creation
ruthra kumar81cd7872023-04-27 09:46:54 +05301265 gain_loss_to_book = [x for x in self.references if x.exchange_gain_loss != 0]
1266 booked = []
1267 if gain_loss_to_book:
1268 vtypes = [x.reference_doctype for x in gain_loss_to_book]
1269 vnames = [x.reference_name for x in gain_loss_to_book]
1270 je = qb.DocType("Journal Entry")
1271 jea = qb.DocType("Journal Entry Account")
1272 parents = (
1273 qb.from_(jea)
1274 .select(jea.parent)
1275 .where(
1276 (jea.reference_type == "Payment Entry")
1277 & (jea.reference_name == self.name)
1278 & (jea.docstatus == 1)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301279 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301280 .run()
Saqiba20999c2021-07-12 14:33:23 +05301281 )
1282
ruthra kumar81cd7872023-04-27 09:46:54 +05301283 booked = []
1284 if parents:
1285 booked = (
1286 qb.from_(je)
1287 .inner_join(jea)
1288 .on(je.name == jea.parent)
1289 .select(jea.reference_type, jea.reference_name, jea.reference_detail_no)
1290 .where(
1291 (je.docstatus == 1)
1292 & (je.name.isin(parents))
1293 & (je.voucher_type == "Exchange Gain or Loss")
1294 )
1295 .run()
1296 )
Saqiba20999c2021-07-12 14:33:23 +05301297
ruthra kumar81cd7872023-04-27 09:46:54 +05301298 for d in gain_loss_to_book:
ruthra kumarc0b3b062023-07-25 10:51:58 +05301299 # Filter out References for which Gain/Loss is already booked
ruthra kumar81cd7872023-04-27 09:46:54 +05301300 if d.exchange_gain_loss and (
1301 (d.reference_doctype, d.reference_name, str(d.idx)) not in booked
1302 ):
ruthra kumar81cd7872023-04-27 09:46:54 +05301303 if self.payment_type == "Receive":
1304 party_account = self.paid_from
1305 elif self.payment_type == "Pay":
1306 party_account = self.paid_to
1307
ruthra kumar81cd7872023-04-27 09:46:54 +05301308 dr_or_cr = "debit" if d.exchange_gain_loss > 0 else "credit"
ruthra kumar34b5e842023-06-16 14:07:44 +05301309
1310 if d.reference_doctype == "Purchase Invoice":
1311 dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1312
ruthra kumar81cd7872023-04-27 09:46:54 +05301313 reverse_dr_or_cr = "debit" if dr_or_cr == "credit" else "credit"
1314
1315 gain_loss_account = frappe.get_cached_value(
1316 "Company", self.company, "exchange_gain_loss_account"
1317 )
ruthra kumar81cd7872023-04-27 09:46:54 +05301318
ruthra kumaracc73222023-07-27 07:52:01 +05301319 je = create_gain_loss_journal(
ruthra kumar1ea1bfe2023-07-26 16:19:38 +05301320 self.company,
ruthra kumar7e600a62023-10-22 20:26:45 +05301321 args.get("difference_posting_date") if args else self.posting_date,
ruthra kumarc0b3b062023-07-25 10:51:58 +05301322 self.party_type,
1323 self.party,
1324 party_account,
1325 gain_loss_account,
1326 d.exchange_gain_loss,
1327 dr_or_cr,
1328 reverse_dr_or_cr,
1329 d.reference_doctype,
1330 d.reference_name,
1331 d.idx,
1332 self.doctype,
1333 self.name,
1334 d.idx,
ruthra kumard6a3b9a2023-09-03 07:21:09 +05301335 self.cost_center,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301336 )
ruthra kumaracc73222023-07-27 07:52:01 +05301337 frappe.msgprint(
1338 _("Exchange Gain/Loss amount has been booked through {0}").format(
1339 get_link_to_form("Journal Entry", je)
1340 )
1341 )
Saqiba20999c2021-07-12 14:33:23 +05301342
Deepesh Garg016ed952023-06-20 13:22:32 +05301343 def update_against_document_in_jv(self):
Nabin Hait28a05282016-06-27 17:41:39 +05301344 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05301345 Links invoice and advance voucher:
1346 1. cancel advance voucher
1347 2. split into multiple rows if partially adjusted, assign against voucher
1348 3. submit advance voucher
Nabin Hait28a05282016-06-27 17:41:39 +05301349 """
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301350
Nabin Hait28a05282016-06-27 17:41:39 +05301351 if self.doctype == "Sales Invoice":
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301352 party_type = "Customer"
Nabin Hait28a05282016-06-27 17:41:39 +05301353 party = self.customer
1354 party_account = self.debit_to
1355 dr_or_cr = "credit_in_account_currency"
1356 else:
Nabin Haitff2f3ef2016-07-04 11:41:14 +05301357 party_type = "Supplier"
Nabin Hait28a05282016-06-27 17:41:39 +05301358 party = self.supplier
1359 party_account = self.credit_to
1360 dr_or_cr = "debit_in_account_currency"
Nabin Hait48f5fa62014-09-18 15:03:54 +05301361
Nabin Hait28a05282016-06-27 17:41:39 +05301362 lst = []
Ankush Menat494bd9e2022-03-28 18:52:46 +05301363 for d in self.get("advances"):
Nabin Hait28a05282016-06-27 17:41:39 +05301364 if flt(d.allocated_amount) > 0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301365 args = frappe._dict(
1366 {
1367 "voucher_type": d.reference_type,
1368 "voucher_no": d.reference_name,
1369 "voucher_detail_no": d.reference_row,
1370 "against_voucher_type": self.doctype,
1371 "against_voucher": self.name,
1372 "account": party_account,
1373 "party_type": party_type,
1374 "party": party,
1375 "is_advance": "Yes",
1376 "dr_or_cr": dr_or_cr,
1377 "unadjusted_amount": flt(d.advance_amount),
1378 "allocated_amount": flt(d.allocated_amount),
1379 "precision": d.precision("advance_amount"),
1380 "exchange_rate": (
1381 self.conversion_rate if self.party_account_currency != self.company_currency else 1
1382 ),
1383 "grand_total": (
1384 self.base_grand_total
1385 if self.party_account_currency == self.company_currency
1386 else self.grand_total
1387 ),
1388 "outstanding_amount": self.outstanding_amount,
Daizy Modi4efc9472022-11-07 09:21:03 +05301389 "difference_account": frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301390 "Company", self.company, "exchange_gain_loss_account"
1391 ),
1392 "exchange_gain_loss": flt(d.get("exchange_gain_loss")),
1393 }
1394 )
Nabin Hait28a05282016-06-27 17:41:39 +05301395 lst.append(args)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301396
Nabin Hait28a05282016-06-27 17:41:39 +05301397 if lst:
1398 from erpnext.accounts.utils import reconcile_against_document
Ankush Menat494bd9e2022-03-28 18:52:46 +05301399
Deepesh Garg016ed952023-06-20 13:22:32 +05301400 reconcile_against_document(lst)
Anand Doshid2946502014-04-08 20:10:03 +05301401
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301402 def on_cancel(self):
ruthra kumar81cd7872023-04-27 09:46:54 +05301403 from erpnext.accounts.utils import (
1404 cancel_exchange_gain_loss_journal,
1405 unlink_ref_doc_from_payment_entries,
1406 )
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301407
ruthra kumar6e18bb62023-07-11 12:21:10 +05301408 if self.doctype in ["Sales Invoice", "Purchase Invoice", "Payment Entry", "Journal Entry"]:
ruthra kumar81cd7872023-04-27 09:46:54 +05301409 # Cancel Exchange Gain/Loss Journal before unlinking
1410 cancel_exchange_gain_loss_journal(self)
1411
Ankush Menat494bd9e2022-03-28 18:52:46 +05301412 if frappe.db.get_single_value("Accounts Settings", "unlink_payment_on_cancellation_of_invoice"):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301413 unlink_ref_doc_from_payment_entries(self)
1414
1415 elif self.doctype in ["Sales Order", "Purchase Order"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301416 if frappe.db.get_single_value(
1417 "Accounts Settings", "unlink_advance_payment_on_cancelation_of_order"
1418 ):
Rohit Waghchaure5fa9a7a2019-04-01 00:40:38 +05301419 unlink_ref_doc_from_payment_entries(self)
1420
GangaManoj8396f242021-09-20 19:01:46 +05301421 if self.doctype == "Sales Order":
1422 self.unlink_ref_doc_from_po()
1423
1424 def unlink_ref_doc_from_po(self):
GangaManoj8396f242021-09-20 19:01:46 +05301425 so_items = []
1426 for item in self.items:
1427 so_items.append(item.name)
1428
Ankush Menat494bd9e2022-03-28 18:52:46 +05301429 linked_po = list(
1430 set(
1431 frappe.get_all(
1432 "Purchase Order Item",
1433 filters={
1434 "sales_order": self.name,
1435 "sales_order_item": ["in", so_items],
1436 "docstatus": ["<", 2],
1437 },
1438 pluck="parent",
1439 )
1440 )
1441 )
GangaManoj8396f242021-09-20 19:01:46 +05301442
GangaManoj8396f242021-09-20 19:01:46 +05301443 if linked_po:
GangaManoje77534f2021-09-20 19:01:46 +05301444 frappe.db.set_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301445 "Purchase Order Item",
1446 {"sales_order": self.name, "sales_order_item": ["in", so_items], "docstatus": ["<", 2]},
1447 {"sales_order": None, "sales_order_item": None},
GangaManoje77534f2021-09-20 19:01:46 +05301448 )
GangaManoj8396f242021-09-20 19:01:46 +05301449
1450 frappe.msgprint(_("Purchase Orders {0} are un-linked").format("\n".join(linked_po)))
1451
Deepesh Gargd18dde72020-11-29 21:40:04 +05301452 def get_tax_map(self):
1453 tax_map = {}
Ankush Menat494bd9e2022-03-28 18:52:46 +05301454 for tax in self.get("taxes"):
Deepesh Gargd18dde72020-11-29 21:40:04 +05301455 tax_map.setdefault(tax.account_head, 0.0)
1456 tax_map[tax.account_head] += tax.tax_amount
1457
1458 return tax_map
1459
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301460 def get_amount_and_base_amount(self, item, enable_discount_accounting):
1461 amount = item.net_amount
1462 base_amount = item.base_net_amount
1463
Ankush Menat494bd9e2022-03-28 18:52:46 +05301464 if (
1465 enable_discount_accounting
1466 and self.get("discount_amount")
1467 and self.get("additional_discount_account")
1468 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301469 amount = item.amount
1470 base_amount = item.base_amount
1471
1472 return amount, base_amount
1473
1474 def get_tax_amounts(self, tax, enable_discount_accounting):
1475 amount = tax.tax_amount_after_discount_amount
1476 base_amount = tax.base_tax_amount_after_discount_amount
1477
Ankush Menat494bd9e2022-03-28 18:52:46 +05301478 if (
1479 enable_discount_accounting
1480 and self.get("discount_amount")
1481 and self.get("additional_discount_account")
1482 and self.get("apply_discount_on") == "Grand Total"
1483 ):
Deepesh Garg92f7a5a2021-07-21 15:25:40 +05301484 amount = tax.tax_amount
1485 base_amount = tax.base_tax_amount
1486
1487 return amount, base_amount
1488
GangaManoj8f7b0a12021-07-13 03:01:02 +05301489 def make_discount_gl_entries(self, gl_entries):
rahib-hassanf3fa6ac2022-04-20 16:01:12 +05301490 if self.doctype == "Purchase Invoice":
1491 enable_discount_accounting = cint(
1492 frappe.db.get_single_value("Buying Settings", "enable_discount_accounting")
1493 )
1494 elif self.doctype == "Sales Invoice":
1495 enable_discount_accounting = cint(
1496 frappe.db.get_single_value("Selling Settings", "enable_discount_accounting")
1497 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301498
Deepesh Garg3b159662022-08-21 17:51:05 +05301499 if self.doctype == "Purchase Invoice":
1500 dr_or_cr = "credit"
1501 rev_dr_cr = "debit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301502 against_type = "Supplier"
Deepesh Garg3b159662022-08-21 17:51:05 +05301503 supplier_or_customer = self.supplier
1504
1505 else:
1506 dr_or_cr = "debit"
1507 rev_dr_cr = "credit"
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301508 against_type = "Customer"
Deepesh Garg3b159662022-08-21 17:51:05 +05301509 supplier_or_customer = self.customer
1510
GangaManoj8f7b0a12021-07-13 03:01:02 +05301511 if enable_discount_accounting:
1512 for item in self.get("items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301513 if item.get("discount_amount") and item.get("discount_account"):
Deepesh Gargad7bb312021-07-28 11:38:44 +05301514 discount_amount = item.discount_amount * item.qty
GangaManoj8f7b0a12021-07-13 03:01:02 +05301515 if self.doctype == "Purchase Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05301516 income_or_expense_account = (
1517 item.expense_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301518 if (not item.enable_deferred_expense or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301519 else item.deferred_expense_account
1520 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301521 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301522 income_or_expense_account = (
1523 item.income_account
Ankush Menat4551d7d2021-08-19 13:41:10 +05301524 if (not item.enable_deferred_revenue or self.is_return)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301525 else item.deferred_revenue_account
1526 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301527
1528 account_currency = get_account_currency(item.discount_account)
1529 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301530 self.get_gl_dict(
1531 {
1532 "account": item.discount_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 dr_or_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 dr_or_cr + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301540 "cost_center": item.cost_center,
1541 "project": item.project,
1542 },
1543 account_currency,
1544 item=item,
1545 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301546 )
1547
1548 account_currency = get_account_currency(income_or_expense_account)
1549 gl_entries.append(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301550 self.get_gl_dict(
1551 {
1552 "account": income_or_expense_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301553 "against_type": against_type,
Ankush Menat494bd9e2022-03-28 18:52:46 +05301554 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301555 "against_link": supplier_or_customer,
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301556 rev_dr_cr: flt(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301557 discount_amount * self.get("conversion_rate"), item.precision("discount_amount")
1558 ),
Saqib Ansarif915a9c2022-05-17 11:22:01 +05301559 rev_dr_cr
1560 + "_in_account_currency": flt(discount_amount, item.precision("discount_amount")),
Ankush Menat494bd9e2022-03-28 18:52:46 +05301561 "cost_center": item.cost_center,
1562 "project": item.project or self.project,
1563 },
1564 account_currency,
1565 item=item,
1566 )
GangaManoj8f7b0a12021-07-13 03:01:02 +05301567 )
GangaManoj857501c2021-07-15 22:03:46 +05301568
Deepesh Garg3b159662022-08-21 17:51:05 +05301569 if (
Deepesh Gargae3dce02022-08-22 08:57:58 +05301570 (enable_discount_accounting or self.get("is_cash_or_non_trade_discount"))
Deepesh Garg3b159662022-08-21 17:51:05 +05301571 and self.get("additional_discount_account")
1572 and self.get("discount_amount")
1573 ):
1574 gl_entries.append(
1575 self.get_gl_dict(
1576 {
1577 "account": self.additional_discount_account,
Gursheen Anand4c5a83d2023-09-25 19:55:40 +05301578 "against_type": against_type,
Deepesh Garg3b159662022-08-21 17:51:05 +05301579 "against": supplier_or_customer,
Gursheen Anand09439332023-11-08 12:57:00 +05301580 "against_link": supplier_or_customer,
Gursheen Anand112cfe62023-08-31 17:08:51 +05301581 dr_or_cr: self.base_discount_amount,
vr-greycube4ada5a42023-09-27 10:38:32 +05301582 "cost_center": self.cost_center or erpnext.get_default_cost_center(self.company),
Deepesh Garg3b159662022-08-21 17:51:05 +05301583 },
1584 item=self,
Ankush Menat4551d7d2021-08-19 13:41:10 +05301585 )
Deepesh Garg3b159662022-08-21 17:51:05 +05301586 )
Ankush Menat4551d7d2021-08-19 13:41:10 +05301587
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301588 def validate_multiple_billing(self, ref_dt, item_ref_dn, based_on):
Nabin Hait868766d2019-07-15 18:02:58 +05301589 from erpnext.controllers.status_updater import get_allowance_for
Saqib9c913c92021-11-26 12:00:13 +05301590
Nabin Hait868766d2019-07-15 18:02:58 +05301591 item_allowance = {}
1592 global_qty_allowance, global_amount_allowance = None, None
Anand Doshid2946502014-04-08 20:10:03 +05301593
Ankush Menat494bd9e2022-03-28 18:52:46 +05301594 role_allowed_to_over_bill = frappe.db.get_single_value(
1595 "Accounts Settings", "role_allowed_to_over_bill"
1596 )
Ankush Menat648b2d72021-09-20 15:27:12 +05301597 user_roles = frappe.get_roles()
1598
Ankush Menat43bf82b2021-09-20 16:31:20 +05301599 total_overbilled_amt = 0.0
1600
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301601 reference_names = [d.get(item_ref_dn) for d in self.get("items") if d.get(item_ref_dn)]
1602 reference_details = self.get_billing_reference_details(
1603 reference_names, ref_dt + " Item", based_on
1604 )
1605
Nabin Hait4b8185d2014-12-25 18:19:39 +05301606 for item in self.get("items"):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301607 if not item.get(item_ref_dn):
1608 continue
Anand Doshid2946502014-04-08 20:10:03 +05301609
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301610 ref_amt = flt(reference_details.get(item.get(item_ref_dn)), self.precision(based_on, item))
1611
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301612 if not ref_amt:
1613 frappe.msgprint(
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301614 _("System will not check over billing since amount for Item {0} in {1} is zero").format(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301615 item.item_code, ref_dt
1616 ),
1617 title=_("Warning"),
1618 indicator="orange",
1619 )
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301620 continue
Anand Doshid2946502014-04-08 20:10:03 +05301621
Saqib9c913c92021-11-26 12:00:13 +05301622 already_billed = self.get_billed_amount_for_item(item, item_ref_dn, based_on)
Anand Doshid2946502014-04-08 20:10:03 +05301623
Ankush Menat494bd9e2022-03-28 18:52:46 +05301624 total_billed_amt = flt(
1625 flt(already_billed) + flt(item.get(based_on)), self.precision(based_on, item)
1626 )
Anand Doshid2946502014-04-08 20:10:03 +05301627
Ankush Menat494bd9e2022-03-28 18:52:46 +05301628 allowance, item_allowance, global_qty_allowance, global_amount_allowance = get_allowance_for(
1629 item.item_code, item_allowance, global_qty_allowance, global_amount_allowance, "amount"
1630 )
rohitwaghchaure285344e2019-10-11 11:02:11 +05301631
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301632 max_allowed_amt = flt(ref_amt * (100 + allowance) / 100)
Deepesh Gargcb718fc2021-04-19 13:25:15 +05301633
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301634 if total_billed_amt < 0 and max_allowed_amt < 0:
1635 # while making debit note against purchase return entry(purchase receipt) getting overbill error
1636 total_billed_amt = abs(total_billed_amt)
1637 max_allowed_amt = abs(max_allowed_amt)
Afshan53fefd72021-06-24 10:09:02 +05301638
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301639 overbill_amt = total_billed_amt - max_allowed_amt
1640 total_overbilled_amt += overbill_amt
1641
1642 if overbill_amt > 0.01 and role_allowed_to_over_bill not in user_roles:
1643 if self.doctype != "Purchase Invoice":
1644 self.throw_overbill_exception(item, max_allowed_amt)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301645 elif not cint(
1646 frappe.db.get_single_value(
1647 "Buying Settings", "bill_for_rejected_quantity_in_purchase_invoice"
1648 )
1649 ):
Ankush Menat5e4fbba2021-09-20 16:36:27 +05301650 self.throw_overbill_exception(item, max_allowed_amt)
1651
1652 if role_allowed_to_over_bill in user_roles and total_overbilled_amt > 0.1:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301653 frappe.msgprint(
1654 _("Overbilling of {} ignored because you have {} role.").format(
1655 total_overbilled_amt, role_allowed_to_over_bill
1656 ),
1657 indicator="orange",
1658 alert=True,
1659 )
Afshan53fefd72021-06-24 10:09:02 +05301660
Deepesh Garg4c61ee32023-04-02 09:35:27 +05301661 def get_billing_reference_details(self, reference_names, reference_doctype, based_on):
1662 return frappe._dict(
1663 frappe.get_all(
1664 reference_doctype,
1665 filters={"name": ("in", reference_names)},
1666 fields=["name", based_on],
1667 as_list=1,
1668 )
1669 )
1670
Saqib9c913c92021-11-26 12:00:13 +05301671 def get_billed_amount_for_item(self, item, item_ref_dn, based_on):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301672 """
1673 Returns Sum of Amount of
1674 Sales/Purchase Invoice Items
1675 that are linked to `item_ref_dn` (`dn_detail` / `pr_detail`)
1676 that are submitted OR not submitted but are under current invoice
1677 """
Saqib9c913c92021-11-26 12:00:13 +05301678
1679 from frappe.query_builder import Criterion
1680 from frappe.query_builder.functions import Sum
1681
1682 item_doctype = frappe.qb.DocType(item.doctype)
1683 based_on_field = frappe.qb.Field(based_on)
1684 join_field = frappe.qb.Field(item_ref_dn)
1685
1686 result = (
1687 frappe.qb.from_(item_doctype)
1688 .select(Sum(based_on_field))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301689 .where(join_field == item.get(item_ref_dn))
Saqib9c913c92021-11-26 12:00:13 +05301690 .where(
Ankush Menat494bd9e2022-03-28 18:52:46 +05301691 Criterion.any(
1692 [ # select all items from other invoices OR current invoices
1693 Criterion.all(
1694 [ # for selecting items from other invoices
1695 item_doctype.docstatus == 1,
1696 item_doctype.parent != self.name,
1697 ]
1698 ),
1699 Criterion.all(
1700 [ # for selecting items from current invoice, that are linked to same reference
1701 item_doctype.docstatus == 0,
1702 item_doctype.parent == self.name,
1703 item_doctype.name != item.name,
1704 ]
1705 ),
1706 ]
1707 )
Saqib9c913c92021-11-26 12:00:13 +05301708 )
1709 ).run()
1710
1711 return result[0][0] if result else 0
1712
Afshan53fefd72021-06-24 10:09:02 +05301713 def throw_overbill_exception(self, item, max_allowed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301714 frappe.throw(
1715 _(
1716 "Cannot overbill for Item {0} in row {1} more than {2}. To allow over-billing, please set allowance in Accounts Settings"
1717 ).format(item.item_code, item.idx, max_allowed_amt)
1718 )
Anand Doshid2946502014-04-08 20:10:03 +05301719
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301720 def get_company_default(self, fieldname, ignore_validation=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +05301721 from erpnext.accounts.utils import get_company_default
Ankush Menat494bd9e2022-03-28 18:52:46 +05301722
Rohit Waghchaure2a14f252021-07-30 12:36:35 +05301723 return get_company_default(self.company, fieldname, ignore_validation=ignore_validation)
Anand Doshid2946502014-04-08 20:10:03 +05301724
Nabin Haita36adbd2013-08-02 14:50:12 +05301725 def get_stock_items(self):
1726 stock_items = []
Nabin Haitdd38a262014-12-26 13:15:21 +05301727 item_codes = list(set(item.item_code for item in self.get("items")))
Nabin Haita36adbd2013-08-02 14:50:12 +05301728 if item_codes:
Saqib Ansari199a6da2022-03-31 11:41:52 +05301729 stock_items = frappe.db.get_values(
1730 "Item", {"name": ["in", item_codes], "is_stock_item": 1}, pluck="name", cache=True
1731 )
Anand Doshid2946502014-04-08 20:10:03 +05301732
Nabin Haita36adbd2013-08-02 14:50:12 +05301733 return stock_items
Anand Doshid2946502014-04-08 20:10:03 +05301734
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301735 def set_total_advance_paid(self):
ruthra kumar44870652022-11-01 10:11:38 +05301736 ple = frappe.qb.DocType("Payment Ledger Entry")
1737 party = self.customer if self.doctype == "Sales Order" else self.supplier
1738 advance = (
1739 frappe.qb.from_(ple)
ruthra kumarbf76b852022-11-22 12:16:11 +05301740 .select(ple.account_currency, Abs(Sum(ple.amount_in_account_currency)).as_("amount"))
ruthra kumar44870652022-11-01 10:11:38 +05301741 .where(
1742 (ple.against_voucher_type == self.doctype)
1743 & (ple.against_voucher_no == self.name)
1744 & (ple.party == party)
ruthra kumarbf76b852022-11-22 12:16:11 +05301745 & (ple.docstatus == 1)
ruthra kumar44870652022-11-01 10:11:38 +05301746 & (ple.company == self.company)
1747 )
1748 .run(as_dict=True)
1749 )
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301750
Nabin Haitb2206d12016-01-27 15:43:12 +05301751 if advance:
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301752 advance = advance[0]
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +05301753
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301754 advance_paid = flt(advance.amount, self.precision("advance_paid"))
Ankush Menat494bd9e2022-03-28 18:52:46 +05301755 formatted_advance_paid = fmt_money(
1756 advance_paid, precision=self.precision("advance_paid"), currency=advance.account_currency
1757 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301758
Ankush Menat494bd9e2022-03-28 18:52:46 +05301759 frappe.db.set_value(self.doctype, self.name, "party_account_currency", advance.account_currency)
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301760
1761 if advance.account_currency == self.currency:
finbyz5efc7972019-01-05 11:12:11 +05301762 order_total = self.get("rounded_total") or self.grand_total
1763 precision = "rounded_total" if self.get("rounded_total") else "grand_total"
Nabin Haitb2206d12016-01-27 15:43:12 +05301764 else:
finbyz5efc7972019-01-05 11:12:11 +05301765 order_total = self.get("base_rounded_total") or self.base_grand_total
1766 precision = "base_rounded_total" if self.get("base_rounded_total") else "base_grand_total"
Sagar Voraf733a392019-01-07 14:24:01 +05301767
Ankush Menat494bd9e2022-03-28 18:52:46 +05301768 formatted_order_total = fmt_money(
1769 order_total, precision=self.precision(precision), currency=advance.account_currency
1770 )
Anand Doshi7c0a58a2016-01-29 12:16:24 +05301771
Nabin Hait9db1b222016-06-30 12:37:53 +05301772 if self.currency == self.company_currency and advance_paid > order_total:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301773 frappe.throw(
1774 _(
1775 "Total advance ({0}) against Order {1} cannot be greater than the Grand Total ({2})"
1776 ).format(formatted_advance_paid, self.name, formatted_order_total)
1777 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05301778
Nabin Hait13093b42016-06-29 18:04:37 +05301779 frappe.db.set_value(self.doctype, self.name, "advance_paid", advance_paid)
Ankit Javalkar8e7ca412014-09-12 15:18:53 +05301780
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301781 @property
1782 def company_abbr(self):
Nabin Hait6a5695f2018-08-09 11:30:21 +05301783 if not hasattr(self, "_abbr"):
Daizy Modi4efc9472022-11-07 09:21:03 +05301784 self._abbr = frappe.get_cached_value("Company", self.company, "abbr")
ankitjavalkarworke60822b2014-08-26 14:29:06 +05301785
1786 return self._abbr
1787
marination4be5b5c2020-10-08 19:08:27 +05301788 def raise_missing_debit_credit_account_error(self, party_type, party):
marination53b1a9a2020-11-03 15:45:25 +05301789 """Raise an error if debit to/credit to account does not exist."""
Ankush Menat494bd9e2022-03-28 18:52:46 +05301790 db_or_cr = (
1791 frappe.bold("Debit To") if self.doctype == "Sales Invoice" else frappe.bold("Credit To")
1792 )
marination4be5b5c2020-10-08 19:08:27 +05301793 rec_or_pay = "Receivable" if self.doctype == "Sales Invoice" else "Payable"
1794
1795 link_to_party = frappe.utils.get_link_to_form(party_type, party)
1796 link_to_company = frappe.utils.get_link_to_form("Company", self.company)
1797
Ankush Menat494bd9e2022-03-28 18:52:46 +05301798 message = _("{0} Account not found against Customer {1}.").format(
1799 db_or_cr, frappe.bold(party) or ""
1800 )
marination4be5b5c2020-10-08 19:08:27 +05301801 message += "<br>" + _("Please set one of the following:") + "<br>"
Ankush Menat494bd9e2022-03-28 18:52:46 +05301802 message += (
1803 "<br><ul><li>"
1804 + _("'Account' in the Accounting section of Customer {0}").format(link_to_party)
1805 + "</li>"
1806 )
1807 message += (
1808 "<li>"
1809 + _("'Default {0} Account' in Company {1}").format(rec_or_pay, link_to_company)
1810 + "</li></ul>"
1811 )
marination4be5b5c2020-10-08 19:08:27 +05301812
marination53b1a9a2020-11-03 15:45:25 +05301813 frappe.throw(message, title=_("Account Missing"), exc=AccountMissingError)
marination4be5b5c2020-10-08 19:08:27 +05301814
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301815 def validate_party(self):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301816 party_type, party = self.get_party()
shreyaseba9ca42016-01-26 14:56:52 +05301817 validate_party_frozen_disabled(party_type, party)
Anand Doshi979326b2015-09-11 16:22:37 +05301818
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301819 def get_party(self):
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301820 party_type = None
shreyas29b565f2016-01-25 17:30:49 +05301821 if self.doctype in ("Opportunity", "Quotation", "Sales Order", "Delivery Note", "Sales Invoice"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301822 party_type = "Customer"
shreyas29b565f2016-01-25 17:30:49 +05301823
Ankush Menat494bd9e2022-03-28 18:52:46 +05301824 elif self.doctype in (
1825 "Supplier Quotation",
1826 "Purchase Order",
1827 "Purchase Receipt",
1828 "Purchase Invoice",
1829 ):
1830 party_type = "Supplier"
shreyas29b565f2016-01-25 17:30:49 +05301831
1832 elif self.meta.get_field("customer"):
1833 party_type = "Customer"
Neil Trini Lasrado3fbbb712015-07-17 12:10:12 +05301834
Neil Trini Lasrado79bf2332015-07-20 13:03:48 +05301835 elif self.meta.get_field("supplier"):
shreyas29b565f2016-01-25 17:30:49 +05301836 party_type = "Supplier"
Anand Doshi979326b2015-09-11 16:22:37 +05301837
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301838 party = self.get(party_type.lower()) if party_type else None
Anand Doshi979326b2015-09-11 16:22:37 +05301839
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301840 return party_type, party
Anand Doshi979326b2015-09-11 16:22:37 +05301841
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301842 def validate_currency(self):
Nabin Hait6e439a52015-08-28 19:24:22 +05301843 if self.get("currency"):
Nabin Hait4ffd7f32015-08-27 12:28:36 +05301844 party_type, party = self.get_party()
Nabin Hait6e439a52015-08-28 19:24:22 +05301845 if party_type and party:
Anand Doshib20baf82015-09-25 16:17:50 +05301846 party_account_currency = get_party_account_currency(party_type, party, self.company)
Anand Doshi979326b2015-09-11 16:22:37 +05301847
Ankush Menat494bd9e2022-03-28 18:52:46 +05301848 if (
1849 party_account_currency
1850 and party_account_currency != self.company_currency
1851 and self.currency != party_account_currency
1852 ):
Gursheen Anand112cfe62023-08-31 17:08:51 +05301853
Ankush Menat494bd9e2022-03-28 18:52:46 +05301854 frappe.throw(
1855 _("Accounting Entry for {0}: {1} can only be made in currency: {2}").format(
1856 party_type, party, party_account_currency
1857 ),
1858 InvalidCurrency,
1859 )
Anand Doshi979326b2015-09-11 16:22:37 +05301860
shreyas29b565f2016-01-25 17:30:49 +05301861 # Note: not validating with gle account because we don't have the account
1862 # at quotation / sales order level and we shouldn't stop someone
1863 # from creating a sales invoice if sales order is already created
Rushabh Mehta2cb7a9f2016-06-15 16:45:03 +05301864
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301865 def validate_party_account_currency(self):
Deepesh Garg33d97672022-05-12 16:40:29 +05301866 if self.doctype not in ("Sales Invoice", "Purchase Invoice"):
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301867 return
1868
Deepesh Garg33d97672022-05-12 16:40:29 +05301869 if self.is_opening == "Yes":
Deepesh Garg60915e82021-08-21 23:05:48 +05301870 return
1871
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301872 party_type, party = self.get_party()
1873 party_gle_currency = get_party_gle_currency(party_type, party, self.company)
Deepesh Garg33d97672022-05-12 16:40:29 +05301874 party_account = (
1875 self.get("debit_to") if self.doctype == "Sales Invoice" else self.get("credit_to")
1876 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301877 party_account_currency = get_account_currency(party_account)
Deepesh Garge04e67c2022-07-11 19:25:18 +05301878 allow_multi_currency_invoices_against_single_party_account = frappe.db.get_singles_value(
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301879 "Accounts Settings", "allow_multi_currency_invoices_against_single_party_account"
1880 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301881
Deepesh Garg3cf609f2022-07-11 13:46:59 +05301882 if (
1883 not party_gle_currency
1884 and (party_account_currency != self.currency)
1885 and not allow_multi_currency_invoices_against_single_party_account
1886 ):
Deepesh Garg33d97672022-05-12 16:40:29 +05301887 frappe.throw(
Devin Slauenwhite3a1c9232022-06-02 14:15:50 -04001888 _("Party Account {0} currency ({1}) and document currency ({2}) should be same").format(
Devin Slauenwhiteb061ea42022-06-02 14:23:54 -04001889 frappe.bold(party_account), party_account_currency, self.currency
Deepesh Garg33d97672022-05-12 16:40:29 +05301890 )
1891 )
Deepesh Garg80c85dd2021-08-12 15:39:07 +05301892
Nabin Hait297d74a2016-11-23 15:58:51 +05301893 def delink_advance_entries(self, linked_doc_name):
1894 total_allocated_amount = 0
1895 for adv in self.advances:
1896 consider_for_total_advance = True
1897 if adv.reference_name == linked_doc_name:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301898 frappe.db.sql(
1899 """delete from `tab{0} Advance`
1900 where name = %s""".format(
1901 self.doctype
1902 ),
1903 adv.name,
1904 )
Nabin Hait297d74a2016-11-23 15:58:51 +05301905 consider_for_total_advance = False
1906
1907 if consider_for_total_advance:
1908 total_allocated_amount += flt(adv.allocated_amount, adv.precision("allocated_amount"))
1909
Ankush Menat494bd9e2022-03-28 18:52:46 +05301910 frappe.db.set_value(
1911 self.doctype, self.name, "total_advance", total_allocated_amount, update_modified=False
1912 )
Rohit Waghchaure6087fe12016-04-09 14:31:09 +05301913
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301914 def group_similar_items(self):
1915 group_item_qty = {}
1916 group_item_amount = {}
Shreya Shah785f1aa2018-10-11 10:14:25 +05301917 # to update serial number in print
1918 count = 0
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301919
1920 for item in self.items:
1921 group_item_qty[item.item_code] = group_item_qty.get(item.item_code, 0) + item.qty
1922 group_item_amount[item.item_code] = group_item_amount.get(item.item_code, 0) + item.amount
1923
1924 duplicate_list = []
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301925 for item in self.items:
1926 if item.item_code in group_item_qty:
Shreya Shah785f1aa2018-10-11 10:14:25 +05301927 count += 1
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301928 item.qty = group_item_qty[item.item_code]
1929 item.amount = group_item_amount[item.item_code]
deepeshgarg007e8d21cd2019-06-24 17:46:44 +05301930
1931 if item.qty:
1932 item.rate = flt(flt(item.amount) / flt(item.qty), item.precision("rate"))
1933 else:
1934 item.rate = 0
1935
Shreya Shah785f1aa2018-10-11 10:14:25 +05301936 item.idx = count
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301937 del group_item_qty[item.item_code]
1938 else:
1939 duplicate_list.append(item)
KanchanChauhan49a50fe2016-11-18 13:57:53 +05301940 for item in duplicate_list:
1941 self.remove(item)
1942
tunde32aa7c12017-09-07 06:52:15 +01001943 def set_payment_schedule(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301944 if self.doctype == "Sales Invoice" and self.is_pos:
1945 self.payment_terms_template = ""
Manas Solankia7f55892018-04-02 10:32:00 +05301946 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05301947
Ankush Menat494bd9e2022-03-28 18:52:46 +05301948 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05301949 if not party_account_currency:
1950 party_type, party = self.get_party()
1951
1952 if party_type and party:
1953 party_account_currency = get_party_account_currency(party_type, party, self.company)
1954
rohitwaghchaureda941af2018-01-17 16:23:04 +05301955 posting_date = self.get("bill_date") or self.get("posting_date") or self.get("transaction_date")
tundedf3a1752017-09-11 11:02:57 +01001956 date = self.get("due_date")
1957 due_date = date or posting_date
Deepesh Garg26210162020-08-11 16:06:13 +05301958
Saqib Ansarid552fe62021-04-23 14:46:52 +05301959 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
1960 grand_total = self.get("rounded_total") or self.grand_total
Deepesh Garg5c758942023-04-16 17:11:24 +05301961 automatically_fetch_payment_terms = 0
Deepesh Garg26210162020-08-11 16:06:13 +05301962
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301963 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301964 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Hait2f9f4f92017-12-20 12:24:59 +05301965 grand_total = grand_total - flt(self.write_off_amount)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301966 po_or_so, doctype, fieldname = self.get_order_details()
Ankush Menat494bd9e2022-03-28 18:52:46 +05301967 automatically_fetch_payment_terms = cint(
1968 frappe.db.get_single_value("Accounts Settings", "automatically_fetch_payment_terms")
1969 )
tunde96b8f222017-09-08 15:35:59 +01001970
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301971 if self.get("total_advance"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05301972 if party_account_currency == self.company_currency:
1973 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301974 grand_total = flt(
1975 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
1976 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05301977 else:
1978 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05301979 base_grand_total = flt(
1980 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
1981 )
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05301982
Nabin Hait0551f7b2017-11-21 19:58:16 +05301983 if not self.get("payment_schedule"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301984 if (
1985 self.doctype in ["Sales Invoice", "Purchase Invoice"]
1986 and automatically_fetch_payment_terms
1987 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
1988 ):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301989 self.fetch_payment_terms_from_order(po_or_so, doctype)
Ankush Menat494bd9e2022-03-28 18:52:46 +05301990 if self.get("payment_terms_template"):
Deepesh Gargbcf56e62021-08-06 23:53:16 +05301991 self.ignore_default_payment_terms_template = 1
1992 elif self.get("payment_terms_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05301993 data = get_payment_terms(
1994 self.payment_terms_template, posting_date, grand_total, base_grand_total
1995 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05301996 for item in data:
1997 self.append("payment_schedule", item)
GangaManoj4323f4b2021-07-22 05:57:42 +05301998 elif self.doctype not in ["Purchase Receipt"]:
Ankush Menat494bd9e2022-03-28 18:52:46 +05301999 data = dict(
2000 due_date=due_date,
2001 invoice_portion=100,
2002 payment_amount=grand_total,
2003 base_payment_amount=base_grand_total,
2004 )
Nabin Hait0551f7b2017-11-21 19:58:16 +05302005 self.append("payment_schedule", data)
Deepesh Gargbcf56e62021-08-06 23:53:16 +05302006
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302007 allocate_payment_based_on_payment_terms = frappe.db.get_value(
2008 "Payment Terms Template", self.payment_terms_template, "allocate_payment_based_on_payment_terms"
2009 )
2010
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302011 if not (
2012 automatically_fetch_payment_terms
Gursheen Kaur Anandedbefee2023-08-04 17:49:17 +05302013 and allocate_payment_based_on_payment_terms
Deepesh Gargf7b50f22023-04-25 19:18:45 +05302014 and self.linked_order_has_payment_terms(po_or_so, fieldname, doctype)
2015 ):
Deepesh Garg5c758942023-04-16 17:11:24 +05302016 for d in self.get("payment_schedule"):
2017 if d.invoice_portion:
2018 d.payment_amount = flt(
2019 grand_total * flt(d.invoice_portion / 100), d.precision("payment_amount")
2020 )
2021 d.base_payment_amount = flt(
2022 base_grand_total * flt(d.invoice_portion / 100), d.precision("base_payment_amount")
2023 )
2024 d.outstanding = d.payment_amount
2025 elif not d.invoice_portion:
2026 d.base_payment_amount = flt(
2027 d.payment_amount * self.get("conversion_rate"), d.precision("base_payment_amount")
2028 )
ruthra kumar0da6c162023-05-16 18:57:42 +05302029 else:
2030 self.fetch_payment_terms_from_order(po_or_so, doctype)
2031 self.ignore_default_payment_terms_template = 1
tunde43870aa2017-08-18 11:59:30 +01002032
GangaManoj4323f4b2021-07-22 05:57:42 +05302033 def get_order_details(self):
2034 if self.doctype == "Sales Invoice":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302035 po_or_so = self.get("items")[0].get("sales_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302036 po_or_so_doctype = "Sales Order"
2037 po_or_so_doctype_name = "sales_order"
2038
tunde43870aa2017-08-18 11:59:30 +01002039 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302040 po_or_so = self.get("items")[0].get("purchase_order")
GangaManoj4323f4b2021-07-22 05:57:42 +05302041 po_or_so_doctype = "Purchase Order"
2042 po_or_so_doctype_name = "purchase_order"
Ankush Menat4551d7d2021-08-19 13:41:10 +05302043
GangaManoj4323f4b2021-07-22 05:57:42 +05302044 return po_or_so, po_or_so_doctype, po_or_so_doctype_name
2045
GangaManojc7c90242021-07-29 19:18:35 +05302046 def linked_order_has_payment_terms(self, po_or_so, fieldname, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302047 if po_or_so and self.all_items_have_same_po_or_so(po_or_so, fieldname):
GangaManojc7c90242021-07-29 19:18:35 +05302048 if self.linked_order_has_payment_terms_template(po_or_so, doctype):
GangaManoj4323f4b2021-07-22 05:57:42 +05302049 return True
2050 elif self.linked_order_has_payment_schedule(po_or_so):
2051 return True
Ankush Menat4551d7d2021-08-19 13:41:10 +05302052
GangaManoj4323f4b2021-07-22 05:57:42 +05302053 return False
2054
2055 def all_items_have_same_po_or_so(self, po_or_so, fieldname):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302056 for item in self.get("items"):
GangaManoj4323f4b2021-07-22 05:57:42 +05302057 if item.get(fieldname) != po_or_so:
2058 return False
Ankush Menat4551d7d2021-08-19 13:41:10 +05302059
GangaManoj4323f4b2021-07-22 05:57:42 +05302060 return True
2061
GangaManojc7c90242021-07-29 19:18:35 +05302062 def linked_order_has_payment_terms_template(self, po_or_so, doctype):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302063 return frappe.get_value(doctype, po_or_so, "payment_terms_template")
GangaManoj4323f4b2021-07-22 05:57:42 +05302064
2065 def linked_order_has_payment_schedule(self, po_or_so):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302066 return frappe.get_all("Payment Schedule", filters={"parent": po_or_so})
GangaManoj4323f4b2021-07-22 05:57:42 +05302067
2068 def fetch_payment_terms_from_order(self, po_or_so, po_or_so_doctype):
2069 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302070 Fetch Payment Terms from Purchase/Sales Order on creating a new Purchase/Sales Invoice.
GangaManoj4323f4b2021-07-22 05:57:42 +05302071 """
2072 po_or_so = frappe.get_cached_doc(po_or_so_doctype, po_or_so)
2073
2074 self.payment_schedule = []
2075 self.payment_terms_template = po_or_so.payment_terms_template
2076
2077 for schedule in po_or_so.payment_schedule:
2078 payment_schedule = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302079 "payment_term": schedule.payment_term,
2080 "due_date": schedule.due_date,
2081 "invoice_portion": schedule.invoice_portion,
2082 "mode_of_payment": schedule.mode_of_payment,
2083 "description": schedule.description,
Deepesh Garg5c758942023-04-16 17:11:24 +05302084 "payment_amount": schedule.payment_amount,
2085 "base_payment_amount": schedule.base_payment_amount,
2086 "outstanding": schedule.outstanding,
2087 "paid_amount": schedule.paid_amount,
GangaManoj4323f4b2021-07-22 05:57:42 +05302088 }
GangaManoj5b33e752021-08-05 21:50:09 +05302089
Ankush Menat494bd9e2022-03-28 18:52:46 +05302090 if schedule.discount_type == "Percentage":
2091 payment_schedule["discount_type"] = schedule.discount_type
2092 payment_schedule["discount"] = schedule.discount
GangaManoj5b33e752021-08-05 21:50:09 +05302093
ruthra kumar9bd56b02022-02-01 14:14:04 +05302094 if not schedule.invoice_portion:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302095 payment_schedule["payment_amount"] = schedule.payment_amount
ruthra kumar9bd56b02022-02-01 14:14:04 +05302096
GangaManoj4323f4b2021-07-22 05:57:42 +05302097 self.append("payment_schedule", payment_schedule)
tunde43870aa2017-08-18 11:59:30 +01002098
tundebe1b8712017-08-19 08:21:44 +01002099 def set_due_date(self):
Nabin Hait0551f7b2017-11-21 19:58:16 +05302100 due_dates = [d.due_date for d in self.get("payment_schedule") if d.due_date]
2101 if due_dates:
2102 self.due_date = max(due_dates)
tunde62af5c52017-09-22 15:16:38 +01002103
2104 def validate_payment_schedule_dates(self):
tunde77ecacc2017-09-22 23:12:55 +01002105 dates = []
tunde9bed2de2017-09-25 10:19:35 +01002106 li = []
tunde43870aa2017-08-18 11:59:30 +01002107
Ankush Menat494bd9e2022-03-28 18:52:46 +05302108 if self.doctype == "Sales Invoice" and self.is_pos:
2109 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302110
tunde43870aa2017-08-18 11:59:30 +01002111 for d in self.get("payment_schedule"):
Nabin Hait2f9f4f92017-12-20 12:24:59 +05302112 if self.doctype == "Sales Order" and getdate(d.due_date) < getdate(self.transaction_date):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302113 frappe.throw(
2114 _("Row {0}: Due Date in the Payment Terms table cannot be before Posting Date").format(d.idx)
2115 )
tunde77ecacc2017-09-22 23:12:55 +01002116 elif d.due_date in dates:
mnatalia5f0e8d62018-05-22 06:38:50 +03002117 li.append(_("{0} in row {1}").format(d.due_date, d.idx))
tunde9bed2de2017-09-25 10:19:35 +01002118 dates.append(d.due_date)
2119
2120 if li:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302121 duplicates = "<br>" + "<br>".join(li)
2122 frappe.throw(
2123 _("Rows with duplicate due dates in other rows were found: {0}").format(duplicates)
2124 )
tunde43870aa2017-08-18 11:59:30 +01002125
tunde62af5c52017-09-22 15:16:38 +01002126 def validate_payment_schedule_amount(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302127 if self.doctype == "Sales Invoice" and self.is_pos:
2128 return
rohitwaghchauredb9fa782018-03-01 10:32:29 +05302129
Ankush Menat494bd9e2022-03-28 18:52:46 +05302130 party_account_currency = self.get("party_account_currency")
Deepesh Garg26210162020-08-11 16:06:13 +05302131 if not party_account_currency:
2132 party_type, party = self.get_party()
2133
2134 if party_type and party:
2135 party_account_currency = get_party_account_currency(party_type, party, self.company)
2136
Nabin Hait0551f7b2017-11-21 19:58:16 +05302137 if self.get("payment_schedule"):
2138 total = 0
Saqib Ansarid552fe62021-04-23 14:46:52 +05302139 base_total = 0
Nabin Hait0551f7b2017-11-21 19:58:16 +05302140 for d in self.get("payment_schedule"):
Deepesh Garg9c170522021-10-25 20:06:24 +05302141 total += flt(d.payment_amount, d.precision("payment_amount"))
2142 base_total += flt(d.base_payment_amount, d.precision("base_payment_amount"))
tunde43870aa2017-08-18 11:59:30 +01002143
Saqib Ansarid552fe62021-04-23 14:46:52 +05302144 base_grand_total = self.get("base_rounded_total") or self.base_grand_total
2145 grand_total = self.get("rounded_total") or self.grand_total
Rohit Waghchaure4a267b92019-05-09 19:50:00 +05302146
Nabin Haite591c852017-12-21 11:46:30 +05302147 if self.doctype in ("Sales Invoice", "Purchase Invoice"):
Saqib Ansarid552fe62021-04-23 14:46:52 +05302148 base_grand_total = base_grand_total - flt(self.base_write_off_amount)
Nabin Haite591c852017-12-21 11:46:30 +05302149 grand_total = grand_total - flt(self.write_off_amount)
Saqib Ansarid552fe62021-04-23 14:46:52 +05302150
2151 if self.get("total_advance"):
2152 if party_account_currency == self.company_currency:
2153 base_grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302154 grand_total = flt(
2155 base_grand_total / self.get("conversion_rate"), self.precision("grand_total")
2156 )
Saqib Ansarid552fe62021-04-23 14:46:52 +05302157 else:
2158 grand_total -= self.get("total_advance")
Ankush Menat494bd9e2022-03-28 18:52:46 +05302159 base_grand_total = flt(
2160 grand_total * self.get("conversion_rate"), self.precision("base_grand_total")
2161 )
Deepesh Garg9c170522021-10-25 20:06:24 +05302162
Ankush Menat494bd9e2022-03-28 18:52:46 +05302163 if (
2164 flt(total, self.precision("grand_total")) - flt(grand_total, self.precision("grand_total"))
2165 > 0.1
2166 or flt(base_total, self.precision("base_grand_total"))
2167 - flt(base_grand_total, self.precision("base_grand_total"))
2168 > 0.1
2169 ):
2170 frappe.throw(
2171 _("Total Payment Amount in Payment Schedule must be equal to Grand / Rounded Total")
2172 )
tunde43870aa2017-08-18 11:59:30 +01002173
Nabin Hait877e1bb2017-11-17 12:27:43 +05302174 def is_rounded_total_disabled(self):
2175 if self.meta.get_field("disable_rounded_total"):
2176 return self.disable_rounded_total
2177 else:
2178 return frappe.db.get_single_value("Global Defaults", "disable_rounded_total")
2179
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302180 def set_inter_company_account(self):
2181 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302182 Set intercompany account for inter warehouse transactions
2183 This account will be used in case billing company and internal customer's
2184 representation company is same
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302185 """
2186
2187 if self.is_internal_transfer() and not self.unrealized_profit_loss_account:
Daizy Modi4efc9472022-11-07 09:21:03 +05302188 unrealized_profit_loss_account = frappe.get_cached_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302189 "Company", self.company, "unrealized_profit_loss_account"
2190 )
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302191
2192 if not unrealized_profit_loss_account:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302193 msg = _(
2194 "Please select Unrealized Profit / Loss account or add default Unrealized Profit / Loss account account for company {0}"
2195 ).format(frappe.bold(self.company))
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302196 frappe.throw(msg)
2197
2198 self.unrealized_profit_loss_account = unrealized_profit_loss_account
2199
2200 def is_internal_transfer(self):
2201 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302202 It will an internal transfer if its an internal customer and representation
2203 company is same as billing company
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302204 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302205 if self.doctype in ("Sales Invoice", "Delivery Note", "Sales Order"):
2206 internal_party_field = "is_internal_customer"
2207 elif self.doctype in ("Purchase Invoice", "Purchase Receipt", "Purchase Order"):
2208 internal_party_field = "is_internal_supplier"
Ankush Menat3714e362022-05-16 18:09:14 +05302209 else:
2210 return False
Deepesh Gargf17ea2c2020-12-11 21:30:39 +05302211
2212 if self.get(internal_party_field) and (self.represents_company == self.company):
2213 return True
2214
2215 return False
2216
Saqib Ansari977b09b2021-08-19 17:57:30 +05302217 def process_common_party_accounting(self):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302218 is_invoice = self.doctype in ["Sales Invoice", "Purchase Invoice"]
Saqib Ansari977b09b2021-08-19 17:57:30 +05302219 if not is_invoice:
2220 return
2221
Ankush Menat494bd9e2022-03-28 18:52:46 +05302222 if frappe.db.get_single_value("Accounts Settings", "enable_common_party_accounting"):
Saqib Ansari977b09b2021-08-19 17:57:30 +05302223 party_link = self.get_common_party_link()
2224 if party_link and self.outstanding_amount:
2225 self.create_advance_and_reconcile(party_link)
2226
2227 def get_common_party_link(self):
2228 party_type, party = self.get_party()
Saqib Ansari72543682021-08-25 20:15:23 +05302229 return frappe.db.get_value(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302230 doctype="Party Link",
2231 filters={"secondary_role": party_type, "secondary_party": party},
2232 fieldname=["primary_role", "primary_party"],
2233 as_dict=True,
Saqib Ansari72543682021-08-25 20:15:23 +05302234 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302235
2236 def create_advance_and_reconcile(self, party_link):
2237 secondary_party_type, secondary_party = self.get_party()
2238 primary_party_type, primary_party = party_link.primary_role, party_link.primary_party
2239
2240 primary_account = get_party_account(primary_party_type, primary_party, self.company)
2241 secondary_account = get_party_account(secondary_party_type, secondary_party, self.company)
2242
Ankush Menat494bd9e2022-03-28 18:52:46 +05302243 jv = frappe.new_doc("Journal Entry")
2244 jv.voucher_type = "Journal Entry"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302245 jv.posting_date = self.posting_date
2246 jv.company = self.company
Ankush Menat494bd9e2022-03-28 18:52:46 +05302247 jv.remark = "Adjustment for {} {}".format(self.doctype, self.name)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302248
2249 reconcilation_entry = frappe._dict()
2250 advance_entry = frappe._dict()
Saqib Ansari977b09b2021-08-19 17:57:30 +05302251
2252 reconcilation_entry.account = secondary_account
2253 reconcilation_entry.party_type = secondary_party_type
2254 reconcilation_entry.party = secondary_party
2255 reconcilation_entry.reference_type = self.doctype
2256 reconcilation_entry.reference_name = self.name
Deepesh Gargf88431a2023-04-25 20:54:22 +05302257 reconcilation_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(
2258 self.company
2259 )
Saqib Ansari977b09b2021-08-19 17:57:30 +05302260
2261 advance_entry.account = primary_account
2262 advance_entry.party_type = primary_party_type
2263 advance_entry.party = primary_party
Deepesh Gargf88431a2023-04-25 20:54:22 +05302264 advance_entry.cost_center = self.cost_center or erpnext.get_default_cost_center(self.company)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302265 advance_entry.is_advance = "Yes"
Saqib Ansari977b09b2021-08-19 17:57:30 +05302266
Ankush Menat494bd9e2022-03-28 18:52:46 +05302267 if self.doctype == "Sales Invoice":
Saqib Ansari977b09b2021-08-19 17:57:30 +05302268 reconcilation_entry.credit_in_account_currency = self.outstanding_amount
2269 advance_entry.debit_in_account_currency = self.outstanding_amount
2270 else:
2271 advance_entry.credit_in_account_currency = self.outstanding_amount
2272 reconcilation_entry.debit_in_account_currency = self.outstanding_amount
2273
Ankush Menat494bd9e2022-03-28 18:52:46 +05302274 jv.append("accounts", reconcilation_entry)
2275 jv.append("accounts", advance_entry)
Saqib Ansari977b09b2021-08-19 17:57:30 +05302276
2277 jv.save()
2278 jv.submit()
2279
Deepesh Gargd05d1532022-06-14 12:50:49 +05302280 def check_conversion_rate(self):
2281 default_currency = erpnext.get_company_currency(self.company)
2282 if not default_currency:
2283 throw(_("Please enter default currency in Company Master"))
2284 if (
2285 (self.currency == default_currency and flt(self.conversion_rate) != 1.00)
2286 or not self.conversion_rate
2287 or (self.currency != default_currency and flt(self.conversion_rate) == 1.00)
2288 ):
2289 throw(_("Conversion rate cannot be 0 or 1"))
2290
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002291 def check_finance_books(self, item, asset):
Nabin Haitfefe9502022-09-09 14:40:36 +05302292 if (
2293 len(asset.finance_books) > 1
2294 and not item.get("finance_book")
2295 and not self.get("finance_book")
2296 and asset.finance_books[0].finance_book
2297 ):
2298 frappe.throw(
2299 _("Select finance book for the item {0} at row {1}").format(item.item_code, item.idx)
2300 )
Saif Ur Rehman7a5d75b2021-09-13 23:01:52 +05002301
Gursheen Anand68effd92023-09-21 17:28:07 +05302302 def check_if_fields_updated(self, fields_to_check, child_tables):
2303 # Check if any field affecting accounting entry is altered
2304 doc_before_update = self.get_doc_before_save()
2305 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
2306
2307 # Check if opening entry check updated
2308 needs_repost = doc_before_update.get("is_opening") != self.is_opening
2309
2310 if not needs_repost:
2311 # Parent Level Accounts excluding party account
2312 fields_to_check += accounting_dimensions
2313 for field in fields_to_check:
2314 if doc_before_update.get(field) != self.get(field):
2315 needs_repost = 1
2316 break
2317
2318 if not needs_repost:
2319 # Check for child tables
2320 for table in child_tables:
2321 needs_repost = check_if_child_table_updated(
2322 doc_before_update.get(table), self.get(table), child_tables[table]
2323 )
2324 if needs_repost:
2325 break
2326
2327 return needs_repost
2328
2329 @frappe.whitelist()
2330 def repost_accounting_entries(self):
2331 if self.repost_required:
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302332 repost_ledger = frappe.new_doc("Repost Accounting Ledger")
2333 repost_ledger.company = self.company
2334 repost_ledger.append("vouchers", {"voucher_type": self.doctype, "voucher_no": self.name})
Gursheen Kaur Anand1b808e12023-11-02 14:01:26 +05302335 repost_ledger.flags.ignore_permissions = True
Gursheen Anand7ebf0832023-09-23 19:13:33 +05302336 repost_ledger.insert()
2337 repost_ledger.submit()
Gursheen Anand68effd92023-09-21 17:28:07 +05302338 self.db_set("repost_required", 0)
2339 else:
2340 frappe.throw(_("No updates pending for reposting"))
2341
Ankush Menat494bd9e2022-03-28 18:52:46 +05302342
Rushabh Mehta793ba6b2014-02-14 15:47:51 +05302343@frappe.whitelist()
Rushabh Mehtaf56d73c2013-10-10 16:35:09 +05302344def get_tax_rate(account_head):
Daizy Modi4efc9472022-11-07 09:21:03 +05302345 return frappe.get_cached_value(
2346 "Account", account_head, ["tax_rate", "account_name"], as_dict=True
2347 )
Rushabh Mehtaa33d4682015-06-01 17:15:42 +05302348
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002349
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302350@frappe.whitelist()
Nabin Haita2426fc2018-01-15 17:45:46 +05302351def get_default_taxes_and_charges(master_doctype, tax_template=None, company=None):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302352 if not company:
2353 return {}
rohitwaghchaure505661b2017-12-11 14:52:28 +05302354
Nabin Haita2426fc2018-01-15 17:45:46 +05302355 if tax_template and company:
Daizy Modi4efc9472022-11-07 09:21:03 +05302356 tax_template_company = frappe.get_cached_value(master_doctype, tax_template, "company")
Nabin Haita2426fc2018-01-15 17:45:46 +05302357 if tax_template_company == company:
2358 return
2359
2360 default_tax = frappe.db.get_value(master_doctype, {"is_default": 1, "company": company})
rohitwaghchaure505661b2017-12-11 14:52:28 +05302361
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302362 return {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302363 "taxes_and_charges": default_tax,
2364 "taxes": get_taxes_and_charges(master_doctype, default_tax),
Rushabh Mehta98aa5812017-11-14 09:32:32 +05302365 }
Nabin Hait6b039142014-05-02 15:45:10 +05302366
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002367
Nabin Hait6b039142014-05-02 15:45:10 +05302368@frappe.whitelist()
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302369def get_taxes_and_charges(master_doctype, master_name):
Nabin Hait1fe50122015-05-16 12:14:39 +05302370 if not master_name:
2371 return
Ankush Menat77dcdff2022-06-01 22:01:07 +05302372 from frappe.model import child_table_fields, default_fields
Ankush Menat494bd9e2022-03-28 18:52:46 +05302373
Nabin Hait6b039142014-05-02 15:45:10 +05302374 tax_master = frappe.get_doc(master_doctype, master_name)
2375
2376 taxes_and_charges = []
Nabin Haitffc7f3f2015-05-12 15:07:02 +05302377 for i, tax in enumerate(tax_master.get("taxes")):
Nabin Hait6b039142014-05-02 15:45:10 +05302378 tax = tax.as_dict()
2379
Ankush Menat77dcdff2022-06-01 22:01:07 +05302380 for fieldname in default_fields + child_table_fields:
Nabin Hait6b039142014-05-02 15:45:10 +05302381 if fieldname in tax:
2382 del tax[fieldname]
2383
2384 taxes_and_charges.append(tax)
2385
2386 return taxes_and_charges
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302387
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002388
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302389def validate_conversion_rate(currency, conversion_rate, conversion_rate_label, company):
2390 """common validation for currency and price list currency"""
2391
Ankush Menat494bd9e2022-03-28 18:52:46 +05302392 company_currency = frappe.get_cached_value("Company", company, "default_currency")
Rushabh Mehta66e08e32014-09-29 12:17:03 +05302393
2394 if not conversion_rate:
Saqib60212ff2020-10-26 11:17:04 +05302395 throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302396 _("{0} is mandatory. Maybe Currency Exchange record is not created for {1} to {2}.").format(
2397 conversion_rate_label, currency, company_currency
2398 )
Saqib60212ff2020-10-26 11:17:04 +05302399 )
Nabin Hait613d0812015-02-23 11:58:15 +05302400
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002401
Nabin Hait613d0812015-02-23 11:58:15 +05302402def validate_taxes_and_charges(tax):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302403 if tax.charge_type in ["Actual", "On Net Total", "On Paid Amount"] and tax.row_id:
2404 frappe.throw(
2405 _("Can refer row only if the charge type is 'On Previous Row Amount' or 'Previous Row Total'")
2406 )
2407 elif tax.charge_type in ["On Previous Row Amount", "On Previous Row Total"]:
Nabin Hait613d0812015-02-23 11:58:15 +05302408 if cint(tax.idx) == 1:
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002409 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05302410 _(
2411 "Cannot select charge type as 'On Previous Row Amount' or 'On Previous Row Total' for first row"
2412 )
2413 )
Nabin Hait613d0812015-02-23 11:58:15 +05302414 elif not tax.row_id:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302415 frappe.throw(
2416 _("Please specify a valid Row ID for row {0} in table {1}").format(tax.idx, _(tax.doctype))
2417 )
Nabin Hait613d0812015-02-23 11:58:15 +05302418 elif tax.row_id and cint(tax.row_id) >= cint(tax.idx):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302419 frappe.throw(
2420 _("Cannot refer row number greater than or equal to current row number for this Charge type")
2421 )
Nabin Hait613d0812015-02-23 11:58:15 +05302422
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302423 if tax.charge_type == "Actual":
Nabin Haitbc6c3602015-02-27 23:40:56 +05302424 tax.rate = None
Rushabh Mehta2a21bc92015-02-25 15:08:42 +05302425
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002426
Ankush Menat494bd9e2022-03-28 18:52:46 +05302427def validate_account_head(idx, account, company, context=""):
2428 account_company = frappe.get_cached_value("Account", account, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302429
Deepesh Garg5a2b5712022-02-18 20:05:49 +05302430 if account_company != company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302431 frappe.throw(
2432 _("Row {0}: {3} Account {1} does not belong to Company {2}").format(
2433 idx, frappe.bold(account), frappe.bold(company), context
2434 ),
2435 title=_("Invalid Account"),
2436 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302437
2438
2439def validate_cost_center(tax, doc):
2440 if not tax.cost_center:
2441 return
2442
Ankush Menat494bd9e2022-03-28 18:52:46 +05302443 company = frappe.get_cached_value("Cost Center", tax.cost_center, "company")
Anuja Pawar0e337be2021-08-10 17:26:35 +05302444
2445 if company != doc.company:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302446 frappe.throw(
2447 _("Row {0}: Cost Center {1} does not belong to Company {2}").format(
2448 tax.idx, frappe.bold(tax.cost_center), frappe.bold(doc.company)
2449 ),
2450 title=_("Invalid Cost Center"),
2451 )
Anuja Pawar0e337be2021-08-10 17:26:35 +05302452
2453
Nabin Hait613d0812015-02-23 11:58:15 +05302454def validate_inclusive_tax(tax, doc):
2455 def _on_previous_row_error(row_range):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302456 throw(
2457 _("To include tax in row {0} in Item rate, taxes in rows {1} must also be included").format(
2458 tax.idx, row_range
2459 )
2460 )
Nabin Hait613d0812015-02-23 11:58:15 +05302461
2462 if cint(getattr(tax, "included_in_print_rate", None)):
2463 if tax.charge_type == "Actual":
2464 # inclusive tax cannot be of type Actual
Ankush Menat494bd9e2022-03-28 18:52:46 +05302465 throw(
2466 _("Charge of type 'Actual' in row {0} cannot be included in Item Rate or Paid Amount").format(
2467 tax.idx
2468 )
2469 )
2470 elif tax.charge_type == "On Previous Row Amount" and not cint(
2471 doc.get("taxes")[cint(tax.row_id) - 1].included_in_print_rate
2472 ):
Nabin Hait613d0812015-02-23 11:58:15 +05302473 # referred row should also be inclusive
2474 _on_previous_row_error(tax.row_id)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302475 elif tax.charge_type == "On Previous Row Total" and not all(
2476 [cint(t.included_in_print_rate) for t in doc.get("taxes")[: cint(tax.row_id) - 1]]
2477 ):
Deepesh Garg5ef9a622021-06-14 14:34:44 +05302478 # all rows about the referred tax should be inclusive
Nabin Hait613d0812015-02-23 11:58:15 +05302479 _on_previous_row_error("1 - %d" % (tax.row_id,))
Nabin Hait93b3a372015-02-24 17:08:34 +05302480 elif tax.get("category") == "Valuation":
Nabin Hait19ea7212020-08-11 20:34:57 +05302481 frappe.throw(_("Valuation type charges can not be marked as Inclusive"))
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302482
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302483
Ankush Menat494bd9e2022-03-28 18:52:46 +05302484def set_balance_in_account_currency(
2485 gl_dict, account_currency=None, conversion_rate=None, company_currency=None
2486):
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002487 if (not conversion_rate) and (account_currency != company_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302488 frappe.throw(
2489 _("Account: {0} with currency: {1} can not be selected").format(
2490 gl_dict.account, account_currency
2491 )
2492 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002493
Ankush Menat494bd9e2022-03-28 18:52:46 +05302494 gl_dict["account_currency"] = (
2495 company_currency if account_currency == company_currency else account_currency
2496 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302497
2498 # set debit/credit in account currency if not provided
2499 if flt(gl_dict.debit) and not flt(gl_dict.debit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302500 gl_dict.debit_in_account_currency = (
2501 gl_dict.debit
2502 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302503 else flt(gl_dict.debit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302504 )
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302505
2506 if flt(gl_dict.credit) and not flt(gl_dict.credit_in_account_currency):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302507 gl_dict.credit_in_account_currency = (
2508 gl_dict.credit
2509 if account_currency == company_currency
Revant Nandgaonkar5da941b2016-02-18 16:02:05 +05302510 else flt(gl_dict.credit / conversion_rate, 2)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302511 )
Nabin Hait1991c7b2016-06-27 20:09:05 +05302512
2513
Ankush Menat494bd9e2022-03-28 18:52:46 +05302514def get_advance_journal_entries(
2515 party_type,
2516 party,
2517 party_account,
2518 amount_field,
2519 order_doctype,
2520 order_list,
2521 include_unallocated=True,
2522):
Gursheen Anand4ee16372023-06-08 13:15:23 +05302523 journal_entry = frappe.qb.DocType("Journal Entry")
2524 journal_acc = frappe.qb.DocType("Journal Entry Account")
2525 q = (
2526 frappe.qb.from_(journal_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302527 .inner_join(journal_acc)
2528 .on(journal_entry.name == journal_acc.parent)
2529 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302530 ConstantColumn("Journal Entry").as_("reference_type"),
2531 (journal_entry.name).as_("reference_name"),
2532 (journal_entry.remark).as_("remarks"),
Deepesh Garg3aead052023-06-22 11:41:43 +05302533 (journal_acc[amount_field]).as_("amount"),
Gursheen Anand4ee16372023-06-08 13:15:23 +05302534 (journal_acc.name).as_("reference_row"),
2535 (journal_acc.reference_name).as_("against_order"),
2536 (journal_acc.exchange_rate),
Gursheen Anand74619262023-06-02 17:13:51 +05302537 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302538 .where(
2539 journal_acc.account.isin(party_account)
2540 & (journal_acc.party_type == party_type)
2541 & (journal_acc.party == party)
2542 & (journal_acc.is_advance == "Yes")
2543 & (journal_entry.docstatus == 1)
2544 )
2545 )
Gursheen Anand74619262023-06-02 17:13:51 +05302546 if party_type == "Customer":
2547 q = q.where(journal_acc.credit_in_account_currency > 0)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302548
Gursheen Anand4ee16372023-06-08 13:15:23 +05302549 else:
2550 q = q.where(journal_acc.debit_in_account_currency > 0)
2551
Deepesh Garg3aead052023-06-22 11:41:43 +05302552 if include_unallocated:
2553 q = q.where((journal_acc.reference_name.isnull()) | (journal_acc.reference_name == ""))
2554
Nabin Hait1991c7b2016-06-27 20:09:05 +05302555 if order_list:
Deepesh Garg3aead052023-06-22 11:41:43 +05302556 q = q.where(
Deepesh Garg6d121ae2023-06-22 13:03:09 +05302557 (journal_acc.reference_type == order_doctype) & ((journal_acc.reference_type).isin(order_list))
Deepesh Garg3aead052023-06-22 11:41:43 +05302558 )
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302559
Gursheen Anand74619262023-06-02 17:13:51 +05302560 q = q.orderby(journal_entry.posting_date)
Rushabh Mehta66958302017-01-16 16:57:53 +05302561
Gursheen Anand74619262023-06-02 17:13:51 +05302562 journal_entries = q.run(as_dict=True)
Nabin Hait1991c7b2016-06-27 20:09:05 +05302563 return list(journal_entries)
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302564
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002565
Smit Vora3e282bf2023-09-19 20:47:21 +05302566@erpnext.allow_regional
2567def get_advance_payment_entries_for_regional(*args, **kwargs):
2568 return get_advance_payment_entries(*args, **kwargs)
2569
2570
Ankush Menat494bd9e2022-03-28 18:52:46 +05302571def get_advance_payment_entries(
2572 party_type,
2573 party,
2574 party_account,
2575 order_doctype,
2576 order_list=None,
2577 include_unallocated=True,
2578 against_all_orders=False,
2579 limit=None,
2580 condition=None,
2581):
Gursheen Anand74619262023-06-02 17:13:51 +05302582
Deepesh Garg92f845c2023-06-21 12:21:19 +05302583 payment_entries = []
2584 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand74619262023-06-02 17:13:51 +05302585
Deepesh Garg92f845c2023-06-21 12:21:19 +05302586 if order_list or against_all_orders:
2587 q = get_common_query(
2588 party_type,
2589 party,
2590 party_account,
2591 limit,
2592 condition,
2593 )
2594 payment_ref = frappe.qb.DocType("Payment Entry Reference")
Gursheen Anand74619262023-06-02 17:13:51 +05302595
Deepesh Garg92f845c2023-06-21 12:21:19 +05302596 q = q.inner_join(payment_ref).on(payment_entry.name == payment_ref.parent)
2597 q = q.select(
2598 (payment_ref.allocated_amount).as_("amount"),
2599 (payment_ref.name).as_("reference_row"),
2600 (payment_ref.reference_name).as_("against_order"),
Deepesh Garg92f845c2023-06-21 12:21:19 +05302601 )
2602
Deepesh Garg3aead052023-06-22 11:41:43 +05302603 q = q.where(payment_ref.reference_doctype == order_doctype)
Deepesh Garg92f845c2023-06-21 12:21:19 +05302604 if order_list:
2605 q = q.where(payment_ref.reference_name.isin(order_list))
2606
2607 allocated = list(q.run(as_dict=True))
2608 payment_entries += allocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302609 if include_unallocated:
2610 q = get_common_query(
2611 party_type,
2612 party,
2613 party_account,
2614 limit,
2615 condition,
2616 )
2617 q = q.select((payment_entry.unallocated_amount).as_("amount"))
2618 q = q.where(payment_entry.unallocated_amount > 0)
2619
2620 unallocated = list(q.run(as_dict=True))
2621 payment_entries += unallocated
Deepesh Garg92f845c2023-06-21 12:21:19 +05302622 return payment_entries
Gursheen Anand74619262023-06-02 17:13:51 +05302623
Saqiba20999c2021-07-12 14:33:23 +05302624
Deepesh Garg92f845c2023-06-21 12:21:19 +05302625def get_common_query(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302626 party_type,
2627 party,
2628 party_account,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302629 limit,
2630 condition,
2631):
RitvikSardanad2f03c82023-09-05 12:00:54 +05302632 account_type = frappe.db.get_value("Party Type", party_type, "account_type")
2633 payment_type = "Receive" if account_type == "Receivable" else "Pay"
Gursheen Anand4ee16372023-06-08 13:15:23 +05302634 payment_entry = frappe.qb.DocType("Payment Entry")
Gursheen Anand4ee16372023-06-08 13:15:23 +05302635
2636 q = (
2637 frappe.qb.from_(payment_entry)
Gursheen Anand74619262023-06-02 17:13:51 +05302638 .select(
Gursheen Anand4ee16372023-06-08 13:15:23 +05302639 ConstantColumn("Payment Entry").as_("reference_type"),
2640 (payment_entry.name).as_("reference_name"),
Gursheen Anand74619262023-06-02 17:13:51 +05302641 payment_entry.posting_date,
Gursheen Anand4ee16372023-06-08 13:15:23 +05302642 (payment_entry.remarks).as_("remarks"),
Ankush Menat494bd9e2022-03-28 18:52:46 +05302643 )
Gursheen Anand74619262023-06-02 17:13:51 +05302644 .where(payment_entry.payment_type == payment_type)
2645 .where(payment_entry.party_type == party_type)
2646 .where(payment_entry.party == party)
2647 .where(payment_entry.docstatus == 1)
2648 )
Gursheen Anand4ee16372023-06-08 13:15:23 +05302649
RitvikSardanad2f03c82023-09-05 12:00:54 +05302650 if payment_type == "Receive":
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302651 q = q.select((payment_entry.paid_from_account_currency).as_("currency"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302652 q = q.select(payment_entry.paid_from)
2653 q = q.where(payment_entry.paid_from.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302654 else:
Deepesh Gargb64ebc62023-06-21 17:49:45 +05302655 q = q.select((payment_entry.paid_to_account_currency).as_("currency"))
Gursheen Anand74619262023-06-02 17:13:51 +05302656 q = q.select(payment_entry.paid_to)
Gursheen Anand4ee16372023-06-08 13:15:23 +05302657 q = q.where(payment_entry.paid_to.isin(party_account))
Gursheen Anand74619262023-06-02 17:13:51 +05302658
2659 if payment_type == "Receive":
Deepesh Garg92f845c2023-06-21 12:21:19 +05302660 q = q.select((payment_entry.source_exchange_rate).as_("exchange_rate"))
Gursheen Anand4ee16372023-06-08 13:15:23 +05302661 else:
Deepesh Garg92f845c2023-06-21 12:21:19 +05302662 q = q.select((payment_entry.target_exchange_rate).as_("exchange_rate"))
Rushabh Mehtaea0ff232016-07-07 14:02:26 +05302663
Deepesh Garg92f845c2023-06-21 12:21:19 +05302664 if condition:
ruthra kumar86bac2c2023-07-04 09:02:05 +05302665 if condition.get("name", None):
2666 q = q.where(payment_entry.name.like(f"%{condition.get('name')}%"))
2667
Deepesh Garg92f845c2023-06-21 12:21:19 +05302668 q = q.where(payment_entry.company == condition["company"])
2669 q = (
2670 q.where(payment_entry.posting_date >= condition["from_payment_date"])
2671 if condition.get("from_payment_date")
2672 else q
Gursheen Anand74619262023-06-02 17:13:51 +05302673 )
Deepesh Garg92f845c2023-06-21 12:21:19 +05302674 q = (
2675 q.where(payment_entry.posting_date <= condition["to_payment_date"])
2676 if condition.get("to_payment_date")
2677 else q
2678 )
2679 if condition.get("get_payments") == True:
2680 q = (
2681 q.where(payment_entry.cost_center == condition["cost_center"])
2682 if condition.get("cost_center")
2683 else q
2684 )
2685 q = (
2686 q.where(payment_entry.unallocated_amount >= condition["minimum_payment_amount"])
2687 if condition.get("minimum_payment_amount")
2688 else q
2689 )
2690 q = (
2691 q.where(payment_entry.unallocated_amount <= condition["maximum_payment_amount"])
2692 if condition.get("maximum_payment_amount")
2693 else q
2694 )
2695 else:
2696 q = (
2697 q.where(payment_entry.total_debit >= condition["minimum_payment_amount"])
2698 if condition.get("minimum_payment_amount")
2699 else q
2700 )
2701 q = (
2702 q.where(payment_entry.total_debit <= condition["maximum_payment_amount"])
2703 if condition.get("maximum_payment_amount")
2704 else q
2705 )
Gursheen Anand74619262023-06-02 17:13:51 +05302706
2707 q = q.orderby(payment_entry.posting_date)
2708 q = q.limit(limit) if limit else q
Deepesh Garg92f845c2023-06-21 12:21:19 +05302709
Gursheen Anand74619262023-06-02 17:13:51 +05302710 return q
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302711
Ankush Menat494bd9e2022-03-28 18:52:46 +05302712
Rohit Waghchaure2f1db572016-11-08 12:39:33 +05302713def update_invoice_status():
Sagar Vorac8b9a552021-09-22 12:11:35 +05302714 """Updates status as Overdue for applicable invoices. Runs daily."""
Sagar Vora8d9d0982021-10-20 19:15:35 +05302715 today = getdate()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302716 payment_schedule = frappe.qb.DocType("Payment Schedule")
Sagar Vorac8b9a552021-09-22 12:11:35 +05302717 for doctype in ("Sales Invoice", "Purchase Invoice"):
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302718 invoice = frappe.qb.DocType(doctype)
2719
2720 consider_base_amount = invoice.party_account_currency != invoice.currency
2721 payment_amount = (
2722 frappe.qb.terms.Case()
2723 .when(consider_base_amount, payment_schedule.base_payment_amount)
2724 .else_(payment_schedule.payment_amount)
Sagar Vora8d9d0982021-10-20 19:15:35 +05302725 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002726
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302727 payable_amount = (
2728 frappe.qb.from_(payment_schedule)
2729 .select(Sum(payment_amount))
Ankush Menat494bd9e2022-03-28 18:52:46 +05302730 .where((payment_schedule.parent == invoice.name) & (payment_schedule.due_date < today))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302731 )
2732
2733 total = (
2734 frappe.qb.terms.Case()
2735 .when(invoice.disable_rounded_total, invoice.grand_total)
2736 .else_(invoice.rounded_total)
2737 )
2738
2739 base_total = (
2740 frappe.qb.terms.Case()
2741 .when(invoice.disable_rounded_total, invoice.base_grand_total)
2742 .else_(invoice.base_rounded_total)
2743 )
2744
Ankush Menat494bd9e2022-03-28 18:52:46 +05302745 total_amount = frappe.qb.terms.Case().when(consider_base_amount, base_total).else_(total)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302746
2747 is_overdue = total_amount - invoice.outstanding_amount < payable_amount
2748
2749 conditions = (
2750 (invoice.docstatus == 1)
2751 & (invoice.outstanding_amount > 0)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302752 & (invoice.status.like("Unpaid%") | invoice.status.like("Partly Paid%"))
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302753 & (
Pruthvi Patel16a90d32021-12-20 13:24:19 +05302754 ((invoice.is_pos & invoice.due_date < today) | is_overdue)
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302755 if doctype == "Sales Invoice"
2756 else is_overdue
2757 )
2758 )
2759
Pruthvi Patel0799f372021-11-12 12:56:29 +05302760 status = (
2761 frappe.qb.terms.Case()
2762 .when(invoice.status.like("%Discounted"), "Overdue and Discounted")
2763 .else_("Overdue")
2764 )
2765
2766 frappe.qb.update(invoice).set("status", status).where(conditions).run()
Pruthvi Patel6c96ed42021-10-30 16:44:15 +05302767
2768
Nabin Hait92759692017-08-15 08:23:51 +05302769@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302770def get_payment_terms(
2771 terms_template, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2772):
Nabin Hait92759692017-08-15 08:23:51 +05302773 if not terms_template:
2774 return
2775
2776 terms_doc = frappe.get_doc("Payment Terms Template", terms_template)
2777
2778 schedule = []
tundefb144302017-08-19 15:01:40 +01002779 for d in terms_doc.get("terms"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302780 term_details = get_payment_term_details(
2781 d, posting_date, grand_total, base_grand_total, bill_date
2782 )
Nabin Hait92759692017-08-15 08:23:51 +05302783 schedule.append(term_details)
2784
2785 return schedule
2786
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08002787
Nabin Hait92759692017-08-15 08:23:51 +05302788@frappe.whitelist()
Ankush Menat494bd9e2022-03-28 18:52:46 +05302789def get_payment_term_details(
2790 term, posting_date=None, grand_total=None, base_grand_total=None, bill_date=None
2791):
Nabin Hait92759692017-08-15 08:23:51 +05302792 term_details = frappe._dict()
Ankush Menat8fe5feb2021-11-04 19:48:32 +05302793 if isinstance(term, str):
Nabin Hait92759692017-08-15 08:23:51 +05302794 term = frappe.get_doc("Payment Term", term)
2795 else:
2796 term_details.payment_term = term.payment_term
2797 term_details.description = term.description
2798 term_details.invoice_portion = term.invoice_portion
Rohit Waghchaure52bf56d2017-11-27 11:43:52 +05302799 term_details.payment_amount = flt(term.invoice_portion) * flt(grand_total) / 100
Saqib Ansarid552fe62021-04-23 14:46:52 +05302800 term_details.base_payment_amount = flt(term.invoice_portion) * flt(base_grand_total) / 100
Saqib0586b7d2021-03-31 15:03:53 +05302801 term_details.discount_type = term.discount_type
2802 term_details.discount = term.discount
Saqib0586b7d2021-03-31 15:03:53 +05302803 term_details.outstanding = term_details.payment_amount
2804 term_details.mode_of_payment = term.mode_of_payment
2805
Shreya Shah3a9eec22018-02-16 13:05:21 +05302806 if bill_date:
2807 term_details.due_date = get_due_date(term, bill_date)
Saqib0586b7d2021-03-31 15:03:53 +05302808 term_details.discount_date = get_discount_date(term, bill_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302809 elif posting_date:
2810 term_details.due_date = get_due_date(term, posting_date)
Saqib0586b7d2021-03-31 15:03:53 +05302811 term_details.discount_date = get_discount_date(term, posting_date)
Shreya Shah3a9eec22018-02-16 13:05:21 +05302812
2813 if getdate(term_details.due_date) < getdate(posting_date):
2814 term_details.due_date = posting_date
2815
Nabin Hait92759692017-08-15 08:23:51 +05302816 return term_details
2817
Ankush Menat494bd9e2022-03-28 18:52:46 +05302818
Shreya Shah3a9eec22018-02-16 13:05:21 +05302819def get_due_date(term, posting_date=None, bill_date=None):
Nabin Hait92759692017-08-15 08:23:51 +05302820 due_date = None
Shreya Shah3a9eec22018-02-16 13:05:21 +05302821 date = bill_date or posting_date
Nabin Hait92759692017-08-15 08:23:51 +05302822 if term.due_date_based_on == "Day(s) after invoice date":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302823 due_date = add_days(date, term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302824 elif term.due_date_based_on == "Day(s) after the end of the invoice month":
Shreya Shah3a9eec22018-02-16 13:05:21 +05302825 due_date = add_days(get_last_day(date), term.credit_days)
Nabin Hait92759692017-08-15 08:23:51 +05302826 elif term.due_date_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302827 due_date = get_last_day(add_months(date, term.credit_months))
tunde96b8f222017-09-08 15:35:59 +01002828 return due_date
tundebabzyad08d4c2018-05-16 07:01:41 +01002829
Ankush Menat494bd9e2022-03-28 18:52:46 +05302830
Saqib0586b7d2021-03-31 15:03:53 +05302831def get_discount_date(term, posting_date=None, bill_date=None):
2832 discount_validity = None
2833 date = bill_date or posting_date
2834 if term.discount_validity_based_on == "Day(s) after invoice date":
2835 discount_validity = add_days(date, term.discount_validity)
2836 elif term.discount_validity_based_on == "Day(s) after the end of the invoice month":
2837 discount_validity = add_days(get_last_day(date), term.discount_validity)
2838 elif term.discount_validity_based_on == "Month(s) after the end of the invoice month":
Deepesh Gargbfb81ef2022-11-30 20:53:41 +05302839 discount_validity = get_last_day(add_months(date, term.discount_validity))
Saqib0586b7d2021-03-31 15:03:53 +05302840 return discount_validity
tundebabzyad08d4c2018-05-16 07:01:41 +01002841
Ankush Menat494bd9e2022-03-28 18:52:46 +05302842
tundebabzyad08d4c2018-05-16 07:01:41 +01002843def get_supplier_block_status(party_name):
2844 """
2845 Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
2846 a `Supplier`
2847 """
Ankush Menat494bd9e2022-03-28 18:52:46 +05302848 supplier = frappe.get_doc("Supplier", party_name)
tundebabzyad08d4c2018-05-16 07:01:41 +01002849 info = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302850 "on_hold": supplier.on_hold,
2851 "release_date": supplier.release_date,
2852 "hold_type": supplier.hold_type,
tundebabzyad08d4c2018-05-16 07:01:41 +01002853 }
2854 return info
2855
Ankush Menat494bd9e2022-03-28 18:52:46 +05302856
marination698d9832020-08-19 14:59:46 +05302857def set_child_tax_template_and_map(item, child_item, parent_doc):
2858 args = {
Ankush Menat494bd9e2022-03-28 18:52:46 +05302859 "item_code": item.item_code,
2860 "posting_date": parent_doc.transaction_date,
2861 "tax_category": parent_doc.get("tax_category"),
2862 "company": parent_doc.get("company"),
2863 }
marination698d9832020-08-19 14:59:46 +05302864
2865 child_item.item_tax_template = _get_item_tax_template(args, item.taxes)
2866 if child_item.get("item_tax_template"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302867 child_item.item_tax_rate = get_item_tax_map(
2868 parent_doc.get("company"), child_item.item_tax_template, as_json=True
2869 )
2870
marination698d9832020-08-19 14:59:46 +05302871
Afshanb3bbebd2021-08-09 14:39:32 +05302872def add_taxes_from_tax_template(child_item, parent_doc, db_insert=True):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302873 add_taxes_from_item_tax_template = frappe.db.get_single_value(
2874 "Accounts Settings", "add_taxes_from_item_tax_template"
2875 )
Marica3b1be2b2020-10-22 17:04:31 +05302876
2877 if child_item.get("item_tax_rate") and add_taxes_from_item_tax_template:
2878 tax_map = json.loads(child_item.get("item_tax_rate"))
2879 for tax_type in tax_map:
2880 tax_rate = flt(tax_map[tax_type])
Ankush Menat494bd9e2022-03-28 18:52:46 +05302881 taxes = parent_doc.get("taxes") or []
Marica3b1be2b2020-10-22 17:04:31 +05302882 # add new row for tax head only if missing
2883 found = any(tax.account_head == tax_type for tax in taxes)
2884 if not found:
2885 tax_row = parent_doc.append("taxes", {})
Ankush Menat494bd9e2022-03-28 18:52:46 +05302886 tax_row.update(
2887 {
2888 "description": str(tax_type).split(" - ")[0],
2889 "charge_type": "On Net Total",
2890 "account_head": tax_type,
2891 "rate": tax_rate,
2892 }
2893 )
Marica3b1be2b2020-10-22 17:04:31 +05302894 if parent_doc.doctype == "Purchase Order":
Ankush Menat494bd9e2022-03-28 18:52:46 +05302895 tax_row.update({"category": "Total", "add_deduct_tax": "Add"})
Afshanb3bbebd2021-08-09 14:39:32 +05302896 if db_insert:
2897 tax_row.db_insert()
Marica3b1be2b2020-10-22 17:04:31 +05302898
Ankush Menat494bd9e2022-03-28 18:52:46 +05302899
2900def set_order_defaults(
2901 parent_doctype, parent_doctype_name, child_doctype, child_docname, trans_item
2902):
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002903 """
pateljannat637ddff2021-02-09 16:17:30 +05302904 Returns a Sales/Purchase Order Item child item containing the default values
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002905 """
Saqib438e0432020-04-03 10:02:56 +05302906 p_doc = frappe.get_doc(parent_doctype, parent_doctype_name)
Ankush Menat686685b2023-05-31 12:50:14 +05302907 child_item = frappe.new_doc(child_doctype, parent_doc=p_doc, parentfield=child_docname)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302908 item = frappe.get_doc("Item", trans_item.get("item_code"))
marination0673f552021-03-31 01:38:22 +05302909
pateljannat637ddff2021-02-09 16:17:30 +05302910 for field in ("item_code", "item_name", "description", "item_group"):
marination0673f552021-03-31 01:38:22 +05302911 child_item.update({field: item.get(field)})
2912
pateljannat637ddff2021-02-09 16:17:30 +05302913 date_fieldname = "delivery_date" if child_doctype == "Sales Order Item" else "schedule_date"
Jannat Patelbb0d8f82021-02-11 20:59:28 +05302914 child_item.update({date_fieldname: trans_item.get(date_fieldname) or p_doc.get(date_fieldname)})
marination0673f552021-03-31 01:38:22 +05302915 child_item.stock_uom = item.stock_uom
Saqib61314242020-09-15 11:14:31 +05302916 child_item.uom = trans_item.get("uom") or item.stock_uom
Andy Zhu1062d7e2020-10-06 10:51:42 +13002917 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
Ankush Menat494bd9e2022-03-28 18:52:46 +05302918 conversion_factor = flt(
2919 get_conversion_factor(item.item_code, child_item.uom).get("conversion_factor")
2920 )
2921 child_item.conversion_factor = flt(trans_item.get("conversion_factor")) or conversion_factor
marination0673f552021-03-31 01:38:22 +05302922
pateljannat637ddff2021-02-09 16:17:30 +05302923 if child_doctype == "Purchase Order Item":
marination0673f552021-03-31 01:38:22 +05302924 # Initialized value will update in parent validation
2925 child_item.base_rate = 1
2926 child_item.base_amount = 1
pateljannat637ddff2021-02-09 16:17:30 +05302927 if child_doctype == "Sales Order Item":
2928 child_item.warehouse = get_item_warehouse(item, p_doc, overwrite_warehouse=True)
2929 if not child_item.warehouse:
Ankush Menat494bd9e2022-03-28 18:52:46 +05302930 frappe.throw(
2931 _("Cannot find {} for item {}. Please set the same in Item Master or Stock Settings.").format(
2932 frappe.bold("default warehouse"), frappe.bold(item.item_code)
2933 )
2934 )
marination0673f552021-03-31 01:38:22 +05302935
marination698d9832020-08-19 14:59:46 +05302936 set_child_tax_template_and_map(item, child_item, p_doc)
Marica3b1be2b2020-10-22 17:04:31 +05302937 add_taxes_from_tax_template(child_item, p_doc)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01002938 return child_item
2939
Ankush Menat494bd9e2022-03-28 18:52:46 +05302940
marination0673f552021-03-31 01:38:22 +05302941def validate_child_on_delete(row, parent):
2942 """Check if partially transacted item (row) is being deleted."""
2943 if parent.doctype == "Sales Order":
2944 if flt(row.delivered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302945 frappe.throw(
2946 _("Row #{0}: Cannot delete item {1} which has already been delivered").format(
2947 row.idx, row.item_code
2948 )
2949 )
marination0673f552021-03-31 01:38:22 +05302950 if flt(row.work_order_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302951 frappe.throw(
2952 _("Row #{0}: Cannot delete item {1} which has work order assigned to it.").format(
2953 row.idx, row.item_code
2954 )
2955 )
marination0673f552021-03-31 01:38:22 +05302956 if flt(row.ordered_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302957 frappe.throw(
2958 _("Row #{0}: Cannot delete item {1} which is assigned to customer's purchase order.").format(
2959 row.idx, row.item_code
2960 )
2961 )
marination0673f552021-03-31 01:38:22 +05302962
2963 if parent.doctype == "Purchase Order" and flt(row.received_qty):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302964 frappe.throw(
2965 _("Row #{0}: Cannot delete item {1} which has already been received").format(
2966 row.idx, row.item_code
2967 )
2968 )
marination0673f552021-03-31 01:38:22 +05302969
2970 if flt(row.billed_amt):
Ankush Menat494bd9e2022-03-28 18:52:46 +05302971 frappe.throw(
2972 _("Row #{0}: Cannot delete item {1} which has already been billed.").format(
2973 row.idx, row.item_code
2974 )
2975 )
2976
marination0673f552021-03-31 01:38:22 +05302977
2978def update_bin_on_delete(row, doctype):
2979 """Update bin for deleted item (row)."""
Chillar Anand915b3432021-09-02 16:44:59 +05302980 from erpnext.stock.stock_balance import (
2981 get_indented_qty,
2982 get_ordered_qty,
2983 get_reserved_qty,
2984 update_bin_qty,
2985 )
Ankush Menat494bd9e2022-03-28 18:52:46 +05302986
marination0673f552021-03-31 01:38:22 +05302987 qty_dict = {}
2988
2989 if doctype == "Sales Order":
2990 qty_dict["reserved_qty"] = get_reserved_qty(row.item_code, row.warehouse)
2991 else:
2992 if row.material_request_item:
2993 qty_dict["indented_qty"] = get_indented_qty(row.item_code, row.warehouse)
2994
2995 qty_dict["ordered_qty"] = get_ordered_qty(row.item_code, row.warehouse)
2996
Deepesh Garga61790c2022-02-22 20:58:10 +05302997 if row.warehouse:
2998 update_bin_qty(row.item_code, row.warehouse, qty_dict)
marination0673f552021-03-31 01:38:22 +05302999
Ankush Menat494bd9e2022-03-28 18:52:46 +05303000
Ankush Menatdd11f262022-06-27 15:55:08 +05303001def validate_and_delete_children(parent, data) -> bool:
Saqib0ad74492019-12-24 16:42:30 +05303002 deleted_children = []
3003 updated_item_names = [d.get("docname") for d in data]
3004 for item in parent.items:
3005 if item.name not in updated_item_names:
3006 deleted_children.append(item)
3007
3008 for d in deleted_children:
marination0673f552021-03-31 01:38:22 +05303009 validate_child_on_delete(d, parent)
Saqib0ad74492019-12-24 16:42:30 +05303010 d.cancel()
3011 d.delete()
marination0673f552021-03-31 01:38:22 +05303012
Gursheen Kaur Anand9087e142023-12-02 19:53:00 +05303013 if parent.doctype == "Purchase Order":
3014 parent.update_ordered_qty_in_so_for_removed_items(deleted_children)
3015
marination0673f552021-03-31 01:38:22 +05303016 # need to update ordered qty in Material Request first
3017 # bin uses Material Request Items to recalculate & update
3018 parent.update_prevdoc_status()
3019
3020 for d in deleted_children:
3021 update_bin_on_delete(d, parent.doctype)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003022
Ankush Menatdd11f262022-06-27 15:55:08 +05303023 return bool(deleted_children)
3024
Rohan Bansala93b5142021-04-06 17:10:52 +05303025
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003026@frappe.whitelist()
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003027def update_child_qty_rate(parent_doctype, trans_items, parent_doctype_name, child_docname="items"):
Ankush Menat494bd9e2022-03-28 18:52:46 +05303028 def check_doc_permissions(doc, perm_type="create"):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303029 try:
3030 doc.check_permission(perm_type)
Saqib6db92fb2020-09-14 19:54:17 +05303031 except frappe.PermissionError:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303032 actions = {"create": "add", "write": "update"}
Saqib6db92fb2020-09-14 19:54:17 +05303033
Ankush Menat494bd9e2022-03-28 18:52:46 +05303034 frappe.throw(
3035 _("You do not have permissions to {} items in a {}.").format(
3036 actions[perm_type], parent_doctype
3037 ),
3038 title=_("Insufficient Permissions"),
3039 )
marination665c27a2020-09-15 12:04:38 +05303040
Saqib6db92fb2020-09-14 19:54:17 +05303041 def validate_workflow_conditions(doc):
3042 workflow = get_workflow_name(doc.doctype)
3043 if not workflow:
3044 return
3045
3046 workflow_doc = frappe.get_doc("Workflow", workflow)
3047 current_state = doc.get(workflow_doc.workflow_state_field)
3048 roles = frappe.get_roles()
3049
3050 transitions = []
3051 for transition in workflow_doc.transitions:
3052 if transition.next_state == current_state and transition.allowed in roles:
3053 if not is_transition_condition_satisfied(transition, doc):
3054 continue
3055 transitions.append(transition.as_dict())
3056
3057 if not transitions:
Saqib18318932020-09-23 13:01:49 +05303058 frappe.throw(
Ankush Menat494bd9e2022-03-28 18:52:46 +05303059 _("You are not allowed to update as per the conditions set in {} Workflow.").format(
3060 get_link_to_form("Workflow", workflow)
3061 ),
3062 title=_("Insufficient Permissions"),
Saqib18318932020-09-23 13:01:49 +05303063 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303064
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303065 def get_new_child_item(item_row):
Rohit Waghchaureff70e612021-03-06 22:08:08 +05303066 child_doctype = "Sales Order Item" if parent_doctype == "Sales Order" else "Purchase Order Item"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303067 return set_order_defaults(
3068 parent_doctype, parent_doctype_name, child_doctype, child_docname, item_row
3069 )
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303070
marination0c915432022-05-10 18:04:02 +05303071 def validate_quantity(child_item, new_data):
3072 if not flt(new_data.get("qty")):
3073 frappe.throw(
3074 _("Row # {0}: Quantity for Item {1} cannot be zero").format(
3075 new_data.get("idx"), frappe.bold(new_data.get("item_code"))
3076 ),
3077 title=_("Invalid Qty"),
3078 )
3079
3080 if parent_doctype == "Sales Order" and flt(new_data.get("qty")) < flt(child_item.delivered_qty):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303081 frappe.throw(_("Cannot set quantity less than delivered quantity"))
3082
marination0c915432022-05-10 18:04:02 +05303083 if parent_doctype == "Purchase Order" and flt(new_data.get("qty")) < flt(
3084 child_item.received_qty
3085 ):
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303086 frappe.throw(_("Cannot set quantity less than received quantity"))
3087
Ankush Menatdd11f262022-06-27 15:55:08 +05303088 def should_update_supplied_items(doc) -> bool:
3089 """Subcontracted PO can allow following changes *after submit*:
3090
3091 1. Change rate of subcontracting - regardless of other changes.
3092 2. Change qty and/or add new items and/or remove items
3093 Exception: Transfer/Consumption is already made, qty change not allowed.
3094 """
3095
3096 supplied_items_processed = any(
3097 item.supplied_qty or item.consumed_qty or item.returned_qty for item in doc.supplied_items
3098 )
3099
3100 update_supplied_items = (
3101 any_qty_changed or items_added_or_removed or any_conversion_factor_changed
3102 )
3103 if update_supplied_items and supplied_items_processed:
3104 frappe.throw(_("Item qty can not be updated as raw materials are already processed."))
3105
3106 return update_supplied_items
3107
s-aga-r9588bb72023-08-21 22:23:57 +05303108 def validate_fg_item_for_subcontracting(new_data, is_new):
3109 if is_new:
3110 if not new_data.get("fg_item"):
3111 frappe.throw(
3112 _("Finished Good Item is not specified for service item {0}").format(new_data["item_code"])
3113 )
3114 else:
3115 is_sub_contracted_item, default_bom = frappe.db.get_value(
3116 "Item", new_data["fg_item"], ["is_sub_contracted_item", "default_bom"]
3117 )
3118
3119 if not is_sub_contracted_item:
3120 frappe.throw(
3121 _("Finished Good Item {0} must be a sub-contracted item").format(new_data["fg_item"])
3122 )
3123 elif not default_bom:
3124 frappe.throw(_("Default BOM not found for FG Item {0}").format(new_data["fg_item"]))
3125
3126 if not new_data.get("fg_item_qty"):
3127 frappe.throw(_("Finished Good Item {0} Qty can not be zero").format(new_data["fg_item"]))
3128
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003129 data = json.loads(trans_items)
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003130
Ankush Menatdd11f262022-06-27 15:55:08 +05303131 any_qty_changed = False # updated to true if any item's qty changes
3132 items_added_or_removed = False # updated to true if any new item is added or removed
3133 any_conversion_factor_changed = False
3134
Ankush Menat494bd9e2022-03-28 18:52:46 +05303135 sales_doctypes = ["Sales Order", "Sales Invoice", "Delivery Note", "Quotation"]
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303136 parent = frappe.get_doc(parent_doctype, parent_doctype_name)
marination665c27a2020-09-15 12:04:38 +05303137
Ankush Menat494bd9e2022-03-28 18:52:46 +05303138 check_doc_permissions(parent, "write")
Ankush Menatdd11f262022-06-27 15:55:08 +05303139 _removed_items = validate_and_delete_children(parent, data)
3140 items_added_or_removed |= _removed_items
Saqib0ad74492019-12-24 16:42:30 +05303141
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003142 for d in data:
3143 new_child_flag = False
Ankush Menat6de7b8e2021-08-24 12:18:40 +05303144
3145 if not d.get("item_code"):
3146 # ignore empty rows
3147 continue
3148
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003149 if not d.get("docname"):
3150 new_child_flag = True
Ankush Menatdd11f262022-06-27 15:55:08 +05303151 items_added_or_removed = True
Ankush Menat494bd9e2022-03-28 18:52:46 +05303152 check_doc_permissions(parent, "create")
Rohit Waghchaure8d5380a2020-06-18 14:06:31 +05303153 child_item = get_new_child_item(d)
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003154 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303155 check_doc_permissions(parent, "write")
3156 child_item = frappe.get_doc(parent_doctype + " Item", d.get("docname"))
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303157
Saqib Ansaric579b082020-05-29 22:21:50 +05303158 prev_rate, new_rate = flt(child_item.get("rate")), flt(d.get("rate"))
3159 prev_qty, new_qty = flt(child_item.get("qty")), flt(d.get("qty"))
s-aga-r9588bb72023-08-21 22:23:57 +05303160 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 +05303161 prev_con_fac, new_con_fac = flt(child_item.get("conversion_factor")), flt(
3162 d.get("conversion_factor")
3163 )
Saqib61314242020-09-15 11:14:31 +05303164 prev_uom, new_uom = child_item.get("uom"), d.get("uom")
Saqib Ansaric579b082020-05-29 22:21:50 +05303165
Ankush Menat494bd9e2022-03-28 18:52:46 +05303166 if parent_doctype == "Sales Order":
Saqib Ansaric579b082020-05-29 22:21:50 +05303167 prev_date, new_date = child_item.get("delivery_date"), d.get("delivery_date")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303168 elif parent_doctype == "Purchase Order":
marinationb7e94cc2020-06-15 11:32:42 +05303169 prev_date, new_date = child_item.get("schedule_date"), d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303170
3171 rate_unchanged = prev_rate == new_rate
marinationf9c4b202020-06-12 15:49:53 +05303172 qty_unchanged = prev_qty == new_qty
s-aga-r9588bb72023-08-21 22:23:57 +05303173 fg_qty_unchanged = prev_fg_qty == new_fg_qty
Saqib61314242020-09-15 11:14:31 +05303174 uom_unchanged = prev_uom == new_uom
Saqib Ansaric579b082020-05-29 22:21:50 +05303175 conversion_factor_unchanged = prev_con_fac == new_con_fac
Ankush Menatdd11f262022-06-27 15:55:08 +05303176 any_conversion_factor_changed |= not conversion_factor_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303177 date_unchanged = (
3178 prev_date == getdate(new_date) if prev_date and new_date else False
3179 ) # in case of delivery note etc
3180 if (
3181 rate_unchanged
3182 and qty_unchanged
s-aga-r9588bb72023-08-21 22:23:57 +05303183 and fg_qty_unchanged
Ankush Menat494bd9e2022-03-28 18:52:46 +05303184 and conversion_factor_unchanged
3185 and uom_unchanged
3186 and date_unchanged
3187 ):
Saqibdd374ff2020-02-27 12:51:31 +05303188 continue
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003189
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303190 validate_quantity(child_item, d)
Ankush Menatdd11f262022-06-27 15:55:08 +05303191 if flt(child_item.get("qty")) != flt(d.get("qty")):
3192 any_qty_changed = True
deepeshgarg00777cde832018-12-27 15:56:51 +05303193
s-aga-r9588bb72023-08-21 22:23:57 +05303194 if (
3195 parent.doctype == "Purchase Order"
3196 and parent.is_subcontracted
3197 and not parent.is_old_subcontracting_flow
3198 ):
3199 validate_fg_item_for_subcontracting(d, new_child_flag)
3200 child_item.fg_item_qty = flt(d["fg_item_qty"])
3201
3202 if new_child_flag:
3203 child_item.fg_item = d["fg_item"]
3204
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003205 child_item.qty = flt(d.get("qty"))
Saqib56fea7d2020-10-09 21:19:25 +05303206 rate_precision = child_item.precision("rate") or 2
3207 conv_fac_precision = child_item.precision("conversion_factor") or 2
3208 qty_precision = child_item.precision("qty") or 2
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003209
Maricab9f5a1c2023-11-27 09:05:22 +05303210 # Amount cannot be lesser than billed amount, except for negative amounts
3211 row_rate = flt(d.get("rate"), rate_precision)
3212 amount_below_billed_amt = flt(child_item.billed_amt, rate_precision) > flt(
3213 row_rate * flt(d.get("qty"), qty_precision), rate_precision
3214 )
3215 if amount_below_billed_amt and row_rate > 0.0:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303216 frappe.throw(
3217 _("Row #{0}: Cannot set Rate if amount is greater than billed amount for Item {1}.").format(
3218 child_item.idx, child_item.item_code
3219 )
3220 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003221 else:
Maricab9f5a1c2023-11-27 09:05:22 +05303222 child_item.rate = row_rate
marinationf9c4b202020-06-12 15:49:53 +05303223
Saqib Ansari2c3c8aa2020-05-29 21:55:38 +05303224 if d.get("conversion_factor"):
marinationf9c4b202020-06-12 15:49:53 +05303225 if child_item.stock_uom == child_item.uom:
3226 child_item.conversion_factor = 1
3227 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303228 child_item.conversion_factor = flt(d.get("conversion_factor"), conv_fac_precision)
marination665c27a2020-09-15 12:04:38 +05303229
Saqib61314242020-09-15 11:14:31 +05303230 if d.get("uom"):
3231 child_item.uom = d.get("uom")
Ankush Menat494bd9e2022-03-28 18:52:46 +05303232 conversion_factor = flt(
3233 get_conversion_factor(child_item.item_code, child_item.uom).get("conversion_factor")
3234 )
3235 child_item.conversion_factor = (
3236 flt(d.get("conversion_factor"), conv_fac_precision) or conversion_factor
3237 )
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303238
Ankush Menat494bd9e2022-03-28 18:52:46 +05303239 if d.get("delivery_date") and parent_doctype == "Sales Order":
3240 child_item.delivery_date = d.get("delivery_date")
marinationf9c4b202020-06-12 15:49:53 +05303241
Ankush Menat494bd9e2022-03-28 18:52:46 +05303242 if d.get("schedule_date") and parent_doctype == "Purchase Order":
3243 child_item.schedule_date = d.get("schedule_date")
Saqib Ansaric579b082020-05-29 22:21:50 +05303244
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303245 if flt(child_item.price_list_rate):
Maricaf0674472019-10-11 10:47:09 +05303246 if flt(child_item.rate) > flt(child_item.price_list_rate):
3247 # if rate is greater than price_list_rate, set margin
3248 # or set discount
3249 child_item.discount_percentage = 0
rohitwaghchaure81c21752019-10-31 15:56:10 +05303250
3251 if parent_doctype in sales_doctypes:
3252 child_item.margin_type = "Amount"
Ankush Menat494bd9e2022-03-28 18:52:46 +05303253 child_item.margin_rate_or_amount = flt(
3254 child_item.rate - child_item.price_list_rate, child_item.precision("margin_rate_or_amount")
3255 )
rohitwaghchaure81c21752019-10-31 15:56:10 +05303256 child_item.rate_with_margin = child_item.rate
Maricaf0674472019-10-11 10:47:09 +05303257 else:
Ankush Menat494bd9e2022-03-28 18:52:46 +05303258 child_item.discount_percentage = flt(
3259 (1 - flt(child_item.rate) / flt(child_item.price_list_rate)) * 100.0,
3260 child_item.precision("discount_percentage"),
3261 )
3262 child_item.discount_amount = flt(child_item.price_list_rate) - flt(child_item.rate)
rohitwaghchaure81c21752019-10-31 15:56:10 +05303263
3264 if parent_doctype in sales_doctypes:
3265 child_item.margin_type = ""
3266 child_item.margin_rate_or_amount = 0
3267 child_item.rate_with_margin = 0
Mangesh-Khairnara3d52002019-08-05 10:16:40 +05303268
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003269 child_item.flags.ignore_validate_update_after_submit = True
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003270 if new_child_flag:
Saqib Ansarif53299e2020-04-15 22:08:12 +05303271 parent.load_from_db()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303272 child_item.idx = len(parent.items) + 1
Stavros Anastasiadis3d82b742018-12-10 13:00:55 +01003273 child_item.insert()
3274 else:
3275 child_item.save()
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003276
Rushabh Mehtafafbb022018-12-24 22:09:15 +05303277 parent.reload()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303278 parent.flags.ignore_validate_update_after_submit = True
3279 parent.set_qty_as_per_stock_uom()
3280 parent.calculate_taxes_and_totals()
Ankush Menatdf6e2082021-02-11 11:04:39 +05303281 parent.set_total_in_words()
Nabin Hait49a46f02019-10-21 13:35:43 +05303282 if parent_doctype == "Sales Order":
Marica3dee5272020-06-23 10:33:47 +05303283 make_packing_list(parent)
Nabin Hait49a46f02019-10-21 13:35:43 +05303284 parent.set_gross_profit()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303285 frappe.get_doc("Authorization Control").validate_approving_authority(
3286 parent.doctype, parent.company, parent.base_grand_total
3287 )
Doridel Cahanap6f06cc22018-05-17 16:28:58 +08003288
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303289 parent.set_payment_schedule()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303290 if parent_doctype == "Purchase Order":
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303291 parent.validate_minimum_order_qty()
3292 parent.validate_budget()
3293 if parent.is_against_so():
3294 parent.update_status_updater()
Nabin Haitb2da0822018-07-13 17:01:40 +05303295 else:
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303296 parent.check_credit_limit()
Ankush Menat733c9de2022-01-04 18:39:30 +05303297
3298 # reset index of child table
3299 for idx, row in enumerate(parent.get(child_docname), start=1):
3300 row.idx = idx
3301
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303302 parent.save()
Nabin Haitb2da0822018-07-13 17:01:40 +05303303
Ankush Menat494bd9e2022-03-28 18:52:46 +05303304 if parent_doctype == "Purchase Order":
3305 update_last_purchase_rate(parent, is_submit=1)
s-aga-r68f5dd32023-12-01 14:45:01 +05303306
3307 if any_qty_changed or items_added_or_removed or any_conversion_factor_changed:
3308 parent.update_prevdoc_status()
3309
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303310 parent.update_requested_qty()
3311 parent.update_ordered_qty()
3312 parent.update_ordered_and_reserved_qty()
3313 parent.update_receiving_percentage()
s-aga-rb9b17172023-08-22 16:53:54 +05303314
3315 if parent.is_subcontracted:
3316 if parent.is_old_subcontracting_flow:
3317 if should_update_supplied_items(parent):
3318 parent.update_reserved_qty_for_subcontract()
3319 parent.create_raw_materials_supplied()
3320 parent.save()
3321 else:
3322 if not parent.can_update_items():
3323 frappe.throw(
3324 _(
3325 "Items cannot be updated as Subcontracting Order is created against the Purchase Order {0}."
3326 ).format(frappe.bold(parent.name))
3327 )
Ankush Menatc84e11a2022-06-01 12:55:10 +05303328 else: # Sales Order
3329 parent.validate_warehouse()
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303330 parent.update_reserved_qty()
3331 parent.update_project()
Ankush Menat494bd9e2022-03-28 18:52:46 +05303332 parent.update_prevdoc_status("submit")
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303333 parent.update_delivery_status()
Nabin Haitb2da0822018-07-13 17:01:40 +05303334
Saqib6db92fb2020-09-14 19:54:17 +05303335 parent.reload()
3336 validate_workflow_conditions(parent)
3337
Rushabh Mehtac9b1a352018-12-24 20:55:35 +05303338 parent.update_blanket_order()
3339 parent.update_billing_percentage()
3340 parent.set_status()
Gauravf1e28e02019-02-13 16:46:24 +05303341
s-aga-rac24d772023-04-05 19:48:15 +05303342 # Cancel and Recreate Stock Reservation Entries.
s-aga-r38e93672023-04-02 21:24:59 +05303343 if parent_doctype == "Sales Order":
3344 from erpnext.stock.doctype.stock_reservation_entry.stock_reservation_entry import (
3345 cancel_stock_reservation_entries,
3346 has_reserved_stock,
s-aga-r38e93672023-04-02 21:24:59 +05303347 )
3348
3349 if has_reserved_stock(parent.doctype, parent.name):
3350 cancel_stock_reservation_entries(parent.doctype, parent.name)
s-aga-r2d8363a2023-09-02 11:02:24 +05303351
3352 if parent.per_picked == 0:
3353 parent.create_stock_reservation_entries()
s-aga-r38e93672023-04-02 21:24:59 +05303354
Ankush Menat494bd9e2022-03-28 18:52:46 +05303355
Gursheen Anand68effd92023-09-21 17:28:07 +05303356def check_if_child_table_updated(
3357 child_table_before_update, child_table_after_update, fields_to_check
3358):
3359 accounting_dimensions = get_accounting_dimensions() + ["cost_center", "project"]
3360 # Check if any field affecting accounting entry is altered
3361 for index, item in enumerate(child_table_after_update):
3362 for field in fields_to_check:
3363 if child_table_before_update[index].get(field) != item.get(field):
3364 return True
3365
3366 for dimension in accounting_dimensions:
3367 if child_table_before_update[index].get(dimension) != item.get(dimension):
3368 return True
3369
3370 return False
3371
3372
Gursheen Ananda06017c2023-06-12 15:24:53 +05303373@erpnext.allow_regional
3374def validate_regional(doc):
3375 pass
3376
3377
3378@erpnext.allow_regional
3379def validate_einvoice_fields(doc):
3380 pass
3381
3382
3383@erpnext.allow_regional
3384def update_gl_dict_with_regional_fields(doc, gl_dict):
3385 pass