blob: 9be5c0d03f171fc31e0c7b4981fb7fbc45833fac [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 Haitc3afb252013-03-19 12:01:24 +05303
Rohan Bansal7f8b95e2021-04-14 14:12:03 +05304import json
marinationfac40352020-12-07 21:35:49 +05305from collections import defaultdict
Ankush Menate6ab8df2022-02-06 13:02:34 +05306from typing import List, Tuple
Rohan Bansal7f8b95e2021-04-14 14:12:03 +05307
8import frappe
Rohan Bansal7f8b95e2021-04-14 14:12:03 +05309from frappe import _
10from frappe.utils import cint, cstr, flt, get_link_to_form, getdate
11
12import erpnext
Chillar Anand915b3432021-09-02 16:44:59 +053013from erpnext.accounts.general_ledger import (
14 make_gl_entries,
15 make_reverse_gl_entries,
16 process_gl_map,
17)
Rohit Waghchaure5d5dc562021-06-22 15:23:04 +053018from erpnext.accounts.utils import get_fiscal_year
Rushabh Mehta1f847992013-12-12 19:12:19 +053019from erpnext.controllers.accounts_controller import AccountsController
Nabin Hait6d7b0ce2017-06-15 11:09:27 +053020from erpnext.stock import get_warehouse_account_map
Ankush Menat8f577242022-01-07 11:10:23 +053021from erpnext.stock.stock_ledger import get_items_to_be_repost
Rohan Bansal7f8b95e2021-04-14 14:12:03 +053022
Nabin Haitc3afb252013-03-19 12:01:24 +053023
Nabin Hait5a9579b2018-12-24 14:54:42 +053024class QualityInspectionRequiredError(frappe.ValidationError): pass
25class QualityInspectionRejectedError(frappe.ValidationError): pass
Anurag Mishra0c8411d2018-12-28 16:53:00 +053026class QualityInspectionNotSubmittedError(frappe.ValidationError): pass
Nabin Hait5a9579b2018-12-24 14:54:42 +053027
Nabin Haitc3afb252013-03-19 12:01:24 +053028class StockController(AccountsController):
Nabin Hait8af429d2016-11-16 17:21:59 +053029 def validate(self):
30 super(StockController, self).validate()
Maricafd3d9762020-06-12 12:30:59 +053031 if not self.get('is_return'):
marination596560c2020-06-11 16:39:03 +053032 self.validate_inspection()
rohitwaghchaure9af557f2019-12-30 13:26:47 +053033 self.validate_serialized_batch()
marinationeecfc4c2021-07-22 13:23:54 +053034 self.clean_serial_nos()
marinationfd04e962020-04-03 15:46:48 +053035 self.validate_customer_provided_item()
Anupam Kumar7e1dcf92021-02-11 20:19:30 +053036 self.set_rate_of_stock_uom()
Deepesh Gargb4be2922021-01-28 13:09:56 +053037 self.validate_internal_transfer()
marinationfac40352020-12-07 21:35:49 +053038 self.validate_putaway_capacity()
Rushabh Mehtaffd80a62017-01-16 17:23:20 +053039
Nabin Haita77b8c92020-12-21 14:45:50 +053040 def make_gl_entries(self, gl_entries=None, from_repost=False):
Anand Doshif78d1ae2014-03-28 13:55:00 +053041 if self.docstatus == 2:
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +053042 make_reverse_gl_entries(voucher_type=self.doctype, voucher_no=self.name)
Anand Doshi2ce39cf2014-04-07 18:51:58 +053043
Deepesh Garg528c7132022-02-01 14:42:55 +053044 provisional_accounting_for_non_stock_items = \
45 cint(frappe.db.get_value('Company', self.company, 'enable_provisional_accounting_for_non_stock_items'))
46
47 if cint(erpnext.is_perpetual_inventory_enabled(self.company)) or provisional_accounting_for_non_stock_items:
Rohit Waghchaure6b33c9b2019-03-08 11:13:35 +053048 warehouse_account = get_warehouse_account_map(self.company)
Anand Doshi2ce39cf2014-04-07 18:51:58 +053049
Anand Doshif78d1ae2014-03-28 13:55:00 +053050 if self.docstatus==1:
Nabin Hait9784d272016-12-30 16:21:35 +053051 if not gl_entries:
52 gl_entries = self.get_gl_entries(warehouse_account)
Nabin Haita77b8c92020-12-21 14:45:50 +053053 make_gl_entries(gl_entries, from_repost=from_repost)
Nabin Hait145e5e22013-10-22 23:51:41 +053054
Rohit Waghchaureb6381c62018-06-12 13:54:40 +053055 elif self.doctype in ['Purchase Receipt', 'Purchase Invoice'] and self.docstatus == 1:
Rohit Waghchaure42169722018-05-16 18:16:08 +053056 gl_entries = []
57 gl_entries = self.get_asset_gl_entry(gl_entries)
Nabin Haita77b8c92020-12-21 14:45:50 +053058 make_gl_entries(gl_entries, from_repost=from_repost)
Anand Doshi2ce39cf2014-04-07 18:51:58 +053059
rohitwaghchaure9af557f2019-12-30 13:26:47 +053060 def validate_serialized_batch(self):
61 from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos
62 for d in self.get("items"):
63 if hasattr(d, 'serial_no') and hasattr(d, 'batch_no') and d.serial_no and d.batch_no:
Rohit Waghchaure6b482eb2021-07-23 16:40:45 +053064 serial_nos = frappe.get_all("Serial No",
65 fields=["batch_no", "name", "warehouse"],
66 filters={
67 "name": ("in", get_serial_nos(d.serial_no))
68 }
69 )
70
71 for row in serial_nos:
72 if row.warehouse and row.batch_no != d.batch_no:
rohitwaghchaure9af557f2019-12-30 13:26:47 +053073 frappe.throw(_("Row #{0}: Serial No {1} does not belong to Batch {2}")
Rohit Waghchaure6b482eb2021-07-23 16:40:45 +053074 .format(d.idx, row.name, d.batch_no))
rohitwaghchaure9af557f2019-12-30 13:26:47 +053075
Saqib Ansari903055b2020-10-20 11:59:06 +053076 if flt(d.qty) > 0.0 and d.get("batch_no") and self.get("posting_date") and self.docstatus < 2:
rohitwaghchaure28a48802020-04-28 13:01:43 +053077 expiry_date = frappe.get_cached_value("Batch", d.get("batch_no"), "expiry_date")
78
79 if expiry_date and getdate(expiry_date) < getdate(self.posting_date):
80 frappe.throw(_("Row #{0}: The batch {1} has already expired.")
81 .format(d.idx, get_link_to_form("Batch", d.get("batch_no"))))
82
marinationeecfc4c2021-07-22 13:23:54 +053083 def clean_serial_nos(self):
Ankush Menatb20df372022-01-24 19:19:58 +053084 from erpnext.stock.doctype.serial_no.serial_no import clean_serial_no_string
85
marinationeecfc4c2021-07-22 13:23:54 +053086 for row in self.get("items"):
87 if hasattr(row, "serial_no") and row.serial_no:
Ankush Menatb20df372022-01-24 19:19:58 +053088 # remove extra whitespace and store one serial no on each line
89 row.serial_no = clean_serial_no_string(row.serial_no)
marinationeecfc4c2021-07-22 13:23:54 +053090
Ankush Menate177c522022-01-24 19:28:26 +053091 for row in self.get('packed_items') or []:
92 if hasattr(row, "serial_no") and row.serial_no:
93 # remove extra whitespace and store one serial no on each line
94 row.serial_no = clean_serial_no_string(row.serial_no)
95
Nabin Haite83069c2013-11-14 18:40:08 +053096 def get_gl_entries(self, warehouse_account=None, default_expense_account=None,
Nabin Hait142007a2013-09-17 15:15:16 +053097 default_cost_center=None):
Nabin Haitadeb9762014-10-06 11:53:52 +053098
Nabin Hait142007a2013-09-17 15:15:16 +053099 if not warehouse_account:
Rohit Waghchaure6b33c9b2019-03-08 11:13:35 +0530100 warehouse_account = get_warehouse_account_map(self.company)
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530101
Anand Doshide1a97d2014-04-17 11:37:46 +0530102 sle_map = self.get_stock_ledger_details()
103 voucher_details = self.get_voucher_details(default_expense_account, default_cost_center, sle_map)
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530104
Nabin Hait2e296fa2013-08-28 18:53:11 +0530105 gl_list = []
Nabin Hait7a75e102013-09-17 10:21:20 +0530106 warehouse_with_no_account = []
Nabin Hait19f8fa52021-02-22 22:27:22 +0530107 precision = self.get_debit_field_precision()
Nabin Hait8c61f342016-12-15 13:46:03 +0530108 for item_row in voucher_details:
Deepesh Gargb4be2922021-01-28 13:09:56 +0530109
Nabin Hait8c61f342016-12-15 13:46:03 +0530110 sle_list = sle_map.get(item_row.name)
Nabin Hait2e296fa2013-08-28 18:53:11 +0530111 if sle_list:
112 for sle in sle_list:
113 if warehouse_account.get(sle.warehouse):
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530114 # from warehouse account
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530115
Nabin Hait8c61f342016-12-15 13:46:03 +0530116 self.check_expense_account(item_row)
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530117
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530118 # expense account/ target_warehouse / source_warehouse
119 if item_row.get('target_warehouse'):
120 warehouse = item_row.get('target_warehouse')
121 expense_account = warehouse_account[warehouse]["account"]
122 else:
123 expense_account = item_row.expense_account
124
Nabin Hait2e296fa2013-08-28 18:53:11 +0530125 gl_list.append(self.get_gl_dict({
Nabin Hait6d7b0ce2017-06-15 11:09:27 +0530126 "account": warehouse_account[sle.warehouse]["account"],
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530127 "against": expense_account,
Nabin Hait8c61f342016-12-15 13:46:03 +0530128 "cost_center": item_row.cost_center,
Deepesh Garg1b30ca62020-06-19 12:12:08 +0530129 "project": item_row.project or self.get('project'),
xdlumertzcdaf0a02021-11-27 12:03:35 -0300130 "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
rohitwaghchaure61ad6292020-01-15 16:35:31 +0530131 "debit": flt(sle.stock_value_difference, precision),
Nabin Hait8770ea22019-05-22 18:03:09 +0530132 "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No",
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530133 }, warehouse_account[sle.warehouse]["account_currency"], item=item_row))
Nabin Hait27994c22013-08-26 16:53:30 +0530134
Nabin Hait2e296fa2013-08-28 18:53:11 +0530135 gl_list.append(self.get_gl_dict({
Deepesh Gargf17ea2c2020-12-11 21:30:39 +0530136 "account": expense_account,
Nabin Hait6d7b0ce2017-06-15 11:09:27 +0530137 "against": warehouse_account[sle.warehouse]["account"],
Nabin Hait8c61f342016-12-15 13:46:03 +0530138 "cost_center": item_row.cost_center,
xdlumertzcdaf0a02021-11-27 12:03:35 -0300139 "remarks": self.get("remarks") or _("Accounting Entry for Stock"),
rohitwaghchaure61ad6292020-01-15 16:35:31 +0530140 "credit": flt(sle.stock_value_difference, precision),
Nabin Hait3f119ec2019-05-16 17:28:39 +0530141 "project": item_row.get("project") or self.get("project"),
Nabin Hait8770ea22019-05-22 18:03:09 +0530142 "is_opening": item_row.get("is_opening") or self.get("is_opening") or "No"
deepeshgarg0073d11ac02019-05-19 00:02:01 +0530143 }, item=item_row))
Nabin Hait7a75e102013-09-17 10:21:20 +0530144 elif sle.warehouse not in warehouse_with_no_account:
145 warehouse_with_no_account.append(sle.warehouse)
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530146
147 if warehouse_with_no_account:
Nabin Haitd6625022016-10-24 18:17:57 +0530148 for wh in warehouse_with_no_account:
149 if frappe.db.get_value("Warehouse", wh, "company"):
Nabin Haita77b8c92020-12-21 14:45:50 +0530150 frappe.throw(_("Warehouse {0} is not linked to any account, please mention the account in the warehouse record or set default inventory account in company {1}.").format(wh, self.company))
Rushabh Mehta14a908b2015-10-15 12:28:20 +0530151
Nabin Hait19f8fa52021-02-22 22:27:22 +0530152 return process_gl_map(gl_list, precision=precision)
153
154 def get_debit_field_precision(self):
155 if not frappe.flags.debit_field_precision:
156 frappe.flags.debit_field_precision = frappe.get_precision("GL Entry", "debit_in_account_currency")
157
158 return frappe.flags.debit_field_precision
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530159
Anand Doshide1a97d2014-04-17 11:37:46 +0530160 def get_voucher_details(self, default_expense_account, default_cost_center, sle_map):
161 if self.doctype == "Stock Reconciliation":
Nabin Hait3f119ec2019-05-16 17:28:39 +0530162 reconciliation_purpose = frappe.db.get_value(self.doctype, self.name, "purpose")
163 is_opening = "Yes" if reconciliation_purpose == "Opening Stock" else "No"
164 details = []
Nabin Hait34c551d2019-07-03 10:34:31 +0530165 for voucher_detail_no in sle_map:
Nabin Hait3f119ec2019-05-16 17:28:39 +0530166 details.append(frappe._dict({
167 "name": voucher_detail_no,
168 "expense_account": default_expense_account,
169 "cost_center": default_cost_center,
170 "is_opening": is_opening
171 }))
172 return details
Anand Doshide1a97d2014-04-17 11:37:46 +0530173 else:
Nabin Haitdd38a262014-12-26 13:15:21 +0530174 details = self.get("items")
Anand Doshi094610d2014-04-16 19:56:53 +0530175
Anand Doshide1a97d2014-04-17 11:37:46 +0530176 if default_expense_account or default_cost_center:
177 for d in details:
178 if default_expense_account and not d.get("expense_account"):
179 d.expense_account = default_expense_account
180 if default_cost_center and not d.get("cost_center"):
181 d.cost_center = default_cost_center
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530182
Anand Doshide1a97d2014-04-17 11:37:46 +0530183 return details
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530184
Ankush Menate6ab8df2022-02-06 13:02:34 +0530185 def get_items_and_warehouses(self) -> Tuple[List[str], List[str]]:
186 """Get list of items and warehouses affected by a transaction"""
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530187
Ankush Menate6ab8df2022-02-06 13:02:34 +0530188 if not (hasattr(self, "items") or hasattr(self, "packed_items")):
189 return [], []
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530190
Ankush Menate6ab8df2022-02-06 13:02:34 +0530191 item_rows = (self.get("items") or []) + (self.get("packed_items") or [])
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530192
Ankush Menate6ab8df2022-02-06 13:02:34 +0530193 items = {d.item_code for d in item_rows if d.item_code}
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530194
Ankush Menate6ab8df2022-02-06 13:02:34 +0530195 warehouses = set()
196 for d in item_rows:
197 if d.get("warehouse"):
198 warehouses.add(d.warehouse)
Nabin Haitbecf75d2014-03-27 17:18:29 +0530199
Ankush Menate6ab8df2022-02-06 13:02:34 +0530200 if self.doctype == "Stock Entry":
201 if d.get("s_warehouse"):
202 warehouses.add(d.s_warehouse)
203 if d.get("t_warehouse"):
204 warehouses.add(d.t_warehouse)
205
206 return list(items), list(warehouses)
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530207
Nabin Hait2e296fa2013-08-28 18:53:11 +0530208 def get_stock_ledger_details(self):
209 stock_ledger = {}
Nabin Haitea8fab52017-02-06 17:13:39 +0530210 stock_ledger_entries = frappe.db.sql("""
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530211 select
Nabin Hait0a6aaf42017-02-07 01:23:26 +0530212 name, warehouse, stock_value_difference, valuation_rate,
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +0530213 voucher_detail_no, item_code, posting_date, posting_time,
Nabin Hait0a6aaf42017-02-07 01:23:26 +0530214 actual_qty, qty_after_transaction
Nabin Haitea8fab52017-02-06 17:13:39 +0530215 from
216 `tabStock Ledger Entry`
217 where
218 voucher_type=%s and voucher_no=%s
219 """, (self.doctype, self.name), as_dict=True)
Nabin Hait0a6aaf42017-02-07 01:23:26 +0530220
Nabin Haitea8fab52017-02-06 17:13:39 +0530221 for sle in stock_ledger_entries:
Deepesh Gargb4be2922021-01-28 13:09:56 +0530222 stock_ledger.setdefault(sle.voucher_detail_no, []).append(sle)
Nabin Hait2e296fa2013-08-28 18:53:11 +0530223 return stock_ledger
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530224
Rushabh Mehta551406a2017-04-21 12:40:19 +0530225 def make_batches(self, warehouse_field):
Rushabh Mehtae385b5b2017-04-20 15:21:01 +0530226 '''Create batches if required. Called before submit'''
227 for d in self.items:
Rushabh Mehta551406a2017-04-21 12:40:19 +0530228 if d.get(warehouse_field) and not d.batch_no:
229 has_batch_no, create_new_batch = frappe.db.get_value('Item', d.item_code, ['has_batch_no', 'create_new_batch'])
230 if has_batch_no and create_new_batch:
231 d.batch_no = frappe.get_doc(dict(
232 doctype='Batch',
233 item=d.item_code,
234 supplier=getattr(self, 'supplier', None),
235 reference_doctype=self.doctype,
236 reference_name=self.name)).insert().name
Rushabh Mehtae385b5b2017-04-20 15:21:01 +0530237
Nabin Hait27994c22013-08-26 16:53:30 +0530238 def check_expense_account(self, item):
Rushabh Mehta052fe822014-04-16 19:20:11 +0530239 if not item.get("expense_account"):
Rohit Waghchaureceab6922020-11-18 17:57:35 +0530240 msg = _("Please set an Expense Account in the Items table")
241 frappe.throw(_("Row #{0}: Expense Account not set for the Item {1}. {2}")
242 .format(item.idx, frappe.bold(item.item_code), msg), title=_("Expense Account Missing"))
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530243
Anand Doshi496123a2014-06-19 19:25:19 +0530244 else:
Nabin Hait19f8fa52021-02-22 22:27:22 +0530245 is_expense_account = frappe.get_cached_value("Account",
Nabin Hait00778c92014-06-25 19:12:24 +0530246 item.get("expense_account"), "report_type")=="Profit and Loss"
jof2jc524ebbc2016-02-08 23:44:55 +0700247 if self.doctype not in ("Purchase Receipt", "Purchase Invoice", "Stock Reconciliation", "Stock Entry") and not is_expense_account:
Nabin Hait00778c92014-06-25 19:12:24 +0530248 frappe.throw(_("Expense / Difference account ({0}) must be a 'Profit or Loss' account")
249 .format(item.get("expense_account")))
Anand Doshi496123a2014-06-19 19:25:19 +0530250 if is_expense_account and not item.get("cost_center"):
251 frappe.throw(_("{0} {1}: Cost Center is mandatory for Item {2}").format(
252 _(self.doctype), self.name, item.get("item_code")))
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530253
Rohit Waghchaure8996b7d2020-01-23 17:36:52 +0530254 def delete_auto_created_batches(self):
255 for d in self.items:
256 if not d.batch_no: continue
257
Ankush Menatea5efd02022-01-21 13:12:31 +0530258 frappe.db.set_value("Serial No", {"batch_no": d.batch_no, "status": "Inactive"}, "batch_no", None)
Saqibe9ac3e02020-03-02 15:02:58 +0530259
Rohit Waghchaure8996b7d2020-01-23 17:36:52 +0530260 d.batch_no = None
261 d.db_set("batch_no", None)
262
263 for data in frappe.get_all("Batch",
264 {'reference_name': self.name, 'reference_doctype': self.doctype}):
265 frappe.delete_doc("Batch", data.name)
Rohit Waghchaure4f4dbf12020-01-23 12:42:42 +0530266
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530267 def get_sl_entries(self, d, args):
Nabin Hait5288bde2014-11-03 15:08:21 +0530268 sl_dict = frappe._dict({
Nabin Hait296d6262014-05-02 17:36:13 +0530269 "item_code": d.get("item_code", None),
Nabin Haitdc82d4f2014-04-07 12:02:57 +0530270 "warehouse": d.get("warehouse", None),
Anand Doshif78d1ae2014-03-28 13:55:00 +0530271 "posting_date": self.posting_date,
272 "posting_time": self.posting_time,
Valmik Janglad89dcf62016-03-04 14:33:49 +0530273 'fiscal_year': get_fiscal_year(self.posting_date, company=self.company)[0],
Anand Doshif78d1ae2014-03-28 13:55:00 +0530274 "voucher_type": self.doctype,
275 "voucher_no": self.name,
Nabin Hait1e2f20a2013-08-02 11:42:11 +0530276 "voucher_detail_no": d.name,
Nabin Haitdc82d4f2014-04-07 12:02:57 +0530277 "actual_qty": (self.docstatus==1 and 1 or -1)*flt(d.get("stock_qty")),
Nabin Haitc865f222015-09-21 09:18:43 +0530278 "stock_uom": frappe.db.get_value("Item", args.get("item_code") or d.get("item_code"), "stock_uom"),
Nabin Hait1e2f20a2013-08-02 11:42:11 +0530279 "incoming_rate": 0,
Anand Doshif78d1ae2014-03-28 13:55:00 +0530280 "company": self.company,
Nabin Hait296d6262014-05-02 17:36:13 +0530281 "batch_no": cstr(d.get("batch_no")).strip(),
282 "serial_no": d.get("serial_no"),
rohitwaghchaure93779c22018-03-21 17:52:41 +0530283 "project": d.get("project") or self.get('project'),
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +0530284 "is_cancelled": 1 if self.docstatus==2 else 0
Nabin Hait5288bde2014-11-03 15:08:21 +0530285 })
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530286
Nabin Hait1e2f20a2013-08-02 11:42:11 +0530287 sl_dict.update(args)
288 return sl_dict
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530289
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +0530290 def make_sl_entries(self, sl_entries, allow_negative_stock=False,
Nabin Hait54c865e2015-03-27 15:38:31 +0530291 via_landed_cost_voucher=False):
Rushabh Mehta1f847992013-12-12 19:12:19 +0530292 from erpnext.stock.stock_ledger import make_sl_entries
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +0530293 make_sl_entries(sl_entries, allow_negative_stock, via_landed_cost_voucher)
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530294
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +0530295 def make_gl_entries_on_cancel(self):
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530296 if frappe.db.sql("""select name from `tabGL Entry` where voucher_type=%s
Anand Doshif78d1ae2014-03-28 13:55:00 +0530297 and voucher_no=%s""", (self.doctype, self.name)):
Deepesh Garg2a9c5ba2020-04-30 10:38:58 +0530298 self.make_gl_entries()
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530299
Anand Doshia740f752014-06-25 13:31:02 +0530300 def get_serialized_items(self):
301 serialized_items = []
Ankush Menata9c84f72021-06-11 16:00:48 +0530302 item_codes = list(set(d.item_code for d in self.get("items")))
Anand Doshia740f752014-06-25 13:31:02 +0530303 if item_codes:
304 serialized_items = frappe.db.sql_list("""select name from `tabItem`
Rushabh Mehta1e8025b2015-07-24 15:16:25 +0530305 where has_serial_no=1 and name in ({})""".format(", ".join(["%s"]*len(item_codes))),
Anand Doshia740f752014-06-25 13:31:02 +0530306 tuple(item_codes))
307
308 return serialized_items
Rushabh Mehtab16b9cd2015-08-03 16:13:33 +0530309
Saurabh2e292062015-11-18 17:03:33 +0530310 def validate_warehouse(self):
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530311 from erpnext.stock.utils import validate_disabled_warehouse, validate_warehouse_company
Saurabh2e292062015-11-18 17:03:33 +0530312
Ankush Menata9c84f72021-06-11 16:00:48 +0530313 warehouses = list(set(d.warehouse for d in
314 self.get("items") if getattr(d, "warehouse", None)))
Saurabh2e292062015-11-18 17:03:33 +0530315
Deepesh Garg15ff6a52020-02-18 12:28:41 +0530316 target_warehouses = list(set([d.target_warehouse for d in
317 self.get("items") if getattr(d, "target_warehouse", None)]))
318
319 warehouses.extend(target_warehouses)
320
321 from_warehouse = list(set([d.from_warehouse for d in
322 self.get("items") if getattr(d, "from_warehouse", None)]))
323
324 warehouses.extend(from_warehouse)
325
Saurabh2e292062015-11-18 17:03:33 +0530326 for w in warehouses:
Jannat Patel30c88732021-02-11 11:46:48 +0530327 validate_disabled_warehouse(w)
Saurabh2e292062015-11-18 17:03:33 +0530328 validate_warehouse_company(w, self.company)
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530329
Anand Doshi6b71ef52016-01-06 16:32:06 +0530330 def update_billing_percentage(self, update_modified=True):
marinationd6596a12020-11-02 15:07:48 +0530331 target_ref_field = "amount"
332 if self.doctype == "Delivery Note":
333 target_ref_field = "amount - (returned_qty * rate)"
334
Nabin Haitbdab0ee2015-12-30 19:08:11 +0530335 self._update_percent_field({
336 "target_dt": self.doctype + " Item",
337 "target_parent_dt": self.doctype,
338 "target_parent_field": "per_billed",
marinationd6596a12020-11-02 15:07:48 +0530339 "target_ref_field": target_ref_field,
Nabin Haitbdab0ee2015-12-30 19:08:11 +0530340 "target_field": "billed_amt",
341 "name": self.name,
Anand Doshi6b71ef52016-01-06 16:32:06 +0530342 }, update_modified)
Anand Doshia740f752014-06-25 13:31:02 +0530343
Nabin Hait8af429d2016-11-16 17:21:59 +0530344 def validate_inspection(self):
marination9ac9a4e2021-06-21 16:18:35 +0530345 """Checks if quality inspection is set/ is valid for Items that require inspection."""
346 inspection_fieldname_map = {
347 "Purchase Receipt": "inspection_required_before_purchase",
348 "Purchase Invoice": "inspection_required_before_purchase",
349 "Sales Invoice": "inspection_required_before_delivery",
350 "Delivery Note": "inspection_required_before_delivery"
351 }
352 inspection_required_fieldname = inspection_fieldname_map.get(self.doctype)
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530353
marination9ac9a4e2021-06-21 16:18:35 +0530354 # return if inspection is not required on document level
rohitwaghchaure4e8fdf72018-02-22 11:03:48 +0530355 if ((not inspection_required_fieldname and self.doctype != "Stock Entry") or
356 (self.doctype == "Stock Entry" and not self.inspection_required) or
357 (self.doctype in ["Sales Invoice", "Purchase Invoice"] and not self.update_stock)):
Nabin Hait8af429d2016-11-16 17:21:59 +0530358 return
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530359
marination9ac9a4e2021-06-21 16:18:35 +0530360 for row in self.get('items'):
361 qi_required = False
362 if (inspection_required_fieldname and frappe.db.get_value("Item", row.item_code, inspection_required_fieldname)):
363 qi_required = True
364 elif self.doctype == "Stock Entry" and row.t_warehouse:
365 qi_required = True # inward stock needs inspection
Rushabh Mehtaffd80a62017-01-16 17:23:20 +0530366
marination9ac9a4e2021-06-21 16:18:35 +0530367 if qi_required: # validate row only if inspection is required on item level
368 self.validate_qi_presence(row)
369 if self.docstatus == 1:
370 self.validate_qi_submission(row)
371 self.validate_qi_rejection(row)
372
373 def validate_qi_presence(self, row):
374 """Check if QI is present on row level. Warn on save and stop on submit if missing."""
375 if not row.quality_inspection:
marination654e9d82021-06-21 16:51:12 +0530376 msg = f"Row #{row.idx}: Quality Inspection is required for Item {frappe.bold(row.item_code)}"
marination9ac9a4e2021-06-21 16:18:35 +0530377 if self.docstatus == 1:
marination654e9d82021-06-21 16:51:12 +0530378 frappe.throw(_(msg), title=_("Inspection Required"), exc=QualityInspectionRequiredError)
marination9ac9a4e2021-06-21 16:18:35 +0530379 else:
marination654e9d82021-06-21 16:51:12 +0530380 frappe.msgprint(_(msg), title=_("Inspection Required"), indicator="blue")
marination9ac9a4e2021-06-21 16:18:35 +0530381
382 def validate_qi_submission(self, row):
383 """Check if QI is submitted on row level, during submission"""
marinationf67f13c2021-07-10 18:24:24 +0530384 action = frappe.db.get_single_value("Stock Settings", "action_if_quality_inspection_is_not_submitted")
marination9ac9a4e2021-06-21 16:18:35 +0530385 qa_docstatus = frappe.db.get_value("Quality Inspection", row.quality_inspection, "docstatus")
386
387 if not qa_docstatus == 1:
388 link = frappe.utils.get_link_to_form('Quality Inspection', row.quality_inspection)
marination654e9d82021-06-21 16:51:12 +0530389 msg = f"Row #{row.idx}: Quality Inspection {link} is not submitted for the item: {row.item_code}"
marination9ac9a4e2021-06-21 16:18:35 +0530390 if action == "Stop":
marination654e9d82021-06-21 16:51:12 +0530391 frappe.throw(_(msg), title=_("Inspection Submission"), exc=QualityInspectionNotSubmittedError)
marination9ac9a4e2021-06-21 16:18:35 +0530392 else:
Marica9ba3fce2021-06-22 11:20:17 +0530393 frappe.msgprint(_(msg), alert=True, indicator="orange")
marination9ac9a4e2021-06-21 16:18:35 +0530394
395 def validate_qi_rejection(self, row):
396 """Check if QI is rejected on row level, during submission"""
marinationf67f13c2021-07-10 18:24:24 +0530397 action = frappe.db.get_single_value("Stock Settings", "action_if_quality_inspection_is_rejected")
marination9ac9a4e2021-06-21 16:18:35 +0530398 qa_status = frappe.db.get_value("Quality Inspection", row.quality_inspection, "status")
399
400 if qa_status == "Rejected":
401 link = frappe.utils.get_link_to_form('Quality Inspection', row.quality_inspection)
marination654e9d82021-06-21 16:51:12 +0530402 msg = f"Row #{row.idx}: Quality Inspection {link} was rejected for item {row.item_code}"
marination9ac9a4e2021-06-21 16:18:35 +0530403 if action == "Stop":
marination654e9d82021-06-21 16:51:12 +0530404 frappe.throw(_(msg), title=_("Inspection Rejected"), exc=QualityInspectionRejectedError)
marination9ac9a4e2021-06-21 16:18:35 +0530405 else:
marination654e9d82021-06-21 16:51:12 +0530406 frappe.msgprint(_(msg), alert=True, indicator="orange")
Manas Solankicc902412016-11-10 19:15:11 +0530407
Nabin Haitb2d3c0f2018-06-14 15:54:34 +0530408 def update_blanket_order(self):
Nabin Haitd1f40ad2018-06-14 17:09:55 +0530409 blanket_orders = list(set([d.blanket_order for d in self.items if d.blanket_order]))
Nabin Haitb2d3c0f2018-06-14 15:54:34 +0530410 for blanket_order in blanket_orders:
411 frappe.get_doc("Blanket Order", blanket_order).update_ordered_qty()
Manas Solankie5e87f72018-05-28 20:07:08 +0530412
marinationfd04e962020-04-03 15:46:48 +0530413 def validate_customer_provided_item(self):
414 for d in self.get('items'):
415 # Customer Provided parts will have zero valuation rate
416 if frappe.db.get_value('Item', d.item_code, 'is_customer_provided_item'):
417 d.allow_zero_valuation_rate = 1
Anand Doshi2ce39cf2014-04-07 18:51:58 +0530418
Anupam Kumar7e1dcf92021-02-11 20:19:30 +0530419 def set_rate_of_stock_uom(self):
420 if self.doctype in ["Purchase Receipt", "Purchase Invoice", "Purchase Order", "Sales Invoice", "Sales Order", "Delivery Note", "Quotation"]:
421 for d in self.get("items"):
Rohit Waghchaure13584432021-03-26 14:11:50 +0530422 d.stock_uom_rate = d.rate / (d.conversion_factor or 1)
Anupam Kumar7e1dcf92021-02-11 20:19:30 +0530423
Deepesh Gargb4be2922021-01-28 13:09:56 +0530424 def validate_internal_transfer(self):
425 if self.doctype in ('Sales Invoice', 'Delivery Note', 'Purchase Invoice', 'Purchase Receipt') \
426 and self.is_internal_transfer():
427 self.validate_in_transit_warehouses()
428 self.validate_multi_currency()
429 self.validate_packed_items()
430
431 def validate_in_transit_warehouses(self):
432 if (self.doctype == 'Sales Invoice' and self.get('update_stock')) or self.doctype == 'Delivery Note':
433 for item in self.get('items'):
434 if not item.target_warehouse:
435 frappe.throw(_("Row {0}: Target Warehouse is mandatory for internal transfers").format(item.idx))
436
437 if (self.doctype == 'Purchase Invoice' and self.get('update_stock')) or self.doctype == 'Purchase Receipt':
438 for item in self.get('items'):
439 if not item.from_warehouse:
440 frappe.throw(_("Row {0}: From Warehouse is mandatory for internal transfers").format(item.idx))
441
442 def validate_multi_currency(self):
443 if self.currency != self.company_currency:
444 frappe.throw(_("Internal transfers can only be done in company's default currency"))
445
446 def validate_packed_items(self):
447 if self.doctype in ('Sales Invoice', 'Delivery Note Item') and self.get('packed_items'):
448 frappe.throw(_("Packed Items cannot be transferred internally"))
449
marinationfac40352020-12-07 21:35:49 +0530450 def validate_putaway_capacity(self):
451 # if over receipt is attempted while 'apply putaway rule' is disabled
452 # and if rule was applied on the transaction, validate it.
marination957615b2021-01-18 23:47:24 +0530453 from erpnext.stock.doctype.putaway_rule.putaway_rule import get_available_putaway_capacity
454 valid_doctype = self.doctype in ("Purchase Receipt", "Stock Entry", "Purchase Invoice",
455 "Stock Reconciliation")
marinationfac40352020-12-07 21:35:49 +0530456
marination957615b2021-01-18 23:47:24 +0530457 if self.doctype == "Purchase Invoice" and self.get("update_stock") == 0:
458 valid_doctype = False
459
460 if valid_doctype:
marinationfac40352020-12-07 21:35:49 +0530461 rule_map = defaultdict(dict)
462 for item in self.get("items"):
marination957615b2021-01-18 23:47:24 +0530463 warehouse_field = "t_warehouse" if self.doctype == "Stock Entry" else "warehouse"
464 rule = frappe.db.get_value("Putaway Rule",
465 {
466 "item_code": item.get("item_code"),
467 "warehouse": item.get(warehouse_field)
468 },
469 ["name", "disable"], as_dict=True)
470 if rule:
471 if rule.get("disabled"): continue # dont validate for disabled rule
472
473 if self.doctype == "Stock Reconciliation":
474 stock_qty = flt(item.qty)
475 else:
476 stock_qty = flt(item.transfer_qty) if self.doctype == "Stock Entry" else flt(item.stock_qty)
477
478 rule_name = rule.get("name")
479 if not rule_map[rule_name]:
480 rule_map[rule_name]["warehouse"] = item.get(warehouse_field)
481 rule_map[rule_name]["item"] = item.get("item_code")
482 rule_map[rule_name]["qty_put"] = 0
483 rule_map[rule_name]["capacity"] = get_available_putaway_capacity(rule_name)
484 rule_map[rule_name]["qty_put"] += flt(stock_qty)
marinationfac40352020-12-07 21:35:49 +0530485
486 for rule, values in rule_map.items():
487 if flt(values["qty_put"]) > flt(values["capacity"]):
marination957615b2021-01-18 23:47:24 +0530488 message = self.prepare_over_receipt_message(rule, values)
marinationfac40352020-12-07 21:35:49 +0530489 frappe.throw(msg=message, title=_("Over Receipt"))
marination957615b2021-01-18 23:47:24 +0530490
491 def prepare_over_receipt_message(self, rule, values):
492 message = _("{0} qty of Item {1} is being received into Warehouse {2} with capacity {3}.") \
493 .format(
494 frappe.bold(values["qty_put"]), frappe.bold(values["item"]),
495 frappe.bold(values["warehouse"]), frappe.bold(values["capacity"])
496 )
497 message += "<br><br>"
498 rule_link = frappe.utils.get_link_to_form("Putaway Rule", rule)
Ankush Menatad6a2652021-04-17 16:50:02 +0530499 message += _("Please adjust the qty or edit {0} to proceed.").format(rule_link)
marination957615b2021-01-18 23:47:24 +0530500 return message
marinationfac40352020-12-07 21:35:49 +0530501
Nabin Haita77b8c92020-12-21 14:45:50 +0530502 def repost_future_sle_and_gle(self):
503 args = frappe._dict({
504 "posting_date": self.posting_date,
505 "posting_time": self.posting_time,
506 "voucher_type": self.doctype,
507 "voucher_no": self.name,
508 "company": self.company
509 })
Sagar Vora868c0bf2021-03-27 16:10:20 +0530510 if future_sle_exists(args):
Ankush Menat45dd46b2021-11-02 10:50:52 +0530511 item_based_reposting = cint(frappe.db.get_single_value("Stock Reposting Settings", "item_based_reposting"))
512 if item_based_reposting:
513 create_item_wise_repost_entries(voucher_type=self.doctype, voucher_no=self.name)
514 else:
515 create_repost_item_valuation_entry(args)
516
Nabin Hait19f8fa52021-02-22 22:27:22 +0530517
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530518@frappe.whitelist()
519def make_quality_inspections(doctype, docname, items):
Rohan Bansala06ec032021-06-02 14:55:31 +0530520 if isinstance(items, str):
521 items = json.loads(items)
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530522
Rohan Bansala06ec032021-06-02 14:55:31 +0530523 inspections = []
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530524 for item in items:
Rohan Bansal1cdf5a02021-05-26 14:42:15 +0530525 if flt(item.get("sample_size")) > flt(item.get("qty")):
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530526 frappe.throw(_("{item_name}'s Sample Size ({sample_size}) cannot be greater than the Accepted Quantity ({accepted_quantity})").format(
527 item_name=item.get("item_name"),
528 sample_size=item.get("sample_size"),
529 accepted_quantity=item.get("qty")
530 ))
531
532 quality_inspection = frappe.get_doc({
533 "doctype": "Quality Inspection",
534 "inspection_type": "Incoming",
535 "inspected_by": frappe.session.user,
536 "reference_type": doctype,
537 "reference_name": docname,
538 "item_code": item.get("item_code"),
539 "description": item.get("description"),
Rohan Bansal1cdf5a02021-05-26 14:42:15 +0530540 "sample_size": flt(item.get("sample_size")),
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530541 "item_serial_no": item.get("serial_no").split("\n")[0] if item.get("serial_no") else None,
542 "batch_no": item.get("batch_no")
543 }).insert()
544 quality_inspection.save()
Rohan Bansal1cdf5a02021-05-26 14:42:15 +0530545 inspections.append(quality_inspection.name)
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530546
Rohan Bansal1cdf5a02021-05-26 14:42:15 +0530547 return inspections
Rohan Bansal7f8b95e2021-04-14 14:12:03 +0530548
Nabin Haitb99c77b2020-12-25 18:12:35 +0530549def is_reposting_pending():
550 return frappe.db.exists("Repost Item Valuation",
551 {'docstatus': 1, 'status': ['in', ['Queued','In Progress']]})
552
Rohit Waghchaure8520edc2021-06-15 10:21:44 +0530553def future_sle_exists(args, sl_entries=None):
554 key = (args.voucher_type, args.voucher_no)
Nabin Haita77b8c92020-12-21 14:45:50 +0530555
Rohit Waghchaure8520edc2021-06-15 10:21:44 +0530556 if validate_future_sle_not_exists(args, key, sl_entries):
557 return False
558 elif get_cached_data(args, key):
559 return True
560
561 if not sl_entries:
562 sl_entries = get_sle_entries_against_voucher(args)
563 if not sl_entries:
564 return
565
566 or_conditions = get_conditions_to_validate_future_sle(sl_entries)
567
568 data = frappe.db.sql("""
569 select item_code, warehouse, count(name) as total_row
Deepesh Garg6f107da2021-10-12 20:15:55 +0530570 from `tabStock Ledger Entry` force index (item_warehouse)
Rohit Waghchaure8520edc2021-06-15 10:21:44 +0530571 where
572 ({})
573 and timestamp(posting_date, posting_time)
574 >= timestamp(%(posting_date)s, %(posting_time)s)
575 and voucher_no != %(voucher_no)s
576 and is_cancelled = 0
577 GROUP BY
578 item_code, warehouse
579 """.format(" or ".join(or_conditions)), args, as_dict=1)
580
581 for d in data:
582 frappe.local.future_sle[key][(d.item_code, d.warehouse)] = d.total_row
583
584 return len(data)
585
586def validate_future_sle_not_exists(args, key, sl_entries=None):
587 item_key = ''
588 if args.get('item_code'):
589 item_key = (args.get('item_code'), args.get('warehouse'))
590
591 if not sl_entries and hasattr(frappe.local, 'future_sle'):
592 if (not frappe.local.future_sle.get(key) or
593 (item_key and item_key not in frappe.local.future_sle.get(key))):
594 return True
595
596def get_cached_data(args, key):
597 if not hasattr(frappe.local, 'future_sle'):
598 frappe.local.future_sle = {}
599
600 if key not in frappe.local.future_sle:
601 frappe.local.future_sle[key] = frappe._dict({})
602
603 if args.get('item_code'):
604 item_key = (args.get('item_code'), args.get('warehouse'))
605 count = frappe.local.future_sle[key].get(item_key)
606
607 return True if (count or count == 0) else False
608 else:
609 return frappe.local.future_sle[key]
610
611def get_sle_entries_against_voucher(args):
612 return frappe.get_all("Stock Ledger Entry",
Nabin Haita77b8c92020-12-21 14:45:50 +0530613 filters={"voucher_type": args.voucher_type, "voucher_no": args.voucher_no},
614 fields=["item_code", "warehouse"],
615 order_by="creation asc")
616
Rohit Waghchaure8520edc2021-06-15 10:21:44 +0530617def get_conditions_to_validate_future_sle(sl_entries):
Sagar Vora868c0bf2021-03-27 16:10:20 +0530618 warehouse_items_map = {}
619 for entry in sl_entries:
620 if entry.warehouse not in warehouse_items_map:
621 warehouse_items_map[entry.warehouse] = set()
Nabin Haita77b8c92020-12-21 14:45:50 +0530622
Sagar Vora868c0bf2021-03-27 16:10:20 +0530623 warehouse_items_map[entry.warehouse].add(entry.item_code)
624
625 or_conditions = []
626 for warehouse, items in warehouse_items_map.items():
627 or_conditions.append(
Noah Jacobb5a14912021-06-15 12:44:04 +0530628 f"""warehouse = {frappe.db.escape(warehouse)}
629 and item_code in ({', '.join(frappe.db.escape(item) for item in items)})""")
Sagar Vora868c0bf2021-03-27 16:10:20 +0530630
Rohit Waghchaure8520edc2021-06-15 10:21:44 +0530631 return or_conditions
Nabin Haita77b8c92020-12-21 14:45:50 +0530632
633def create_repost_item_valuation_entry(args):
634 args = frappe._dict(args)
635 repost_entry = frappe.new_doc("Repost Item Valuation")
636 repost_entry.based_on = args.based_on
637 if not args.based_on:
638 repost_entry.based_on = 'Transaction' if args.voucher_no else "Item and Warehouse"
639 repost_entry.voucher_type = args.voucher_type
640 repost_entry.voucher_no = args.voucher_no
641 repost_entry.item_code = args.item_code
642 repost_entry.warehouse = args.warehouse
643 repost_entry.posting_date = args.posting_date
644 repost_entry.posting_time = args.posting_time
645 repost_entry.company = args.company
646 repost_entry.allow_zero_rate = args.allow_zero_rate
647 repost_entry.flags.ignore_links = True
Ankush Menataa024fc2021-11-18 12:51:26 +0530648 repost_entry.flags.ignore_permissions = True
Nabin Haita77b8c92020-12-21 14:45:50 +0530649 repost_entry.save()
Sagar Vora868c0bf2021-03-27 16:10:20 +0530650 repost_entry.submit()
Ankush Menat6dc9b822021-10-28 15:53:18 +0530651
652
653def create_item_wise_repost_entries(voucher_type, voucher_no, allow_zero_rate=False):
654 """Using a voucher create repost item valuation records for all item-warehouse pairs."""
655
Ankush Menatd220e082021-10-28 17:47:00 +0530656 stock_ledger_entries = get_items_to_be_repost(voucher_type, voucher_no)
657
Ankush Menat6dc9b822021-10-28 15:53:18 +0530658 distinct_item_warehouses = set()
Ankush Menat6dc9b822021-10-28 15:53:18 +0530659 repost_entries = []
660
661 for sle in stock_ledger_entries:
662 item_wh = (sle.item_code, sle.warehouse)
663 if item_wh in distinct_item_warehouses:
664 continue
665 distinct_item_warehouses.add(item_wh)
666
667 repost_entry = frappe.new_doc("Repost Item Valuation")
668 repost_entry.based_on = "Item and Warehouse"
669 repost_entry.voucher_type = voucher_type
670 repost_entry.voucher_no = voucher_no
671
672 repost_entry.item_code = sle.item_code
673 repost_entry.warehouse = sle.warehouse
674 repost_entry.posting_date = sle.posting_date
675 repost_entry.posting_time = sle.posting_time
676 repost_entry.allow_zero_rate = allow_zero_rate
677 repost_entry.flags.ignore_links = True
Ankush Menat0a2964d2021-11-24 15:55:31 +0530678 repost_entry.flags.ignore_permissions = True
Ankush Menat6dc9b822021-10-28 15:53:18 +0530679 repost_entry.submit()
680 repost_entries.append(repost_entry)
681
682 return repost_entries