payservedb 9.2.8 → 9.3.0

package/src/models/levy.js

@@ -1,213 +1,213 @@
-const mongoose = require("mongoose");
-
-// Define the schema for Levy
-const levySchema = new mongoose.Schema(
-  {
-    levyName: {
-      type: String,
-      required: true,
-      trim: true,
-      minlength: [1, "Levy name must be at least 1 character long"],
-    },
-    levyType: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "LevyType",
-      required: true,
-    },
-    amount: {
-      type: Number,
-      required: true,
-      min: [0, "Amount must be a positive number"],
-    },
-    dueDate: {
-      type: String,
-      required: true,
-    },
-    levyApplicant: {
-      type: String,
-      required: true,
-      trim: true,
-    },
-    taxEnabled: {
-      type: Boolean,
-      default: false,
-      required: false
-    },
-    taxRate: {
-      type: Number,
-      default: 0,
-      required: false,
-      min: [0, 'Tax rate must be a positive number'],
-      max: [100, 'Tax rate cannot exceed 100']
-    },
-    taxType: {
-      type: String,
-      enum: ['VAT', 'Withholding', 'ServiceTax', 'Custom'],
-      default: 'VAT'
-    },
-    collectionFrequency: {
-      type: String,
-      required: true,
-      trim: true,
-    },
-    invoiceDay: {
-      type: String,
-      required: true,
-    },
-    billingType: {
-      type: String,
-      enum: ['Prepaid', 'Postpaid'],
-      required: true,
-      default: 'Postpaid'
-    },
-    currency: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "Currency",
-      required: true,
-    },
-    mobilePayment: {
-      type: Boolean,
-      default: false,
-      required: false,
-    },
-    paymentMethodId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "FacilityPaymentDetails",
-      required: false,
-    },
-    bankPayment: {
-      type: Boolean,
-      default: false,
-      required: false,
-    },
-    // Reference to BankDetails document
-    bankAccountId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "BankDetails",
-      required: false,
-    },
-    // Reference to BillerAddress document
-    billerAddressId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "BillerAddress",
-      required: true,
-    },
-    // GL Account Configuration
-    glAccounts: {
-      invoice: {
-        debit: {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: "GLAccount",
-        },
-        credit: {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: "GLAccount",
-        }
-      },
-      payment: {
-        debit: {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: "GLAccount",
-        },
-        credit: {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: "GLAccount",
-        }
-      }
-    },
-    disabled: {
-      type: Boolean,
-      default: false,
-      required: false,
-    },
-    facilityId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "Facility",
-      required: true,
-    },
-    // Reminder reference
-    reminderId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: 'Reminder',
-      required: false
-    },
-    // Penalty reference
-    penaltyId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: 'Penalty',
-      required: false
-    }
-  },
-  {
-    timestamps: true,
-  }
-);
-
-// Add virtuals for populated references
-levySchema.virtual('bankAccount', {
-  ref: 'BankDetails',
-  localField: 'bankAccountId',
-  foreignField: '_id',
-  justOne: true
-});
-
-levySchema.virtual('billerAddress', {
-  ref: 'BillerAddress',
-  localField: 'billerAddressId',
-  foreignField: '_id',
-  justOne: true
-});
-
-levySchema.virtual('reminder', {
-  ref: 'Reminder',
-  localField: 'reminderId',
-  foreignField: '_id',
-  justOne: true
-});
-
-levySchema.virtual('penalty', {
-  ref: 'Penalty',
-  localField: 'penaltyId',
-  foreignField: '_id',
-  justOne: true
-});
-
-// Pre-save validation middleware
-levySchema.pre('save', function (next) {
-  // Validate bank payment requirements
-  if (this.bankPayment && !this.bankAccountId) {
-    const error = new Error('Bank account is required when bank payment is enabled');
-    return next(error);
-  }
-
-  // Validate mobile payment requirements
-  if (this.mobilePayment && !this.paymentMethodId) {
-    const error = new Error('Payment method is required when mobile payment is enabled');
-    return next(error);
-  }
-
-  next();
-});
-
-// Add indexes for better performance
-levySchema.index({ facilityId: 1 });
-levySchema.index({ levyType: 1 });
-levySchema.index({ disabled: 1 });
-levySchema.index({ bankAccountId: 1 });
-levySchema.index({ billerAddressId: 1 });
-levySchema.index({ reminderId: 1 });
-levySchema.index({ penaltyId: 1 });
-levySchema.index({ createdAt: -1 });
-
-// Compound indexes
-levySchema.index({ facilityId: 1, disabled: 1 });
-levySchema.index({ facilityId: 1, levyType: 1 });
-
-// Ensure virtual fields are serialized
-levySchema.set('toJSON', { virtuals: true });
-levySchema.set('toObject', { virtuals: true });
-
-// Compile the model from the schema
-const Levy = mongoose.model("Levy", levySchema);
-
+const mongoose = require("mongoose");
+
+// Define the schema for Levy
+const levySchema = new mongoose.Schema(
+  {
+    levyName: {
+      type: String,
+      required: true,
+      trim: true,
+      minlength: [1, "Levy name must be at least 1 character long"],
+    },
+    levyType: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "LevyType",
+      required: true,
+    },
+    amount: {
+      type: Number,
+      required: true,
+      min: [0, "Amount must be a positive number"],
+    },
+    dueDate: {
+      type: String,
+      required: true,
+    },
+    levyApplicant: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    taxEnabled: {
+      type: Boolean,
+      default: false,
+      required: false
+    },
+    taxRate: {
+      type: Number,
+      default: 0,
+      required: false,
+      min: [0, 'Tax rate must be a positive number'],
+      max: [100, 'Tax rate cannot exceed 100']
+    },
+    taxType: {
+      type: String,
+      enum: ['VAT', 'Withholding', 'ServiceTax', 'Custom'],
+      default: 'VAT'
+    },
+    collectionFrequency: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    invoiceDay: {
+      type: String,
+      required: true,
+    },
+    billingType: {
+      type: String,
+      enum: ['Prepaid', 'Postpaid'],
+      required: true,
+      default: 'Postpaid'
+    },
+    currency: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Currency",
+      required: true,
+    },
+    mobilePayment: {
+      type: Boolean,
+      default: false,
+      required: false,
+    },
+    paymentMethodId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "FacilityPaymentDetails",
+      required: false,
+    },
+    bankPayment: {
+      type: Boolean,
+      default: false,
+      required: false,
+    },
+    // Reference to BankDetails document
+    bankAccountId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "BankDetails",
+      required: false,
+    },
+    // Reference to BillerAddress document
+    billerAddressId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "BillerAddress",
+      required: true,
+    },
+    // GL Account Configuration
+    glAccounts: {
+      invoice: {
+        debit: {
+          type: mongoose.Schema.Types.ObjectId,
+          ref: "GLAccount",
+        },
+        credit: {
+          type: mongoose.Schema.Types.ObjectId,
+          ref: "GLAccount",
+        }
+      },
+      payment: {
+        debit: {
+          type: mongoose.Schema.Types.ObjectId,
+          ref: "GLAccount",
+        },
+        credit: {
+          type: mongoose.Schema.Types.ObjectId,
+          ref: "GLAccount",
+        }
+      }
+    },
+    disabled: {
+      type: Boolean,
+      default: false,
+      required: false,
+    },
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Facility",
+      required: true,
+    },
+    // Reminder reference
+    reminderId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'Reminder',
+      required: false
+    },
+    // Penalty reference
+    penaltyId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'Penalty',
+      required: false
+    }
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// Add virtuals for populated references
+levySchema.virtual('bankAccount', {
+  ref: 'BankDetails',
+  localField: 'bankAccountId',
+  foreignField: '_id',
+  justOne: true
+});
+
+levySchema.virtual('billerAddress', {
+  ref: 'BillerAddress',
+  localField: 'billerAddressId',
+  foreignField: '_id',
+  justOne: true
+});
+
+levySchema.virtual('reminder', {
+  ref: 'Reminder',
+  localField: 'reminderId',
+  foreignField: '_id',
+  justOne: true
+});
+
+levySchema.virtual('penalty', {
+  ref: 'Penalty',
+  localField: 'penaltyId',
+  foreignField: '_id',
+  justOne: true
+});
+
+// Pre-save validation middleware
+levySchema.pre('save', function (next) {
+  // Validate bank payment requirements
+  if (this.bankPayment && !this.bankAccountId) {
+    const error = new Error('Bank account is required when bank payment is enabled');
+    return next(error);
+  }
+
+  // Validate mobile payment requirements
+  if (this.mobilePayment && !this.paymentMethodId) {
+    const error = new Error('Payment method is required when mobile payment is enabled');
+    return next(error);
+  }
+
+  next();
+});
+
+// Add indexes for better performance
+levySchema.index({ facilityId: 1 });
+levySchema.index({ levyType: 1 });
+levySchema.index({ disabled: 1 });
+levySchema.index({ bankAccountId: 1 });
+levySchema.index({ billerAddressId: 1 });
+levySchema.index({ reminderId: 1 });
+levySchema.index({ penaltyId: 1 });
+levySchema.index({ createdAt: -1 });
+
+// Compound indexes
+levySchema.index({ facilityId: 1, disabled: 1 });
+levySchema.index({ facilityId: 1, levyType: 1 });
+
+// Ensure virtual fields are serialized
+levySchema.set('toJSON', { virtuals: true });
+levySchema.set('toObject', { virtuals: true });
+
+// Compile the model from the schema
+const Levy = mongoose.model("Levy", levySchema);
+
 module.exports = Levy;

package/src/models/levy_deposits.js

@@ -1,127 +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'
+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'
 };