Merge pull request #4419 from nabinhait/salary_payment_days

[fix] Payment Days and holidays considering joining and relieving dates

erpnext/hr/doctype/holiday_list/test_records.json

@@ -7,6 +7,10 @@
     "description": "New Year", 
     "holiday_date": "2013-01-01"
    },
+   {
+    "description": "Republic Day", 
+    "holiday_date": "2013-01-26"
+   },
    {
     "description": "Test Holiday", 
     "holiday_date": "2013-02-01"

erpnext/hr/doctype/salary_slip/salary_slip.py

@@ -4,7 +4,7 @@
 from __future__ import unicode_literals
 import frappe
 
-from frappe.utils import add_days, cint, cstr, flt, getdate, nowdate, rounded
+from frappe.utils import add_days, cint, cstr, flt, getdate, nowdate, rounded, date_diff
 from frappe.model.naming import make_autoname
 
 from frappe import msgprint, _
@@ -20,19 +20,20 @@ class SalarySlip(TransactionBase):
 
 	def get_emp_and_leave_details(self):
 		if self.employee:
-			self.get_leave_details()
+			joining_date, relieving_date = frappe.db.get_value("Employee", self.employee, 
-			struct = self.check_sal_struct()
+				["date_of_joining", "relieving_date"])
+				
+			self.get_leave_details(joining_date, relieving_date)
+			
+			struct = self.check_sal_struct(joining_date, relieving_date)
 			if struct:
 				self.set("earnings", [])
 				self.set("deduction", [])
 				self.pull_sal_struct(struct)
 
-	def check_sal_struct(self):
+	def check_sal_struct(self, joining_date, relieving_date):
 		m = get_month_details(self.fiscal_year, self.month)
 		
-		joining_date, relieving_date = frappe.db.get_value("Employee", self.employee, 
-			["date_of_joining", "relieving_date"])
-		
 		struct = frappe.db.sql("""select name from `tabSalary Structure`
 			where employee=%s and is_active = 'Yes'
 			and (from_date <= %s or from_date <= %s) 
@@ -51,69 +52,76 @@ class SalarySlip(TransactionBase):
 		make_salary_slip(struct, self)
 
 	def pull_emp_details(self):
-		emp = frappe.db.get_value("Employee", self.employee,
+		emp = frappe.db.get_value("Employee", self.employee, ["bank_name", "bank_ac_no"], as_dict=1)
-			["bank_name", "bank_ac_no"], as_dict=1)
 		if emp:
 			self.bank_name = emp.bank_name
 			self.bank_account_no = emp.bank_ac_no
 
-	def get_leave_details(self, lwp=None):
+	def get_leave_details(self, joining_date=None, relieving_date=None, lwp=None):
 		if not self.fiscal_year:
 			self.fiscal_year = frappe.db.get_default("fiscal_year")
 		if not self.month:
 			self.month = "%02d" % getdate(nowdate()).month
 			
-		m = get_month_details(self.fiscal_year, self.month)
+		if not joining_date:
-		holidays = self.get_holidays_for_employee(m)
+			joining_date, relieving_date = frappe.db.get_value("Employee", self.employee, 
+				["date_of_joining", "relieving_date"])
 
-		if not cint(frappe.db.get_value("HR Settings", "HR Settings",
+		m = get_month_details(self.fiscal_year, self.month)
-			"include_holidays_in_total_working_days")):
+		holidays = self.get_holidays_for_employee(m['month_start_date'], m['month_end_date'])
-				m["month_days"] -= len(holidays)
+
-				if m["month_days"] < 0:
+		working_days = m["month_days"]
+		if not cint(frappe.db.get_value("HR Settings", None, "include_holidays_in_total_working_days")):
+			working_days -= len(holidays)
+			if working_days < 0:
 				frappe.throw(_("There are more holidays than working days this month."))
 
 		if not lwp:
 			lwp = self.calculate_lwp(holidays, m)
-		self.total_days_in_month = m['month_days']
+		self.total_days_in_month = working_days
 		self.leave_without_pay = lwp
-		payment_days = flt(self.get_payment_days(m)) - flt(lwp)
+		payment_days = flt(self.get_payment_days(m, joining_date, relieving_date)) - flt(lwp)
 		self.payment_days = payment_days > 0 and payment_days or 0
 		
+	def get_payment_days(self, month, joining_date, relieving_date):
+		start_date = month['month_start_date']
+		if joining_date:
+			if joining_date > month['month_start_date']:
+				start_date = joining_date
+			elif joining_date > month['month_end_date']:
+				return
 		
-	def get_payment_days(self, m):
+		if relieving_date:
-		payment_days = m['month_days']
+			if relieving_date > start_date and relieving_date < month['month_end_date']:
-		emp = frappe.db.sql("select date_of_joining, relieving_date from `tabEmployee` \
+				end_date = relieving_date
-			where name = %s", self.employee, as_dict=1)[0]
+			elif relieving_date < month['month_start_date']:
+				frappe.throw(_("Employee relieved on {0} must be set as 'Left'").format(relieving_date))
+		else:
+			end_date = month['month_end_date']
 			
-		if emp['relieving_date']:
+		payment_days = date_diff(end_date, start_date) + 1
-			if getdate(emp['relieving_date']) > m['month_start_date'] and \
-				getdate(emp['relieving_date']) < m['month_end_date']:
-					payment_days = getdate(emp['relieving_date']).day
-			elif getdate(emp['relieving_date']) < m['month_start_date']:
-				frappe.throw(_("Employee relieved on {0} must be set as 'Left'").format(emp["relieving_date"]))
 
-		if emp['date_of_joining']:
+		if not cint(frappe.db.get_value("HR Settings", None, "include_holidays_in_total_working_days")):
-			if getdate(emp['date_of_joining']) > m['month_start_date'] and \
+			holidays = self.get_holidays_for_employee(start_date, end_date)
-				getdate(emp['date_of_joining']) < m['month_end_date']:
+			payment_days -= len(holidays)
-					payment_days = payment_days - getdate(emp['date_of_joining']).day + 1
-			elif getdate(emp['date_of_joining']) > m['month_end_date']:
-				payment_days = 0
 
 		return payment_days
 
-	def get_holidays_for_employee(self, m):
+	def get_holidays_for_employee(self, start_date, end_date):
 		holidays = frappe.db.sql("""select t1.holiday_date
 			from `tabHoliday` t1, tabEmployee t2
 			where t1.parent = t2.holiday_list and t2.name = %s
 			and t1.holiday_date between %s and %s""",
-			(self.employee, m['month_start_date'], m['month_end_date']))
+			(self.employee, start_date, end_date))
+			
 		if not holidays:
 			holidays = frappe.db.sql("""select t1.holiday_date
 				from `tabHoliday` t1, `tabHoliday List` t2
 				where t1.parent = t2.name and t2.is_default = 1
 				and t2.fiscal_year = %s
-				and t1.holiday_date between %s and %s""", (self.fiscal_year,
+				and t1.holiday_date between %s and %s""", 
-					m['month_start_date'], m['month_end_date']))
+				(self.fiscal_year, start_date, end_date))
+		
 		holidays = [cstr(i[0]) for i in holidays]
 		return holidays
 
@@ -148,11 +156,10 @@ class SalarySlip(TransactionBase):
 		from frappe.utils import money_in_words
 		self.check_existing()
 
-		if not (len(self.get("earnings")) or
+		if not (len(self.get("earnings")) or len(self.get("deductions"))):
-			len(self.get("deductions"))):
 			self.get_emp_and_leave_details()
 		else:
-			self.get_leave_details(self.leave_without_pay)
+			self.get_leave_details(lwp = self.leave_without_pay)
 
 		if not self.net_pay:
 			self.calculate_net_pay()

erpnext/hr/doctype/salary_slip/test_salary_slip.py

@@ -25,11 +25,11 @@ class TestSalarySlip(unittest.TestCase):
 		la.submit()
 
 	def tearDown(self):
-		frappe.db.set_value("HR Settings", "HR Settings", "include_holidays_in_total_working_days", 0)
+		frappe.db.set_value("HR Settings", None, "include_holidays_in_total_working_days", 0)
 		frappe.set_user("Administrator")
 
 	def test_salary_slip_with_holidays_included(self):
-		frappe.db.set_value("HR Settings", "HR Settings", "include_holidays_in_total_working_days", 1)
+		frappe.db.set_value("HR Settings", None, "include_holidays_in_total_working_days", 1)
 		ss = frappe.copy_doc(test_records[0])
 		ss.insert()
 		
@@ -43,18 +43,46 @@ class TestSalarySlip(unittest.TestCase):
 		self.assertEquals(ss.net_pay, 14867.74)
 
 	def test_salary_slip_with_holidays_excluded(self):
-		frappe.db.set_value("HR Settings", "HR Settings", "include_holidays_in_total_working_days", 0)
+		frappe.db.set_value("HR Settings", None, "include_holidays_in_total_working_days", 0)
 		ss = frappe.copy_doc(test_records[0])
 		ss.insert()
 		
-		self.assertEquals(ss.total_days_in_month, 30)
+		self.assertEquals(ss.total_days_in_month, 29)
-		self.assertEquals(ss.payment_days, 29)
+		self.assertEquals(ss.payment_days, 28)
-		self.assertEquals(ss.earnings[0].e_modified_amount, 14500)
+		self.assertEquals(ss.earnings[0].e_modified_amount, 14482.76)
 		self.assertEquals(ss.earnings[1].e_modified_amount, 500)
 		self.assertEquals(ss.deductions[0].d_modified_amount, 100)
-		self.assertEquals(ss.deductions[1].d_modified_amount, 48.33)
+		self.assertEquals(ss.deductions[1].d_modified_amount, 48.28)
-		self.assertEquals(ss.gross_pay, 15000)
+		self.assertEquals(ss.gross_pay, 14982.76)
-		self.assertEquals(ss.net_pay, 14851.67)
+		self.assertEquals(ss.net_pay, 14834.48)
+		
+	def test_payment_days(self):
+		# Holidays not included in working days
+		frappe.db.set_value("HR Settings", None, "include_holidays_in_total_working_days", 0)
+		
+		# set joinng date in the same month
+		frappe.db.set_value("Employee", "_T-Employee-0001", "date_of_joining", "2013-01-11")
+		
+		ss = frappe.copy_doc(test_records[0])
+		ss.insert()
+		
+		self.assertEquals(ss.total_days_in_month, 29)
+		self.assertEquals(ss.payment_days, 19)
+		
+		# set relieving date in the same month
+		frappe.db.set_value("Employee", "_T-Employee-0001", "relieving_date", "2013-01-28")
+		ss.save()
+		self.assertEquals(ss.total_days_in_month, 29)
+		self.assertEquals(ss.payment_days, 16)
+		
+		# Holidays included in working days
+		frappe.db.set_value("HR Settings", None, "include_holidays_in_total_working_days", 1)
+		ss.save()
+		self.assertEquals(ss.total_days_in_month, 31)
+		self.assertEquals(ss.payment_days, 17)
+		
+		frappe.db.set_value("Employee", "_T-Employee-0001", "date_of_joining", "2001-01-11")
+		frappe.db.set_value("Employee", "_T-Employee-0001", "relieving_date", None)
 
 	def test_employee_salary_slip_read_permission(self):
 		self.make_employee("test_employee@example.com")