payservedb 4.3.5 → 4.3.6

package/package.json

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

package/src/models/invoice.js

@@ -84,10 +84,12 @@ const invoiceSchema = new mongoose.Schema(
       default: 0,
       min: 0,
     },
+    // Mark as deprecated, keep for backward compatibility
     overpay: {
       type: Number,
       default: 0,
       min: 0,
+      deprecated: true
     },
     issueDate: {
       type: Date,
@@ -114,7 +116,9 @@ const invoiceSchema = new mongoose.Schema(
       type: String,
       default: null,
     },
-    // New field for balance brought forward
+    // Enhanced balanceBroughtForward field
+    // Positive values = customer owes money
+    // Negative values = credit (previously tracked in overpay field)
     balanceBroughtForward: {
       type: Number,
       default: 0,
@@ -171,10 +175,29 @@ invoiceSchema.index({ issueDate: -1 });
 invoiceSchema.index({ 'currency.code': 1 }); // Add index for currency code
 invoiceSchema.index({ 'currency.id': 1 }); // Add index for currency ID
 invoiceSchema.index({ 'currency.code': 1, 'client.clientId': 1, status: 1 }); // Compound index for currency-based queries
+invoiceSchema.index({ 'client.clientId': 1, balanceBroughtForward: 1 }); // Add index for finding invoices with credit balances
 
 // Add virtual field for calculating balance
 invoiceSchema.virtual('calculatedBalance').get(function () {
-  return this.totalAmount - (this.amountPaid || 0);
+  const baseBalance = this.totalAmount - (this.amountPaid || 0);
+  
+  // Add positive balanceBroughtForward (customer owes money)
+  if (this.balanceBroughtForward > 0) {
+    return baseBalance + this.balanceBroughtForward;
+  }
+  
+  // Subtract negative balanceBroughtForward (credit)
+  return baseBalance;
+});
+
+// Add virtual field for credit balance
+invoiceSchema.virtual('creditBalance').get(function () {
+  return this.balanceBroughtForward < 0 ? Math.abs(this.balanceBroughtForward) : 0;
+});
+
+// Getter for compatible overpay field
+invoiceSchema.virtual('effectiveOverpay').get(function () {
+  return this.balanceBroughtForward < 0 ? Math.abs(this.balanceBroughtForward) : 0;
 });
 
 // Add method for currency conversion if needed
@@ -190,6 +213,14 @@ invoiceSchema.statics.findByCurrency = function (currencyCode) {
   return this.find({ 'currency.code': currencyCode.toUpperCase() });
 };
 
+// Add static method to find invoices with credit balance
+invoiceSchema.statics.findWithCreditBalance = function(clientId) {
+  return this.find({
+    'client.clientId': clientId,
+    'balanceBroughtForward': { $lt: 0 }
+  }).sort({ updatedAt: -1 });
+};
+
 // Add static method to calculate totals by currency
 invoiceSchema.statics.calculateTotalsByCurrency = function (query = {}) {
   return this.aggregate([
@@ -205,6 +236,17 @@ invoiceSchema.statics.calculateTotalsByCurrency = function (query = {}) {
   ]);
 };
 
+// Pre-save middleware to ensure overpay and balanceBroughtForward stay in sync during transition
+invoiceSchema.pre('save', function(next) {
+  // If balanceBroughtForward is negative (credit), sync with overpay for backwards compatibility
+  if (this.balanceBroughtForward < 0) {
+    this.overpay = Math.abs(this.balanceBroughtForward);
+  } else {
+    this.overpay = 0; // No overpay if there's no negative balance
+  }
+  next();
+});
+
 const Invoice = mongoose.model('Invoice', invoiceSchema);
 
-module.exports = Invoice;
+module.exports = Invoice;