Refactor invoice handling:

- Updated `getAllInvoices` to disable paranoid mode for fetching all invoices.
- Enhanced `deleteInvoice` to prevent modification of already synced invoices and set status to archived before deletion.
- Created migration to remove unique constraint from `reference_number` in invoices.
- Added validation hooks in the Invoice model to ensure unique reference numbers for non-archived invoices.

src/controllers/invoice/invoice.controller.ts

@@ -317,9 +317,10 @@ export const getAllInvoices = async (req: AuthenticatedRequest, res: Response):
         },
         {
           model: InvoiceDetail,
-          as: 'InvoiceDetails',
-        }
-      ]
+          as: "InvoiceDetails",
+        },
+      ],
+      paranoid: false,
     });
 
     if (roleData?.name === "Property Manager") {
@@ -664,6 +665,16 @@ export const deleteInvoice = async (req: Request, res: Response): Promise<Respon
       return res.status(404).json({ error: "Invoice not found" });
     }
 
+    if (invoice.status === "sync success") {
+      return res
+        .status(400)
+        .json({ error: "Invoice has already been synced and cannot be modified" });
+    }
+
+    invoice.status = "archived";
+
+    await invoice.save();
+
     await invoice.destroy();
 
     return res.status(204).send();

src/db/migrations/20250123074217-remove-unique-constraint-from-invoice-reference-number.js

@@ -0,0 +1,32 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    /**
+     * Add altering commands here.
+     *
+     * Example:
+     * await queryInterface.createTable('users', { id: Sequelize.INTEGER });
+     */
+
+    await queryInterface.changeColumn("invoices", "reference_number", {
+      type: Sequelize.STRING(100),
+      unique: false,
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    /**
+     * Add reverting commands here.
+     *
+     * Example:
+     * await queryInterface.dropTable('users');
+     */
+
+    await queryInterface.changeColumn("invoices", "reference_number", {
+      type: Sequelize.STRING(100),
+      unique: true,
+    });
+  },
+};

src/models/invoice.ts

@@ -2,11 +2,14 @@ import {
   DataTypes,
   Model,
   CreationOptional,
-} from 'sequelize';
-import { sequelize } from './index';
-import { InvoiceInterface } from '../shared/interfaces/invoice.interface';
-import User from './users';
-import InvoiceDetail from './invoicedetail';
+  ValidationErrorItem,
+  Op,
+  ValidationError,
+} from "sequelize";
+import { sequelize } from "./index";
+import { InvoiceInterface } from "../shared/interfaces/invoice.interface";
+import User from "./users";
+import InvoiceDetail from "./invoicedetail";
 
 class Invoice extends Model<InvoiceInterface> implements InvoiceInterface {
   declare id?: number;
@@ -15,12 +18,12 @@ class Invoice extends Model<InvoiceInterface> implements InvoiceInterface {
   declare vendor_name: string;
   declare invoice_date: Date;
   declare total: number;
-  declare amount_paid: number; 
+  declare amount_paid: number;
   declare due_date?: Date;
   declare term?: string;
   declare description?: string;
   declare payment_status?: string;
-  declare pw_work_order_id?: number; 
+  declare pw_work_order_id?: number;
   declare pw_vendor_id?: number;
   declare filename?: string;
   declare pdf_url?: string;
@@ -38,7 +41,6 @@ Invoice.init(
     },
     reference_number: {
       type: DataTypes.STRING(100),
-      unique: true,
     },
     invoice_number: {
       type: DataTypes.STRING(100),
@@ -52,7 +54,7 @@ Invoice.init(
     total: {
       type: DataTypes.DECIMAL(10, 2),
     },
-    amount_paid: { 
+    amount_paid: {
       type: DataTypes.DECIMAL(10, 2),
     },
     due_date: {
@@ -69,17 +71,17 @@ Invoice.init(
     },
     payment_status: {
       type: DataTypes.STRING(50),
-      defaultValue: 'pending',
+      defaultValue: "pending",
     },
     pw_work_order_id: {
       type: DataTypes.INTEGER,
       allowNull: true,
-    }, 
+    },
     pw_vendor_id: {
       type: DataTypes.INTEGER,
       allowNull: true,
     },
-    filename:{
+    filename: {
       type: DataTypes.STRING(255),
       allowNull: false,
     },
@@ -91,26 +93,60 @@ Invoice.init(
       type: DataTypes.STRING(50),
       allowNull: false,
     },
-    uploaded_by: { 
+    uploaded_by: {
       type: DataTypes.INTEGER,
       allowNull: false,
     },
   },
   {
     sequelize,
-    tableName: 'invoices',
+    tableName: "invoices",
     underscored: true,
     freezeTableName: true,
     timestamps: true,
-    createdAt: 'created_at',
-    updatedAt: 'updated_at',
+    createdAt: "created_at",
+    updatedAt: "updated_at",
     paranoid: true,
-    deletedAt: 'deleted_at',
+    deletedAt: "deleted_at",
   }
 );
 
-Invoice.belongsTo(User, { foreignKey: 'uploaded_by',  as: 'uploadedBy'  });
-Invoice.hasMany(InvoiceDetail, { foreignKey: 'invoice_id' });
+Invoice.belongsTo(User, { foreignKey: "uploaded_by", as: "uploadedBy" });
+Invoice.hasMany(InvoiceDetail, { foreignKey: "invoice_id" });
+
+const validateInvoice = async (invoice: Invoice) => {
+  const existingInvoice = await Invoice.findOne({
+    where: {
+      reference_number: invoice.reference_number,
+      status: { [Op.ne]: "archived" },
+      id: { [Op.ne]: invoice.id },
+    },
+  });
+
+  const validationErrorItems: ValidationErrorItem[] = [];
+
+  if (existingInvoice) {
+    validationErrorItems.push(
+      new ValidationErrorItem(
+        "Invoice with the same reference number already exists; archive it before adding another.",
+        "unique violation",
+        "reference_number",
+        invoice.reference_number,
+        invoice,
+        "isUnique",
+        "reference_number",
+        []
+      )
+    );
+  }
+
+  if (validationErrorItems.length > 0) {
+    throw new ValidationError("Validation Error", validationErrorItems);
+  }
+};
 
+Invoice.addHook("beforeCreate", validateInvoice);
+Invoice.addHook("beforeUpdate", validateInvoice);
+Invoice.addHook("beforeSave", validateInvoice);
 
 export default Invoice;