payservedb 8.3.8 → 8.4.0

package/src/models/facilityInvoice.js

@@ -1,5 +1,5 @@
 const mongoose = require("mongoose");
-const {RecipientSchema} = require("./facilityInvoiceRecipient")
+const { RecipientSchema } = require("./facilityInvoiceRecipient");
 
 const FacilityInvoiceSchema = new mongoose.Schema(
   {
@@ -13,11 +13,11 @@ const FacilityInvoiceSchema = new mongoose.Schema(
       ref: "FacilityInvoiceContract",
       required: true,
     },
-      recipient: {
-          type: RecipientSchema,
-          required: true,
-      },
-      invoiceNumber: {
+    recipient: {
+      type: RecipientSchema,
+      required: true,
+    },
+    invoiceNumber: {
       type: String,
       required: true,
       trim: true,
@@ -32,7 +32,7 @@ const FacilityInvoiceSchema = new mongoose.Schema(
     },
     status: {
       type: String,
-      enum: ["pending", "paid", "overdue"],
+      enum: ["pending", "paid", "partially_paid", "overdue"],
       default: "pending",
     },
     invoiceType: {
@@ -52,6 +52,7 @@ const FacilityInvoiceSchema = new mongoose.Schema(
             "powerMeters",
             "hotWaterMeters",
             "coldWaterMeters",
+            "sms",
           ],
           trim: true,
         },
@@ -88,10 +89,26 @@ const FacilityInvoiceSchema = new mongoose.Schema(
         },
       },
     ],
+    // Subtotal of all invoice items before tax and balance
+    subtotal: {
+      type: Number,
+      required: true,
+      min: [0, "Subtotal cannot be negative"],
+      default: 0,
+    },
+    balanceBroughtForward: {
+      type: Number,
+      default: 0,
+    },
+    // Tax amount calculated on subtotal
+    taxAmount: {
+      type: Number,
+      default: 0,
+      min: [0, "Tax amount cannot be negative"],
+    },
     amount: {
       type: Number,
       required: true,
-      min: [0, "Total amount cannot be negative"],
     },
     taxRate: {
       type: Number,

package/src/models/facilityInvoicePayment.js

@@ -23,6 +23,11 @@ const FacilityInvoicePaymentSchema = new mongoose.Schema({
     type: String,
     required: false,
   },
+  proofOfPaymentUrl: {
+    type: String,
+    required: false,
+    trim: true,
+  },
   status: {
     type: String,
     enum: ["pending", "paid", "overpaid", "rejected"],

package/src/models/water_meter_account.js

@@ -40,6 +40,12 @@ const waterMeterAccountSchema = new mongoose.Schema({
         type: mongoose.Schema.Types.ObjectId,
         ref: 'Unit',
     },
+    unitName: {
+        type: String,
+        required: true,
+        trim: true,
+        index: true
+    },
     payment_type: {
         type: String,
         required: true,
@@ -79,4 +85,4 @@ const waterMeterAccountSchema = new mongoose.Schema({
 
 const WaterMeterAccount = mongoose.model('WaterMeterAccount', waterMeterAccountSchema);
 
-module.exports = WaterMeterAccount;
+module.exports = WaterMeterAccount;

package/src/models/water_meter_settings.js

@@ -25,6 +25,13 @@ const waterMeterSettingsSchema = new mongoose.Schema({
     type: Number,
     default: 0
   },
+  freeWaterAllowance: {
+    type: Number,
+    required: true,
+    default: 0,
+    min: 0,
+    description: "Free water allowance in cubic meters (m³) - users won't be billed for consumption up to this amount"
+  },
   gracePeriod: {
     type: Number,
     required: true,
@@ -262,19 +269,16 @@ const waterMeterSettingsSchema = new mongoose.Schema({
   },
 
   //GL ACCOUNT DOUBLE ENTRIES
-
   invocieCreationDe: {
     type: mongoose.Schema.Types.ObjectId,
     ref: 'GLAccountDoubleEntries',
     unique: true
   },
-
   invoicePaymentDe: {
     type: mongoose.Schema.Types.ObjectId,
     ref: 'GLAccountDoubleEntries',
     unique: true
   },
-
 }, {
   timestamps: true
 });

package/src/models/zohoIntegration.js

@@ -0,0 +1,262 @@
+const mongoose = require("mongoose");
+
+const ZohoIntegrationSchema = new mongoose.Schema(
+  {
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Facility",
+      required: [true, "Facility ID is required"],
+      unique: true,
+      index: true,
+    },
+
+    // Zoho API Credentials
+    // NOTE: clientSecret, refreshToken, and accessToken should be encrypted before storage
+    clientId: {
+      type: String,
+      required: [true, "Zoho Client ID is required"],
+      trim: true,
+    },
+    clientSecret: {
+      type: String,
+      required: [true, "Zoho Client Secret is required"],
+      trim: true,
+      // This field should be encrypted in the application layer
+    },
+    refreshToken: {
+      type: String,
+      required: [true, "Zoho Refresh Token is required"],
+      trim: true,
+      // This field should be encrypted in the application layer
+    },
+    accessToken: {
+      type: String,
+      trim: true,
+      default: null,
+      // This field should be encrypted in the application layer
+      // Auto-refreshed by the system
+    },
+    organizationId: {
+      type: String,
+      required: [true, "Zoho Organization ID is required"],
+      trim: true,
+    },
+
+    // Integration Status
+    isActive: {
+      type: Boolean,
+      default: true,
+    },
+    connectionStatus: {
+      type: String,
+      enum: ["connected", "disconnected", "error", "pending"],
+      default: "pending",
+    },
+    connectionError: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    lastConnectionTest: {
+      type: Date,
+      default: null,
+    },
+
+    // Token Management
+    tokenExpiresAt: {
+      type: Date,
+      default: null,
+    },
+    lastTokenRefreshAt: {
+      type: Date,
+      default: null,
+    },
+    tokenRefreshCount: {
+      type: Number,
+      default: 0,
+      min: [0, "Token refresh count cannot be negative"],
+    },
+
+    // Sync Statistics
+    lastSyncedAt: {
+      type: Date,
+      default: null,
+    },
+    totalInvoicesSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total invoices synced cannot be negative"],
+    },
+    totalPaymentsSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total payments synced cannot be negative"],
+    },
+    totalCustomersSynced: {
+      type: Number,
+      default: 0,
+      min: [0, "Total customers synced cannot be negative"],
+    },
+    successfulSyncs: {
+      type: Number,
+      default: 0,
+      min: [0, "Successful syncs cannot be negative"],
+    },
+    failedSyncs: {
+      type: Number,
+      default: 0,
+      min: [0, "Failed syncs cannot be negative"],
+    },
+
+    // Sync Configuration
+    autoSyncEnabled: {
+      type: Boolean,
+      default: true,
+    },
+    syncFrequency: {
+      type: String,
+      enum: ["realtime", "hourly", "daily", "manual"],
+      default: "realtime",
+    },
+    lastSyncError: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+
+    // Invoice Sync Settings
+    syncInvoicesOnCreation: {
+      type: Boolean,
+      default: true,
+    },
+    syncPaymentsOnReceipt: {
+      type: Boolean,
+      default: true,
+    },
+    markInvoicesAsSent: {
+      type: Boolean,
+      default: true,
+    },
+
+    // API Configuration
+    apiBaseUrl: {
+      type: String,
+      trim: true,
+      default: "https://www.zohoapis.com/books/v3",
+    },
+    requestTimeout: {
+      type: Number,
+      default: 30000,
+      min: [1000, "Request timeout must be at least 1000ms"],
+    },
+    maxRetries: {
+      type: Number,
+      default: 3,
+      min: [0, "Max retries cannot be negative"],
+      max: [10, "Max retries cannot exceed 10"],
+    },
+
+    // Audit Fields
+    createdBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+    updatedBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+    lastModifiedBy: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      default: null,
+    },
+
+    // Notes and metadata
+    notes: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    metadata: {
+      type: mongoose.Schema.Types.Mixed,
+      default: {},
+    },
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// Indexes for better query performance
+ZohoIntegrationSchema.index({ facilityId: 1, isActive: 1 });
+ZohoIntegrationSchema.index({ connectionStatus: 1 });
+ZohoIntegrationSchema.index({ lastSyncedAt: -1 });
+
+// Virtual for success rate
+ZohoIntegrationSchema.virtual("syncSuccessRate").get(function () {
+  const total = this.successfulSyncs + this.failedSyncs;
+  if (total === 0) return 0;
+  return ((this.successfulSyncs / total) * 100).toFixed(2);
+});
+
+// Method to mask sensitive fields for API responses
+ZohoIntegrationSchema.methods.toSafeObject = function () {
+  const obj = this.toObject();
+
+  // Mask sensitive fields
+  if (obj.clientSecret) {
+    obj.clientSecret = "••••••••" + obj.clientSecret.slice(-4);
+  }
+  if (obj.refreshToken) {
+    obj.refreshToken = "••••••••" + obj.refreshToken.slice(-4);
+  }
+  if (obj.accessToken) {
+    obj.accessToken = "••••••••" + (obj.accessToken ? obj.accessToken.slice(-4) : "");
+  }
+
+  return obj;
+};
+
+// Method to check if token needs refresh (5 minutes buffer)
+ZohoIntegrationSchema.methods.needsTokenRefresh = function () {
+  if (!this.tokenExpiresAt) return true;
+  const bufferTime = 5 * 60 * 1000; // 5 minutes in milliseconds
+  return new Date().getTime() >= (this.tokenExpiresAt.getTime() - bufferTime);
+};
+
+// Method to increment sync counters
+ZohoIntegrationSchema.methods.incrementSyncCounters = function (type, success = true) {
+  this.lastSyncedAt = new Date();
+
+  if (type === "invoice") {
+    this.totalInvoicesSynced += 1;
+  } else if (type === "payment") {
+    this.totalPaymentsSynced += 1;
+  } else if (type === "customer") {
+    this.totalCustomersSynced += 1;
+  }
+
+  if (success) {
+    this.successfulSyncs += 1;
+    this.lastSyncError = null;
+  } else {
+    this.failedSyncs += 1;
+  }
+
+  return this.save();
+};
+
+// Pre-save hook to update timestamps
+ZohoIntegrationSchema.pre("save", function (next) {
+  this.updatedAt = new Date();
+  next();
+});
+
+const ZohoIntegration = mongoose.model(
+  "ZohoIntegration",
+  ZohoIntegrationSchema
+);
+
+module.exports = ZohoIntegration;

package/.idea/material_theme_project_new.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MaterialThemeProjectNewConfig">
-    <option name="metadata">
-      <MTProjectMetadataState>
-        <option name="migrated" value="true" />
-        <option name="pristineConfig" value="false" />
-        <option name="userId" value="1756d2b0:198e001a643:-7ffe" />
-      </MTProjectMetadataState>
-    </option>
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/psdb.iml" filepath="$PROJECT_DIR$/.idea/psdb.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/psdb.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>