@tomei/finance 0.2.5 → 0.2.7

package/migrations/finance-account-migration.js

@@ -20,7 +20,7 @@ module.exports = {
         type: Sequelize.STRING(10),
         allowNull: false,
       },
-      AccSystemAccountId: {
+      AccSystemRefId: {
         type: Sequelize.STRING(10),
         allowNull: false,
       },

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

@@ -28,7 +28,7 @@ module.exports = {
         type: Sequelize.CHAR(1),
         allowNull: false,
       },
-      DatePostedToAccSystem: {
+      PostedDateTime: {
         type: Sequelize.DATE,
         allowNull: true,
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {

package/src/account/account.ts

@@ -2,7 +2,8 @@ import { IAccountRepository } from './interfaces/account.repository.interface';
 import { AccountModel } from './entities/account.entity';
 import { ObjectBase, PersonBase, RecordNotFoundError } from '@tomei/general';
 import { IBaseRepository } from '@tomei/general/dist/interfaces/repository.base.interface';
-export class Account {
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
+export class Account implements IAccountSystemEntity {
   accountRepository: IAccountRepository;
   AccountNo: string;
   Owner: PersonBase;
@@ -14,7 +15,7 @@ export class Account {
   private RelatedObjectId: string;
   private RelatedObjectType: string;
   private ParentAccountNo: string;
-  private AccSystemAccountId: string;
+  AccSystemRefId: string;
 
   SystemCode: string;
   AccSystemCode: string;
@@ -22,6 +23,9 @@ export class Account {
   Description: string;
   AccountType: string;
   AccountSubtype: string;
+  PostedToAccSystemYN: 'N';
+  PostedById: string;
+  PostedDateTime: Date;
 
   CreatedAt: Date;
   CreatedById: string;
@@ -41,7 +45,7 @@ export class Account {
         this.ParentAccountNo = accountData.ParentAccountNo;
         this.SystemCode = accountData.SystemCode;
         this.AccSystemCode = accountData.AccSystemCode;
-        this.AccSystemAccountId = accountData.AccSystemAccountId;
+        this.AccSystemRefId = accountData.AccSystemRefId;
         this.Name = accountData.Name;
         this.Description = accountData.Description;
         this.AccountType = accountData.AccountType;
@@ -83,7 +87,7 @@ export class Account {
     if (!this.AccSystemCode) {
       throw new Error('AccSystemCode is required.');
     }
-    if (!this.AccSystemAccountId) {
+    if (!this.AccSystemRefId) {
       throw new Error('AccSystemAccountId is required.');
     }
     if (!this.AccountType) {
@@ -97,17 +101,17 @@ export class Account {
   }
 
   async save(
-    accSystemAccountId: string,
+    AccSystemRefId: string,
     userId: string,
     dbTransaction?: any,
   ): Promise<AccountModel> {
-    this.AccSystemAccountId = accSystemAccountId;
+    this.AccSystemRefId = AccSystemRefId;
     const data = await this.accountRepository.create(
       {
         AccountNo: this.AccountNo,
         SystemCode: this.SystemCode,
         AccSystemCode: this.AccSystemCode,
-        AccSystemAccountId: this.AccSystemAccountId,
+        AccSystemRefId: this.AccSystemRefId,
         Name: this.Name,
         Description: this.Description,
         AccountType: this.AccountType,
@@ -135,7 +139,7 @@ export class Account {
       try {
         const account = await this.accountRepository.findOne({
           OwnerId: this.OwnerId,
-          AccSystemAccountId: this.AccSystemAccountId,
+          AccSystemRefId: this.AccSystemRefId,
         });
 
         if (account) {

package/src/account/entities/account.entity.ts

@@ -56,7 +56,7 @@ export class AccountModel extends Model {
     allowNull: false,
     type: DataType.STRING(10),
   })
-  AccSystemAccountId: string;
+  AccSystemRefId: string;
 
   @ApiProperty({
     type: String,

package/src/customer/customer.ts

@@ -1,36 +1,50 @@
-import { AddressBase, PersonBase } from '@tomei/general';
-import { IAccountSystem } from '../interfaces';
-import { getConfig } from '../config';
-import * as cuid from 'cuid';
+import { AddressBase, PersonBase, RecordNotFoundError } from '@tomei/general';
+import { FinanceCustomerModel } from './entities/customer.entity';
+import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 
 export abstract class Customer extends PersonBase {
-  ObjectId: string; // Finance_Customer.CustomerId
-  ObjectName: string;
-
-  AccSystemCustomerId: string; //customer id return from accounting system
-  CustomerRefId: string | undefined; //CRM customer CustomerId
-  SystemCode: string;
-  AccSystemCode: string;
-
   FullName: string;
   IDNo: string;
   IDType: string;
-  public Email: string;
   ContactNo: string;
+  Email: string;
   DefaultAddress: AddressBase;
 
-  accountingSystem: IAccountSystem;
+  financeCustomerRepository: IFinanceCustomerRepository;
+
+  CustomerId: string;
+
+  SystemCode: string;
+  AccSystemCode: string;
+  AccSystemCustomerId: string; //customer id return from accounting system
+  CustSystemCode: string;
+  CustSystemRefId: string;
 
   constructor(
-    accountingSystem: IAccountSystem,
     systemCode: string,
-    email: string,
+    accSystemCode: string,
+    custSystemCode: string,
+    custSystemRefId: string,
   ) {
     super();
-    this.accountingSystem = accountingSystem;
-    this.SystemCode = systemCode;
-    this.AccSystemCode = getConfig().systemConfig[systemCode].accountingSystem;
-    this.Email = email;
+    const financeCustomerData = this.financeCustomerRepository.findOne({
+      where: {
+        SystemCode: systemCode,
+        AccSystemCode: accSystemCode,
+        AccSystemCustomerId: custSystemCode,
+        CustomerRefId: custSystemRefId,
+      },
+    });
+    if (financeCustomerData) {
+      this.CustomerId = financeCustomerData.CustomerId;
+      this.AccSystemCode = accSystemCode;
+      this.AccSystemCustomerId = financeCustomerData.AccSystemCustomerId;
+      this.CustSystemCode = custSystemCode;
+      this.CustSystemRefId = custSystemRefId;
+    } else {
+      const notFoundError = new RecordNotFoundError('No Record Found');
+      throw notFoundError;
+    }
   }
 
   /*
@@ -63,33 +77,20 @@ export abstract class Customer extends PersonBase {
     this.DefaultAddress = person.DefaultAddress;
   }
 
-  /**
-   *
-   * @returns {string} - Return Finance CustomerId
-   */
-  getCustomerId(): string {
-    if (!this.ObjectId) {
-      throw new Error('Finance Customer must be created first.');
-    }
-    return this.ObjectId;
-  }
-
-  /**
-   * Create customer in accounting system
-   *
-   */
-  async create() {
-    try {
-      this.AccSystemCustomerId = await this.accountingSystem.createCustomer({
-        FullName: this.FullName,
-        Email: this.Email,
-        ContractNo: this.ContactNo,
-        DefaultAddress: this.DefaultAddress,
-      });
-
-      this.ObjectId = cuid();
-    } catch (error) {
-      throw error;
-    }
+  async save(
+    customerId: string,
+    dbTransaction?: any,
+  ): Promise<FinanceCustomerModel> {
+    const data = await this.financeCustomerRepository.create(
+      {
+        CustomerId: customerId,
+        SystemCode: this.SystemCode,
+        AccSystemCode: this.SystemCode,
+        AccSystemCustomerId: this.AccSystemCustomerId,
+        CustomerRefId: this.CustSystemRefId,
+      },
+      dbTransaction,
+    );
+    return data;
   }
 }

package/src/customer/finance-customer.repository.ts

@@ -1,20 +1,28 @@
 import { InjectModel } from '@nestjs/sequelize';
+import { BaseRepository } from '@tomei/general';
 import { FinanceCustomerModel } from './entities/customer.entity';
 import { IFinanceCustomerAttr } from './interfaces/finance-customer-attr.interface';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 
 export class FinanceCustomerRepository
-  implements IFinanceCustomerRepository<FinanceCustomerModel>
+  extends BaseRepository<FinanceCustomerModel>
+  implements IFinanceCustomerRepository
 {
   constructor(
     @InjectModel(FinanceCustomerModel)
-    private readonly customerModel: typeof FinanceCustomerModel,
-  ) {}
+    private readonly financeCustomerModel: typeof FinanceCustomerModel,
+  ) {
+    super(financeCustomerModel);
+  }
 
   create(
     data: IFinanceCustomerAttr | any,
     options?: any,
   ): Promise<FinanceCustomerModel> | any {
-    return this.customerModel.create(data, options);
+    return this.financeCustomerModel.create(data, options);
+  }
+
+  findOne(options: any): Promise<FinanceCustomerModel> {
+    return this.financeCustomerModel.findOne(options);
   }
 }

package/src/customer/interfaces/finance-customer.repository.interface.ts

@@ -1,3 +1,4 @@
-export interface IFinanceCustomerRepository<T> {
-  create?(data: T | any, options?: any): Promise<T> | any;
-}
+import { IBaseRepository } from '@tomei/general';
+import { FinanceCustomerModel } from '../entities/customer.entity';
+
+export type IFinanceCustomerRepository = IBaseRepository<FinanceCustomerModel>;

package/src/document/document.ts

@@ -11,8 +11,9 @@ import {
 import { DocumentStatus, DocType } from 'src/enum';
 import { DocumentRepository } from './document.repository';
 import { IDocumentAttr } from './interfaces/document-attr.interface';
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
 
-export class Document extends ObjectBase {
+export class Document extends ObjectBase implements IAccountSystemEntity {
   ObjectId: string;
   ObjectName: string;
 
@@ -23,15 +24,18 @@ export class Document extends ObjectBase {
   Currency: string;
   Amount: number;
   Description: string;
-  Status: DocumentStatus;
   IssuedById: string;
   IssuedToId: string;
   IssuedToType: string;
   AccSystemCode: string;
-  PostedToAccYN: string;
+  PostedToAccSystemYN = 'N';
+  PostedById: string;
+  PostedDateTime: Date;
+  AccSystemRefId: string;
   UseAccSystemDocYN: string;
   private DocHTMLFilePath: string;
   private DocPDFFilePath: string;
+  private Status: DocumentStatus;
 
   documentRepository: DocumentRepository;
   mediaRepository: IMediasRepository;
@@ -103,7 +107,7 @@ export class Document extends ObjectBase {
     this.IssuedToId = params.IssuedToId;
     this.IssuedToType = params.IssuedToType;
     this.AccSystemCode = params.AccSystemCode;
-    this.PostedToAccYN = params.PostedToAccYN;
+    this.PostedToAccSystemYN = params.PostedToAccSystemYN;
     this.UseAccSystemDocYN = params.UseAccSystemDocYN;
     this.DocPDFFilePath = params.DocPDFFilePath;
     this.DocHTMLFilePath = params.DocHTMLFilePath;

package/src/document/interfaces/document-attr.interface.ts

@@ -13,7 +13,7 @@ export class IDocumentAttr {
   IssuedToId: string;
   IssuedToType: string;
   AccSystemCode: string;
-  PostedToAccYN: string;
+  PostedToAccSystemYN: string;
   UseAccSystemDocYN: string;
   DocPDFFilePath: string;
   DocHTMLFilePath: string;

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

@@ -1,13 +1,15 @@
+import axios from 'axios';
+import { CompanyBase, PersonBase } from '@tomei/general';
 import { BadRequestException } from '@nestjs/common';
 import { IAccountSystem } from 'src/interfaces';
 import { JournalEntry, JournalEntryRepository } from 'src/journal-entry';
 import { LedgerTransactionRepository } from 'src/ledger-transaction';
-import axios from 'axios';
 import { Account } from 'src/account';
-import { CompanyBase, PersonBase } from '@tomei/general';
+import { Customer, FinanceCustomerRepository } from 'src/customer';
 
 export class FinanceCompany {
   journalEntryRepository: JournalEntryRepository;
+  financeCustomerRepository: FinanceCustomerRepository;
   ledgerTransactionRepository: LedgerTransactionRepository;
   accountingSystem: IAccountSystem;
 
@@ -37,6 +39,70 @@ export class FinanceCompany {
     }
   }
 
+  async createCustomer(
+    dbTransaction: any,
+    custSystemCode: string,
+    custSystemRefId: string,
+    customer: Customer,
+  ) {
+    try {
+      if (customer.CustSystemCode || customer.CustSystemRefId) {
+        throw new BadRequestException(
+          'CustSystemCode and CustomerRefId are required fields.',
+        );
+      }
+
+      const financeCustomerData = await this.financeCustomerRepository.findOne({
+        where: {
+          SystemCode: this.SystemCode,
+          AccSystemCode: this.AccSystemCode,
+          AccSystemCustomerId: custSystemCode,
+          CustomerRefId: custSystemRefId,
+        },
+      });
+
+      if (financeCustomerData) {
+        throw new BadRequestException('Customer already created previously.');
+      }
+
+      const customerData = await customer.getDetails();
+
+      if (!customerData.FullName) {
+        throw new BadRequestException(
+          'FullName is required to be retrieved from GetDetails().',
+        );
+      }
+
+      // Retrieve the type of accounting system, API Key, and API secret based on SysCode from the Config.ts
+      const customerId = await this.accountingSystem.createCustomer(
+        customerData,
+      );
+
+      const newCustomer = await customer.save(customerId, dbTransaction);
+
+      const payload = {
+        Action: 'Create',
+        Activity: 'Finance Customer Created',
+        Description: `Customer (ID: ${newCustomer.CustomerId}) has been created for ${this.AccSystemCode}`,
+        EntityType: 'finance_Customer',
+        EntityValueBefore: JSON.stringify({}),
+        EntityValueAfter: JSON.stringify(newCustomer),
+        PerformedById: 'test',
+        PerformedAt: new Date(),
+        EntityId: newCustomer.CustomerId,
+      };
+
+      await axios.post(
+        `${process.env.COMMON_API_URL}/activity-histories`,
+        payload,
+      );
+
+      return customer;
+    } catch (error) {
+      throw error;
+    }
+  }
+
   async postJournal(dbTransaction: any, journalEntry: JournalEntry) {
     try {
       if (

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

@@ -67,7 +67,7 @@ export class JournalEntryModel extends Model {
     allowNull: true,
     type: DataType.DATE,
   })
-  DatePostedToAccSystem: Date;
+  PostedDateTime: Date;
 
   @HasMany(() => LedgerTransactionModel)
   LedgerTransactions: LedgerTransactionModel[];

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

@@ -6,15 +6,19 @@ import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
 import { TransactionTypeOptions } from 'src/enum';
 import { Op } from 'sequelize';
 import { JournalEntryModel } from './entities/journal-entry.entity';
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
 
-export class JournalEntry {
+export class JournalEntry implements IAccountSystemEntity {
   JournalEntryId: string;
   Date: Date;
   Name: string;
   Description: string;
   PostedById: string;
-  PostedToAccSystemYN: string;
+  PostedToAccSystemYN = 'N';
   DatePosted?: string;
+  AccSystemCode: string;
+  AccSystemRefId: string;
+  PostedDateTime: Date;
 
   journalEntryRepository: JournalEntryRepository;
   ledgerTransactionRepository: LedgerTransactionRepository;

package/src/payment/payment.ts

@@ -10,7 +10,8 @@ import { IPaymentAttr } from './interfaces/payment-attr.interface';
 import { PaymentModel } from './entities/payment.entity';
 import axios from 'axios';
 import { IPaymentParams } from './interfaces/payment-params.interface';
-export class Payment extends ObjectBase {
+import { IAccountSystemEntity } from 'src/interfaces/account-system-entity.interface';
+export class Payment extends ObjectBase implements IAccountSystemEntity {
   ObjectId: string;
   ObjectName: string;
 
@@ -44,6 +45,12 @@ export class Payment extends ObjectBase {
   private PaymentItemRepository: IPaymentItemRepository;
   private sequelize: Sequelize;
 
+  AccSystemCode: string;
+  PostedToAccSystemYN = 'N';
+  AccSystemRefId: string;
+  PostedById: string;
+  PostedDateTime: Date;
+
   constructor(
     AccountingSystem: IAccountSystem,
     PaymentRepository: IPaymentRepository,