payservedb 9.2.9 → 9.3.0

package/index.js

@@ -94,6 +94,7 @@ const models = {
   Levy: require("./src/models/levy"),
   LevyType: require("./src/models/levytype"),
   LevyContract: require("./src/models/levycontract"),
+  DepositSchema: require("./src/models/levy_deposits"),
   Invoice: require("./src/models/invoice"),
   CombinedInvoice: require("./src/models/combined_invoice"),
   InvoiceGeneration: require("./src/models/invoice_generation_approval"),
@@ -143,8 +144,6 @@ const models = {
   Expense: require("./src/models/expense"),
   ExpenseCategory: require("./src/models/expense_category"),
   InvoiceSettings: require("./src/models/levy_invoice_settings"),
-  DepositSchema: require("./src/models/levy_deposits"),
-  ContractPaymentReceiptSchema: require("./src/models/levy_payment_receipt"),
   Account: require("./src/models/account"),
   FacilityPaymentDetails: require("./src/models/facility_payment_details"),
   DefaultPaymentDetails: require("./src/models/default_payment_details"),
@@ -190,9 +189,12 @@ const models = {
   UnitManagementTemplate: require("./src/models/unitManagementTemplate"),
   PropertyManagerRevenue: require("./src/models/propertyManagerRevenue"),
   PropertyManagerContract: require("./src/models/propertyManagerContract"),
+  PropertyManagerRevenueEntry: require("./src/models/propertyManagerRevenueEntry"),
+  PropertyManagementSettings: require("./src/models/propertyManagementSettings"),
   BillerAddress: require("./src/models/billerAddress"),
   AssetAssignment: require("./src/models/assetsAssignment"),
   Wallet: require("./src/models/wallet"),
+  WalletTransaction: require("./src/models/wallet_transactions"),
   GoodsReceivedNote: require("./src/models/goodsReceivedNotes"),
   CommunicationStatus: require("./src/models/communication_status"),
   MeterCommandQueue: require("./src/models/water_meter_Command_Queue"),
@@ -266,7 +268,6 @@ const models = {
   RecipientGroupMember: require("./src/models/recipient_group_member"),
   InvoiceWithholdingTax: require("./src/models/InvoiceWithholdingTax"),
   InvoiceCreditAdjustment: require("./src/models/invoiceCreditAdjustment"),
-  WalletTransaction: require("./src/models/wallet_transaction"),
 };
 
 // Function to get models dynamically from a specific database connection

package/package.json

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

package/src/models/levycontract.js

@@ -118,19 +118,6 @@ const LevyContractSchema = new Schema(
                 default: 0,
                 min: [0, 'Upfront amount cannot be negative']
             },
-            numberOfMonths: {
-                type: Number,
-                min: [1, 'Number of months must be at least 1']
-            },
-            amountPerMonth: {
-                type: Number,
-                min: [0, 'Amount per month cannot be negative']
-            },
-            calculationMode: {
-                type: String,
-                enum: ['auto', 'custom'],
-                default: 'auto'
-            },
             billingPeriods: {
                 type: [String],
                 default: []

package/src/models/movein_application.js

@@ -3,7 +3,7 @@ const mongoose = require('mongoose');
 const moveInApplicationSchema = new mongoose.Schema(
     {
         unitId: { type: mongoose.Schema.Types.ObjectId, required: true, index: true },
-        facilityId: { type: mongoose.Schema.Types.ObjectId, ref: 'Facility', default: null, index: true },
+        facilityId: { type: mongoose.Schema.Types.ObjectId, ref: 'Facility', required: true, index: true },
         unitName: { type: String, default: null },
         facilityName: { type: String, default: null },
         tenantId: { type: mongoose.Schema.Types.ObjectId, ref: 'User', required: true, index: true },

package/src/models/power_invoice.js

@@ -46,11 +46,16 @@ const powerInvoiceSchema = new mongoose.Schema(
       // Positive = arrears carried forward; Negative = credit from overpayment
     },
 
-    withholdingTaxPercentage: {
+    withholdingTaxes: [
+      {
+        name: { type: String, required: true },       // e.g. "withholding"
+        percentage: { type: Number, required: true }, // e.g. 5
+        amount: { type: Number, required: true },     // e.g. 50 (subTotal * percentage / 100)
+      },
+    ],
+    totalWithholdingTax: {
       type: Number,
-      min: 0,
-      max: 100,
-      default: 0
+      default: 0,
     },
 
     // ── Biller Address ─────────────────────────────────────────────────────────

package/src/models/propertyManagementSettings.js

@@ -0,0 +1,60 @@
+const mongoose = require('mongoose');
+
+const feeRuleSchema = new mongoose.Schema(
+    {
+        type: {
+            type: String,
+            enum: ['percentage', 'amount'],
+            default: 'percentage'
+        },
+        value: {
+            type: Number,
+            default: 0,
+            min: [0, 'Fee value cannot be negative']
+        }
+    },
+    { _id: false }
+);
+
+// Per-facility property management revenue settings.
+// Booking commission is configured in the booking module (BookingConfig /
+// BookingProperty), so only lease fee and rent commission live here.
+const propertyManagementSettingsSchema = new mongoose.Schema(
+    {
+        facility: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Facility',
+            required: true,
+            unique: true
+        },
+        // One-time fee earned when the first rent payment lands on a managed unit
+        leaseFee: {
+            type: feeRuleSchema,
+            default: () => ({ type: 'percentage', value: 0 })
+        },
+        // Commission earned on every rent payment collected on a managed unit
+        rentCommission: {
+            type: feeRuleSchema,
+            default: () => ({ type: 'percentage', value: 0 })
+        },
+        updatedBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        }
+    },
+    { timestamps: true }
+);
+
+propertyManagementSettingsSchema.pre('validate', function (next) {
+    const rules = [this.leaseFee, this.rentCommission];
+    for (const rule of rules) {
+        if (rule && rule.type === 'percentage' && rule.value > 100) {
+            return next(new Error('Percentage fee cannot exceed 100%'));
+        }
+    }
+    next();
+});
+
+const PropertyManagementSettings = mongoose.model('PropertyManagementSettings', propertyManagementSettingsSchema);
+
+module.exports = PropertyManagementSettings;

package/src/models/propertyManagerRevenueEntry.js

@@ -0,0 +1,108 @@
+const mongoose = require('mongoose');
+
+// One document per revenue event earned by a property manager.
+// Sources: booking commission, lease fee (first rent payment) and rent commission.
+const propertyManagerRevenueEntrySchema = new mongoose.Schema({
+    facility: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+        index: true
+    },
+    propertyManager: {
+        id: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User',
+            required: true,
+            index: true
+        },
+        fullName: String,
+        email: String,
+        phoneNumber: String
+    },
+    contractId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'PropertyManagerContract'
+    },
+    contractName: String,
+    unit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Unit',
+        required: true
+    },
+    unitName: String,
+    source: {
+        type: String,
+        enum: ['booking_commission', 'lease_fee', 'rent_commission'],
+        required: true,
+        index: true
+    },
+    // Amount the rate was applied to (paid amount of the invoice / booking)
+    baseAmount: {
+        type: Number,
+        default: 0
+    },
+    rate: {
+        type: {
+            type: String,
+            enum: ['percentage', 'amount']
+        },
+        value: {
+            type: Number,
+            default: 0
+        }
+    },
+    // Revenue earned by the property manager
+    amount: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    // Source document that generated this entry (dedupe key)
+    reference: {
+        kind: {
+            type: String,
+            enum: ['invoice', 'reservation'],
+            required: true
+        },
+        id: {
+            type: mongoose.Schema.Types.ObjectId,
+            required: true
+        },
+        number: String
+    },
+    // Tenant / guest the revenue relates to
+    client: {
+        id: mongoose.Schema.Types.ObjectId,
+        name: String
+    },
+    earnedDate: {
+        type: Date,
+        default: Date.now,
+        index: true
+    },
+    status: {
+        type: String,
+        enum: ['earned', 'cancelled'],
+        default: 'earned'
+    },
+    notes: String,
+    createdBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User'
+    }
+}, {
+    timestamps: true
+});
+
+// A source document can only generate one entry per revenue stream
+propertyManagerRevenueEntrySchema.index(
+    { facility: 1, source: 1, 'reference.id': 1 },
+    { unique: true }
+);
+propertyManagerRevenueEntrySchema.index({ facility: 1, 'propertyManager.id': 1, source: 1, earnedDate: -1 });
+propertyManagerRevenueEntrySchema.index({ facility: 1, earnedDate: -1 });
+
+const PropertyManagerRevenueEntry = mongoose.model('PropertyManagerRevenueEntry', propertyManagerRevenueEntrySchema);
+
+module.exports = PropertyManagerRevenueEntry;

package/src/models/user.js

@@ -22,7 +22,7 @@ const userSchema = new mongoose.Schema({
         type: String,
         required: false
     },
-    type: {
+   type: {
         type: String,
         required: [true, 'Type is required'],
         enum: ['Company', 'Project Manager', 'Universal', 'Core', 'Resident', 'Landlord', 'Supplier', 'Customer_Support', 'Customer'],
@@ -125,12 +125,6 @@ const userSchema = new mongoose.Schema({
             }
         }
     },
-    canReceiveReports: {
-        water: { type: Boolean, default: false },
-        levy: { type: Boolean, default: false },
-        power: { type: Boolean, default: false },
-        lease: { type: Boolean, default: false },
-    },
     kyc: {
 
         Id: {

package/src/models/valueaddedservices.js

@@ -14,6 +14,35 @@ const valueAddedServiceSchema = new mongoose.Schema({
     providerType: {
         type: String,
         required: true,
+    },
+    pricingModel: {
+        type: String,
+        required: true,
+    },
+    fixedprice: {
+        type: String,
+        required: true,
+    },
+    applicableTaxes: [{
+        taxId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'CountryTaxRate'
+        },
+        taxName: String,
+        taxRate: Number
+    }],
+    // GL Account configurations
+    invoiceDoubleEntryAccount: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'GLAccountDoubleEntries'
+    },
+    paymentDoubleEntryAccount: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'GLAccountDoubleEntries'
+    },
+    taxDoubleEntryAccount: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'GLAccountDoubleEntries'
     }
 }, {
     timestamps: true

package/src/models/water_invoice.js

@@ -10,12 +10,7 @@ const waterInvoiceSchema = new mongoose.Schema(
     },
     accountNumber: {
       type: String,
-      required: true // static on the meter — always present, customer or not
-    },
-    unitId: {
-      type: mongoose.Schema.Types.ObjectId,
-      ref: 'Unit',
-      default: null
+      required: true
     },
     unitName: {
       type: String,
@@ -29,18 +24,10 @@ const waterInvoiceSchema = new mongoose.Schema(
       type: mongoose.Schema.Types.ObjectId,
       required: true
     },
-
-    // Customer is now OPTIONAL — a meter can be billed with no active tenant
     customerId: {
       type: mongoose.Schema.Types.ObjectId,
-      required: false,
-      default: null
-    },
-    hasActiveCustomer: {
-      type: Boolean,
-      default: true
+      required: true
     },
-
     billingType: {
       type: String,
       enum: ['postpaid'],
@@ -50,27 +37,6 @@ const waterInvoiceSchema = new mongoose.Schema(
       default: 0
     },
 
-    // Tracks WHY the balance was carried forward the way it was —
-    // critical for audit trail when tenants move in/out of a unit.
-    balanceSource: {
-      type: String,
-      enum: ['customer', 'unit', 'reset-new-tenant', 'none', 'error'],
-      default: 'none'
-    },
-
-    // If a tenant changed and there was an outstanding balance from the
-    // PREVIOUS tenant, it is NOT carried onto the new tenant's invoice.
-    // It's recorded here instead so it isn't silently lost, and can be
-    // picked up by a separate collections/reconciliation process.
-    unresolvedPriorBalance: {
-      type: Number,
-      default: 0
-    },
-    unresolvedPriorCustomerId: {
-      type: mongoose.Schema.Types.ObjectId,
-      default: null
-    },
-
     paymentMethods: {
       mobilePayment: {
         status: {