payservedb 9.1.2 → 9.1.4

package/index.js

@@ -94,6 +94,7 @@ const models = {
   Levy: require("./src/models/levy"),
   LevyType: require("./src/models/levytype"),
   LevyContract: require("./src/models/levycontract"),
+  DepositSchema: require("./src/models/levy_deposits"),
   Invoice: require("./src/models/invoice"),
   InvoiceEditLog: require("./src/models/invoice_edit_log"),
   CombinedInvoice: require("./src/models/combined_invoice"),

package/package.json

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

package/src/models/levy_deposits.js

@@ -0,0 +1,127 @@
+const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
+
+const DepositSchema = new Schema(
+    {
+        contractId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'LevyContract',
+            required: [true, 'Contract ID is required']
+        },
+        customerId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Customer',
+            required: [true, 'Customer ID is required']
+        },
+        unitId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Unit',
+            required: [true, 'Unit ID is required']
+        },
+        facilityId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Facility',
+            required: [true, 'Facility ID is required']
+        },
+        amount: {
+            type: Number,
+            required: [true, 'Amount is required'],
+            min: [0, 'Amount cannot be negative']
+        },
+        datePaid: {
+            type: Date,
+            required: [true, 'Date paid is required']
+        },
+        // NEW FIELDS FOR DEPOSIT/UPFRONT PAYMENT
+        receiptNumber: {
+            type: String,
+            trim: true
+        },
+        paymentReference: {
+            type: String,
+            trim: true
+        },
+        // For upfront payment tracking
+        upfrontPaymentId: {
+            type: String,
+            trim: true
+        },
+        billingPeriods: [{
+            type: String
+        }],
+        // Status fields
+        status: {
+            type: String,
+            enum: ['Held', 'Refunded', 'Partially Refunded', 'Forfeited'],
+            default: 'Held',
+            required: [true, 'Status is required']
+        },
+        refundedAmount: {
+            type: Number,
+            default: 0,
+            min: [0, 'Refunded amount cannot be negative']
+        },
+        refundDate: {
+            type: Date
+        }
+    },
+    {
+        timestamps: true,
+        toJSON: { virtuals: true },
+        toObject: { virtuals: true }
+    }
+);
+
+// Virtual populate for Contract details
+DepositSchema.virtual('contract', {
+    ref: 'LevyContract',
+    localField: 'contractId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Virtual populate for Customer details
+DepositSchema.virtual('customer', {
+    ref: 'Customer',
+    localField: 'customerId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Virtual populate for Unit details
+DepositSchema.virtual('unit', {
+    ref: 'Unit',
+    localField: 'unitId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Virtual for remaining (unrefunded) balance
+DepositSchema.virtual('balanceRemaining').get(function () {
+    return this.amount - (this.refundedAmount || 0);
+});
+
+// Pre-save middleware: set refundDate when status moves to Refunded/Partially Refunded
+DepositSchema.pre('save', function (next) {
+    if (
+        (this.status === 'Refunded' || this.status === 'Partially Refunded') &&
+        !this.refundDate &&
+        this.isModified('status')
+    ) {
+        this.refundDate = new Date();
+    }
+    // Guard against refunded amount exceeding original amount
+    if ((this.refundedAmount || 0) > this.amount) {
+        return next(new Error('Refunded amount cannot exceed deposit amount'));
+    }
+    // Auto-flip to fully Refunded when refundedAmount covers the amount
+    if (this.refundedAmount >= this.amount) {
+        this.status = 'Refunded';
+    }
+    next();
+});
+
+module.exports = {
+    schema: DepositSchema,
+    name: 'Deposit'
+};