brotherton-erpnext/erpnext/controllers/selling_controller.py

240 lines
8.6 KiB
Python
Raw Normal View History

# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt
from __future__ import unicode_literals
2014-02-14 10:17:51 +00:00
import frappe
from frappe.utils import cint, flt, cstr, comma_or
from erpnext.setup.utils import get_company_currency
2014-04-14 13:50:45 +00:00
from frappe import _, throw
from erpnext.stock.get_item_details import get_available_qty
from erpnext.controllers.stock_controller import StockController
2013-03-19 06:31:24 +00:00
class SellingController(StockController):
2014-07-18 11:09:31 +00:00
def __setup__(self):
2015-02-22 19:36:00 +00:00
if hasattr(self, "taxes"):
self.print_templates = {
"taxes": "templates/print_formats/includes/taxes.html"
2014-07-21 12:55:45 +00:00
}
2014-07-18 11:09:31 +00:00
2014-09-09 10:45:35 +00:00
def get_feed(self):
return _("To {0} | {1} {2}").format(self.customer_name, self.currency,
self.grand_total)
2014-09-09 10:45:35 +00:00
def onload(self):
if self.doctype in ("Sales Order", "Delivery Note", "Sales Invoice"):
2014-12-26 07:45:21 +00:00
for item in self.get("items"):
item.update(get_available_qty(item.item_code,
item.warehouse))
2013-10-18 06:59:11 +00:00
def validate(self):
super(SellingController, self).validate()
self.validate_max_discount()
check_active_sales_items(self)
2014-04-08 14:40:03 +00:00
def set_missing_values(self, for_validate=False):
2013-06-14 12:14:03 +00:00
super(SellingController, self).set_missing_values(for_validate)
2014-04-08 14:40:03 +00:00
# set contact and address details for customer, if they are not mentioned
2013-06-14 12:14:03 +00:00
self.set_missing_lead_customer_details()
2013-10-17 11:31:14 +00:00
self.set_price_list_and_item_details()
2014-04-08 14:40:03 +00:00
2013-06-14 12:14:03 +00:00
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)
2014-05-02 10:15:10 +00:00
if not self.meta.get_field("sales_team"):
party_details.pop("sales_team")
self.update_if_missing(party_details)
2014-04-08 14:40:03 +00:00
elif getattr(self, "lead", None):
2015-02-17 05:06:54 +00:00
from erpnext.crm.doctype.lead.lead import get_lead_details
self.update_if_missing(get_lead_details(self.lead))
2014-04-08 14:40:03 +00:00
2013-10-17 11:31:14 +00:00
def set_price_list_and_item_details(self):
self.set_price_list_currency("Selling")
2014-02-11 10:44:52 +00:00
self.set_missing_item_details()
2014-04-08 14:40:03 +00:00
def apply_shipping_rule(self):
if self.shipping_rule:
2014-03-28 11:14:37 +00:00
shipping_rule = frappe.get_doc("Shipping Rule", self.shipping_rule)
value = self.base_net_total
2014-04-08 14:40:03 +00:00
# TODO
# shipping rule calculation based on item's net weight
2014-04-08 14:40:03 +00:00
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
2014-04-08 14:40:03 +00:00
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()
2014-04-08 14:40:03 +00:00
def set_total_in_words(self):
2014-02-14 10:17:51 +00:00
from frappe.utils import money_in_words
company_currency = get_company_currency(self.company)
2014-04-08 14:40:03 +00:00
2015-07-22 12:17:49 +00:00
disable_rounded_total = cint(frappe.db.get_value("Global Defaults", None, "disable_rounded_total"))
2014-04-08 14:40:03 +00:00
if self.meta.get_field("base_in_words"):
self.base_in_words = money_in_words(disable_rounded_total and
2015-07-22 12:17:49 +00:00
abs(self.base_grand_total) or abs(self.base_rounded_total), company_currency)
if self.meta.get_field("in_words"):
2014-04-08 14:40:03 +00:00
self.in_words = money_in_words(disable_rounded_total and
2015-07-22 12:17:49 +00:00
abs(self.grand_total) or abs(self.rounded_total), self.currency)
2014-04-08 14:40:03 +00:00
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:
2014-04-14 13:50:45 +00:00
throw(_("Commission rate cannot be greater than 100"))
2014-04-08 14:40:03 +00:00
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
2014-03-27 10:42:56 +00:00
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))
2014-04-08 14:40:03 +00:00
total += sales_person.allocated_percentage
2014-04-08 14:40:03 +00:00
if sales_team and total != 100.0:
2014-04-14 13:50:45 +00:00
throw(_("Total allocated percentage for sales team should be 100"))
2014-04-08 14:40:03 +00:00
def validate_order_type(self):
2013-06-14 12:14:03 +00:00
valid_types = ["Sales", "Maintenance", "Shopping Cart"]
if not self.order_type:
self.order_type = "Sales"
elif self.order_type not in valid_types:
2014-07-07 06:05:54 +00:00
throw(_("Order Type must be one of {0}").format(comma_or(valid_types)))
2014-04-08 14:40:03 +00:00
2013-10-18 06:59:11 +00:00
def validate_max_discount(self):
2014-12-26 07:45:21 +00:00
for d in self.get("items"):
2014-02-26 07:05:33 +00:00
discount = flt(frappe.db.get_value("Item", d.item_code, "max_discount"))
2014-04-08 14:40:03 +00:00
2014-02-10 12:24:04 +00:00
if discount and flt(d.discount_percentage) > discount:
2014-04-16 11:51:25 +00:00
frappe.throw(_("Maxiumm discount for Item {0} is {1}%").format(d.item_code, discount))
2014-04-08 14:40:03 +00:00
2013-10-18 06:59:11 +00:00
def get_item_list(self):
il = []
2014-12-26 07:45:21 +00:00
for d in self.get("items"):
if d.qty is None:
2014-08-18 10:10:15 +00:00
frappe.throw(_("Row {0}: Qty is mandatory").format(d.idx))
2015-07-07 08:29:23 +00:00
if self.has_product_bundle(d.item_code):
for p in self.get("packed_items"):
2013-10-18 06:59:11 +00:00
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
2014-02-14 10:17:51 +00:00
il.append(frappe._dict({
2013-10-18 06:59:11 +00:00
'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
2013-10-18 06:59:11 +00:00
}))
else:
2014-02-14 10:17:51 +00:00
il.append(frappe._dict({
2013-10-18 06:59:11 +00:00
'warehouse': d.warehouse,
'item_code': d.item_code,
'qty': d.qty,
'uom': d.stock_uom,
'stock_uom': d.stock_uom,
2014-04-07 06:32:57 +00:00
'batch_no': cstr(d.get("batch_no")).strip(),
'serial_no': cstr(d.get("serial_no")).strip(),
'name': d.name,
'target_warehouse': d.target_warehouse
2013-10-18 06:59:11 +00:00
}))
return il
2014-04-08 14:40:03 +00:00
2015-07-07 08:29:23 +00:00
def has_product_bundle(self, item_code):
return frappe.db.sql("""select name from `tabProduct Bundle`
2013-10-18 06:59:11 +00:00
where new_item_code=%s and docstatus != 2""", item_code)
2014-04-08 14:40:03 +00:00
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
2014-04-08 14:40:03 +00:00
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 ifnull(si.update_stock, 0) = 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
2013-10-18 06:59:11 +00:00
def get_so_qty_and_warehouse(self, so_detail):
2014-02-26 07:05:33 +00:00
so_item = frappe.db.sql("""select qty, warehouse from `tabSales Order Item`
2013-10-18 06:59:11 +00:00
where name = %s and docstatus = 1""", so_detail, as_dict=1)
so_qty = so_item and flt(so_item[0]["qty"]) or 0.0
2014-02-10 12:24:04 +00:00
so_warehouse = so_item and so_item[0]["warehouse"] or ""
2013-10-18 06:59:11 +00:00
return so_qty, so_warehouse
2014-04-08 14:40:03 +00:00
2013-10-18 06:59:11 +00:00
def check_stop_sales_order(self, ref_fieldname):
2014-12-26 07:45:21 +00:00
for d in self.get("items"):
if d.get(ref_fieldname):
status = frappe.db.get_value("Sales Order", d.get(ref_fieldname), "status")
2013-10-18 06:59:11 +00:00
if status == "Stopped":
2014-04-15 11:00:55 +00:00
frappe.throw(_("Sales Order {0} is stopped").format(d.get(ref_fieldname)))
2014-04-08 14:40:03 +00:00
2013-10-18 06:59:11 +00:00
def check_active_sales_items(obj):
2014-12-26 07:45:21 +00:00
for d in obj.get("items"):
2013-10-18 06:59:11 +00:00
if d.item_code:
2014-04-08 14:40:03 +00:00
item = frappe.db.sql("""select docstatus, is_sales_item,
is_service_item, income_account from tabItem where name = %s""",
2013-10-18 06:59:11 +00:00
d.item_code, as_dict=True)[0]
if item.is_sales_item == 0 and item.is_service_item == 0:
2014-04-16 11:51:25 +00:00
frappe.throw(_("Item {0} must be Sales or Service Item in {1}").format(d.item_code, d.idx))
2014-04-03 12:08:54 +00:00
if getattr(d, "income_account", None) and not item.income_account:
2014-04-08 14:40:03 +00:00
frappe.db.set_value("Item", d.item_code, "income_account",
2013-10-18 07:25:59 +00:00
d.income_account)