@tomei/finance 0.2.11 → 0.2.13

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

@@ -0,0 +1,88 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, DataType, Model, Table, HasMany } from 'sequelize-typescript';
+import { FinanceCustomerModel } from '../../customer/entities/customer.entity';
+
+@Table({ tableName: 'finance_Company', createdAt: false, updatedAt: false })
+export class FinanceCompanyModel extends Model {
+  @ApiProperty({ type: String, description: 'CompanyId' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CompanyId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'CompanySystemCode',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  CompSystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'CompanySystemRefId',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CompSystemRefId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account System Code eg. "EZC", "CRM"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account Company Id in API',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  AccSystemRefId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'PostedToAccSystemYN',
+    example: 'Y',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  PostedToAccSystemYN: string;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'PostedById',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(30),
+  })
+  PostedById: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'PostedToAccSystem Date',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.DATE,
+  })
+  PostedDateTime: Date;
+
+  @HasMany(() => FinanceCustomerModel)
+  FinanceCustomers: FinanceCustomerModel[];
+}

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

@@ -0,0 +1,30 @@
+import { Injectable } from '@nestjs/common/decorators';
+import { InjectModel } from '@nestjs/sequelize';
+import { BaseRepository } from '@tomei/general';
+import { FinanceCompanyModel } from './entities/finance-company.entity';
+import { IFinanceCompanyAttr } from './interfaces/finance-company-attr.interface';
+import { IFinanceCompanyRepository } from './interfaces/finance-company.repository.interface';
+
+@Injectable()
+export class FinanceCompanyRepository
+  extends BaseRepository<FinanceCompanyModel>
+  implements IFinanceCompanyRepository
+{
+  constructor(
+    @InjectModel(FinanceCompanyModel)
+    private readonly financeCompanyModel: typeof FinanceCompanyModel,
+  ) {
+    super(financeCompanyModel);
+  }
+
+  create(
+    data: IFinanceCompanyAttr | any,
+    options?: any,
+  ): Promise<FinanceCompanyModel> | any {
+    return this.financeCompanyModel.create(data, options);
+  }
+
+  findOne(options: any): Promise<FinanceCompanyModel> {
+    return this.financeCompanyModel.findOne(options);
+  }
+}

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

@@ -1,42 +1,169 @@
 import axios from 'axios';
-import { ICompany, LoginUserBase } from '@tomei/general';
+import { HashTable, IBaseRepository, LoginUserBase } from '@tomei/general';
 import { BadRequestException } from '@nestjs/common';
 import { IAccountSystem } from '../interfaces';
 import { JournalEntry, JournalEntryRepository } from '../journal-entry';
 import { LedgerTransactionRepository } from '../ledger-transaction';
 import { Account } from '../account';
 import { Customer, FinanceCustomerRepository } from '../customer';
+import { AccountSystemEntity } from '../account-system-entity';
+import cuid from 'cuid';
 
-export class FinanceCompany {
+export class FinanceCompany extends AccountSystemEntity {
+  private _CompSystemCode = '';
+  private _CompSystemCompanyId = '';
+  private _AccSystemCode = '';
+  protected BaseRepository: IBaseRepository;
+  private static _htFinanceCompanyIds = new HashTable();
+  private static _htFinanceCompanies = new HashTable();
   journalEntryRepository: JournalEntryRepository;
   financeCustomerRepository: FinanceCustomerRepository;
   ledgerTransactionRepository: LedgerTransactionRepository;
-  accountingSystem: IAccountSystem;
+  AccountingSystem: IAccountSystem;
 
-  private SystemCode: string;
-  private AccSystemCode: string;
-  private Company: ICompany;
-  private LoginUser: LoginUserBase;
+  get CompSystemCode(): string {
+    return this._CompSystemCode;
+  }
+
+  private set CompSystemCode(code: string) {
+    this._CompSystemCode = code;
+  }
+
+  get CompSystemCompanyId() {
+    return this._CompSystemCompanyId;
+  }
+
+  set CompSystemCompanyId(id: string) {
+    this._CompSystemCompanyId = id;
+  }
+
+  get AccSystemCode() {
+    return this._AccSystemCode;
+  }
 
-  constructor(
-    company: ICompany,
-    systemCode: string,
+  private set AccSystemCode(code: string) {
+    this._AccSystemCode = code;
+  }
+
+  get ObjectId() {
+    return this.CompanyId;
+  }
+
+  get ObjectName() {
+    return `${this.CompSystemCode}-${this.CompSystemCompanyId}-${this.AccSystemCode}`;
+  }
+
+  get TableName() {
+    return 'finance_Company';
+  }
+
+  private constructor(
+    compSystemCode: string,
+    compSystemCompanyId: string,
     accSystemCode: string,
-    loginUser: LoginUserBase,
   ) {
-    this.SystemCode = systemCode;
+    super();
+    this.CompSystemCode = compSystemCode;
+    this.CompSystemCompanyId = compSystemCompanyId;
     this.AccSystemCode = accSystemCode;
-    if (company != null) {
-      this.Company = company;
-    } else {
-      throw new BadRequestException('Company cannot be null');
+  }
+
+  static getFinanceCompanyId(
+    compSystemCode: string,
+    compSystemCompanyId: string,
+    accSystemCode: string,
+  ): string {
+    let sCompanyId = '';
+    /*Assemble the hashtable key*/
+    const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+    /*Check if the FinanceCompany has previously being loaded*/
+    if (!FinanceCompany._htFinanceCompanyIds.get(sKey)) {
+      /*Instantiate a new FinanceCompany*/
+      const financeCompany = new FinanceCompany(
+        compSystemCode,
+        compSystemCompanyId,
+        accSystemCode,
+      );
+
+      /*todo:Retrieve the finance company from finance_Company table using compSystemCode,
+       * compSystemCompanyId and accSystemCode */
+
+      /*todo:Retrieve and store the companyId from the result*/
+      financeCompany.CompanyId = 'asdf';
+      sCompanyId = financeCompany.CompanyId;
+
+      /*Add the details into the hashtable*/
+      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+      FinanceCompany._htFinanceCompanies.add(sCompanyId, financeCompany);
+    }
+
+    if (typeof FinanceCompany._htFinanceCompanyIds.get(sKey) === 'string') {
+      sCompanyId = FinanceCompany._htFinanceCompanyIds.get(sKey);
     }
 
-    if (loginUser != null && loginUser.ObjectId == '') {
-      this.LoginUser = loginUser;
-    } else {
-      throw new BadRequestException('Login user cannot be null');
+    return sCompanyId;
+  }
+
+  static getFinanceCompany(companyId: string): FinanceCompany {
+    /*Check if the finance company is previously be loaded*/
+    if (!FinanceCompany._htFinanceCompanies.get(companyId)) {
+      /*todo:Retrieve the finance company from finance_Company table using compSystemCode,
+       * compSystemCompanyId and accSystemCode */
+
+      /*todo:Using the result returned, instantiate a new FinanceCompany*/
+      const compSystemCode = '';
+      const compSystemCompanyId = '';
+      const accSystemCode = '';
+
+      const financeCompany = new FinanceCompany(
+        compSystemCode,
+        compSystemCompanyId,
+        accSystemCode,
+      );
+
+      /*todo:Retrieve and store the CompanyId from the result*/
+      financeCompany.CompanyId = 'asdf';
+
+      /*Add the details into the hashtable*/
+      const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+      FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+      FinanceCompany._htFinanceCompanies.add(
+        financeCompany.CompanyId,
+        financeCompany,
+      );
     }
+
+    return FinanceCompany._htFinanceCompanies.get(companyId);
+  }
+
+  static createFinanceCompany(
+    dbTransaction: any,
+    loginUser: LoginUserBase,
+    compSystemCode: string,
+    compSystemCompanyId: string,
+    accSystemCode: string,
+  ) {
+    /*Instantiate a new FinanceCompany*/
+    const financeCompany = new FinanceCompany(
+      compSystemCode,
+      compSystemCompanyId,
+      accSystemCode,
+    );
+
+    /*todo:Validating if the finance company already exists in finance_Company*/
+
+    /*Generating the companyId*/
+    financeCompany.CompanyId = cuid();
+
+    /*todo:Save the FinanceCompany to the finance_Company table*/
+
+    /*Add the details to hashtable*/
+    const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+    FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
+    FinanceCompany._htFinanceCompanies.add(
+      financeCompany.CompanyId,
+      financeCompany,
+    );
   }
 
   async createCustomer(
@@ -54,7 +181,8 @@ export class FinanceCompany {
 
       const financeCustomerData = await this.financeCustomerRepository.findOne({
         where: {
-          SystemCode: this.SystemCode,
+          /*todo:verify SystemCode*/
+          // SystemCode: this.SystemCode,
           AccSystemCode: this.AccSystemCode,
           AccSystemCustomerId: custSystemCode,
           CustomerRefId: custSystemRefId,
@@ -66,7 +194,7 @@ export class FinanceCompany {
       }
 
       // Retrieve the type of accounting system, API Key, and API secret based on SysCode from the Config.ts
-      const customerId = await this.accountingSystem.createCustomer({
+      const customerId = await this.AccountingSystem.createCustomer({
         customer,
       });
 
@@ -131,7 +259,7 @@ export class FinanceCompany {
         ledgerTransaction.save();
       }
 
-      await this.accountingSystem.postJournalEntry(newJournalEntry);
+      await this.AccountingSystem.postJournalEntry(newJournalEntry);
 
       const payload = {
         Action: 'Create',
@@ -174,7 +302,7 @@ export class FinanceCompany {
         };
       }
 
-      const accSystemAccountId = await this.accountingSystem.createAccount(
+      const accSystemAccountId = await this.AccountingSystem.createAccount(
         createAccountPayload,
       );
 

package/src/finance-company/index.ts

@@ -1,3 +1,13 @@
 import { FinanceCompany } from './finance-company';
+import { FinanceCompanyModel } from './entities/finance-company.entity';
+import { IFinanceCompanyAttr } from './interfaces/finance-company-attr.interface';
+import { IFinanceCompanyRepository } from './interfaces/finance-company.repository.interface';
+import { FinanceCompanyRepository } from './finance-company.repository';
 
-export { FinanceCompany };
+export {
+  FinanceCompany,
+  FinanceCompanyModel,
+  IFinanceCompanyAttr,
+  IFinanceCompanyRepository,
+  FinanceCompanyRepository,
+};

package/src/finance-company/interfaces/finance-company-attr.interface.ts

@@ -0,0 +1,10 @@
+export interface IFinanceCompanyAttr {
+  CompanyId: string;
+  CompSystemCode: string;
+  CompSystemRefId: string;
+  AccSystemCode: string;
+  AccSystemRefId: string;
+  PostedToAccSystemYN: string;
+  PostedById: string;
+  PostedDateTime?: Date;
+}

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

@@ -0,0 +1,4 @@
+import { IBaseRepository } from '@tomei/general';
+import { FinanceCompanyModel } from '../entities/finance-company.entity';
+
+export type IFinanceCompanyRepository = IBaseRepository<FinanceCompanyModel>;

package/src/journal-entry/interfaces/journal-entry-attr.interface.ts

@@ -2,8 +2,8 @@ export interface IJournalEntryAttr {
   JournalEntryId: string;
   Date: Date;
   Name: string;
-  Description: string;
+  Description?: string;
   PostedById: string;
   PostedToAccSystemYN: string;
-  DatePosted?: string;
+  PostedDateTime?: Date;
 }

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

@@ -6,37 +6,21 @@ import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
 import { TransactionTypeOptions } from '../enum';
 import { Op } from 'sequelize';
 import { JournalEntryModel } from './entities/journal-entry.entity';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
+import { AccountSystemEntity } from '../account-system-entity';
 
 export class JournalEntry extends AccountSystemEntity {
   TableName: string;
   protected BaseRepository;
   ObjectId: string;
   ObjectName: string;
-
-  /*todo:remove when ObjectBase updated.*/
-  get objectId(): string {
-    return '';
-  }
-
-  /*todo:remove when ObjectBase updated.*/
-  get objectName(): string {
-    return '';
-  }
   JournalEntryId: string;
   Date: Date;
   Name: string;
   Description: string;
-  PostedById: string;
-  PostedToAccSystemYN = 'N';
   DatePosted?: string;
   AccSystemCode: string;
-  AccSystemRefId: string;
-  PostedDateTime: Date;
-
   journalEntryRepository: JournalEntryRepository;
   ledgerTransactionRepository: LedgerTransactionRepository;
-
   private _DebitTransactions: any = null;
   private _CreditTransactions: any = null;
 
@@ -104,7 +88,7 @@ export class JournalEntry extends AccountSystemEntity {
     this.Description = params.Description;
     this.PostedById = params.PostedById;
     this.PostedToAccSystemYN = params.PostedToAccSystemYN;
-    this.DatePosted = params.DatePosted;
+    this.PostedDateTime = params.PostedDateTime;
   }
 
   getData() {
@@ -149,7 +133,7 @@ export class JournalEntry extends AccountSystemEntity {
       Description: '',
       PostedById: '',
       PostedToAccSystemYN: 'N',
-      DatePosted: null,
+      PostedDateTime: null,
     });
 
     const ledgerTransaction = new LedgerTransaction(

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

@@ -1,5 +1,4 @@
-import { TransactionTypeOptions } from 'src/enum/transaction-type.enum';
-
+import { TransactionTypeOptions } from '../../enum';
 export interface ILedgerTransactionAttr {
   TransactionId: string;
   TransactionType: string;

package/src/payment/payment.ts

@@ -10,13 +10,12 @@ import { IPaymentAttr } from './interfaces/payment-attr.interface';
 import { PaymentModel } from './entities/payment.entity';
 import axios from 'axios';
 import { IPaymentParams } from './interfaces/payment-params.interface';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
+import { AccountSystemEntity } from '../account-system-entity';
 export class Payment extends AccountSystemEntity {
   protected BaseRepository: IBaseRepository;
   TableName: string;
   ObjectId: string;
   ObjectName: string;
-
   private Amount: number;
   private Currency: string;
   private Method: PaymentMethod;
@@ -24,7 +23,6 @@ export class Payment extends AccountSystemEntity {
   private Status: string;
   private PaymentType: PaymentType;
   private PaymentDate: Date;
-
   private AccountNo: string;
   private SystemCode: string;
   private OwnerId: string;
@@ -35,7 +33,6 @@ export class Payment extends AccountSystemEntity {
   private CreatedById: string;
   private UpdatedAt: Date;
   private UpdatedById: string;
-
   private Customer: Customer;
   private ReceivableAccount: Account;
   private DepositAccount: Account;
@@ -46,12 +43,7 @@ export class Payment extends AccountSystemEntity {
   private PaymentRepository: IPaymentRepository;
   private PaymentItemRepository: IPaymentItemRepository;
   private sequelize: Sequelize;
-
   AccSystemCode: string;
-  PostedToAccSystemYN = 'N';
-  AccSystemRefId: string;
-  PostedById: string;
-  PostedDateTime: Date;
 
   constructor(
     AccountingSystem: IAccountSystem,
@@ -80,15 +72,6 @@ export class Payment extends AccountSystemEntity {
     }
   }
 
-  /*todo:remove when ObjectBase updated.*/
-  get objectId(): string {
-    return this.ObjectId;
-  }
-  /*todo:remove when ObjectBase updated.*/
-  get objectName(): string {
-    return this.ObjectName;
-  }
-
   init(Params: IPaymentParams): void {
     if (Params.Currency) this.Currency = Params.Currency;
     if (Params.Method) this.Method = Params.Method;