feat: add ability to filter transactions by amount greater/smaller than a parameter

Author: morremeyer

api/docs.go

@@ -2400,6 +2400,24 @@ const docTemplate = `{
                 ],
                 "summary": "Get transactions",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Filter by amount",
+                        "name": "amount",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Amount less than or equal to this",
+                        "name": "amountLessOrEqual",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Amount more than or equal to this",
+                        "name": "amountMoreOrEqual",
+                        "in": "query"
+                    },
                     {
                         "type": "string",
                         "description": "Filter by note",

api/swagger.json

@@ -2388,6 +2388,24 @@
                 ],
                 "summary": "Get transactions",
                 "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Filter by amount",
+                        "name": "amount",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Amount less than or equal to this",
+                        "name": "amountLessOrEqual",
+                        "in": "query"
+                    },
+                    {
+                        "type": "string",
+                        "description": "Amount more than or equal to this",
+                        "name": "amountMoreOrEqual",
+                        "in": "query"
+                    },
                     {
                         "type": "string",
                         "description": "Filter by note",

api/swagger.yaml

@@ -2486,6 +2486,18 @@ paths:
     get:
       description: Returns a list of transactions
       parameters:
+      - description: Filter by amount
+        in: query
+        name: amount
+        type: string
+      - description: Amount less than or equal to this
+        in: query
+        name: amountLessOrEqual
+        type: string
+      - description: Amount more than or equal to this
+        in: query
+        name: amountMoreOrEqual
+        type: string
       - description: Filter by note
         in: query
         name: note

pkg/controllers/transaction.go

@@ -35,6 +35,8 @@ type TransactionLinks struct {
 type TransactionQueryFilter struct {
 	Date                  time.Time       `form:"date"`
 	Amount                decimal.Decimal `form:"amount"`
+	AmountLessOrEqual     decimal.Decimal `form:"amountLessOrEqual" filterField:"false"` // Amount less than or equal to this
+	AmountMoreOrEqual     decimal.Decimal `form:"amountMoreOrEqual" filterField:"false"` // Amount more than or equal to this
 	Note                  string          `form:"note" filterField:"false"`
 	BudgetID              string          `form:"budget"`
 	SourceAccountID       string          `form:"source"`
@@ -199,17 +201,19 @@ func (co Controller) CreateTransaction(c *gin.Context) {
 //	@Failure		404
 //	@Failure		500	{object}	httperrors.HTTPError
 //	@Router			/v1/transactions [get]
-//	@Param			date					query	time.Time		false	"Filter by date"
-//	@Param			amount					query	decimal.Decimal	false	"Filter by amount"
-//	@Param			note					query	string			false	"Filter by note"
-//	@Param			budget					query	string			false	"Filter by budget ID"
-//	@Param			account					query	string			false	"Filter by ID of associated account, regardeless of source or destination"
-//	@Param			source					query	string			false	"Filter by source account ID"
-//	@Param			destination				query	string			false	"Filter by destination account ID"
-//	@Param			envelope				query	string			false	"Filter by envelope ID"
-//	@Param			reconciled				query	bool			false	"DEPRECATED. Filter by reconcilication state"
-//	@Param			reconciledSource		query	bool			false	"Reconcilication state in source account"
-//	@Param			reconciledDestination	query	bool			false	"Reconcilication state in destination account"
+//	@Param			date					query	time.Time	false	"Filter by date"
+//	@Param			amount					query	string		false	"Filter by amount"
+//	@Param			amountLessOrEqual		query	string		false	"Amount less than or equal to this"
+//	@Param			amountMoreOrEqual		query	string		false	"Amount more than or equal to this"
+//	@Param			note					query	string		false	"Filter by note"
+//	@Param			budget					query	string		false	"Filter by budget ID"
+//	@Param			account					query	string		false	"Filter by ID of associated account, regardeless of source or destination"
+//	@Param			source					query	string		false	"Filter by source account ID"
+//	@Param			destination				query	string		false	"Filter by destination account ID"
+//	@Param			envelope				query	string		false	"Filter by envelope ID"
+//	@Param			reconciled				query	bool		false	"DEPRECATED. Filter by reconcilication state"
+//	@Param			reconciledSource		query	bool		false	"Reconcilication state in source account"
+//	@Param			reconciledDestination	query	bool		false	"Reconcilication state in destination account"
 func (co Controller) GetTransactions(c *gin.Context) {
 	var filter TransactionQueryFilter
 	if err := c.Bind(&filter); err != nil {
@@ -248,6 +252,14 @@ func (co Controller) GetTransactions(c *gin.Context) {
 		})
 	}
 
+	if !filter.AmountLessOrEqual.IsZero() {
+		query = query.Where("transactions.amount <= ?", filter.AmountLessOrEqual)
+	}
+
+	if !filter.AmountMoreOrEqual.IsZero() {
+		query = query.Where("transactions.amount >= ?", filter.AmountMoreOrEqual)
+	}
+
 	if filter.Note != "" {
 		query = query.Where("note LIKE ?", fmt.Sprintf("%%%s%%", filter.Note))
 	} else if slices.Contains(setFields, "Note") {

pkg/controllers/transaction_test.go

@@ -174,6 +174,15 @@ func (suite *TestSuiteStandard) TestGetTransactionsFilter() {
 		{"Non-existing Account", "account=534a3562-c5e8-46d1-a2e2-e96c00e7efec", 0},
 		{"Existing Account 2", fmt.Sprintf("account=%s", a2.Data.ID), 3},
 		{"Existing Account 1", fmt.Sprintf("account=%s", a1.Data.ID), 2},
+		{"Amount less or equal to 2.71", "amountLessOrEqual=2.71", 0},
+		{"Amount less or equal to 2.718", "amountLessOrEqual=2.718", 2},
+		{"Amount less or equal to 1000", "amountLessOrEqual=1000", 2},
+		{"Amount more or equal to 2.718", "amountMoreOrEqual=2.718", 3},
+		{"Amount more or equal to 11235.813", "amountMoreOrEqual=11235.813", 1},
+		{"Amount more or equal to 99999", "amountMoreOrEqual=99999", 0},
+		{"Amount more or equal to 100", "amountMoreOrEqual=100", 1},
+		{"Amount more or equal to 100 and less than 10", "amountMoreOrEqual=100&amountLessOrEqual=10", 0},
+		{"Amount more or equal to 1 and less than 3", "amountMoreOrEqual=1&amountLessOrEqual=3", 2},
 	}
 
 	for _, tt := range tests {