payservedb 8.4.5 → 8.4.7

package/src/models/invoice.js

@@ -9,7 +9,7 @@ const invoiceSchema = new mongoose.Schema(
     },
     accountNumber: {
       type: String,
-      required: true
+      required: true,
     },
     client: {
       clientId: {
@@ -19,12 +19,12 @@ const invoiceSchema = new mongoose.Schema(
       },
       firstName: {
         type: String,
-        required: true
+        required: true,
       },
       lastName: {
         type: String,
-        required: true
-      }
+        required: true,
+      },
     },
     facility: {
       id: {
@@ -34,8 +34,8 @@ const invoiceSchema = new mongoose.Schema(
       },
       name: {
         type: String,
-        required: true
-      }
+        required: true,
+      },
     },
     unit: {
       id: { type: mongoose.Schema.Types.ObjectId, ref: "Unit", required: true },
@@ -45,19 +45,19 @@ const invoiceSchema = new mongoose.Schema(
       id: {
         type: mongoose.Schema.Types.ObjectId,
         ref: "Currency",
-        required: true
+        required: true,
       },
       name: {
         type: String,
-        required: true
+        required: true,
       },
       code: {
         type: String,
         required: true,
         uppercase: true,
         minlength: 3,
-        maxlength: 3
-      }
+        maxlength: 3,
+      },
     },
     items: [
       {
@@ -88,7 +88,7 @@ const invoiceSchema = new mongoose.Schema(
       type: Number,
       default: 0,
       min: 0,
-      deprecated: true
+      deprecated: true,
     },
     issueDate: {
       type: Date,
@@ -101,7 +101,15 @@ const invoiceSchema = new mongoose.Schema(
     status: {
       type: String,
       required: true,
-      enum: ["Unpaid", "Pending", "Paid", "Overdue", "Cancelled", "Partially Paid", "Void"],
+      enum: [
+        "Unpaid",
+        "Pending",
+        "Paid",
+        "Overdue",
+        "Cancelled",
+        "Partially Paid",
+        "Void",
+      ],
     },
     penalty: {
       type: Number,
@@ -123,40 +131,40 @@ const invoiceSchema = new mongoose.Schema(
     yearMonth: {
       type: String,
       match: /^\d{4}-\d{2}$/, // Validates format like "2025-08"
-      index: true
+      index: true,
     },
     // NEW FIELD 2: Simple notification tracking
     notificationsSent: {
       sms: {
         type: Boolean,
-        default: false
+        default: false,
       },
       email: {
         type: Boolean,
-        default: false
+        default: false,
       },
       attempts: {
         type: Number,
-        default: 0
-      }
+        default: 0,
+      },
     },
     voidMetadata: {
       voidedBy: {
         userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
         name: { type: String },
-        role: { type: String }
+        role: { type: String },
       },
       voidedAt: { type: Date },
-      reason: { type: String }
+      reason: { type: String },
     },
     cancelMetadata: {
       cancelledBy: {
         userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
         name: { type: String },
-        role: { type: String }
+        role: { type: String },
       },
       cancelledAt: { type: Date },
-      reason: { type: String }
+      reason: { type: String },
     },
     lastReminderSent: Date,
     reminderHistory: [
@@ -166,29 +174,42 @@ const invoiceSchema = new mongoose.Schema(
         notificationTypes: [String],
       },
     ],
-    reconciliationHistory: [{
-      date: { type: Date, required: true },
-      amount: { type: Number, required: true },
-      type: {
-        type: String,
-        enum: ['payment', 'cash', 'cheque', 'bank-transfer', 'mpesa-transfer', 'overpay-transfer', 'balance-deduction', 'overpay-received', 'credit-forward', 'debit-forward'],
-        required: true
-      },
-      sourceInvoice: String,
-      destinationInvoice: String,
-      paymentReference: String,
-      paymentCompletion: String,
-      remainingBalance: Number,
-      notes: String,
-      exchangeRate: {
-        type: Number,
-        default: 1  // For cross-currency reconciliations
+    reconciliationHistory: [
+      {
+        date: { type: Date, required: true },
+        amount: { type: Number, required: true },
+        type: {
+          type: String,
+          enum: [
+            "payment",
+            "cash",
+            "cheque",
+            "bank-transfer",
+            "mpesa-transfer",
+            "overpay-transfer",
+            "balance-deduction",
+            "overpay-received",
+            "credit-forward",
+            "debit-forward",
+          ],
+          required: true,
+        },
+        sourceInvoice: String,
+        destinationInvoice: String,
+        paymentReference: String,
+        paymentCompletion: String,
+        remainingBalance: Number,
+        notes: String,
+        exchangeRate: {
+          type: Number,
+          default: 1, // For cross-currency reconciliations
+        },
+        originalCurrency: {
+          code: String, // Original currency code if different from invoice currency
+          amount: Number, // Amount in original currency
+        },
       },
-      originalCurrency: {
-        code: String,  // Original currency code if different from invoice currency
-        amount: Number // Amount in original currency
-      }
-    }],
+    ],
     paymentDetails: {
       paymentStatus: { type: String, required: true },
       paymentMethod: { type: String },
@@ -202,17 +223,60 @@ const invoiceSchema = new mongoose.Schema(
       openedBy: {
         facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
         userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
-        userRole: { type: String }
+        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" }
-      }]
+      viewHistory: [
+        {
+          viewedAt: { type: Date, required: true },
+          facilityId: { type: mongoose.Schema.Types.ObjectId, ref: "Facility" },
+          userId: { type: mongoose.Schema.Types.ObjectId, ref: "User" },
+        },
+      ],
     },
     invoiceUrl: {
       type: String,
-      default: null
+      default: null,
+    },
+    // eTims tax integration fields
+    ticketUrl: {
+      type: String,
+      default: null,
+      description: "QR code URL from eTims/KRA for tax invoice verification",
+    },
+    txsync: {
+      status: {
+        type: String,
+        enum: ["pending", "synced", "failed", "not-applicable"],
+        default: "not-applicable",
+      },
+      syncedAt: {
+        type: Date,
+        default: null,
+      },
+      etimsInvoiceNo: {
+        type: String,
+        default: null,
+      },
+      sdcId: {
+        type: String,
+        default: null,
+      },
+      receiptNo: {
+        type: String,
+        default: null,
+      },
+      errorMessage: {
+        type: String,
+        default: null,
+      },
+      attempts: {
+        type: Number,
+        default: 0,
+      },
+      lastAttemptAt: {
+        type: Date,
+        default: null,
+      },
     },
     // New fields for double entry accounts
     invoiceDoubleEntryAccount: {
@@ -229,42 +293,45 @@ const invoiceSchema = new mongoose.Schema(
     accountdebitedData: {
       amount: { type: Number },
       description: { type: String },
-      isActive: { type: Boolean, default: true }
+      isActive: { type: Boolean, default: true },
     },
     accountcreditedData: {
       amount: { type: Number },
       description: { type: String },
-      isActive: { type: Boolean, default: true }
-    }
+      isActive: { type: Boolean, default: true },
+    },
   },
   {
     timestamps: true,
-  }
+  },
 );
 
 // Add indexes for frequently queried fields
 invoiceSchema.index({ accountNumber: 1 });
 invoiceSchema.index({ status: 1 });
-invoiceSchema.index({ 'client.clientId': 1, status: 1 });
-invoiceSchema.index({ 'reconciliationHistory.paymentReference': 1 });
+invoiceSchema.index({ "client.clientId": 1, status: 1 });
+invoiceSchema.index({ "reconciliationHistory.paymentReference": 1 });
 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
-invoiceSchema.index({ 'viewStatus.isOpened': 1 }); // Add index for view status
-invoiceSchema.index({ 'viewStatus.openedBy.facilityId': 1 }); // Add index for facility view tracking
+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
+invoiceSchema.index({ "viewStatus.isOpened": 1 }); // Add index for view status
+invoiceSchema.index({ "viewStatus.openedBy.facilityId": 1 }); // Add index for facility view tracking
 // Add index for double entry accounts
 invoiceSchema.index({ invoiceDoubleEntryAccount: 1 });
 invoiceSchema.index({ paymentDoubleEntryAccount: 1 });
 // NEW INDEXES for new fields
 invoiceSchema.index({ yearMonth: 1 }); // For filtering by year-month
 invoiceSchema.index({ yearMonth: 1, status: 1 }); // Combined index for monthly reports
-invoiceSchema.index({ 'notificationsSent.sms': 1 }); // For finding SMS sent/not sent
-invoiceSchema.index({ 'notificationsSent.email': 1 }); // For finding email sent/not sent
+invoiceSchema.index({ "notificationsSent.sms": 1 }); // For finding SMS sent/not sent
+invoiceSchema.index({ "notificationsSent.email": 1 }); // For finding email sent/not sent
+// eTims tax sync indexes
+invoiceSchema.index({ "txsync.status": 1 }); // For finding invoices by sync status
+invoiceSchema.index({ "txsync.etimsInvoiceNo": 1 }); // For looking up by eTims invoice number
 
 // Add virtual field for calculating balance
-invoiceSchema.virtual('calculatedBalance').get(function () {
+invoiceSchema.virtual("calculatedBalance").get(function () {
   const baseBalance = this.totalAmount - (this.amountPaid || 0);
 
   // Add positive balanceBroughtForward (customer owes money)
@@ -277,33 +344,42 @@ invoiceSchema.virtual('calculatedBalance').get(function () {
 });
 
 // Add virtual field for credit balance
-invoiceSchema.virtual('creditBalance').get(function () {
-  return this.balanceBroughtForward < 0 ? Math.abs(this.balanceBroughtForward) : 0;
+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;
+invoiceSchema.virtual("effectiveOverpay").get(function () {
+  return this.balanceBroughtForward < 0
+    ? Math.abs(this.balanceBroughtForward)
+    : 0;
 });
 
 // Add virtual populate for invoice double entry account
-invoiceSchema.virtual('invoiceDoubleEntry', {
-  ref: 'GLAccountDoubleEntries',
-  localField: 'invoiceDoubleEntryAccount',
-  foreignField: '_id',
-  justOne: true
+invoiceSchema.virtual("invoiceDoubleEntry", {
+  ref: "GLAccountDoubleEntries",
+  localField: "invoiceDoubleEntryAccount",
+  foreignField: "_id",
+  justOne: true,
 });
 
 // Add virtual populate for payment double entry account
-invoiceSchema.virtual('paymentDoubleEntry', {
-  ref: 'GLAccountDoubleEntries',
-  localField: 'paymentDoubleEntryAccount',
-  foreignField: '_id',
-  justOne: true
+invoiceSchema.virtual("paymentDoubleEntry", {
+  ref: "GLAccountDoubleEntries",
+  localField: "paymentDoubleEntryAccount",
+  foreignField: "_id",
+  justOne: true,
 });
 
 // Add method for currency conversion if needed
-invoiceSchema.methods.convertAmount = function (amount, fromCurrency, toCurrency, exchangeRate) {
+invoiceSchema.methods.convertAmount = function (
+  amount,
+  fromCurrency,
+  toCurrency,
+  exchangeRate,
+) {
   if (fromCurrency === toCurrency) {
     return amount;
   }
@@ -312,14 +388,14 @@ invoiceSchema.methods.convertAmount = function (amount, fromCurrency, toCurrency
 
 // Add static method to find invoices by currency
 invoiceSchema.statics.findByCurrency = function (currencyCode) {
-  return this.find({ 'currency.code': currencyCode.toUpperCase() });
+  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 }
+    "client.clientId": clientId,
+    balanceBroughtForward: { $lt: 0 },
   }).sort({ updatedAt: -1 });
 };
 
@@ -329,20 +405,20 @@ invoiceSchema.statics.calculateTotalsByCurrency = function (query = {}) {
     { $match: query },
     {
       $group: {
-        _id: '$currency.code',
-        totalAmount: { $sum: '$totalAmount' },
-        totalPaid: { $sum: '$amountPaid' },
-        count: { $sum: 1 }
-      }
-    }
+        _id: "$currency.code",
+        totalAmount: { $sum: "$totalAmount" },
+        totalPaid: { $sum: "$amountPaid" },
+        count: { $sum: 1 },
+      },
+    },
   ]);
 };
 
 // New static method to find all unviewed invoices
 invoiceSchema.statics.findUnviewedInvoices = function (facilityId) {
   return this.find({
-    'facility.id': facilityId,
-    'viewStatus.isOpened': false
+    "facility.id": facilityId,
+    "viewStatus.isOpened": false,
   });
 };
 
@@ -355,17 +431,33 @@ invoiceSchema.statics.findByYearMonth = function (yearMonth) {
 // Find invoices where notifications haven't been sent
 invoiceSchema.statics.findPendingNotifications = function (facilityId) {
   return this.find({
-    'facility.id': facilityId,
-    status: { $in: ['Unpaid', 'Overdue'] },
+    "facility.id": facilityId,
+    status: { $in: ["Unpaid", "Overdue"] },
     $or: [
-      { 'notificationsSent.sms': false },
-      { 'notificationsSent.email': false }
-    ]
+      { "notificationsSent.sms": false },
+      { "notificationsSent.email": false },
+    ],
+  });
+};
+
+// Find invoices pending eTims sync
+invoiceSchema.statics.findPendingTaxSync = function (facilityId) {
+  return this.find({
+    "facility.id": facilityId,
+    "txsync.status": "pending",
+  });
+};
+
+// Find invoices with failed eTims sync
+invoiceSchema.statics.findFailedTaxSync = function (facilityId) {
+  return this.find({
+    "facility.id": facilityId,
+    "txsync.status": "failed",
   });
 };
 
 // Pre-save middleware to ensure overpay and balanceBroughtForward stay in sync during transition
-invoiceSchema.pre('save', function (next) {
+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);
@@ -376,13 +468,13 @@ invoiceSchema.pre('save', function (next) {
   // NEW: Auto-generate yearMonth from issueDate if not provided
   if (!this.yearMonth && this.issueDate) {
     const year = this.issueDate.getFullYear();
-    const month = String(this.issueDate.getMonth() + 1).padStart(2, '0');
+    const month = String(this.issueDate.getMonth() + 1).padStart(2, "0");
     this.yearMonth = `${year}-${month}`;
   }
 
   next();
 });
 
-const Invoice = mongoose.model('Invoice', invoiceSchema);
+const Invoice = mongoose.model("Invoice", invoiceSchema);
 
-module.exports = Invoice;
+module.exports = Invoice;

package/src/models/invoicing_schedule.js

@@ -16,6 +16,11 @@ const InvoicingScheduleSchema = new mongoose.Schema({
         trim: true,
         index: true
     },
+    isAutomatic: {
+        type: Boolean,
+        required: true,
+        default: true 
+    },
     createdAt: {
         type: Date,
         default: Date.now
@@ -33,4 +38,4 @@ InvoicingScheduleSchema.pre('save', function(next) {
 
 const InvoicingSchedule = mongoose.model('InvoicingSchedule', InvoicingScheduleSchema);
 
-module.exports = InvoicingSchedule;
+module.exports = InvoicingSchedule;