payservedb 9.5.3 → 9.5.5

package/src/models/combined_invoice.js

@@ -1,425 +1,425 @@
-const mongoose = require("mongoose");
-
-const combinedInvoiceSchema = new mongoose.Schema(
-  {
-    // Customer Information
-    customer: {
-      customerId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Customer",
-        required: true,
-      },
-      firstName: {
-        type: String,
-        required: true,
-      },
-      lastName: {
-        type: String,
-        required: true,
-      },
-      accountNumber: {
-        type: String,
-        required: true,
-      },
-    },
-
-    // Unit Information
-    unit: {
-      id: { 
-        type: mongoose.Schema.Types.ObjectId, 
-        ref: "Unit", 
-        required: true 
-      },
-      name: { 
-        type: String, 
-        required: true 
-      },
-    },
-
-    // Facility Information
-    facility: {
-      id: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Facility",
-        required: true,
-      },
-      name: {
-        type: String,
-        required: true,
-      },
-    },
-
-    // Currency Information
-    currency: {
-      id: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "Currency",
-        required: true,
-      },
-      name: {
-        type: String,
-        required: true,
-      },
-      code: {
-        type: String,
-        required: true,
-        uppercase: true,
-        minlength: 3,
-        maxlength: 3,
-      },
-    },
-
-    // Billing Period (Year-Month format)
-    period: {
-      type: String,
-      required: true,
-      match: /^\d{4}-\d{2}$/, // Format: "2025-01"
-      index: true,
-    },
-
-    // Issue Date
-    issueDate: {
-      type: Date,
-      required: true,
-    },
-
-    // Due Date (can be based on the latest invoice due date)
-    dueDate: {
-      type: Date,
-      required: true,
-    },
-
-    // Overall Status
-    status: {
-      type: String,
-      required: true,
-      enum: [
-        "Unpaid",
-        "Pending",
-        "Paid",
-        "Overdue",
-        "Cancelled",
-        "Partially Paid",
-        "Void",
-      ],
-      default: "Unpaid",
-    },
-
-    // Total Amount (sum of all individual invoices)
-    totalAmount: {
-      type: Number,
-      required: true,
-      default: 0,
-    },
-
-    // Total Tax (sum of all individual invoice taxes)
-    totalTax: {
-      type: Number,
-      required: true,
-      default: 0,
-    },
-
-    // Total Amount Paid
-    amountPaid: {
-      type: Number,
-      default: 0,
-      min: 0,
-    },
-
-    // Total Balance Brought Forward
-    totalBalanceBroughtForward: {
-      type: Number,
-      default: 0,
-    },
-
-    // Array of Individual Invoices
-    invoices: [
-      {
-        invoiceId: {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: "Invoice",
-          required: true,
-        },
-        invoiceNumber: {
-          type: String,
-          required: true,
-        },
-        type: {
-          type: String,
-          required: true,
-          enum: ["levy", "lease", "water", "service", "utility", "contract"],
-        },
-        description: {
-          type: String,
-          required: true,
-        },
-        period: {
-          type: String,
-          required: true,
-          match: /^\d{4}-\d{2}$/,
-        },
-        amount: {
-          type: Number,
-          required: true,
-          min: 0,
-        },
-        tax: {
-          type: Number,
-          required: true,
-          default: 0,
-        },
-        balanceBroughtForward: {
-          type: Number,
-          default: 0,
-        },
-        totalAmount: {
-          type: Number,
-          required: true,
-        },
-        amountPaid: {
-          type: Number,
-          default: 0,
-        },
-        status: {
-          type: String,
-          required: true,
-          enum: [
-            "Unpaid",
-            "Pending",
-            "Paid",
-            "Overdue",
-            "Cancelled",
-            "Partially Paid",
-            "Void",
-          ],
-        },
-        issueDate: {
-          type: Date,
-          required: true,
-        },
-        dueDate: {
-          type: Date,
-          required: true,
-        },
-      },
-    ],
-
-    // Notification tracking for the combined invoice
-    notificationsSent: {
-      sms: {
-        type: Boolean,
-        default: false,
-      },
-      email: {
-        type: Boolean,
-        default: false,
-      },
-      attempts: {
-        type: Number,
-        default: 0,
-      },
-    },
-
-    // Last reminder sent
-    lastReminderSent: Date,
-
-    // Combined invoice notes
-    invoiceNote: {
-      type: String,
-      default: null,
-    },
-
-    // View status tracking
-    viewStatus: {
-      isOpened: { type: Boolean, default: false },
-      openedAt: { type: Date, default: null },
-      openedBy: {
-        facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
-        userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
-        userRole: { type: String },
-      },
-      viewHistory: [
-        {
-          viewedAt: { type: Date, required: true },
-          facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
-          userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
-        },
-      ],
-    },
-
-    // Combined invoice URL (if generated)
-    invoiceUrl: {
-      type: String,
-      default: null,
-    },
-
-    // Combined invoice number
-    combinedInvoiceNumber: {
-      type: String,
-      unique: true,
-      sparse: true,
-    },
-
-    // Account number for combined invoice
-    accountNumber: {
-      type: String,
-    },
-
-    // Payment method information (copied from first invoice's lease/levy)
-    paymentMethod: {
-      type: {
-        type: String,
-        enum: ["Bank Transfer", "Mobile Money", "M-Pesa", "Cash", "Cheque", "Other"],
-      },
-      bankDetailsId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: "BankDetails",
-      },
-      mobileMoneyDetails: {
-        businessNumber: String,
-        shortCode: String,
-      },
-    },
-
-    // Biller address reference (copied from first invoice's lease/levy)
-    billerAddressId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: "BillerAddress",
-    },
-  },
-  {
-    timestamps: true,
-  }
-);
-
-// Indexes for efficient querying
-combinedInvoiceSchema.index({ "customer.customerId": 1, period: 1 });
-combinedInvoiceSchema.index({ "unit.id": 1, period: 1 });
-combinedInvoiceSchema.index({ "facility.id": 1, period: 1 });
-combinedInvoiceSchema.index({ status: 1 });
-combinedInvoiceSchema.index({ period: 1 });
-combinedInvoiceSchema.index({ issueDate: -1 });
-combinedInvoiceSchema.index({ "customer.customerId": 1, status: 1 });
-combinedInvoiceSchema.index({ "invoices.invoiceId": 1 });
-combinedInvoiceSchema.index({ "currency.code": 1 });
-
-// Compound index for unique combined invoice per customer/unit/facility/period
-combinedInvoiceSchema.index(
-  { 
-    "customer.customerId": 1, 
-    "unit.id": 1, 
-    "facility.id": 1, 
-    period: 1 
-  },
-  { unique: true }
-);
-
-// Virtual field for calculating total balance
-combinedInvoiceSchema.virtual("calculatedBalance").get(function () {
-  return this.totalAmount - (this.amountPaid || 0) + (this.totalBalanceBroughtForward || 0);
-});
-
-// Virtual field for invoice count
-combinedInvoiceSchema.virtual("invoiceCount").get(function () {
-  return this.invoices ? this.invoices.length : 0;
-});
-
-// Static method to find combined invoice by period and customer
-combinedInvoiceSchema.statics.findByCustomerAndPeriod = function (customerId, period) {
-  return this.findOne({
-    "customer.customerId": customerId,
-    period: period,
-  });
-};
-
-// Static method to find combined invoices by facility and period
-combinedInvoiceSchema.statics.findByFacilityAndPeriod = function (facilityId, period) {
-  return this.find({
-    "facility.id": facilityId,
-    period: period,
-  });
-};
-
-// Static method to find all combined invoices for a customer
-combinedInvoiceSchema.statics.findByCustomer = function (customerId) {
-  return this.find({
-    "customer.customerId": customerId,
-  }).sort({ period: -1 });
-};
-
-// Static method to find pending notifications
-combinedInvoiceSchema.statics.findPendingNotifications = function (facilityId) {
-  return this.find({
-    "facility.id": facilityId,
-    status: { $in: ["Unpaid", "Overdue"] },
-    $or: [
-      { "notificationsSent.sms": false },
-      { "notificationsSent.email": false },
-    ],
-  });
-};
-
-// Method to update status based on individual invoices
-combinedInvoiceSchema.methods.updateOverallStatus = function () {
-  if (!this.invoices || this.invoices.length === 0) {
-    this.status = "Unpaid";
-    return;
-  }
-
-  const statuses = this.invoices.map(inv => inv.status);
-  
-  // If all paid, mark as paid
-  if (statuses.every(s => s === "Paid")) {
-    this.status = "Paid";
-  }
-  // If any overdue, mark as overdue
-  else if (statuses.some(s => s === "Overdue")) {
-    this.status = "Overdue";
-  }
-  // If any partially paid, mark as partially paid
-  else if (statuses.some(s => s === "Partially Paid")) {
-    this.status = "Partially Paid";
-  }
-  // If all cancelled, mark as cancelled
-  else if (statuses.every(s => s === "Cancelled")) {
-    this.status = "Cancelled";
-  }
-  // If all void, mark as void
-  else if (statuses.every(s => s === "Void")) {
-    this.status = "Void";
-  }
-  // Otherwise unpaid
-  else {
-    this.status = "Unpaid";
-  }
-};
-
-// Method to recalculate totals from individual invoices
-combinedInvoiceSchema.methods.recalculateTotals = function () {
-  if (!this.invoices || this.invoices.length === 0) {
-    this.totalAmount = 0;
-    this.totalTax = 0;
-    this.amountPaid = 0;
-    this.totalBalanceBroughtForward = 0;
-    return;
-  }
-
-  this.totalAmount = this.invoices.reduce((sum, inv) => sum + (inv.totalAmount || 0), 0);
-  this.totalTax = this.invoices.reduce((sum, inv) => sum + (inv.tax || 0), 0);
-  this.amountPaid = this.invoices.reduce((sum, inv) => sum + (inv.amountPaid || 0), 0);
-  this.totalBalanceBroughtForward = this.invoices.reduce(
-    (sum, inv) => sum + (inv.balanceBroughtForward || 0), 
-    0
-  );
-};
-
-// Pre-save middleware to auto-calculate totals and status
-combinedInvoiceSchema.pre("save", function (next) {
-  this.recalculateTotals();
-  this.updateOverallStatus();
-  next();
-});
-
-const CombinedInvoice = mongoose.model("CombinedInvoice", combinedInvoiceSchema);
-
+const mongoose = require("mongoose");
+
+const combinedInvoiceSchema = new mongoose.Schema(
+  {
+    // Customer Information
+    customer: {
+      customerId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Customer",
+        required: true,
+      },
+      firstName: {
+        type: String,
+        required: true,
+      },
+      lastName: {
+        type: String,
+        required: true,
+      },
+      accountNumber: {
+        type: String,
+        required: true,
+      },
+    },
+
+    // Unit Information
+    unit: {
+      id: { 
+        type: mongoose.Schema.Types.ObjectId, 
+        ref: "Unit", 
+        required: true 
+      },
+      name: { 
+        type: String, 
+        required: true 
+      },
+    },
+
+    // Facility Information
+    facility: {
+      id: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Facility",
+        required: true,
+      },
+      name: {
+        type: String,
+        required: true,
+      },
+    },
+
+    // Currency Information
+    currency: {
+      id: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Currency",
+        required: true,
+      },
+      name: {
+        type: String,
+        required: true,
+      },
+      code: {
+        type: String,
+        required: true,
+        uppercase: true,
+        minlength: 3,
+        maxlength: 3,
+      },
+    },
+
+    // Billing Period (Year-Month format)
+    period: {
+      type: String,
+      required: true,
+      match: /^\d{4}-\d{2}$/, // Format: "2025-01"
+      index: true,
+    },
+
+    // Issue Date
+    issueDate: {
+      type: Date,
+      required: true,
+    },
+
+    // Due Date (can be based on the latest invoice due date)
+    dueDate: {
+      type: Date,
+      required: true,
+    },
+
+    // Overall Status
+    status: {
+      type: String,
+      required: true,
+      enum: [
+        "Unpaid",
+        "Pending",
+        "Paid",
+        "Overdue",
+        "Cancelled",
+        "Partially Paid",
+        "Void",
+      ],
+      default: "Unpaid",
+    },
+
+    // Total Amount (sum of all individual invoices)
+    totalAmount: {
+      type: Number,
+      required: true,
+      default: 0,
+    },
+
+    // Total Tax (sum of all individual invoice taxes)
+    totalTax: {
+      type: Number,
+      required: true,
+      default: 0,
+    },
+
+    // Total Amount Paid
+    amountPaid: {
+      type: Number,
+      default: 0,
+      min: 0,
+    },
+
+    // Total Balance Brought Forward
+    totalBalanceBroughtForward: {
+      type: Number,
+      default: 0,
+    },
+
+    // Array of Individual Invoices
+    invoices: [
+      {
+        invoiceId: {
+          type: mongoose.Schema.Types.ObjectId,
+          ref: "Invoice",
+          required: true,
+        },
+        invoiceNumber: {
+          type: String,
+          required: true,
+        },
+        type: {
+          type: String,
+          required: true,
+          enum: ["levy", "lease", "water", "service", "utility", "contract"],
+        },
+        description: {
+          type: String,
+          required: true,
+        },
+        period: {
+          type: String,
+          required: true,
+          match: /^\d{4}-\d{2}$/,
+        },
+        amount: {
+          type: Number,
+          required: true,
+          min: 0,
+        },
+        tax: {
+          type: Number,
+          required: true,
+          default: 0,
+        },
+        balanceBroughtForward: {
+          type: Number,
+          default: 0,
+        },
+        totalAmount: {
+          type: Number,
+          required: true,
+        },
+        amountPaid: {
+          type: Number,
+          default: 0,
+        },
+        status: {
+          type: String,
+          required: true,
+          enum: [
+            "Unpaid",
+            "Pending",
+            "Paid",
+            "Overdue",
+            "Cancelled",
+            "Partially Paid",
+            "Void",
+          ],
+        },
+        issueDate: {
+          type: Date,
+          required: true,
+        },
+        dueDate: {
+          type: Date,
+          required: true,
+        },
+      },
+    ],
+
+    // Notification tracking for the combined invoice
+    notificationsSent: {
+      sms: {
+        type: Boolean,
+        default: false,
+      },
+      email: {
+        type: Boolean,
+        default: false,
+      },
+      attempts: {
+        type: Number,
+        default: 0,
+      },
+    },
+
+    // Last reminder sent
+    lastReminderSent: Date,
+
+    // Combined invoice notes
+    invoiceNote: {
+      type: String,
+      default: null,
+    },
+
+    // View status tracking
+    viewStatus: {
+      isOpened: { type: Boolean, default: false },
+      openedAt: { type: Date, default: null },
+      openedBy: {
+        facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
+        userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
+        userRole: { type: String },
+      },
+      viewHistory: [
+        {
+          viewedAt: { type: Date, required: true },
+          facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
+          userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
+        },
+      ],
+    },
+
+    // Combined invoice URL (if generated)
+    invoiceUrl: {
+      type: String,
+      default: null,
+    },
+
+    // Combined invoice number
+    combinedInvoiceNumber: {
+      type: String,
+      unique: true,
+      sparse: true,
+    },
+
+    // Account number for combined invoice
+    accountNumber: {
+      type: String,
+    },
+
+    // Payment method information (copied from first invoice's lease/levy)
+    paymentMethod: {
+      type: {
+        type: String,
+        enum: ["Bank Transfer", "Mobile Money", "M-Pesa", "Cash", "Cheque", "Other"],
+      },
+      bankDetailsId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "BankDetails",
+      },
+      mobileMoneyDetails: {
+        businessNumber: String,
+        shortCode: String,
+      },
+    },
+
+    // Biller address reference (copied from first invoice's lease/levy)
+    billerAddressId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "BillerAddress",
+    },
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// Indexes for efficient querying
+combinedInvoiceSchema.index({ "customer.customerId": 1, period: 1 });
+combinedInvoiceSchema.index({ "unit.id": 1, period: 1 });
+combinedInvoiceSchema.index({ "facility.id": 1, period: 1 });
+combinedInvoiceSchema.index({ status: 1 });
+combinedInvoiceSchema.index({ period: 1 });
+combinedInvoiceSchema.index({ issueDate: -1 });
+combinedInvoiceSchema.index({ "customer.customerId": 1, status: 1 });
+combinedInvoiceSchema.index({ "invoices.invoiceId": 1 });
+combinedInvoiceSchema.index({ "currency.code": 1 });
+
+// Compound index for unique combined invoice per customer/unit/facility/period
+combinedInvoiceSchema.index(
+  { 
+    "customer.customerId": 1, 
+    "unit.id": 1, 
+    "facility.id": 1, 
+    period: 1 
+  },
+  { unique: true }
+);
+
+// Virtual field for calculating total balance
+combinedInvoiceSchema.virtual("calculatedBalance").get(function () {
+  return this.totalAmount - (this.amountPaid || 0) + (this.totalBalanceBroughtForward || 0);
+});
+
+// Virtual field for invoice count
+combinedInvoiceSchema.virtual("invoiceCount").get(function () {
+  return this.invoices ? this.invoices.length : 0;
+});
+
+// Static method to find combined invoice by period and customer
+combinedInvoiceSchema.statics.findByCustomerAndPeriod = function (customerId, period) {
+  return this.findOne({
+    "customer.customerId": customerId,
+    period: period,
+  });
+};
+
+// Static method to find combined invoices by facility and period
+combinedInvoiceSchema.statics.findByFacilityAndPeriod = function (facilityId, period) {
+  return this.find({
+    "facility.id": facilityId,
+    period: period,
+  });
+};
+
+// Static method to find all combined invoices for a customer
+combinedInvoiceSchema.statics.findByCustomer = function (customerId) {
+  return this.find({
+    "customer.customerId": customerId,
+  }).sort({ period: -1 });
+};
+
+// Static method to find pending notifications
+combinedInvoiceSchema.statics.findPendingNotifications = function (facilityId) {
+  return this.find({
+    "facility.id": facilityId,
+    status: { $in: ["Unpaid", "Overdue"] },
+    $or: [
+      { "notificationsSent.sms": false },
+      { "notificationsSent.email": false },
+    ],
+  });
+};
+
+// Method to update status based on individual invoices
+combinedInvoiceSchema.methods.updateOverallStatus = function () {
+  if (!this.invoices || this.invoices.length === 0) {
+    this.status = "Unpaid";
+    return;
+  }
+
+  const statuses = this.invoices.map(inv => inv.status);
+  
+  // If all paid, mark as paid
+  if (statuses.every(s => s === "Paid")) {
+    this.status = "Paid";
+  }
+  // If any overdue, mark as overdue
+  else if (statuses.some(s => s === "Overdue")) {
+    this.status = "Overdue";
+  }
+  // If any partially paid, mark as partially paid
+  else if (statuses.some(s => s === "Partially Paid")) {
+    this.status = "Partially Paid";
+  }
+  // If all cancelled, mark as cancelled
+  else if (statuses.every(s => s === "Cancelled")) {
+    this.status = "Cancelled";
+  }
+  // If all void, mark as void
+  else if (statuses.every(s => s === "Void")) {
+    this.status = "Void";
+  }
+  // Otherwise unpaid
+  else {
+    this.status = "Unpaid";
+  }
+};
+
+// Method to recalculate totals from individual invoices
+combinedInvoiceSchema.methods.recalculateTotals = function () {
+  if (!this.invoices || this.invoices.length === 0) {
+    this.totalAmount = 0;
+    this.totalTax = 0;
+    this.amountPaid = 0;
+    this.totalBalanceBroughtForward = 0;
+    return;
+  }
+
+  this.totalAmount = this.invoices.reduce((sum, inv) => sum + (inv.totalAmount || 0), 0);
+  this.totalTax = this.invoices.reduce((sum, inv) => sum + (inv.tax || 0), 0);
+  this.amountPaid = this.invoices.reduce((sum, inv) => sum + (inv.amountPaid || 0), 0);
+  this.totalBalanceBroughtForward = this.invoices.reduce(
+    (sum, inv) => sum + (inv.balanceBroughtForward || 0), 
+    0
+  );
+};
+
+// Pre-save middleware to auto-calculate totals and status
+combinedInvoiceSchema.pre("save", function (next) {
+  this.recalculateTotals();
+  this.updateOverallStatus();
+  next();
+});
+
+const CombinedInvoice = mongoose.model("CombinedInvoice", combinedInvoiceSchema);
+
 module.exports = CombinedInvoice;