payservedb 8.9.6 → 8.9.8

package/index.js

@@ -95,6 +95,7 @@ const models = {
   LevyType: require("./src/models/levytype"),
   LevyContract: require("./src/models/levycontract"),
   Invoice: require("./src/models/invoice"),
+  InvoiceEditLog: require("./src/models/invoice_edit_log"),
   CombinedInvoice: require("./src/models/combined_invoice"),
   InvoiceGeneration: require("./src/models/invoice_generation_approval"),
   ShortUrl: require("./src/models/short_urls"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payservedb",
-  "version": "8.9.6",
+  "version": "8.9.8",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/src/models/invoice_edit_log.js

@@ -0,0 +1,82 @@
+const mongoose = require("mongoose");
+
+const invoiceEditLogSchema = new mongoose.Schema(
+  {
+    // Invoice reference
+    invoiceId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true,
+    },
+    invoiceNumber: {
+      type: String,
+      required: true,
+    },
+    invoiceType: {
+      type: String,
+      required: true,
+    },
+
+    // Unit & Customer context
+    unit: {
+      type: String,
+      required: true,
+    },
+    customerName: {
+      type: String,
+      required: true,
+    },
+
+    // Who edited
+    editedBy: {
+      userId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "User",
+        required: true,
+      },
+      name: {
+        type: String,
+        required: true,
+      },
+    },
+
+    // What was changed
+    changes: [
+      {
+        field: {
+          type: String,
+          required: true,
+          enum: [
+            "amount",
+            "balanceBroughtForward",
+            "totalBalance",
+            "customer",
+          ],
+        },
+        previousValue: {
+          type: mongoose.Schema.Types.Mixed,
+          required: true,
+        },
+        newValue: {
+          type: mongoose.Schema.Types.Mixed,
+          required: true,
+        },
+        description: {
+          type: String,
+          required: true,
+          // e.g. "Amount updated from KES 5,000 to KES 6,000"
+        },
+      },
+    ],
+  },
+  {
+    timestamps: true, // gives you createdAt as your date & time
+  }
+);
+
+invoiceEditLogSchema.index({ invoiceId: 1 });
+invoiceEditLogSchema.index({ invoiceNumber: 1 });
+invoiceEditLogSchema.index({ "editedBy.userId": 1 });
+
+const InvoiceEditLog = mongoose.model("InvoiceEditLog", invoiceEditLogSchema);
+
+module.exports = InvoiceEditLog;