erpnext/utilities/page/leaderboard/leaderboard.py

# Copyright (c) 2017, Frappe Technologies Pvt. Ltd. and Contributors
# MIT License. See license.txt

from __future__ import unicode_literals, print_function
import frappe
from frappe.utils import add_to_date

@frappe.whitelist()
def get_leaderboard(doctype, timespan, company, field):
	"""return top 10 items for that doctype based on conditions"""
	from_date = get_from_date(timespan)
	records = []
	if doctype == "Customer":
		records = get_all_customers(from_date, company, field)
	elif  doctype == "Item":
		records = get_all_items(from_date, company, field)
	elif  doctype == "Supplier":
		records = get_all_suppliers(from_date, company, field)
	elif  doctype == "Sales Partner":
		records = get_all_sales_partner(from_date, company, field)
	elif doctype == "Sales Person":
		records = get_all_sales_person(from_date, company)

	return records

def get_all_customers(from_date, company, field):
	if field == "outstanding_amount":
		return frappe.db.sql("""
			select customer as name, sum(outstanding_amount) as value
			FROM `tabSales Invoice`
			where docstatus = 1 and posting_date >= %s and company = %s
			group by customer
			order by value DESC
			limit 20
		""", (from_date, company), as_dict=1)
	else:
		if field == "total_sales_amount":
			select_field = "sum(so_item.base_net_amount)"
		elif field == "total_qty_sold":
			select_field = "sum(so_item.stock_qty)"

		return frappe.db.sql("""
			select so.customer as name, {0} as value
			FROM `tabSales Order` as so JOIN `tabSales Order Item` as so_item
				ON so.name = so_item.parent
			where so.docstatus = 1 and so.transaction_date >= %s and so.company = %s
			group by so.customer
			order by value DESC
			limit 20
		""".format(select_field), (from_date, company), as_dict=1)

def get_all_items(from_date, company, field):
	if field in ("available_stock_qty", "available_stock_value"):
		return frappe.db.sql("""
			select item_code as name, {0} as value
			from tabBin
			group by item_code
			order by value desc
			limit 20
		""".format("sum(actual_qty)" if field=="available_stock_qty" else "sum(stock_value)"), as_dict=1)
	else:
		if field == "total_sales_amount":
			select_field = "sum(order_item.base_net_amount)"
			select_doctype = "Sales Order"
		elif field == "total_purchase_amount":
			select_field = "sum(order_item.base_net_amount)"
			select_doctype = "Purchase Order"
		elif field == "total_qty_sold":
			select_field = "sum(order_item.stock_qty)"
			select_doctype = "Sales Order"
		elif field == "total_qty_purchased":
			select_field = "sum(order_item.stock_qty)"
			select_doctype = "Purchase Order"

		return frappe.db.sql("""
			select order_item.item_code as name, {0} as value
			from `tab{1}` sales_order join `tab{1} Item` as order_item
				on sales_order.name = order_item.parent
			where sales_order.docstatus = 1
				and sales_order.company = %s and sales_order.transaction_date >= %s
			group by order_item.item_code
			order by value desc
			limit 20
		""".format(select_field, select_doctype), (company, from_date), as_dict=1)

def get_all_suppliers(from_date, company, field):
	if field == "outstanding_amount":
		return frappe.db.sql("""
			select supplier as name, sum(outstanding_amount) as value
			FROM `tabPurchase Invoice`
			where docstatus = 1 and posting_date >= %s and company = %s
			group by supplier
			order by value DESC
			limit 20""", (from_date, company), as_dict=1)
	else:
		if field == "total_purchase_amount":
			select_field = "sum(purchase_order_item.base_net_amount)"
		elif field == "total_qty_purchased":
			select_field = "sum(purchase_order_item.stock_qty)"

		return frappe.db.sql("""
			select purchase_order.supplier as name, {0} as value
			FROM `tabPurchase Order` as purchase_order LEFT JOIN `tabPurchase Order Item`
				as purchase_order_item ON purchase_order.name = purchase_order_item.parent
			where purchase_order.docstatus = 1 and  purchase_order.modified >= %s
				and  purchase_order.company = %s
			group by purchase_order.supplier
			order by value DESC
			limit 20""".format(select_field), (from_date, company), as_dict=1)

def get_all_sales_partner(from_date, company, field):
	if field == "total_sales_amount":
		select_field = "sum(base_net_total)"
	elif field == "total_commission":
		select_field = "sum(total_commission)"

	return frappe.db.sql("""
		select sales_partner as name, {0} as value
		from `tabSales Order`
	 	where ifnull(sales_partner, '') != '' and docstatus = 1
			and transaction_date >= %s and company = %s
	 	group by sales_partner
	 	order by value DESC
	 	limit 20
	""".format(select_field), (from_date, company), as_dict=1)

def get_all_sales_person(from_date, company):
	return frappe.db.sql("""
		select sales_team.sales_person as name, sum(sales_order.base_net_total) as value
		from `tabSales Order` as sales_order join `tabSales Team` as sales_team
			on sales_order.name = sales_team.parent and sales_team.parenttype = 'Sales Order'
	 	where sales_order.docstatus = 1
			and sales_order.transaction_date >= %s
			and sales_order.company = %s
	 	group by sales_team.sales_person
	 	order by value DESC
	 	limit 20
	""", (from_date, company), as_dict=1)

def get_from_date(seleted_timespan):
	"""return string for ex:this week as date:string"""
	days = months = years = 0
	if "month" == seleted_timespan.lower():
		months = -1
	elif "quarter" == seleted_timespan.lower():
		months = -3
	elif "year" == seleted_timespan.lower():
		years = -1
	else:
		days = -7

	return add_to_date(None, years=years, months=months, days=days,
		as_string=True, as_datetime=True)