# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors # License: GNU General Public License v3. See license.txt from __future__ import unicode_literals import frappe from frappe.utils import cint, flt, cstr, comma_or from frappe import _, throw from erpnext.stock.get_item_details import get_bin_details from erpnext.stock.utils import get_incoming_rate from erpnext.stock.get_item_details import get_conversion_factor from erpnext.controllers.stock_controller import StockController class SellingController(StockController): def __setup__(self): if hasattr(self, "taxes"): self.print_templates = { "taxes": "templates/print_formats/includes/taxes.html" } def get_feed(self): return _("To {0} | {1} {2}").format(self.customer_name, self.currency, self.grand_total) def onload(self): super(SellingController, self).onload() if self.doctype in ("Sales Order", "Delivery Note", "Sales Invoice"): for item in self.get("items"): item.update(get_bin_details(item.item_code, item.warehouse)) def validate(self): super(SellingController, self).validate() self.validate_max_discount() self.validate_selling_price() self.set_qty_as_per_stock_uom() check_active_sales_items(self) def set_missing_values(self, for_validate=False): super(SellingController, self).set_missing_values(for_validate) # set contact and address details for customer, if they are not mentioned self.set_missing_lead_customer_details() self.set_price_list_and_item_details() def set_missing_lead_customer_details(self): if getattr(self, "customer", None): from erpnext.accounts.party import _get_party_details party_details = _get_party_details(self.customer, ignore_permissions=self.flags.ignore_permissions) if not self.meta.get_field("sales_team"): party_details.pop("sales_team") self.update_if_missing(party_details) elif getattr(self, "lead", None): from erpnext.crm.doctype.lead.lead import get_lead_details self.update_if_missing(get_lead_details( self.lead, posting_date=self.get('transaction_date') or self.get('posting_date'), company=self.company)) def set_price_list_and_item_details(self): self.set_price_list_currency("Selling") self.set_missing_item_details() def apply_shipping_rule(self): if self.shipping_rule: shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule) value = self.base_net_total # TODO # shipping rule calculation based on item's net weight shipping_amount = 0.0 for condition in shipping_rule.get("conditions"): if not condition.to_value or (flt(condition.from_value) <= value <= flt(condition.to_value)): shipping_amount = condition.shipping_amount break shipping_charge = { "doctype": "Sales Taxes and Charges", "charge_type": "Actual", "account_head": shipping_rule.account, "cost_center": shipping_rule.cost_center } existing_shipping_charge = self.get("taxes", filters=shipping_charge) if existing_shipping_charge: # take the last record found existing_shipping_charge[-1].tax_amount = shipping_amount else: shipping_charge["tax_amount"] = shipping_amount shipping_charge["description"] = shipping_rule.label self.append("taxes", shipping_charge) self.calculate_taxes_and_totals() def remove_shipping_charge(self): if self.shipping_rule: shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule) existing_shipping_charge = self.get("taxes", { "doctype": "Sales Taxes and Charges", "charge_type": "Actual", "account_head": shipping_rule.account, "cost_center": shipping_rule.cost_center }) if existing_shipping_charge: self.get("taxes").remove(existing_shipping_charge[-1]) self.calculate_taxes_and_totals() def set_total_in_words(self): from frappe.utils import money_in_words disable_rounded_total = cint(frappe.db.get_value("Global Defaults", None, "disable_rounded_total")) if self.meta.get_field("base_in_words"): self.base_in_words = money_in_words(disable_rounded_total and abs(self.base_grand_total) or abs(self.base_rounded_total), self.company_currency) if self.meta.get_field("in_words"): self.in_words = money_in_words(disable_rounded_total and abs(self.grand_total) or abs(self.rounded_total), self.currency) def calculate_commission(self): if self.meta.get_field("commission_rate"): self.round_floats_in(self, ["base_net_total", "commission_rate"]) if self.commission_rate > 100.0: throw(_("Commission rate cannot be greater than 100")) self.total_commission = flt(self.base_net_total * self.commission_rate / 100.0, self.precision("total_commission")) def calculate_contribution(self): if not self.meta.get_field("sales_team"): return total = 0.0 sales_team = self.get("sales_team") for sales_person in sales_team: self.round_floats_in(sales_person) sales_person.allocated_amount = flt( self.base_net_total * sales_person.allocated_percentage / 100.0, self.precision("allocated_amount", sales_person)) total += sales_person.allocated_percentage if sales_team and total != 100.0: throw(_("Total allocated percentage for sales team should be 100")) def validate_order_type(self): valid_types = ["Sales", "Maintenance", "Shopping Cart"] if not self.order_type: self.order_type = "Sales" elif self.order_type not in valid_types: throw(_("Order Type must be one of {0}").format(comma_or(valid_types))) def validate_max_discount(self): for d in self.get("items"): discount = flt(frappe.db.get_value("Item", d.item_code, "max_discount")) if discount and flt(d.discount_percentage) > discount: frappe.throw(_("Maxiumm discount for Item {0} is {1}%").format(d.item_code, discount)) def set_qty_as_per_stock_uom(self): for d in self.get("items"): if d.meta.get_field("stock_qty"): if not d.conversion_factor: frappe.throw(_("Row {0}: Conversion Factor is mandatory").format(d.idx)) d.stock_qty = flt(d.qty) * flt(d.conversion_factor) def validate_selling_price(self): def throw_message(item_name, rate, ref_rate_field): frappe.throw(_("""Selling price for item {0} is lower than its {1}. Selling price should be atleast {2}""") .format(item_name, ref_rate_field, rate)) if not frappe.db.get_single_value("Selling Settings", "validate_selling_price"): return for it in self.get("items"): last_purchase_rate, is_stock_item = frappe.db.get_value("Item", it.item_code, ["last_purchase_rate", "is_stock_item"]) if flt(it.base_rate) < flt(last_purchase_rate): throw_message(it.item_name, last_purchase_rate, "last purchase rate") last_valuation_rate = frappe.db.sql(""" SELECT valuation_rate FROM `tabStock Ledger Entry` WHERE item_code = %s AND warehouse = %s AND valuation_rate > 0 ORDER BY posting_date DESC, posting_time DESC, name DESC LIMIT 1 """, (it.item_code, it.warehouse)) if is_stock_item and flt(it.base_rate) < flt(last_valuation_rate): throw_message(it.name, last_valuation_rate, "valuation rate") def get_item_list(self): il = [] for d in self.get("items"): if d.qty is None: frappe.throw(_("Row {0}: Qty is mandatory").format(d.idx)) if self.has_product_bundle(d.item_code): for p in self.get("packed_items"): if p.parent_detail_docname == d.name and p.parent_item == d.item_code: # the packing details table's qty is already multiplied with parent's qty il.append(frappe._dict({ 'warehouse': p.warehouse, 'item_code': p.item_code, 'qty': flt(p.qty), 'uom': p.uom, 'batch_no': cstr(p.batch_no).strip(), 'serial_no': cstr(p.serial_no).strip(), 'name': d.name, 'target_warehouse': p.target_warehouse })) else: il.append(frappe._dict({ 'warehouse': d.warehouse, 'item_code': d.item_code, 'qty': d.stock_qty, 'uom': d.uom, 'stock_uom': d.stock_uom, 'conversion_factor': d.conversion_factor, 'batch_no': cstr(d.get("batch_no")).strip(), 'serial_no': cstr(d.get("serial_no")).strip(), 'name': d.name, 'target_warehouse': d.target_warehouse })) return il def has_product_bundle(self, item_code): return frappe.db.sql("""select name from `tabProduct Bundle` where new_item_code=%s and docstatus != 2""", item_code) def get_already_delivered_qty(self, current_docname, so, so_detail): delivered_via_dn = frappe.db.sql("""select sum(qty) from `tabDelivery Note Item` where so_detail = %s and docstatus = 1 and against_sales_order = %s and parent != %s""", (so_detail, so, current_docname)) delivered_via_si = frappe.db.sql("""select sum(si_item.qty) from `tabSales Invoice Item` si_item, `tabSales Invoice` si where si_item.parent = si.name and si.update_stock = 1 and si_item.so_detail = %s and si.docstatus = 1 and si_item.sales_order = %s and si.name != %s""", (so_detail, so, current_docname)) total_delivered_qty = (flt(delivered_via_dn[0][0]) if delivered_via_dn else 0) \ + (flt(delivered_via_si[0][0]) if delivered_via_si else 0) return total_delivered_qty def get_so_qty_and_warehouse(self, so_detail): so_item = frappe.db.sql("""select qty, warehouse from `tabSales Order Item` where name = %s and docstatus = 1""", so_detail, as_dict=1) so_qty = so_item and flt(so_item[0]["qty"]) or 0.0 so_warehouse = so_item and so_item[0]["warehouse"] or "" return so_qty, so_warehouse def check_close_sales_order(self, ref_fieldname): for d in self.get("items"): if d.get(ref_fieldname): status = frappe.db.get_value("Sales Order", d.get(ref_fieldname), "status") if status == "Closed": frappe.throw(_("Sales Order {0} is {1}").format(d.get(ref_fieldname), status)) def update_reserved_qty(self): so_map = {} for d in self.get("items"): if d.so_detail: if self.doctype == "Delivery Note" and d.against_sales_order: so_map.setdefault(d.against_sales_order, []).append(d.so_detail) elif self.doctype == "Sales Invoice" and d.sales_order and self.update_stock: so_map.setdefault(d.sales_order, []).append(d.so_detail) for so, so_item_rows in so_map.items(): if so and so_item_rows: sales_order = frappe.get_doc("Sales Order", so) if sales_order.status in ["Closed", "Cancelled"]: frappe.throw(_("{0} {1} is cancelled or closed").format(_("Sales Order"), so), frappe.InvalidStatusError) sales_order.update_reserved_qty(so_item_rows) def update_stock_ledger(self): self.update_reserved_qty() sl_entries = [] for d in self.get_item_list(): if frappe.db.get_value("Item", d.item_code, "is_stock_item") == 1 and flt(d.qty): if flt(d.conversion_factor)==0.0: d.conversion_factor = get_conversion_factor(d.item_code, d.uom).get("conversion_factor") or 1.0 return_rate = 0 if cint(self.is_return) and self.return_against and self.docstatus==1: return_rate = self.get_incoming_rate_for_sales_return(d.item_code, self.return_against) # On cancellation or if return entry submission, make stock ledger entry for # target warehouse first, to update serial no values properly if d.warehouse and ((not cint(self.is_return) and self.docstatus==1) or (cint(self.is_return) and self.docstatus==2)): sl_entries.append(self.get_sl_entries(d, { "actual_qty": -1*flt(d.qty), "incoming_rate": return_rate })) if d.target_warehouse: target_warehouse_sle = self.get_sl_entries(d, { "actual_qty": flt(d.qty), "warehouse": d.target_warehouse }) if self.docstatus == 1: if not cint(self.is_return): args = frappe._dict({ "item_code": d.item_code, "warehouse": d.warehouse, "posting_date": self.posting_date, "posting_time": self.posting_time, "qty": -1*flt(d.qty), "serial_no": d.serial_no }) target_warehouse_sle.update({ "incoming_rate": get_incoming_rate(args) }) else: target_warehouse_sle.update({ "outgoing_rate": return_rate }) sl_entries.append(target_warehouse_sle) if d.warehouse and ((not cint(self.is_return) and self.docstatus==2) or (cint(self.is_return) and self.docstatus==1)): sl_entries.append(self.get_sl_entries(d, { "actual_qty": -1*flt(d.qty), "incoming_rate": return_rate })) self.make_sl_entries(sl_entries) def check_active_sales_items(obj): for d in obj.get("items"): if d.item_code: item = frappe.db.sql("""select docstatus, income_account from tabItem where name = %s""", d.item_code, as_dict=True)[0] if getattr(d, "income_account", None) and not item.income_account: frappe.db.set_value("Item", d.item_code, "income_account", d.income_account)