@tomei/finance 0.6.39 → 0.6.40

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

@@ -3,7 +3,7 @@
 module.exports = {
   async up(queryInterface, Sequelize) {
     await queryInterface.createTable('finance_LedgerTransaction', {
-      TransactionId: {
+      LedgerNo: {
         type: Sequelize.STRING(30),
         primaryKey: true,
         allowNull: false,
@@ -12,6 +12,10 @@ module.exports = {
         type: Sequelize.STRING(20),
         allowNull: false,
       },
+      JournalBatchNo: {
+        type: Sequelize.STRING(30),
+        allowNull: true,
+      },
       JournalEntryId: {
         type: Sequelize.STRING(30),
         allowNull: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.6.39",
+  "version": "0.6.40",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -79,4 +79,4 @@
       "git add ."
     ]
   }
-}
+}

package/src/account/account.ts

@@ -21,6 +21,7 @@ export default class Account extends AccountSystemEntity {
   CreatedAt: Date;
   UpdatedById = '';
   UpdatedAt: Date;
+  protected _ObjectType = 'Account';
 
   private static _RepositoryBase = new AccountRepository();
 
@@ -35,6 +36,10 @@ export default class Account extends AccountSystemEntity {
     this._IsNewRecord = record;
   }
 
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
   /* AccountSystemEntity Implementation */
   get RepositoryBase() {
     return Account._RepositoryBase;

package/src/account-system-entity/account-system-entity.ts

@@ -11,6 +11,7 @@ export abstract class AccountSystemEntity extends ObjectBase {
   AccSystemRefId = '';
   PostedById = '';
   PostedDateTime: Date;
+  protected abstract _ObjectType: string;
   protected abstract RepositoryBase: IRepositoryBase<any>;
   private static PostHistoryRepository = new PostHistoryRepository();
 

package/src/customer/customer.ts

@@ -28,6 +28,7 @@ export default abstract class FinanceCustomerBase
   protected abstract ParentAPAccountNo: string;
   protected abstract ARAccountNo: string;
   protected abstract APAccountNo: string;
+  protected abstract _ObjectType: string;
 
   abstract FullName: string;
   abstract IDNo: string;

package/src/document/document-item.ts

@@ -25,6 +25,10 @@ export default class DocumentItem extends ObjectBase {
   TaxInclusiveYN = 'N';
   DtAccountNo = '';
   CtAccountNo = '';
+  private _ObjectType = 'DocumentItem';
+  get ObjectType() {
+    return this._ObjectType;
+  }
 
   private static _RepositoryBase = new DocumentItemRepository();
 

package/src/document/document.ts

@@ -2,7 +2,6 @@ import * as util from 'util';
 import * as path from 'path';
 import * as fs from 'fs';
 import * as puppeteer from 'puppeteer';
-import { RecordNotFoundError } from '@tomei/general/dist/class/exceptions/record-not-found.error';
 import {
   Medias,
   InternalMediaDto,
@@ -44,6 +43,11 @@ export default class Document extends AccountSystemEntity {
   UpdatedById = '';
   UpdatedAt: Date;
   UseAccSystemDocYN = 'N';
+  protected _ObjectType = 'Document';
+
+  get ObjectType() {
+    return this._ObjectType;
+  }
 
   private _DocHTMLFileMediaId = '';
   private _DocPDFFileMediaId = '';

package/src/finance-company/finance-company.ts

@@ -40,11 +40,6 @@ import { ApplicationConfig } from '@tomei/config';
 import { TaxRepository } from '../tax/tax.repository';
 import { Tax } from '../tax/tax';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const getConfig = require('../config');
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const config = getConfig();
-
 export default class FinanceCompany extends ObjectBase {
   private _CompanyId = 'New';
   private _CompSystemCode = '';
@@ -374,7 +369,6 @@ export default class FinanceCompany extends ObjectBase {
       );
 
       for (const ledgerTransaction of debitTransactions) {
-        ledgerTransaction.TransactionId = cuid();
         ledgerTransaction.JournalEntryId = newJournalEntry.JournalEntryId;
 
         await ledgerTransaction.save(dbTransaction);
@@ -386,7 +380,6 @@ export default class FinanceCompany extends ObjectBase {
       }
 
       for (const ledgerTransaction of creditTransactions) {
-        ledgerTransaction.TransactionId = cuid();
         ledgerTransaction.JournalEntryId = newJournalEntry.JournalEntryId;
 
         await ledgerTransaction.save(dbTransaction);
@@ -1113,13 +1106,13 @@ export default class FinanceCompany extends ObjectBase {
       const payload = {
         Action: 'Create',
         Activity: 'Issuing a Credit Note Transaction',
-        Description: `Credit Transaction (ID: ${creditTransaction.TransactionId}) has been created`,
+        Description: `Credit Transaction (ID: ${creditTransaction.LedgerNo}) has been created`,
         EntityType: 'CreditTransaction',
         EntityValueBefore: JSON.stringify({}),
         EntityValueAfter: JSON.stringify(creditTransaction),
         PerformedById: loginUser.ObjectId,
         PerformedAt: transactionDate,
-        EntityId: creditTransaction.TransactionId,
+        EntityId: creditTransaction.LedgerNo,
       };
 
       await axios.post(
@@ -1348,7 +1341,7 @@ export default class FinanceCompany extends ObjectBase {
             Currency: paymentPaidWithItem.Currency,
             Amount: paymentPaidWithItem.Amount,
             Status: paymentPaidWithItem.Status,
-            TransactionId: paymentPaidWithItem.TransactionId,
+            LedgerNo: paymentPaidWithItem.LedgerNo,
             RefBank: paymentPaidWithItem.RefBank,
             RefName: paymentPaidWithItem.RefName,
             RefNo: paymentPaidWithItem.RefNo,
@@ -1523,7 +1516,7 @@ export default class FinanceCompany extends ObjectBase {
             Currency: paymentPaidWithItem.Currency,
             Amount: paymentPaidWithItem.Amount,
             Status: paymentPaidWithItem.Status,
-            TransactionId: paymentPaidWithItem.TransactionId,
+            LedgerNo: paymentPaidWithItem.LedgerNo,
             RefBank: paymentPaidWithItem.RefBank,
             RefName: paymentPaidWithItem.RefName,
             RefNo: paymentPaidWithItem.RefNo,
@@ -1664,7 +1657,7 @@ export default class FinanceCompany extends ObjectBase {
             transaction: this._DbTransaction,
           })
           .then((taxes) => {
-            let taxList = [];
+            const taxList = [];
             taxes.forEach((tax) => {
               taxList.push(
                 new Tax({
@@ -1993,7 +1986,7 @@ export default class FinanceCompany extends ObjectBase {
             Currency: paymentPaidWithItem.Currency,
             Amount: paymentPaidWithItem.Amount,
             Status: paymentPaidWithItem.Status,
-            TransactionId: paymentPaidWithItem.TransactionId,
+            LedgerNo: paymentPaidWithItem.LedgerNo,
             RefBank: paymentPaidWithItem.RefBank,
             RefName: paymentPaidWithItem.RefName,
             RefNo: paymentPaidWithItem.RefNo,

package/src/helpers/typeof.ts

@@ -2,12 +2,18 @@ export function type(value: any): string {
   if (value === null) {
     return 'null';
   }
+
   const baseType = typeof value;
 
   if (!['object', 'function'].includes(baseType)) {
     return baseType;
   }
 
+  // if value is object and have propery ObjectType: string return ObjectType instead.
+  if (baseType === 'object' && value.ObjectType) {
+    return value.ObjectType;
+  }
+
   const tag = value[Symbol.toStringTag];
   if (typeof tag === 'string') {
     return tag;

package/src/journal-entry/journal-entry.ts

@@ -13,6 +13,7 @@ export default class JournalEntry extends AccountSystemEntity {
   Date = new Date();
   Name = '';
   Description = '';
+  protected _ObjectType: 'JournalEntry';
 
   private static _RepositoryBase = new JournalEntryRepository();
   private static _LedgerTransactionRepository =
@@ -30,6 +31,10 @@ export default class JournalEntry extends AccountSystemEntity {
     this._JournalEntryId = id;
   }
 
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
   get RepositoryBase() {
     return JournalEntry._RepositoryBase;
   }
@@ -109,7 +114,7 @@ export default class JournalEntry extends AccountSystemEntity {
               (debitTransactionData) =>
                 new LedgerTransaction(
                   this._DbTransaction,
-                  debitTransactionData.TransactionId,
+                  debitTransactionData.LedgerNo,
                 ),
             );
             return Promise.all(debitTransactionObjects);
@@ -142,7 +147,7 @@ export default class JournalEntry extends AccountSystemEntity {
               (creditTransactionData) =>
                 new LedgerTransaction(
                   this._DbTransaction,
-                  creditTransactionData.TransactionId,
+                  creditTransactionData.LedgerNo,
                 ),
             );
             return Promise.all(creditTransactionObjects);

package/src/ledger-transaction/interfaces/ledger-transaction-attr.interface.ts

@@ -1,7 +1,7 @@
 import { TransactionTypeOptions } from '../../enum';
 
 export interface ILedgerTransactionAttr {
-  TransactionId?: string;
+  LedgerNo?: string;
   TransactionType?: TransactionTypeOptions;
   JournalEntryId?: string;
   AccountNo?: string;

package/src/ledger-transaction/ledger-transaction.repository.ts

@@ -8,4 +8,10 @@ export class LedgerTransactionRepository
   constructor() {
     super(LedgerTransactionModel);
   }
+
+  async count(dbTransaction?: any) {
+    return await LedgerTransactionModel.count({
+      transaction: dbTransaction,
+    });
+  }
 }

package/src/ledger-transaction/ledger-transaction.ts

@@ -5,7 +5,7 @@ import { LedgerTransactionRepository } from './ledger-transaction.repository';
 import LedgerTransactionModel from '../models/ledger-transaction.entity';
 
 export default class LedgerTransaction {
-  TransactionId = 'New';
+  LedgerNo = 'New';
   TransactionType = TransactionTypeOptions.DEBIT;
   JournalEntryId = '';
   AccountNo = '';
@@ -19,28 +19,33 @@ export default class LedgerTransaction {
   RelatedObjectType = '';
   RelatedDocNo = '';
   RelatedPaymentId = '';
+  private _ObjectType: 'LedgerTransaction';
 
   private _DbTransaction: any;
 
   private static _LedgerTransactionRepository =
     new LedgerTransactionRepository();
 
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
   constructor(
     transactionType: TransactionTypeOptions,
     dbTransaction?: any,
-    transactionId?: string,
+    LedgerNo?: string,
   ) {
     this.TransactionType = transactionType;
     if (dbTransaction) {
       this._DbTransaction = dbTransaction;
     }
-    if (transactionId) {
-      this.TransactionId = transactionId;
+    if (LedgerNo) {
+      this.LedgerNo = LedgerNo;
     }
   }
 
   init(params?: ILedgerTransactionAttr) {
-    if (params.TransactionId) this.TransactionId = params.TransactionId;
+    if (params.LedgerNo) this.LedgerNo = params.LedgerNo;
     if (params.TransactionType) this.TransactionType = params.TransactionType;
     if (params.JournalEntryId) this.JournalEntryId = params.JournalEntryId;
     if (params.AccountNo) this.AccountNo = params.AccountNo;
@@ -57,7 +62,7 @@ export default class LedgerTransaction {
 
   getData() {
     return {
-      TransactionId: this.TransactionId,
+      LedgerNo: this.LedgerNo,
       TransactionType: this.TransactionType,
       JournalEntryId: this.JournalEntryId,
       AccountNo: this.AccountNo,
@@ -76,11 +81,14 @@ export default class LedgerTransaction {
 
   async save(dbTransaction?: any): Promise<LedgerTransactionModel> {
     try {
-      this.TransactionId = cuid();
+      const count = await LedgerTransaction._LedgerTransactionRepository.count(
+        dbTransaction,
+      );
+      this.LedgerNo = `${count + 1}`;
 
       return await LedgerTransaction._LedgerTransactionRepository.create(
         {
-          TransactionId: this.TransactionId,
+          LedgerNo: this.LedgerNo,
           TransactionType: this.TransactionType,
           JournalEntryId: this.JournalEntryId,
           AccountNo: this.AccountNo,
@@ -135,7 +143,7 @@ export default class LedgerTransaction {
     journalEntryId?: string,
   ): Promise<any> {
     this.init({
-      TransactionId: cuid(),
+      LedgerNo: cuid(),
       TransactionType: transactionType,
       JournalEntryId: journalEntryId,
       // Name: journalEntry.Name,

package/src/models/ledger-transaction.entity.ts

@@ -17,13 +17,13 @@ import PaymentModel from './payment.entity';
   timestamps: false,
 })
 export default class LedgerTransactionModel extends Model {
-  @ApiProperty({ type: String, description: 'Transactionid' })
+  @ApiProperty({ type: String, description: 'LedgerNo' })
   @Column({
     primaryKey: true,
     allowNull: false,
     type: DataType.STRING(30),
   })
-  TransactionId: string;
+  LedgerNo: string;
 
   @ApiProperty({
     type: String,

package/src/models/payment-paid-with.entity.ts

@@ -63,7 +63,7 @@ export default class PaymentPaidWithModel extends Model {
     allowNull: true,
     type: DataType.STRING(100),
   })
-  TransactionId: string;
+  LedgerNo: string;
 
   @Column({
     allowNull: true,

package/src/payment/payment.ts

@@ -20,7 +20,7 @@ export default class Payment extends AccountSystemEntity {
   Currency = 'MYR';
   Amount = 0;
   Status: PaymentStatus;
-  TransactionId: string;
+  LedgerNo: string;
   TransactionApprovalCode: string;
   TransactionAccountName: string;
   TransactionAccountNo: string;
@@ -32,6 +32,7 @@ export default class Payment extends AccountSystemEntity {
   RelatedObjectId = '';
   RelatedObjectType = '';
   ReceiptDocNo = '';
+  _ObjectType: 'Payment';
 
   private static _RepositoryBase = new PaymentRepository();
   private static _PaymentItemRepository = new PaymentItemRepository();
@@ -47,6 +48,10 @@ export default class Payment extends AccountSystemEntity {
     return this._PaymentId;
   }
 
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
   public set PaymentId(id: string) {
     this._PaymentId = id;
   }
@@ -181,7 +186,7 @@ export default class Payment extends AccountSystemEntity {
             ppw.Currency = paymentPaidWithItem.Currency;
             ppw.Amount = paymentPaidWithItem.Amount;
             ppw.Status = paymentPaidWithItem.Status;
-            ppw.TransactionId = paymentPaidWithItem.TransactionId;
+            ppw.LedgerNo = paymentPaidWithItem.LedgerNo;
             ppw.RefBank = paymentPaidWithItem.RefBank;
             ppw.RefName = paymentPaidWithItem.RefName;
             ppw.RefNo = paymentPaidWithItem.RefNo;

package/src/payment-item/payment-item.ts

@@ -14,6 +14,7 @@ export default class PaymentItem extends ObjectBase {
   Name = '';
   Description = '';
   Remarks = '';
+  private _ObjectType = 'PaymentItem';
 
   get PaymentId() {
     return this._PaymentId;
@@ -23,6 +24,10 @@ export default class PaymentItem extends ObjectBase {
     this._PaymentId = id;
   }
 
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
   get PayForObjectId() {
     return this._PayForObjectId;
   }

package/src/payment-method/payment-method.ts

@@ -9,6 +9,11 @@ export default class PaymentMethod extends ObjectBase {
   MethodId = 'New';
   Name = '';
   CompanyId = '';
+  private _ObjectType = 'PaymentMethod';
+
+  get ObjectType() {
+    return this._ObjectType;
+  }
 
   private static _RepositoryBase = new PaymentMethodRepository();
   private static _PaymentMethodTypeRepository =

package/src/payment-method-type/payment-method-type.ts

@@ -9,6 +9,11 @@ export default class PaymentMethodType extends ObjectBase {
   AccountNo = '';
   ProcessingFeeRate = 0.0;
   ProcessingFeeAccountNo = '';
+  private _ObjectType = 'PaymentMethodType';
+
+  get ObjectType() {
+    return this._ObjectType;
+  }
 
   private _DbTransaction: any;
 

package/src/payment-paid-with/interfaces/payment-paid-with.interface.ts

@@ -6,7 +6,7 @@ export class IPaymentPaidWithAttr {
   Currency: string;
   Amount: number;
   Status: PaymentStatus;
-  TransactionId?: string;
+  LedgerNo?: string;
   RefBank?: string;
   RefName?: string;
   RefNo?: string;

package/src/payment-paid-with/payment-paid-with.ts

@@ -9,7 +9,7 @@ export default class PaymentPaidWith extends ObjectBase {
   Currency = 'MYR';
   Amount = 0;
   Status: PaymentStatus;
-  TransactionId = '';
+  LedgerNo = '';
   RefBank = '';
   RefName = '';
   RefNo = '';

package/src/tax/tax.ts

@@ -1,57 +1,61 @@
-import { ITaxAttr } from './interfaces/tax-attr.interface';
-
-export class Tax {
-  private _TaxCode = 'New';
-  private _Description: string;
-  private _CompanyId: string;
-  private _TaxRate = 0;
-  private _CreatedById: string;
-  private _CreatedAt: Date;
-  private _UpdatedById: string;
-  private _UpdatedAt: Date;
-
-  constructor(taxAttr?: ITaxAttr) {
-    if (taxAttr) {
-      this._TaxCode = taxAttr.TaxCode;
-      this._Description = taxAttr.Description;
-      this._CompanyId = taxAttr.CompanyId;
-      this._TaxRate = taxAttr.TaxRate;
-      this._CreatedById = taxAttr.CreatedById;
-      this._CreatedAt = taxAttr.CreatedAt;
-      this._UpdatedById = taxAttr.UpdatedById;
-      this._UpdatedAt = taxAttr.UpdatedAt;
-    }
-  }
-
-  get TaxCode(): string {
-    return this._TaxCode;
-  }
-
-  get Description(): string {
-    return this._Description;
-  }
-
-  get CompanyId(): string {
-    return this._CompanyId;
-  }
-
-  get TaxRate(): number {
-    return this._TaxRate;
-  }
-
-  get CreatedById(): string {
-    return this._CreatedById;
-  }
-
-  get CreatedAt(): Date {
-    return this._CreatedAt;
-  }
-
-  get UpdatedById(): string {
-    return this._UpdatedById;
-  }
-
-  get UpdatedAt(): Date {
-    return this._UpdatedAt;
-  }
-}
+import { ITaxAttr } from './interfaces/tax-attr.interface';
+
+export class Tax {
+  private _TaxCode = 'New';
+  private _Description: string;
+  private _CompanyId: string;
+  private _TaxRate = 0;
+  private _CreatedById: string;
+  private _CreatedAt: Date;
+  private _UpdatedById: string;
+  private _UpdatedAt: Date;
+  private _ObjectType = 'Tax';
+  get ObjectType() {
+    return this._ObjectType;
+  }
+
+  constructor(taxAttr?: ITaxAttr) {
+    if (taxAttr) {
+      this._TaxCode = taxAttr.TaxCode;
+      this._Description = taxAttr.Description;
+      this._CompanyId = taxAttr.CompanyId;
+      this._TaxRate = taxAttr.TaxRate;
+      this._CreatedById = taxAttr.CreatedById;
+      this._CreatedAt = taxAttr.CreatedAt;
+      this._UpdatedById = taxAttr.UpdatedById;
+      this._UpdatedAt = taxAttr.UpdatedAt;
+    }
+  }
+
+  get TaxCode(): string {
+    return this._TaxCode;
+  }
+
+  get Description(): string {
+    return this._Description;
+  }
+
+  get CompanyId(): string {
+    return this._CompanyId;
+  }
+
+  get TaxRate(): number {
+    return this._TaxRate;
+  }
+
+  get CreatedById(): string {
+    return this._CreatedById;
+  }
+
+  get CreatedAt(): Date {
+    return this._CreatedAt;
+  }
+
+  get UpdatedById(): string {
+    return this._UpdatedById;
+  }
+
+  get UpdatedAt(): Date {
+    return this._UpdatedAt;
+  }
+}