@tomei/finance 0.2.13 → 0.2.14

package/migrations/finance-company-migration.js

@@ -25,16 +25,14 @@ module.exports = {
         allowNull: false,
       },
       PostedToAccSystemYN: {
-        type: Sequelize.CHAR(1),
+        type: Sequelize.ENUM(['Y', 'N']),
         allowNull: false,
       },
       PostedById: {
         type: Sequelize.STRING(30),
-        allowNull: true,
       },
       PostedDateTime: {
         type: Sequelize.DATE,
-        allowNull: true,
       },
     });
   },

package/migrations/finance-document-item-migration.js

@@ -8,7 +8,7 @@ module.exports = {
         allowNull: false,
         primaryKey: true,
       },
-      DocNo:{
+      DocNo: {
         type: Sequelize.STRING(30),
         allowNull: false,
         references: {
@@ -18,11 +18,11 @@ module.exports = {
         onUpdate: 'CASCADE',
         onDelete: 'CASCADE',
       },
-      Name:{
+      Name: {
         type: Sequelize.STRING(200),
         allowNull: false,
       },
-      NameBM:{
+      NameBM: {
         type: Sequelize.STRING(200),
         allowNull: false,
       },
@@ -56,7 +56,7 @@ module.exports = {
       },
       Quantity: {
         type: Sequelize.DECIMAL(10, 2),
-        allowNull: false,
+        allowNull: true,
       },
       QuantityUOM: {
         type: Sequelize.STRING(20),
@@ -70,7 +70,19 @@ module.exports = {
         type: Sequelize.STRING(30),
         allowNull: true,
       },
-      DtAccountNo:{
+      TaxAmount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+      },
+      TaxRate: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: true,
+      },
+      TaxInclusiveYN: {
+        type: Sequelize.ENUM(['Y', 'N']),
+        allowNull: true,
+      },
+      DtAccountNo: {
         type: Sequelize.STRING(30),
         allowNull: false,
         references: {
@@ -80,7 +92,7 @@ module.exports = {
         onUpdate: 'CASCADE',
         onDelete: 'CASCADE',
       },
-      CtAccountNo:{
+      CtAccountNo: {
         type: Sequelize.STRING(30),
         allowNull: false,
         references: {

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

@@ -3,6 +3,16 @@
 module.exports = {
   async up(queryInterface, Sequelize) {
     await queryInterface.createTable('finance_JournalEntry', {
+      CompanyId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+        references: {
+          model: 'finance_Company',
+          key: 'CompanyId',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
       JournalEntryId: {
         type: Sequelize.STRING(30),
         primaryKey: true,
@@ -20,14 +30,18 @@ module.exports = {
         type: Sequelize.STRING(1000),
         allowNull: true,
       },
-      PostedById: {
+      AccSystemRefId: {
         type: Sequelize.STRING(30),
-        allowNull: false,
+        allowNull: true,
       },
       PostedToAccSystemYN: {
-        type: Sequelize.CHAR(1),
+        type: Sequelize.ENUM(['Y', 'N']),
         allowNull: false,
       },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: true,
+      },
       PostedDateTime: {
         type: Sequelize.DATE,
         allowNull: true,

package/package.json

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

package/src/account/account.ts

@@ -20,7 +20,6 @@ export class Account extends AccountSystemEntity {
   private RelatedObjectType: string;
   private ParentAccountNo: string;
 
-
   SystemCode: string;
   AccSystemCode: string;
   Name: string;
@@ -28,8 +27,6 @@ export class Account extends AccountSystemEntity {
   AccountType: string;
   AccountSubtype: string;
 
-
-
   CreatedAt: Date;
   CreatedById: string;
 

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

@@ -57,7 +57,7 @@ export abstract class AccountSystemEntity extends ObjectBase {
     try {
       /*retrieve the finance company details from finance_Company to
        * get details of the accounting system*/
-      const company = FinanceCompany.getFinanceCompany(this.CompanyId);
+      const company = await FinanceCompany.getFinanceCompany(this.CompanyId);
 
       /*todo:instantiating the appropriate accounting system to perform the post*/
       // if (this.TableName === 'finance_Customer') {

package/src/customer/entities/customer.entity.ts

@@ -7,7 +7,7 @@ import {
   Model,
   Table,
 } from 'sequelize-typescript';
-import { FinanceCompanyModel } from '../../finance-company/entities/finance-company.entity';
+import { FinanceCompanyModel } from '../../finance-company';
 
 @Table({ tableName: 'finance_Customer', createdAt: false, updatedAt: false })
 export class FinanceCustomerModel extends Model {

package/src/document/document-item.ts

@@ -10,10 +10,13 @@ export class DocumentItem {
   ItemSerialNo?: string;
   Currency: string;
   UnitPrice?: number;
-  Quantity: number;
+  Quantity?: number;
   QuantityUOM?: string;
   Amount: number;
   TaxCode?: string;
+  TaxAmount?: number;
+  TaxRate?: number;
+  TaxInclusiveYN?: string;
   DtAccountNo: string;
   CtAccountNo: string;
 }

package/src/document/entities/document-item.entity.ts

@@ -81,7 +81,7 @@ export class DocumentItemModel extends Model {
 
   @Column({
     type: DataType.DECIMAL(10, 2),
-    allowNull: false,
+    allowNull: true,
   })
   Quantity: number;
 
@@ -103,6 +103,24 @@ export class DocumentItemModel extends Model {
   })
   TaxCode: string;
 
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    allowNull: true,
+  })
+  TaxAmount: number;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    allowNull: true,
+  })
+  TaxRate: number;
+
+  @Column({
+    allowNull: true,
+    type: DataType.ENUM('Y', 'N'),
+  })
+  TaxInclusiveYN: string;
+
   @ForeignKey(() => AccountModel)
   @Column({
     allowNull: false,

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

@@ -10,10 +10,13 @@ export class IDocumentItemAttr {
   ItemSerialNo?: string;
   Currency: string;
   UnitPrice?: number;
-  Quantity: number;
+  Quantity?: number;
   QuantityUOM?: string;
   Amount: number;
   TaxCode?: string;
+  TaxAmount?: number;
+  TaxRate?: number;
+  TaxInclusiveYN?: string;
   DtAccountNo: string;
   CtAccountNo: string;
 }

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

@@ -0,0 +1,41 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, DataType, HasMany, Model, Table } from 'sequelize-typescript';
+import { FinanceCustomerModel } from '../customer';
+
+@Table({ tableName: 'finance_Company', createdAt: false, updatedAt: false })
+export class FinanceCompanyModel extends Model {
+  @ApiProperty({ example: 'cl6nzvo780000qcw38ihpd8w6' })
+  @Column({ primaryKey: true, allowNull: false, type: DataType.STRING(30) })
+  CompanyId: string;
+
+  @ApiProperty({ example: 'AB' })
+  @Column({ allowNull: false, type: DataType.STRING(10) })
+  CompSystemCode: string;
+
+  @ApiProperty({ example: 'cl6nzvo780000qcw38ihpd8w6' })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  CompSystemRefId: string;
+
+  @ApiProperty({ example: 'AB' })
+  @Column({ allowNull: false, type: DataType.STRING(10) })
+  AccSystemCode: string;
+
+  @ApiProperty({ example: 'cl6nzvo780000qcw38ihpd8w6' })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  AccSystemRefId: string;
+
+  @ApiProperty({ example: 'N' })
+  @Column({ defaultValue: 'N', type: DataType.ENUM('Y', 'N') })
+  PostedToAccSystemYN: string;
+
+  @ApiProperty({ example: 'cl6nzvo780000qcw38ihpd8w6' })
+  @Column({ type: DataType.STRING(30) })
+  PostedById: string;
+
+  @ApiProperty({ example: new Date() })
+  @Column({ type: DataType.DATE })
+  PostedDateTime: Date;
+
+  @HasMany(() => FinanceCustomerModel)
+  FinanceCustomers: FinanceCustomerModel[];
+}

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

@@ -1,30 +1,12 @@
-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';
+import { BaseRepository, IBaseRepository } from '@tomei/general';
+import { FinanceCompanyModel } from './finance-company.entity';
 
-@Injectable()
 export class FinanceCompanyRepository
   extends BaseRepository<FinanceCompanyModel>
-  implements IFinanceCompanyRepository
+  implements IBaseRepository<FinanceCompanyModel>
 {
-  constructor(
-    @InjectModel(FinanceCompanyModel)
-    private readonly financeCompanyModel: typeof FinanceCompanyModel,
-  ) {
+  constructor() {
+    const financeCompanyModel = new 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

@@ -8,14 +8,16 @@ import { Account } from '../account';
 import { Customer, FinanceCustomerRepository } from '../customer';
 import { AccountSystemEntity } from '../account-system-entity';
 import cuid from 'cuid';
+import { FinanceCompanyRepository } from './finance-company.repository';
 
 export class FinanceCompany extends AccountSystemEntity {
   private _CompSystemCode = '';
-  private _CompSystemCompanyId = '';
+  private _CompSystemRefId = '';
   private _AccSystemCode = '';
   protected BaseRepository: IBaseRepository;
   private static _htFinanceCompanyIds = new HashTable();
   private static _htFinanceCompanies = new HashTable();
+  private static financeCompanyRepository = new FinanceCompanyRepository();
   journalEntryRepository: JournalEntryRepository;
   financeCustomerRepository: FinanceCustomerRepository;
   ledgerTransactionRepository: LedgerTransactionRepository;
@@ -29,12 +31,12 @@ export class FinanceCompany extends AccountSystemEntity {
     this._CompSystemCode = code;
   }
 
-  get CompSystemCompanyId() {
-    return this._CompSystemCompanyId;
+  get CompSystemRefId() {
+    return this._CompSystemRefId;
   }
 
-  set CompSystemCompanyId(id: string) {
-    this._CompSystemCompanyId = id;
+  set CompSystemRefId(id: string) {
+    this._CompSystemRefId = id;
   }
 
   get AccSystemCode() {
@@ -50,7 +52,7 @@ export class FinanceCompany extends AccountSystemEntity {
   }
 
   get ObjectName() {
-    return `${this.CompSystemCode}-${this.CompSystemCompanyId}-${this.AccSystemCode}`;
+    return `${this.CompSystemCode}-${this.CompSystemRefId}-${this.AccSystemCode}`;
   }
 
   get TableName() {
@@ -59,37 +61,42 @@ export class FinanceCompany extends AccountSystemEntity {
 
   private constructor(
     compSystemCode: string,
-    compSystemCompanyId: string,
+    compSystemRefId: string,
     accSystemCode: string,
   ) {
     super();
     this.CompSystemCode = compSystemCode;
-    this.CompSystemCompanyId = compSystemCompanyId;
+    this.CompSystemRefId = compSystemRefId;
     this.AccSystemCode = accSystemCode;
   }
 
-  static getFinanceCompanyId(
+  static async getFinanceCompanyId(
     compSystemCode: string,
-    compSystemCompanyId: string,
+    compSystemRefId: string,
     accSystemCode: string,
-  ): string {
+  ): Promise<string> {
     let sCompanyId = '';
     /*Assemble the hashtable key*/
-    const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+    const sKey = `${compSystemCode}-${compSystemRefId}-${accSystemCode}`;
     /*Check if the FinanceCompany has previously being loaded*/
     if (!FinanceCompany._htFinanceCompanyIds.get(sKey)) {
       /*Instantiate a new FinanceCompany*/
       const financeCompany = new FinanceCompany(
         compSystemCode,
-        compSystemCompanyId,
+        compSystemRefId,
         accSystemCode,
       );
 
-      /*todo:Retrieve the finance company from finance_Company table using compSystemCode,
-       * compSystemCompanyId and accSystemCode */
+      /*Retrieve the finance company from finance_Company table using compSystemCode,
+       * CompSystemRefId and accSystemCode */
+      const company = await FinanceCompany.financeCompanyRepository.findOne({
+        CompSystemCode: compSystemCode,
+        CompSystemRefId: compSystemRefId,
+        AccSystemCode: accSystemCode,
+      });
 
-      /*todo:Retrieve and store the companyId from the result*/
-      financeCompany.CompanyId = 'asdf';
+      /*Retrieve and store the companyId from the result*/
+      financeCompany.CompanyId = company.CompanyId;
       sCompanyId = financeCompany.CompanyId;
 
       /*Add the details into the hashtable*/
@@ -104,28 +111,31 @@ export class FinanceCompany extends AccountSystemEntity {
     return sCompanyId;
   }
 
-  static getFinanceCompany(companyId: string): FinanceCompany {
+  static async getFinanceCompany(companyId: string): Promise<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 */
+      /*Retrieve the finance company from finance_Company table using compSystemCode,
+       * CompSystemRefId and accSystemCode */
+      const company = await FinanceCompany.financeCompanyRepository.findOne({
+        CompanyId: companyId,
+      });
 
-      /*todo:Using the result returned, instantiate a new FinanceCompany*/
-      const compSystemCode = '';
-      const compSystemCompanyId = '';
-      const accSystemCode = '';
+      /*Using the result returned, instantiate a new FinanceCompany*/
+      const compSystemCode = company.CompSystemCode;
+      const compSystemRefId = company.CompSystemRefId;
+      const accSystemCode = company.AccSystemCode;
 
       const financeCompany = new FinanceCompany(
         compSystemCode,
-        compSystemCompanyId,
+        compSystemRefId,
         accSystemCode,
       );
 
-      /*todo:Retrieve and store the CompanyId from the result*/
-      financeCompany.CompanyId = 'asdf';
+      /*Retrieve and store the CompanyId from the result*/
+      financeCompany.CompanyId = company.CompanyId;
 
       /*Add the details into the hashtable*/
-      const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+      const sKey = `${compSystemCode}-${compSystemRefId}-${accSystemCode}`;
       FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
       FinanceCompany._htFinanceCompanies.add(
         financeCompany.CompanyId,
@@ -136,29 +146,43 @@ export class FinanceCompany extends AccountSystemEntity {
     return FinanceCompany._htFinanceCompanies.get(companyId);
   }
 
-  static createFinanceCompany(
+  static async createFinanceCompany(
     dbTransaction: any,
     loginUser: LoginUserBase,
     compSystemCode: string,
-    compSystemCompanyId: string,
+    compSystemRefId: string,
     accSystemCode: string,
   ) {
     /*Instantiate a new FinanceCompany*/
     const financeCompany = new FinanceCompany(
       compSystemCode,
-      compSystemCompanyId,
+      compSystemRefId,
       accSystemCode,
     );
 
-    /*todo:Validating if the finance company already exists in finance_Company*/
+    /*Validating if the finance company already exists in finance_Company*/
+    const company = await FinanceCompany.financeCompanyRepository.findOne({
+      CompSystemCode: compSystemCode,
+      CompSystemRefId: compSystemRefId,
+      AccSystemCode: accSystemCode,
+    });
+
+    if (company) {
+      throw Error(
+        'There is already another Finance Company with the compSystemCode, CompSystemRefId and accSystemCode specified.',
+      );
+    }
 
     /*Generating the companyId*/
     financeCompany.CompanyId = cuid();
 
-    /*todo:Save the FinanceCompany to the finance_Company table*/
+    /*Save the FinanceCompany to the finance_Company table*/
+    await FinanceCompany.financeCompanyRepository.create(financeCompany, {
+      transaction: dbTransaction,
+    });
 
     /*Add the details to hashtable*/
-    const sKey = `${compSystemCode}-${compSystemCompanyId}-${accSystemCode}`;
+    const sKey = `${compSystemCode}-${compSystemRefId}-${accSystemCode}`;
     FinanceCompany._htFinanceCompanyIds.add(sKey, financeCompany.CompanyId);
     FinanceCompany._htFinanceCompanies.add(
       financeCompany.CompanyId,

package/src/finance-company/index.ts

@@ -1,13 +1,4 @@
 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';
+import { FinanceCompanyModel } from './finance-company.entity';
 
-export {
-  FinanceCompany,
-  FinanceCompanyModel,
-  IFinanceCompanyAttr,
-  IFinanceCompanyRepository,
-  FinanceCompanyRepository,
-};
+export { FinanceCompany, FinanceCompanyModel };

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

@@ -1,5 +1,14 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { Column, Model, Table, DataType, HasMany } from 'sequelize-typescript';
+import {
+  ForeignKey,
+  BelongsTo,
+  Column,
+  Model,
+  Table,
+  DataType,
+  HasMany,
+} from 'sequelize-typescript';
+import { FinanceCompanyModel } from '../../finance-company';
 import { LedgerTransactionModel } from '../../ledger-transaction/entities/ledger-transaction.entity';
 
 @Table({
@@ -7,6 +16,17 @@ import { LedgerTransactionModel } from '../../ledger-transaction/entities/ledger
   timestamps: false,
 })
 export class JournalEntryModel extends Model {
+  @ApiProperty({
+    example: 'cl6nzvo780000qcw38ihpd8w6',
+    description: 'CompanyId',
+  })
+  @ForeignKey(() => FinanceCompanyModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CompanyId: string;
+
   @ApiProperty({ type: String, description: 'JournalEntryId' })
   @Column({
     primaryKey: true,
@@ -43,22 +63,35 @@ export class JournalEntryModel extends Model {
   Description: string;
 
   @ApiProperty({
-    example: '138140891dd211b288d34bc7b4312a49',
-    description: 'PostedById',
+    type: String,
+    description: 'Account Customer Id in API',
   })
-  @Column({ allowNull: false, type: DataType.STRING(30) })
-  PostedById: string;
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(30),
+  })
+  AccSystemRefId: string;
 
   @ApiProperty({
-    type: String,
+    example: 'N',
     description: 'PostedToAccSystemYN',
   })
   @Column({
     allowNull: false,
-    type: DataType.CHAR(1),
+    type: DataType.ENUM('Y', 'N'),
   })
   PostedToAccSystemYN: string;
 
+  @ApiProperty({
+    example: '138140891dd211b288',
+    description: 'PostedById',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  PostedById: string;
+
   @ApiProperty({
     example: new Date(),
     description: 'PostedToAccSystem Date',
@@ -71,4 +104,7 @@ export class JournalEntryModel extends Model {
 
   @HasMany(() => LedgerTransactionModel)
   LedgerTransactions: LedgerTransactionModel[];
+
+  @BelongsTo(() => FinanceCompanyModel)
+  FinanceCompany: FinanceCompanyModel;
 }

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

@@ -1,9 +1,11 @@
 export interface IJournalEntryAttr {
+  CompanyId: string;
   JournalEntryId: string;
-  Date: Date;
+  Date?: Date;
   Name: string;
   Description?: string;
-  PostedById: string;
+  AccSystemRefId?: string;
   PostedToAccSystemYN: string;
+  PostedById?: string;
   PostedDateTime?: Date;
 }