Merge pull request #477 from saurabh6790/timesheet-based-payroll

fix: do not hide payroll frequency if its based on timesheet

hrms/patches.txt

@@ -6,4 +6,5 @@ hrms.patches.post_install.set_payroll_entry_status
 hrms.patches.v1_0.rearrange_employee_fields
 hrms.patches.post_install.update_allocate_on_in_leave_type
 hrms.patches.v14_0.create_custom_field_for_appraisal_template
-hrms.patches.post_install.update_performance_module_changes #2023-04-17
+hrms.patches.post_install.update_performance_module_changes #2023-04-17
+hrms.patches.v14_0.update_payroll_frequency_to_none_if_salary_slip_is_based_on_timesheet

hrms/patches/v14_0/update_payroll_frequency_to_none_if_salary_slip_is_based_on_timesheet.py

@@ -0,0 +1,13 @@
+import frappe
+
+
+def execute():
+	frappe.reload_doc("payroll", "doctype", "salary_structure")
+
+	salary_strucutres = frappe.get_all(
+		"Salary Structure", filters={"salary_slip_based_on_timesheet": 1}, fields=["name"]
+	)
+
+	if len(salary_strucutres) > 0:
+		for salary_strucutre in salary_strucutres:
+			frappe.db.set_value("Salary Structure", salary_strucutre.name, "payroll_frequency", "")

hrms/payroll/doctype/payroll_entry/payroll_entry.js

@@ -209,10 +209,9 @@ frappe.ui.form.on('Payroll Entry', {
 
 	get_employee_filters: function (frm) {
 		let filters = {};
-		filters['salary_slip_based_on_timesheet'] = frm.doc.salary_slip_based_on_timesheet;
 
 		let fields = ['company', 'start_date', 'end_date', 'payroll_frequency', 'payroll_payable_account',
-			'currency', 'department', 'branch', 'designation'];
+			'currency', 'department', 'branch', 'designation', 'salary_slip_based_on_timesheet'];
 
 		fields.forEach(field => {
 			if (frm.doc[field]) {
@@ -308,6 +307,7 @@ frappe.ui.form.on('Payroll Entry', {
 
 	salary_slip_based_on_timesheet: function (frm) {
 		frm.toggle_reqd(['payroll_frequency'], !frm.doc.salary_slip_based_on_timesheet);
+		hrms.set_payroll_frequency_to_null(frm);
 	},
 
 	set_start_end_dates: function (frm) {

hrms/payroll/doctype/payroll_entry/payroll_entry.json

@@ -9,18 +9,18 @@
  "field_order": [
   "select_payroll_period",
   "posting_date",
-  "payroll_frequency",
   "company",
   "column_break_5",
   "currency",
   "exchange_rate",
   "payroll_payable_account",
   "status",
   "section_break_cypo",
+  "salary_slip_based_on_timesheet",
+  "payroll_frequency",
   "start_date",
   "end_date",
   "column_break_13",
-  "salary_slip_based_on_timesheet",
   "deduct_tax_for_unclaimed_employee_benefits",
   "deduct_tax_for_unsubmitted_tax_exemption_proof",
   "employees_tab",
@@ -329,7 +329,7 @@
  "icon": "fa fa-cog",
  "is_submittable": 1,
  "links": [],
- "modified": "2023-01-05 17:07:00.372983",
+ "modified": "2023-05-26 17:03:51.264095",
  "modified_by": "Administrator",
  "module": "Payroll",
  "name": "Payroll Entry",

hrms/payroll/doctype/payroll_entry/payroll_entry.py

@@ -109,19 +109,23 @@ def on_cancel(self):
 		self.db_set("error_message", "")
 
 	def make_filters(self):
-		return frappe._dict(
+		filters = frappe._dict(
 			company=self.company,
 			branch=self.branch,
 			department=self.department,
 			designation=self.designation,
 			currency=self.currency,
-			payroll_frequency=self.payroll_frequency,
 			start_date=self.start_date,
 			end_date=self.end_date,
 			payroll_payable_account=self.payroll_payable_account,
 			salary_slip_based_on_timesheet=self.salary_slip_based_on_timesheet,
 		)
 
+		if not self.salary_slip_based_on_timesheet:
+			filters.update(dict(payroll_frequency=self.payroll_frequency))
+
+		return filters
+
 	@frappe.whitelist()
 	def fill_employee_details(self):
 		filters = self.make_filters()
@@ -919,11 +923,12 @@ def get_holiday_list_based_count(
 		return holiday_list_based_count[key] or 0
 
 
-def get_sal_struct(
+def get_salary_structure(
 	company: str, currency: str, salary_slip_based_on_timesheet: int, payroll_frequency: str
 ) -> list[str]:
 	SalaryStructure = frappe.qb.DocType("Salary Structure")
-	return (
+
+	query = (
 		frappe.qb.from_(SalaryStructure)
 		.select(SalaryStructure.name)
 		.where(
@@ -932,9 +937,13 @@ def get_sal_struct(
 			& (SalaryStructure.company == company)
 			& (SalaryStructure.currency == currency)
 			& (SalaryStructure.salary_slip_based_on_timesheet == salary_slip_based_on_timesheet)
-			& (SalaryStructure.payroll_frequency == payroll_frequency)
 		)
-	).run(pluck=True)
+	)
+
+	if not salary_slip_based_on_timesheet:
+		query = query.where(SalaryStructure.payroll_frequency == payroll_frequency)
+
+	return query.run(pluck=True)
 
 
 def get_filtered_employees(
@@ -1322,7 +1331,7 @@ def get_employee_list(
 	offset=None,
 	ignore_match_conditions=False,
 ) -> list:
-	sal_struct = get_sal_struct(
+	sal_struct = get_salary_structure(
 		filters.company,
 		filters.currency,
 		filters.salary_slip_based_on_timesheet,

hrms/payroll/doctype/salary_slip/salary_slip.json

@@ -240,7 +240,6 @@
    "search_index": 1
   },
   {
-   "depends_on": "eval:(!doc.salary_slip_based_on_timesheet)",
    "fieldname": "payroll_frequency",
    "fieldtype": "Select",
    "label": "Payroll Frequency",
@@ -753,7 +752,7 @@
  "idx": 9,
  "is_submittable": 1,
  "links": [],
- "modified": "2023-02-22 18:23:49.783449",
+ "modified": "2023-04-26 17:29:49.079158",
  "modified_by": "Administrator",
  "module": "Payroll",
  "name": "Salary Slip",

hrms/payroll/doctype/salary_structure/salary_structure.js

@@ -180,7 +180,9 @@ frappe.ui.form.on('Salary Structure', {
 	},
 
 	salary_slip_based_on_timesheet: function(frm) {
-		frm.trigger("toggle_fields")
+		frm.trigger("toggle_fields");
+		hrms.set_payroll_frequency_to_null(frm);
+
 	},
 
 	preview_salary_slip: function(frm) {

hrms/payroll/doctype/salary_structure/salary_structure.json

@@ -13,14 +13,14 @@
   "column_break1",
   "is_active",
   "is_default",
-  "payroll_frequency",
   "currency",
   "amended_from",
   "time_sheet_earning_detail",
   "leave_encashment_amount_per_day",
   "max_benefits",
   "column_break_17",
   "salary_slip_based_on_timesheet",
+  "payroll_frequency",
   "salary_component",
   "hour_rate",
   "earning_deduction",
@@ -73,7 +73,7 @@
   },
   {
    "default": "Monthly",
-   "depends_on": "eval:(!doc.salary_slip_based_on_timesheet)",
+   "depends_on": "eval:doc.salary_slip_based_on_timesheet == 0",
    "fieldname": "payroll_frequency",
    "fieldtype": "Select",
    "label": "Payroll Frequency",
@@ -99,7 +99,8 @@
    "default": "0",
    "fieldname": "salary_slip_based_on_timesheet",
    "fieldtype": "Check",
-   "label": "Salary Slip Based on Timesheet"
+   "label": "Salary Slip Based on Timesheet",
+   "search_index": 1
   },
   {
    "fieldname": "column_break_17",
@@ -237,7 +238,7 @@
  "idx": 1,
  "is_submittable": 1,
  "links": [],
- "modified": "2023-03-24 18:16:49.424812",
+ "modified": "2023-06-13 18:02:31.779947",
  "modified_by": "Administrator",
  "module": "Payroll",
  "name": "Salary Structure",

hrms/public/js/utils.js

@@ -10,5 +10,11 @@ $.extend(hrms, {
 				cur_frm.save();
 			}
 		});
+	},
+
+	set_payroll_frequency_to_null: (frm) => {
+		if (frm.doc.salary_slip_based_on_timesheet ==1){
+			frm.set_value("payroll_frequency", "");
+		}
 	}
 })