@tomei/finance 0.1.13 → 0.2.1

package/migrations/finance-journal-entry-migration.js

@@ -0,0 +1,41 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_JournalEntry', {
+      JournalEntryId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      Date: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+      Name: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      Description: {
+        type: Sequelize.STRING(1000),
+        allowNull: true,
+      },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      PostedToAccSystemYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: false,
+      },
+      DatePostedToAccSystem: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_JournalEntry');
+  },
+};

package/migrations/finance-ledger-transaction-migration.js

@@ -0,0 +1,73 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_LedgerTransaction', {
+      TransactionId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      TransactionType: {
+        type: Sequelize.STRING(20),
+        allowNull: false,
+      },
+      JournalEntryId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+        references: {
+          model: 'finance_JournalEntry',
+          key: 'JournalEntryId',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
+      AccountNo: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+        references: {
+          model: 'finance_Account',
+          key: 'AccountNo',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
+      Date: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      Name: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      Description: {
+        type: Sequelize.STRING(1000),
+        allowNull: true,
+      },
+      Currency: {
+        type: Sequelize.CHAR(3),
+        allowNull: false,
+      },
+      DebitAmount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+      },
+      CreditAmount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+      },
+      RelatedObjectId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      RelatedObjectType: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_LedgerTransaction');
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.1.13",
+  "version": "0.2.1",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -34,7 +34,7 @@
     "@nestjs/core": "^9.0.8",
     "@nestjs/platform-express": "^9.0.8",
     "@nestjs/sequelize": "^9.0.0",
-    "@tomei/general": "^0.0.11",
+    "@tomei/general": "^0.0.13",
     "axios": "^1.1.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",

package/src/account/account.ts

@@ -1,189 +1,189 @@
-import { ICreateAccountAttr } from './interfaces/account-attr.interface';
-import { IAccountRepository } from './interfaces/account.repository.interface';
-import * as uniqid from 'uniqid';
-import { AccountModel } from './entities/account.entity';
-import axios from 'axios';
-import { getConfig } from '../config';
-import { IAccountSystem } from 'src/interfaces';
-import { ObjectBase, PersonBase } from '@tomei/general';
-export class Account {
-  accountRepository: IAccountRepository;
-
-  private AccountNo: string;
-  private OwnerId: string;
-  private OwnerType: string;
-  private RelatedObjectId: string;
-  private RelatedObjectType: string;
-  private AccSystemId: string;
-
-  ParentAccountNo: string;
-  Owner: PersonBase;
-  RelatedObject: ObjectBase;
-  AccountType: string;
-  AccountSubType: string;
-  AccountingSystem: IAccountSystem;
-
-  isParamsInitialized: boolean;
-
-  constructor(
-    accountRepository: IAccountRepository,
-    accountingSystem: IAccountSystem,
-    SystemCode: string,
-    params?: ICreateAccountAttr,
-  ) {
-    this.accountRepository = accountRepository;
-    this.AccountingSystem = accountingSystem;
-    this.AccSystemId = getConfig().systemConfig[SystemCode].accountingSystem;
-    if (params) {
-      this.init(params);
-    }
-  }
-
-  init(params: ICreateAccountAttr) {
-    this.Owner = params.Owner;
-    this.OwnerId = params.Owner.ObjectId;
-    this.OwnerType = typeof params.Owner;
-
-    if (params.RelatedObject) {
-      this.RelatedObject = params.RelatedObject;
-      this.RelatedObjectId = params.RelatedObject.ObjectId;
-      this.RelatedObjectType = typeof params.RelatedObject;
-    }
-    if (params.AccountType) this.AccountType = params.AccountType;
-    if (params.AccountSubType) this.AccountSubType = params.AccountSubType;
-    if (params.ParentAccountNo) this.ParentAccountNo = params.ParentAccountNo;
-
-    if (
-      this.Owner &&
-      this.RelatedObject &&
-      this.AccountType &&
-      this.AccountSubType
-    ) {
-      this.isParamsInitialized = true;
-    }
-  }
-
-  /**
-   * This method will return finance_Account.AccountNo
-   * @returns {Promise<string>} AccountNo
-   */
-  async getAccountNo(): Promise<string> {
-    if (this.AccountNo) {
-      return this.AccountNo;
-    } else {
-      try {
-        const account = await this.accountRepository.findOne({
-          OwnerId: this.OwnerId,
-          AccSystemId: this.AccSystemId,
-        });
-
-        if (account) {
-          this.AccountNo = account.AccountNo;
-          return this.AccountNo;
-        } else {
-          throw new Error('Account need to be created first.');
-        }
-      } catch (error) {
-        throw error;
-      }
-    }
-  }
-
-  /**
-   * This method will return finance_Account.AccountNo
-   * @returns {Promise<string>} AccountNo
-   */
-  async create() {
-    try {
-      if (!this.Owner || !this.RelatedObject) {
-        throw new Error(
-          'Owner must be set before creating an account." or "RelatedObject must be set before creating an account.',
-        );
-      }
-
-      if (!this.isParamsInitialized) {
-        throw new Error(
-          'Account parameters must be initialized before creating an account.',
-        );
-      }
-
-      const ownerData = this.Owner.getDetails();
-      if (!ownerData) {
-        throw new Error(
-          'Please save owner information in the database before creating an account',
-        );
-      }
-
-      let isFull = true;
-      for (const key in ownerData) {
-        if (ownerData.hasOwnProperty(key)) {
-          if (!ownerData[key]) {
-            isFull = false;
-            break;
-          }
-        }
-      }
-
-      if (!isFull) {
-        throw new Error(
-          'Please save owner information in the database before creating an account',
-        );
-      }
-
-      let createAccountPayload: any = {
-        Name: this.Owner.FullName,
-        AcctNum: uniqid(),
-        AccountType: this.AccountType,
-        AccountSubType: this.AccountSubType,
-      };
-
-      if (this.ParentAccountNo) {
-        createAccountPayload = {
-          ...createAccountPayload,
-          CurrencyRef: 'MYR',
-          ParentRef: this.ParentAccountNo,
-          SubAccount: true,
-        };
-      }
-
-      const accountId = await this.AccountingSystem.createAccount(
-        createAccountPayload,
-      );
-
-      const account = await this.accountRepository.create({
-        AccountNo: accountId,
-        SystemCode: this.AccSystemId,
-        Name: this.Owner.FullName,
-        OwnerId: this.OwnerId,
-        OwnerType: this.OwnerType,
-        RelatedObjectId: this.RelatedObjectId,
-        RelatedObjectType: this.RelatedObjectType,
-        CreatedAt: new Date(),
-        CreatedById: 'System',
-        UpdatedAt: new Date(),
-        UpdatedById: 'System',
-      });
-
-      const payload = {
-        Action: 'Create',
-        Activity: 'Account Created',
-        Description: `Account (ID: ${account.AccountNo}) has been created`,
-        EntityType: typeof AccountModel,
-        EntityValueBefore: JSON.stringify({}),
-        EntityValueAfter: JSON.stringify(account),
-        PerformedById: account.CreatedById,
-        PerformedAt: new Date(),
-        EntityId: account.AccountNo,
-      };
-
-      await axios.post(
-        `${process.env.COMMON_API_URL}/activity-histories`,
-        payload,
-      );
-
-      return account;
-    } catch (error) {
-      throw error;
-    }
-  }
-}
+import { ICreateAccountAttr } from './interfaces/account-attr.interface';
+import { IAccountRepository } from './interfaces/account.repository.interface';
+import * as uniqid from 'uniqid';
+import { AccountModel } from './entities/account.entity';
+import axios from 'axios';
+import { getConfig } from '../config';
+import { IAccountSystem } from 'src/interfaces';
+import { ObjectBase, PersonBase } from '@tomei/general';
+export class Account {
+  accountRepository: IAccountRepository;
+
+  private AccountNo: string;
+  private OwnerId: string;
+  private OwnerType: string;
+  private RelatedObjectId: string;
+  private RelatedObjectType: string;
+  private AccSystemId: string;
+
+  ParentAccountNo: string;
+  Owner: PersonBase;
+  RelatedObject: ObjectBase;
+  AccountType: string;
+  AccountSubType: string;
+  AccountingSystem: IAccountSystem;
+
+  isParamsInitialized: boolean;
+
+  constructor(
+    accountRepository: IAccountRepository,
+    accountingSystem: IAccountSystem,
+    SystemCode: string,
+    params?: ICreateAccountAttr,
+  ) {
+    this.accountRepository = accountRepository;
+    this.AccountingSystem = accountingSystem;
+    this.AccSystemId = getConfig().systemConfig[SystemCode].accountingSystem;
+    if (params) {
+      this.init(params);
+    }
+  }
+
+  init(params: ICreateAccountAttr) {
+    this.Owner = params.Owner;
+    this.OwnerId = params.Owner.ObjectId;
+    this.OwnerType = typeof params.Owner;
+
+    if (params.RelatedObject) {
+      this.RelatedObject = params.RelatedObject;
+      this.RelatedObjectId = params.RelatedObject.ObjectId;
+      this.RelatedObjectType = typeof params.RelatedObject;
+    }
+    if (params.AccountType) this.AccountType = params.AccountType;
+    if (params.AccountSubType) this.AccountSubType = params.AccountSubType;
+    if (params.ParentAccountNo) this.ParentAccountNo = params.ParentAccountNo;
+
+    if (
+      this.Owner &&
+      this.RelatedObject &&
+      this.AccountType &&
+      this.AccountSubType
+    ) {
+      this.isParamsInitialized = true;
+    }
+  }
+
+  /**
+   * This method will return finance_Account.AccountNo
+   * @returns {Promise<string>} AccountNo
+   */
+  async getAccountNo(): Promise<string> {
+    if (this.AccountNo) {
+      return this.AccountNo;
+    } else {
+      try {
+        const account = await this.accountRepository.findOne({
+          OwnerId: this.OwnerId,
+          AccSystemId: this.AccSystemId,
+        });
+
+        if (account) {
+          this.AccountNo = account.AccountNo;
+          return this.AccountNo;
+        } else {
+          throw new Error('Account need to be created first.');
+        }
+      } catch (error) {
+        throw error;
+      }
+    }
+  }
+
+  /**
+   * This method will return finance_Account.AccountNo
+   * @returns {Promise<string>} AccountNo
+   */
+  async create() {
+    try {
+      if (!this.Owner || !this.RelatedObject) {
+        throw new Error(
+          'Owner must be set before creating an account." or "RelatedObject must be set before creating an account.',
+        );
+      }
+
+      if (!this.isParamsInitialized) {
+        throw new Error(
+          'Account parameters must be initialized before creating an account.',
+        );
+      }
+
+      const ownerData = this.Owner.getDetails();
+      if (!ownerData) {
+        throw new Error(
+          'Please save owner information in the database before creating an account',
+        );
+      }
+
+      let isFull = true;
+      for (const key in ownerData) {
+        if (ownerData.hasOwnProperty(key)) {
+          if (!ownerData[key]) {
+            isFull = false;
+            break;
+          }
+        }
+      }
+
+      if (!isFull) {
+        throw new Error(
+          'Please save owner information in the database before creating an account',
+        );
+      }
+
+      let createAccountPayload: any = {
+        Name: this.Owner.FullName,
+        AcctNum: uniqid(),
+        AccountType: this.AccountType,
+        AccountSubType: this.AccountSubType,
+      };
+
+      if (this.ParentAccountNo) {
+        createAccountPayload = {
+          ...createAccountPayload,
+          CurrencyRef: 'MYR',
+          ParentRef: this.ParentAccountNo,
+          SubAccount: true,
+        };
+      }
+
+      const accountId = await this.AccountingSystem.createAccount(
+        createAccountPayload,
+      );
+
+      const account = await this.accountRepository.create({
+        AccountNo: accountId,
+        SystemCode: this.AccSystemId,
+        Name: this.Owner.FullName,
+        OwnerId: this.OwnerId,
+        OwnerType: this.OwnerType,
+        RelatedObjectId: this.RelatedObjectId,
+        RelatedObjectType: this.RelatedObjectType,
+        CreatedAt: new Date(),
+        CreatedById: 'System',
+        UpdatedAt: new Date(),
+        UpdatedById: 'System',
+      });
+
+      const payload = {
+        Action: 'Create',
+        Activity: 'Account Created',
+        Description: `Account (ID: ${account.AccountNo}) has been created`,
+        EntityType: typeof AccountModel,
+        EntityValueBefore: JSON.stringify({}),
+        EntityValueAfter: JSON.stringify(account),
+        PerformedById: account.CreatedById,
+        PerformedAt: new Date(),
+        EntityId: account.AccountNo,
+      };
+
+      await axios.post(
+        `${process.env.COMMON_API_URL}/activity-histories`,
+        payload,
+      );
+
+      return account;
+    } catch (error) {
+      throw error;
+    }
+  }
+}