payservedb 8.4.5 → 8.4.7

package/src/models/zohoItem.js

@@ -0,0 +1,504 @@
+const mongoose = require("mongoose");
+
+const ZohoItemSchema = new mongoose.Schema(
+  {
+    facilityId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Facility",
+      required: [true, "Facility ID is required"],
+      index: true,
+    },
+
+    // PayServe Fields
+    name: {
+      type: String,
+      required: [true, "Item name is required"],
+      trim: true,
+      maxlength: [100, "Item name cannot exceed 100 characters"],
+      index: true,
+    },
+    description: {
+      type: String,
+      trim: true,
+      maxlength: [2000, "Description cannot exceed 2000 characters"],
+      default: null,
+    },
+    category: {
+      type: String,
+      enum: [
+        "Rent",
+        "Service Charge",
+        "Utilities",
+        "Parking",
+        "Maintenance",
+        "Penalties",
+        "Deposits",
+        "Other",
+      ],
+      default: "Other",
+      index: true,
+    },
+
+    // Pricing
+    rate: {
+      type: Number,
+      required: [true, "Item rate is required"],
+      min: [0, "Rate cannot be negative"],
+      default: 0,
+    },
+    unit: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    sku: {
+      type: String,
+      trim: true,
+      unique: true,
+      sparse: true, // Allows multiple null values
+      default: null,
+    },
+
+    // Item Type Configuration
+    itemType: {
+      type: String,
+      enum: ["sales", "purchases", "sales_and_purchases", "inventory"],
+      default: "sales",
+      required: true,
+    },
+    productType: {
+      type: String,
+      enum: [
+        "goods",
+        "service",
+        "digital_service",
+        "capital_goods",
+        "capital_service",
+      ],
+      default: "service",
+    },
+
+    // Zoho Sync Fields
+    zohoItemId: {
+      type: String,
+      trim: true,
+      unique: true,
+      sparse: true,
+      default: null,
+      index: true,
+    },
+    zohoAccountId: {
+      type: String,
+      trim: true,
+      default: null,
+      index: true,
+    },
+    zohoAccountName: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    zohoPurchaseAccountId: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    zohoInventoryAccountId: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    zohoTaxId: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    zohoTaxName: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    zohoTaxPercentage: {
+      type: Number,
+      min: 0,
+      max: 100,
+      default: null,
+    },
+
+    // Tax Configuration
+    isTaxable: {
+      type: Boolean,
+      default: true,
+    },
+    taxExemptionId: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+
+    // Purchase Information (for inventory items)
+    purchaseDescription: {
+      type: String,
+      trim: true,
+      maxlength: [2000, "Purchase description cannot exceed 2000 characters"],
+      default: null,
+    },
+    purchaseRate: {
+      type: Number,
+      min: [0, "Purchase rate cannot be negative"],
+      default: null,
+    },
+
+    // Inventory Management
+    reorderLevel: {
+      type: Number,
+      min: [0, "Reorder level cannot be negative"],
+      default: null,
+    },
+    initialStock: {
+      type: Number,
+      min: [0, "Initial stock cannot be negative"],
+      default: null,
+    },
+    initialStockRate: {
+      type: Number,
+      min: [0, "Initial stock rate cannot be negative"],
+      default: null,
+    },
+
+    // Country-Specific Fields
+    hsnOrSac: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    satItemKeyCode: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    unitKeyCode: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+
+    // Status
+    status: {
+      type: String,
+      enum: ["active", "inactive"],
+      default: "active",
+      index: true,
+    },
+    isActive: {
+      type: Boolean,
+      default: true,
+      index: true,
+    },
+
+    // Sync Status
+    isSynced: {
+      type: Boolean,
+      default: false,
+      index: true,
+    },
+    lastSyncedAt: {
+      type: Date,
+      default: null,
+    },
+    syncStatus: {
+      type: String,
+      enum: ["pending", "syncing", "synced", "failed"],
+      default: "pending",
+      index: true,
+    },
+    syncError: {
+      type: String,
+      trim: true,
+      default: null,
+    },
+    lastSyncAttemptAt: {
+      type: Date,
+      default: null,
+    },
+
+    // Usage Statistics
+    usageCount: {
+      type: Number,
+      default: 0,
+      min: [0, "Usage count cannot be negative"],
+    },
+    lastUsedAt: {
+      type: Date,
+      default: null,
+    },
+
+    // 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,
+    },
+
+    // Custom Fields (for Zoho custom fields)
+    customFields: {
+      type: mongoose.Schema.Types.Mixed,
+      default: {},
+    },
+
+    // Metadata
+    notes: {
+      type: String,
+      trim: true,
+      maxlength: [1000, "Notes cannot exceed 1000 characters"],
+      default: null,
+    },
+    metadata: {
+      type: mongoose.Schema.Types.Mixed,
+      default: {},
+    },
+  },
+  {
+    timestamps: true,
+  }
+);
+
+// Compound Indexes
+ZohoItemSchema.index({ facilityId: 1, name: 1 });
+ZohoItemSchema.index({ facilityId: 1, status: 1 });
+ZohoItemSchema.index({ facilityId: 1, category: 1 });
+ZohoItemSchema.index({ facilityId: 1, isActive: 1 });
+ZohoItemSchema.index({ facilityId: 1, isSynced: 1 });
+ZohoItemSchema.index({ zohoItemId: 1, facilityId: 1 });
+
+// Text index for searching
+ZohoItemSchema.index({
+  name: "text",
+  description: "text",
+  category: "text",
+});
+
+// Virtual for sync status indicator
+ZohoItemSchema.virtual("needsSync").get(function () {
+  if (!this.zohoItemId) return true;
+  if (!this.isSynced) return true;
+  return false;
+});
+
+// Method to mark as synced
+ZohoItemSchema.methods.markAsSynced = function (zohoItemId, zohoData = {}) {
+  this.zohoItemId = zohoItemId;
+  this.isSynced = true;
+  this.lastSyncedAt = new Date();
+  this.syncStatus = "synced";
+  this.syncError = null;
+
+  // Update Zoho-specific fields if provided
+  if (zohoData.accountId) this.zohoAccountId = zohoData.accountId;
+  if (zohoData.accountName) this.zohoAccountName = zohoData.accountName;
+  if (zohoData.taxId) this.zohoTaxId = zohoData.taxId;
+  if (zohoData.taxName) this.zohoTaxName = zohoData.taxName;
+  if (zohoData.taxPercentage !== undefined)
+    this.zohoTaxPercentage = zohoData.taxPercentage;
+
+  return this.save();
+};
+
+// Method to mark sync as failed
+ZohoItemSchema.methods.markSyncFailed = function (errorMessage) {
+  this.syncStatus = "failed";
+  this.syncError = errorMessage;
+  this.lastSyncAttemptAt = new Date();
+  return this.save();
+};
+
+// Method to increment usage count
+ZohoItemSchema.methods.incrementUsage = function () {
+  this.usageCount += 1;
+  this.lastUsedAt = new Date();
+  return this.save();
+};
+
+// Method to activate item
+ZohoItemSchema.methods.activate = function () {
+  this.status = "active";
+  this.isActive = true;
+  return this.save();
+};
+
+// Method to deactivate item
+ZohoItemSchema.methods.deactivate = function () {
+  this.status = "inactive";
+  this.isActive = false;
+  return this.save();
+};
+
+// Static method to find items by category
+ZohoItemSchema.statics.findByCategory = function (facilityId, category) {
+  return this.find({
+    facilityId,
+    category,
+    isActive: true,
+  }).sort({ name: 1 });
+};
+
+// Static method to find unsynced items
+ZohoItemSchema.statics.findUnsynced = function (facilityId) {
+  return this.find({
+    facilityId,
+    $or: [{ isSynced: false }, { zohoItemId: null }],
+    isActive: true,
+  }).sort({ createdAt: 1 });
+};
+
+// Static method to search items
+ZohoItemSchema.statics.searchItems = function (facilityId, searchText) {
+  return this.find({
+    facilityId,
+    isActive: true,
+    $text: { $search: searchText },
+  }).sort({ score: { $meta: "textScore" } });
+};
+
+// Pre-save hook to update status
+ZohoItemSchema.pre("save", function (next) {
+  // Sync status and isActive
+  if (this.status === "active") {
+    this.isActive = true;
+  } else {
+    this.isActive = false;
+  }
+
+  // Update lastModifiedBy
+  if (this.isModified() && !this.isNew) {
+    this.updatedAt = new Date();
+  }
+
+  next();
+});
+
+// Pre-save validation
+ZohoItemSchema.pre("save", function (next) {
+  // Validate tax exemption
+  if (!this.isTaxable && !this.taxExemptionId) {
+    return next(
+      new Error("Tax exemption ID is required when item is not taxable")
+    );
+  }
+
+  // Validate purchase fields for inventory items
+  if (this.itemType === "inventory" && !this.zohoInventoryAccountId) {
+    // Only validate if already synced to Zoho
+    if (this.isSynced) {
+      return next(
+        new Error("Inventory account ID is required for inventory items")
+      );
+    }
+  }
+
+  next();
+});
+
+// Instance method to convert to Zoho format
+ZohoItemSchema.methods.toZohoFormat = function () {
+  const zohoItem = {
+    name: this.name,
+    rate: this.rate,
+    description: this.description || "",
+    item_type: this.itemType,
+    product_type: this.productType,
+    sku: this.sku || undefined,
+    unit: this.unit || undefined,
+  };
+
+  // Add account IDs if available
+  if (this.zohoAccountId) {
+    zohoItem.account_id = this.zohoAccountId;
+  }
+  if (this.zohoTaxId) {
+    zohoItem.tax_id = this.zohoTaxId;
+  }
+  if (this.zohoPurchaseAccountId) {
+    zohoItem.purchase_account_id = this.zohoPurchaseAccountId;
+  }
+  if (this.zohoInventoryAccountId) {
+    zohoItem.inventory_account_id = this.zohoInventoryAccountId;
+  }
+
+  // Add tax configuration
+  if (this.isTaxable !== undefined) {
+    zohoItem.is_taxable = this.isTaxable;
+  }
+  if (this.taxExemptionId) {
+    zohoItem.tax_exemption_id = this.taxExemptionId;
+  }
+
+  // Add purchase information
+  if (this.purchaseDescription) {
+    zohoItem.purchase_description = this.purchaseDescription;
+  }
+  if (this.purchaseRate) {
+    zohoItem.purchase_rate = this.purchaseRate;
+  }
+
+  // Add inventory information
+  if (this.reorderLevel) {
+    zohoItem.reorder_level = this.reorderLevel;
+  }
+
+  // Add country-specific fields
+  if (this.hsnOrSac) {
+    zohoItem.hsn_or_sac = this.hsnOrSac;
+  }
+  if (this.satItemKeyCode) {
+    zohoItem.sat_item_key_code = this.satItemKeyCode;
+  }
+  if (this.unitKeyCode) {
+    zohoItem.unitkey_code = this.unitKeyCode;
+  }
+
+  return zohoItem;
+};
+
+// Instance method to update from Zoho data
+ZohoItemSchema.methods.updateFromZoho = function (zohoData) {
+  if (zohoData.item_id) this.zohoItemId = zohoData.item_id;
+  if (zohoData.name) this.name = zohoData.name;
+  if (zohoData.rate !== undefined) this.rate = zohoData.rate;
+  if (zohoData.description) this.description = zohoData.description;
+  if (zohoData.status) this.status = zohoData.status;
+  if (zohoData.unit) this.unit = zohoData.unit;
+  if (zohoData.sku) this.sku = zohoData.sku;
+  if (zohoData.product_type) this.productType = zohoData.product_type;
+  if (zohoData.item_type) this.itemType = zohoData.item_type;
+
+  // Update account information
+  if (zohoData.account_id) this.zohoAccountId = zohoData.account_id;
+  if (zohoData.account_name) this.zohoAccountName = zohoData.account_name;
+
+  // Update tax information
+  if (zohoData.tax_id) this.zohoTaxId = zohoData.tax_id;
+  if (zohoData.tax_name) this.zohoTaxName = zohoData.tax_name;
+  if (zohoData.tax_percentage !== undefined)
+    this.zohoTaxPercentage = parseFloat(zohoData.tax_percentage);
+
+  this.isSynced = true;
+  this.lastSyncedAt = new Date();
+  this.syncStatus = "synced";
+
+  return this.save();
+};
+
+const ZohoItem = mongoose.model("ZohoItem", ZohoItemSchema);
+
+module.exports = ZohoItem;