Feat: Added percentage-based expense split and validation

batwara/batwara/doctype/expense/expense.json

@@ -102,7 +102,7 @@
    "fieldname": "split_method",
    "fieldtype": "Select",
    "label": "Split Method",
-   "options": "Equally\nManually",
+   "options": "Equally\nManually\nPercentage",
    "reqd": 1
   },
   {
@@ -118,7 +118,7 @@
    "link_fieldname": "expense"
   }
  ],
- "modified": "2024-07-28 16:20:39.494671",
+ "modified": "2024-09-23 15:52:18.839671",
  "modified_by": "Administrator",
  "module": "Batwara",
  "name": "Expense",

batwara/batwara/doctype/expense/expense.py

@@ -12,9 +12,8 @@ class Expense(Document):
 	from typing import TYPE_CHECKING
 
 	if TYPE_CHECKING:
-		from frappe.types import DF
-
 		from batwara.batwara.doctype.expense_split.expense_split import ExpenseSplit
+		from frappe.types import DF
 
 		amended_from: DF.Link | None
 		amount: DF.Currency
@@ -23,7 +22,7 @@ class Expense(Document):
 		description: DF.Data
 		notes: DF.SmallText | None
 		paid_by: DF.Link
-		split_method: DF.Literal["Equally", "Manually"]
+		split_method: DF.Literal["Equally", "Manually", "Percentage"]
 		splits: DF.Table[ExpenseSplit]
 	# end: auto-generated types
 
@@ -33,6 +32,9 @@ def before_save(self):
 	def apply_split(self):
 		if self.split_method == "Equally":
 			self.calculate_equal_splits()
+		elif self.split_method == "Percentage":
+			self.validate_percentage_splits()
+			self.calculate_percentage_splits() 
 		else:
 			# manually
 			self.validate_manual_splits()
@@ -49,6 +51,15 @@ def calculate_equal_splits(self):
 
 		for s in self.splits:
 			s.amount = split_amount
+
+	def validate_percentage_splits(self):
+		sum_of_percentages = sum(x.percentage for x in self.splits)
+		if sum_of_percentages != 100:
+			frappe.throw("Sum of percentages must equal 100%!")
+
+	def calculate_percentage_splits(self):
+		for s in self.splits:
+			s.amount = (s.percentage / 100) * self.amount
 
 	def before_submit(self):
 		self.create_ledger_entries()

batwara/batwara/doctype/expense_split/expense_split.json

@@ -7,6 +7,7 @@
  "engine": "InnoDB",
  "field_order": [
   "user",
+  "percentage",
   "column_break_lnxs",
   "amount",
   "currency"
@@ -40,12 +41,17 @@
    "label": "Currency",
    "options": "Currency",
    "reqd": 1
+  },
+  {
+   "fieldname": "percentage",
+   "fieldtype": "Float",
+   "label": "Percentage"
   }
  ],
  "index_web_pages_for_search": 1,
  "istable": 1,
  "links": [],
- "modified": "2024-07-27 08:43:35.299074",
+ "modified": "2024-09-23 15:52:55.986929",
  "modified_by": "Administrator",
  "module": "Batwara",
  "name": "Expense Split",

batwara/batwara/doctype/expense_split/expense_split.py

@@ -6,4 +6,20 @@
 
 
 class ExpenseSplit(Document):
+	# begin: auto-generated types
+	# This code is auto-generated. Do not modify anything in this block.
+
+	from typing import TYPE_CHECKING
+
+	if TYPE_CHECKING:
+		from frappe.types import DF
+
+		amount: DF.Currency
+		currency: DF.Link
+		parent: DF.Data
+		parentfield: DF.Data
+		parenttype: DF.Data
+		percentage: DF.Float
+		user: DF.Link
+	# end: auto-generated types
 	pass

frontend/src/pages/CreateNewExpense.vue

@@ -44,6 +44,12 @@
 							expenseDetails.split_method = 'Manually'
 						},
 					},
+					{
+						label: 'Percentage',
+						onClick: () => {
+							expenseDetails.split_method = 'Percentage'
+						},
+					},
 				]"
 				:button="{
 					label: expenseDetails.split_method,
@@ -75,6 +81,20 @@
 				</li>
 			</ol>
 		</div>
+
+		<div v-if="expenseDetails.split_method === 'Percentage'">
+			<ol class="space-y-3">
+				<li v-for="friend in expenseDetails.selected_friends">
+					<FormControl
+						v-model.number="friend.percentage"
+						type="number"
+						:label="friend.label"
+						placeholder="0%"
+					/>
+				</li>
+			</ol>
+		</div>
+
 	</div>
 
 	<div>
@@ -186,6 +206,7 @@ function saveExpense() {
 			splits: expenseDetails.selected_friends.map((f) => ({
 				user: f.value,
 				amount: f.amount || 0.0,
+				percentage: f.percentage || 0.0
 			})),
 		},
 		{