Rohit Waghchaure | a94b897 | 2021-05-24 20:11:15 +0530 | [diff] [blame] | 1 | from __future__ import unicode_literals |
| 2 | |
| 3 | import frappe |
| 4 | from frappe import _ |
| 5 | from frappe.utils import flt, cint |
| 6 | from collections import defaultdict |
| 7 | from erpnext.stock.doctype.serial_no.serial_no import get_serial_nos |
| 8 | |
| 9 | class Subcontracting(object): |
| 10 | def set_materials_for_subcontracted_items(self, raw_material_table): |
| 11 | if self.doctype == 'Purchase Invoice' and not self.update_stock: |
| 12 | return |
| 13 | |
| 14 | self.raw_material_table = raw_material_table |
| 15 | self.identify_change_in_item_table() |
| 16 | self.prepare_supplied_items() |
| 17 | self.validate_consumed_qty() |
| 18 | |
| 19 | def prepare_supplied_items(self): |
| 20 | self.initialized_fields() |
| 21 | self.get_purchase_orders() |
| 22 | self.get_pending_qty_to_receive() |
| 23 | self.get_available_materials() |
| 24 | self.remove_changed_rows() |
| 25 | self.set_supplied_items() |
| 26 | |
| 27 | def initialized_fields(self): |
| 28 | self.available_materials = frappe._dict() |
| 29 | self.alternative_item_details = frappe._dict() |
| 30 | self.get_backflush_based_on() |
| 31 | |
| 32 | def get_backflush_based_on(self): |
| 33 | self.backflush_based_on = frappe.db.get_single_value("Buying Settings", |
| 34 | "backflush_raw_materials_of_subcontract_based_on") |
| 35 | |
| 36 | def get_purchase_orders(self): |
| 37 | self.purchase_orders = [] |
| 38 | |
| 39 | if self.doctype == 'Purchase Order': |
| 40 | return |
| 41 | |
| 42 | self.purchase_orders = [d.purchase_order for d in self.items if d.purchase_order] |
| 43 | |
| 44 | def identify_change_in_item_table(self): |
| 45 | self.changed_name = [] |
| 46 | |
| 47 | if self.doctype == 'Purchase Order' or not self.get(self.raw_material_table): |
| 48 | self.set(self.raw_material_table, []) |
| 49 | return |
| 50 | |
| 51 | item_dict = self.get_data_before_save() |
| 52 | if not item_dict: |
| 53 | return True |
| 54 | |
| 55 | for n_row in self.items: |
| 56 | if (n_row.name not in item_dict) or (n_row.item_code, n_row.qty) != item_dict[n_row.name]: |
| 57 | self.changed_name.append(n_row.name) |
| 58 | |
| 59 | if item_dict.get(n_row.name): |
| 60 | del item_dict[n_row.name] |
| 61 | |
| 62 | self.changed_name.extend(item_dict.keys()) |
| 63 | |
| 64 | def get_data_before_save(self): |
| 65 | item_dict = {} |
| 66 | if self.doctype == 'Purchase Receipt' and self._doc_before_save: |
| 67 | for row in self._doc_before_save.get('items'): |
| 68 | item_dict[row.name] = (row.item_code, row.qty) |
| 69 | |
| 70 | return item_dict |
| 71 | |
| 72 | def get_available_materials(self): |
| 73 | ''' Get the available raw materials which has been transferred to the supplier. |
| 74 | available_materials = { |
| 75 | (item_code, subcontracted_item, purchase_order): { |
| 76 | 'qty': 1, 'serial_no': [ABC], 'batch_no': {'batch1': 1}, 'data': item_details |
| 77 | } |
| 78 | } |
| 79 | ''' |
| 80 | if not self.purchase_orders: |
| 81 | return |
| 82 | |
| 83 | for row in self.get_transferred_items(): |
| 84 | key = (row.rm_item_code, row.main_item_code, row.purchase_order) |
| 85 | |
| 86 | if key not in self.available_materials: |
| 87 | self.available_materials.setdefault(key, frappe._dict({'qty': 0, 'serial_no': [], |
| 88 | 'batch_no': defaultdict(float), 'item_details': row, 'po_details': []}) |
| 89 | ) |
| 90 | |
| 91 | details = self.available_materials[key] |
| 92 | details.qty += row.qty |
| 93 | details.po_details.append(row.po_detail) |
| 94 | |
| 95 | if row.serial_no: |
| 96 | details.serial_no.extend(get_serial_nos(row.serial_no)) |
| 97 | |
| 98 | if row.batch_no: |
| 99 | details.batch_no[row.batch_no] += row.qty |
| 100 | |
| 101 | self.set_alternative_item_details(row) |
| 102 | |
| 103 | for doctype in ['Purchase Receipt', 'Purchase Invoice']: |
Rohit Waghchaure | 9a2db0b | 2021-06-01 11:24:01 +0530 | [diff] [blame^] | 104 | self.update_consumed_materials(doctype) |
Rohit Waghchaure | a94b897 | 2021-05-24 20:11:15 +0530 | [diff] [blame] | 105 | |
Rohit Waghchaure | 9a2db0b | 2021-06-01 11:24:01 +0530 | [diff] [blame^] | 106 | def update_consumed_materials(self, doctype, return_consumed_items=False): |
Rohit Waghchaure | a94b897 | 2021-05-24 20:11:15 +0530 | [diff] [blame] | 107 | '''Deduct the consumed materials from the available materials.''' |
| 108 | |
| 109 | pr_items = self.get_received_items(doctype) |
| 110 | if not pr_items: |
| 111 | return ([], {}) if return_consumed_items else None |
| 112 | |
| 113 | pr_items = {d.name: d.get(self.get('po_field') or 'purchase_order') for d in pr_items} |
| 114 | consumed_materials = self.get_consumed_items(doctype, pr_items.keys()) |
| 115 | |
| 116 | if return_consumed_items: |
| 117 | return (consumed_materials, pr_items) |
| 118 | |
| 119 | for row in consumed_materials: |
| 120 | key = (row.rm_item_code, row.main_item_code, pr_items.get(row.reference_name)) |
| 121 | if not self.available_materials.get(key): |
| 122 | continue |
| 123 | |
| 124 | self.available_materials[key]['qty'] -= row.consumed_qty |
| 125 | if row.serial_no: |
| 126 | self.available_materials[key]['serial_no'] = list( |
| 127 | set(self.available_materials[key]['serial_no']) - set(get_serial_nos(row.serial_no)) |
| 128 | ) |
| 129 | |
| 130 | if row.batch_no: |
| 131 | self.available_materials[key]['batch_no'][row.batch_no] -= row.consumed_qty |
| 132 | |
| 133 | def get_transferred_items(self): |
| 134 | fields = ['`tabStock Entry`.`purchase_order`'] |
| 135 | alias_dict = {'item_code': 'rm_item_code', 'subcontracted_item': 'main_item_code', 'basic_rate': 'rate'} |
| 136 | |
| 137 | child_table_fields = ['item_code', 'item_name', 'description', 'qty', 'basic_rate', 'amount', |
| 138 | 'serial_no', 'uom', 'subcontracted_item', 'stock_uom', 'batch_no', 'conversion_factor', |
| 139 | 's_warehouse', 't_warehouse', 'item_group', 'po_detail'] |
| 140 | |
| 141 | if self.backflush_based_on == 'BOM': |
| 142 | child_table_fields.append('original_item') |
| 143 | |
| 144 | for field in child_table_fields: |
| 145 | fields.append(f'`tabStock Entry Detail`.`{field}` As {alias_dict.get(field, field)}') |
| 146 | |
| 147 | filters = [['Stock Entry', 'docstatus', '=', 1], ['Stock Entry', 'purpose', '=', 'Send to Subcontractor'], |
| 148 | ['Stock Entry', 'purchase_order', 'in', self.purchase_orders]] |
| 149 | |
| 150 | return frappe.get_all('Stock Entry', fields = fields, filters=filters) |
| 151 | |
| 152 | def get_received_items(self, doctype): |
| 153 | fields = [] |
| 154 | self.po_field = 'purchase_order' if doctype == 'Purchase Receipt' else 'po_detail' |
| 155 | |
| 156 | for field in ['name', self.po_field, 'parent']: |
| 157 | fields.append(f'`tab{doctype} Item`.`{field}`') |
| 158 | |
| 159 | filters = [[doctype, 'docstatus', '=', 1], [f'{doctype} Item', self.po_field, 'in', self.purchase_orders]] |
| 160 | if doctype == 'Purchase Invoice': |
| 161 | filters.append(['Purchase Invoice', 'update_stock', "=", 1]) |
| 162 | |
| 163 | return frappe.get_all(f'{doctype}', fields = fields, filters = filters) |
| 164 | |
| 165 | def get_consumed_items(self, doctype, pr_items): |
| 166 | return frappe.get_all(f'{doctype} Item Supplied', |
| 167 | fields = ['serial_no', 'rm_item_code', 'reference_name', 'batch_no', 'consumed_qty', 'main_item_code'], |
| 168 | filters = {'docstatus': 1, 'reference_name': ('in', list(pr_items))}) |
| 169 | |
| 170 | def set_alternative_item_details(self, row): |
| 171 | if row.get('original_item'): |
| 172 | self.alternative_item_details[row.get('original_item')] = row |
| 173 | |
| 174 | def get_pending_qty_to_receive(self): |
| 175 | '''Get qty to be received against the purchase order.''' |
| 176 | |
| 177 | self.qty_to_be_received = defaultdict(float) |
| 178 | |
| 179 | if self.doctype != 'Purchase Order' and self.backflush_based_on != 'BOM' and self.purchase_orders: |
| 180 | for row in frappe.get_all('Purchase Order Item', |
| 181 | fields = ['item_code', '(qty - received_qty) as qty', 'parent', 'name'], |
| 182 | filters = {'docstatus': 1, 'parent': ('in', self.purchase_orders)}): |
| 183 | |
| 184 | self.qty_to_be_received[(row.item_code, row.parent)] += row.qty |
| 185 | |
| 186 | def get_materials_from_bom(self, item_code, bom_no, exploded_item=0): |
| 187 | doctype = 'BOM Item' if not exploded_item else 'BOM Explosion Item' |
| 188 | fields = [f'`tab{doctype}`.`stock_qty` / `tabBOM`.`quantity` as qty_consumed_per_unit'] |
| 189 | |
| 190 | alias_dict = {'item_code': 'rm_item_code', 'name': 'bom_detail_no', 'source_warehouse': 'reserve_warehouse'} |
| 191 | for field in ['item_code', 'name', 'rate', 'stock_uom', |
| 192 | 'source_warehouse', 'description', 'item_name', 'stock_uom']: |
| 193 | fields.append(f'`tab{doctype}`.`{field}` As {alias_dict.get(field, field)}') |
| 194 | |
| 195 | filters = [[doctype, 'parent', '=', bom_no], [doctype, 'docstatus', '=', 1], |
| 196 | ['BOM', 'item', '=', item_code], [doctype, 'sourced_by_supplier', '=', 0]] |
| 197 | |
| 198 | return frappe.get_all('BOM', fields = fields, filters=filters, order_by = f'`tab{doctype}`.`idx`') or [] |
| 199 | |
| 200 | def remove_changed_rows(self): |
| 201 | if not self.changed_name: |
| 202 | return |
| 203 | |
| 204 | i=1 |
| 205 | self.set(self.raw_material_table, []) |
| 206 | for d in self._doc_before_save.supplied_items: |
| 207 | if d.reference_name in self.changed_name: |
| 208 | continue |
| 209 | |
| 210 | d.idx = i |
| 211 | self.append('supplied_items', d) |
| 212 | |
| 213 | i += 1 |
| 214 | |
| 215 | def set_supplied_items(self): |
| 216 | self.bom_items = {} |
| 217 | |
| 218 | has_supplied_items = True if self.get(self.raw_material_table) else False |
| 219 | for row in self.items: |
| 220 | if (self.doctype != 'Purchase Order' and ((self.changed_name and row.name not in self.changed_name) |
| 221 | or (has_supplied_items and not self.changed_name))): |
| 222 | continue |
| 223 | |
| 224 | if self.doctype == 'Purchase Order' or self.backflush_based_on == 'BOM': |
| 225 | for bom_item in self.get_materials_from_bom(row.item_code, row.bom, row.get('include_exploded_items')): |
| 226 | qty = (flt(bom_item.qty_consumed_per_unit) * flt(row.qty) * row.conversion_factor) |
| 227 | bom_item.main_item_code = row.item_code |
| 228 | self.update_reserve_warehouse(bom_item, row) |
| 229 | self.set_alternative_item(bom_item) |
| 230 | self.add_supplied_item(row, bom_item, qty) |
| 231 | |
| 232 | elif self.backflush_based_on != 'BOM': |
| 233 | for key, transfer_item in self.available_materials.items(): |
| 234 | if (key[1], key[2]) == (row.item_code, row.purchase_order) and transfer_item.qty > 0: |
| 235 | qty = self.get_qty_based_on_material_transfer(row, transfer_item) or 0 |
| 236 | transfer_item.qty -= qty |
| 237 | self.add_supplied_item(row, transfer_item.get('item_details'), qty) |
| 238 | |
| 239 | if self.qty_to_be_received: |
| 240 | self.qty_to_be_received[(row.item_code, row.purchase_order)] -= row.qty |
| 241 | |
| 242 | def update_reserve_warehouse(self, row, item): |
| 243 | if self.doctype == 'Purchase Order': |
| 244 | row.reserve_warehouse = (self.set_reserve_warehouse or item.warehouse) |
| 245 | |
| 246 | def get_qty_based_on_material_transfer(self, item_row, transfer_item): |
| 247 | key = (item_row.item_code, item_row.purchase_order) |
| 248 | |
| 249 | if self.qty_to_be_received == item_row.qty: |
| 250 | return transfer_item.qty |
| 251 | |
| 252 | if self.qty_to_be_received: |
| 253 | qty = (flt(item_row.qty) * flt(transfer_item.qty)) / flt(self.qty_to_be_received.get(key, 0)) |
| 254 | if (transfer_item.serial_no or frappe.get_cached_value('UOM', |
| 255 | transfer_item.item_details.stock_uom, 'must_be_whole_number')): |
| 256 | return frappe.utils.ceil(qty) |
| 257 | |
| 258 | return qty |
| 259 | |
| 260 | def set_alternative_item(self, bom_item): |
| 261 | if self.alternative_item_details.get(bom_item.rm_item_code): |
| 262 | bom_item.update(self.alternative_item_details[bom_item.rm_item_code]) |
| 263 | |
| 264 | def add_supplied_item(self, item_row, bom_item, qty): |
| 265 | bom_item.conversion_factor = item_row.conversion_factor |
| 266 | rm_obj = self.append(self.raw_material_table, bom_item) |
| 267 | rm_obj.reference_name = item_row.name |
| 268 | |
| 269 | if self.doctype == 'Purchase Order': |
| 270 | rm_obj.required_qty = qty |
| 271 | else: |
| 272 | self.set_batch_nos(bom_item, item_row, rm_obj, qty) |
| 273 | |
| 274 | def set_batch_nos(self, bom_item, item_row, rm_obj, qty): |
| 275 | key = (rm_obj.rm_item_code, item_row.item_code, item_row.purchase_order) |
| 276 | |
| 277 | if (self.available_materials.get(key) and self.available_materials[key]['batch_no']): |
| 278 | for batch_no, batch_qty in self.available_materials[key]['batch_no'].items(): |
| 279 | if batch_qty >= qty: |
| 280 | self.set_batch_no_as_per_qty(item_row, rm_obj, batch_no, qty) |
| 281 | self.available_materials[key]['batch_no'][batch_no] -= qty |
| 282 | return |
| 283 | |
| 284 | elif qty > 0 and batch_qty > 0: |
| 285 | qty -= batch_qty |
| 286 | new_rm_obj = self.append(self.raw_material_table, bom_item) |
| 287 | new_rm_obj.reference_name = item_row.name |
| 288 | self.set_batch_no_as_per_qty(item_row, new_rm_obj, batch_no, batch_qty) |
| 289 | self.available_materials[key]['batch_no'][batch_no] = 0 |
| 290 | else: |
| 291 | rm_obj.required_qty = qty |
| 292 | rm_obj.consumed_qty = qty |
| 293 | self.set_serial_nos(item_row, rm_obj) |
| 294 | |
| 295 | def set_batch_no_as_per_qty(self, item_row, rm_obj, batch_no, qty): |
| 296 | rm_obj.update({'consumed_qty': qty, 'batch_no': batch_no, 'required_qty': qty}) |
| 297 | self.set_serial_nos(item_row, rm_obj) |
| 298 | |
| 299 | def set_serial_nos(self, item_row, rm_obj): |
| 300 | key = (rm_obj.rm_item_code, item_row.item_code, item_row.purchase_order) |
| 301 | if (self.available_materials.get(key) and self.available_materials[key]['serial_no']): |
| 302 | used_serial_nos = self.available_materials[key]['serial_no'][0: cint(rm_obj.consumed_qty)] |
| 303 | rm_obj.serial_no = '\n'.join(used_serial_nos) |
| 304 | |
| 305 | # Removed the used serial nos from the list |
| 306 | for sn in used_serial_nos: |
| 307 | self.available_materials[key]['serial_no'].remove(sn) |
| 308 | |
| 309 | def set_consumed_qty_in_po(self): |
| 310 | if self.is_subcontracted != 'Yes': |
| 311 | return |
| 312 | |
| 313 | self.get_purchase_orders() |
Rohit Waghchaure | 9a2db0b | 2021-06-01 11:24:01 +0530 | [diff] [blame^] | 314 | consumed_items, pr_items = self.update_consumed_materials(self.doctype, return_consumed_items=True) |
Rohit Waghchaure | a94b897 | 2021-05-24 20:11:15 +0530 | [diff] [blame] | 315 | |
| 316 | itemwise_consumed_qty = defaultdict(float) |
| 317 | for row in consumed_items: |
| 318 | key = (row.rm_item_code, row.main_item_code, pr_items.get(row.reference_name)) |
| 319 | itemwise_consumed_qty[key] += row.consumed_qty |
| 320 | |
| 321 | self.update_consumed_qty_in_po(itemwise_consumed_qty) |
| 322 | |
| 323 | def update_consumed_qty_in_po(self, itemwise_consumed_qty): |
| 324 | fields = ['main_item_code', 'rm_item_code', 'parent', 'supplied_qty', 'name'] |
| 325 | filters = {'docstatus': 1, 'parent': ('in', self.purchase_orders)} |
| 326 | |
| 327 | for row in frappe.get_all('Purchase Order Item Supplied', fields = fields, filters=filters, order_by='idx'): |
| 328 | key = (row.rm_item_code, row.main_item_code, row.parent) |
| 329 | consumed_qty = itemwise_consumed_qty.get(key, 0) |
| 330 | |
| 331 | if row.supplied_qty < consumed_qty: |
| 332 | consumed_qty = row.supplied_qty |
| 333 | |
| 334 | itemwise_consumed_qty[key] -= consumed_qty |
| 335 | frappe.db.set_value('Purchase Order Item Supplied', row.name, 'consumed_qty', consumed_qty) |
| 336 | |
| 337 | def validate_consumed_qty(self): |
| 338 | for row in self.get(self.raw_material_table): |
| 339 | if flt(row.consumed_qty) == 0.0 and row.get('serial_no'): |
| 340 | msg = f'Row {row.idx}: the consumed qty cannot be zero for the item {frappe.bold(row.rm_item_code)}' |
| 341 | |
| 342 | frappe.throw(_(msg),title=_('Consumed Items Qty Check')) |