payservedb 3.9.9 → 4.0.1

package/index.js

@@ -112,6 +112,7 @@ const models = {
     AnalogMeter: require('./src/models/analog_water_meter'),
     AnalogBilling: require('./src/models/analog_water_billing'),
     MeterSize: require('./src/models/water_meter_size'),
+    WaterInvoice: require('./src/models/water_invoice'),
     MeterProtocol: require('./src/models/water_meter_communication'),
     MeterManufacturer: require('./src/models/water_meter_manufacturer'),
     MeterIotCard: require('./src/models/water_meter_iot_cards'),

package/package.json

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

package/src/models/water_invoice.js

@@ -0,0 +1,178 @@
+const mongoose = require('mongoose');
+
+const waterInvoiceSchema = new mongoose.Schema(
+  {
+    // Basic identifiers
+    invoiceNumber: {
+      type: String,
+      required: true,
+      unique: true
+    },
+    accountNumber: {
+      type: String,
+      required: true,
+      unique: true
+    },
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true
+    },
+    customerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      required: true
+    },
+
+    // Dates
+    dateIssued: {
+      type: Date,
+      default: Date.now
+    },
+    dueDate: {
+      type: Date,
+      required: true
+    },
+
+    // Meter & Consumption Details
+    meterNumber: {
+      type: String,
+      required: true
+    },
+    meterReadings: {
+      previousReading: {
+        type: Number,
+        required: true
+      },
+      currentReading: {
+        type: Number,
+        required: true
+      },
+      usage: {
+        type: Number,
+        required: true,
+      }
+    },
+    consumptionPeriod: {
+      startDate: {
+        type: Date,
+        required: true
+      },
+      endDate: {
+        type: Date,
+        required: true
+      }
+    },
+
+    // Charges
+    charges: {
+      waterCharge: {
+        type: Number,
+        required: true
+      },
+      sewerCharge: {
+        type: Number,
+        default: 0
+      },
+      tax: {
+        type: Number,
+        default: 0
+      },
+      otherFees: {
+        type: Number,
+        default: 0
+      },
+      totalMonthlyBill: {
+        type: Number,
+        required: true
+      }
+    },
+    amountPaid: {
+      type: Number,
+      default: 0
+    },
+
+    // Invoice Note & Status
+    invoiceNote: {
+      type: String,
+      default: 'Payment is due within 10 days'
+    },
+    status: {
+      type: String,
+      required: true,
+      enum: ['Pending', 'Paid', 'Partially Paid', 'Cancelled', 'Overdue', 'Unpaid'],
+      default: 'Pending'
+    },
+
+    // Currency Info
+    currency: {
+      id: {
+        type: mongoose.Schema.Types.ObjectId
+      },
+      name: {
+        type: String,
+        default: 'Kenyan Shilling'
+      },
+      code: {
+        type: String,
+        default: 'KES'
+      },
+      symbol: {
+        type: String,
+        default: 'KSh'
+      }
+    },
+
+    // Payment & Reconciliation
+    reconciliationHistory: [
+      {
+        date: {
+          type: Date,
+          default: Date.now
+        },
+        amount: {
+          type: Number,
+          required: true
+        },
+        type: {
+          type: String,
+          default: 'Manual'
+        },
+        paymentReference: {
+          type: String
+        },
+        paymentCompletion: {
+          type: String,
+          default: 'Completed'
+        },
+        sourceInvoice: {
+          type: String
+        },
+        destinationInvoice: {
+          type: String
+        },
+        notes: {
+          type: String
+        },
+        remainingBalance: {
+          type: Number
+        }
+      }
+    ],
+  },
+  {
+    timestamps: true
+  }
+);
+
+waterInvoiceSchema.pre('save', function (next) {
+  if (this.isModified('dueDate') || this.isNew) {
+    const today = new Date();
+    if (this.dueDate < today && this.status === 'Pending') {
+      this.status = 'Overdue';
+    }
+  }
+  next();
+});
+
+const WaterInvoice = mongoose.model('WaterInvoice', waterInvoiceSchema);
+
+module.exports = WaterInvoice;

package/src/models/water_meter_settings.js

@@ -21,6 +21,13 @@ const waterMeterSettingsSchema = new mongoose.Schema({
     required: true,
     default: 10
   },
+  invoiceDay: {
+    type: Number,
+    required: true,
+    min: 0,
+    max: 30,
+    default: 3
+  },
   enforcePayment: {
     type: String,
     enum: ['yes', 'no'],