@tomei/finance 0.2.12 → 0.2.13

package/migrations/finance-company-migration.js

@@ -0,0 +1,45 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_Company', {
+      CompanyId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      CompSystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      CompSystemRefId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      AccSystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      AccSystemRefId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      PostedToAccSystemYN: {
+        type: Sequelize.CHAR(1),
+        allowNull: false,
+      },
+      PostedById: {
+        type: Sequelize.STRING(30),
+        allowNull: true,
+      },
+      PostedDateTime: {
+        type: Sequelize.DATE,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_Company');
+  },
+};

package/migrations/finance-customer-migration.js

@@ -8,22 +8,40 @@ module.exports = {
         primaryKey: true,
         allowNull: false,
       },
-      SystemCode: {
+      CompanyId: {
         type: Sequelize.STRING(30),
         allowNull: false,
+        references: {
+          model: 'finance_Company',
+          key: 'CompanyId',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
       },
-      AccSystemCode: {
-        type: Sequelize.STRING(30),
+      CustSystemCode: {
+        type: Sequelize.STRING(10),
         allowNull: false,
       },
-      AccSystemCustomerId: {
+      CustSystemRefId: {
         type: Sequelize.STRING(30),
         allowNull: false,
       },
-      CustomerRefId: {
+      AccSystemRefId: {
         type: Sequelize.STRING(30),
         allowNull: false,
       },
+      PostedToAccSystemYN: {
+        type: Sequelize.CHAR(1),
+        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.12",
+  "version": "0.2.13",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {

package/src/customer/customer.ts

@@ -1,44 +1,58 @@
-import { IAddress, LoginUserBase, RecordNotFoundError } from '@tomei/general';
+import {
+  IAddress,
+  IPerson,
+  LoginUserBase,
+  RecordNotFoundError,
+} from '@tomei/general';
+import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
 import { FinanceCustomerModel } from './entities/customer.entity';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
+export abstract class Customer extends AccountSystemEntity implements IPerson {
+  abstract FullName: string;
+  abstract IDNo: string;
+  abstract IDType: string;
+  abstract ContactNo: string;
+  abstract Email: string;
+  abstract DefaultAddress: IAddress;
 
-export abstract class Customer extends LoginUserBase {
-  FullName: string;
-  IDNo: string;
-  IDType: string;
-  ContactNo: string;
-  Email: string;
-  DefaultAddress: IAddress;
+  // note: getDetails from spec is void type. Meaning that this probably needed a fix soon
+  async getDetails(): Promise<{
+    FullName: string;
+    IDNo: string;
+    IDType: string;
+    Email: string;
+    ContactNo: string;
+  }> {
+    return {
+      FullName: this.FullName,
+      IDNo: this.IDNo,
+      IDType: this.IDType,
+      Email: this.Email,
+      ContactNo: this.ContactNo,
+    };
+  }
 
   financeCustomerRepository: IFinanceCustomerRepository;
 
   CustomerId: string;
-
-  SystemCode: string;
-  AccSystemCode: string;
-  AccSystemCustomerId: string; // customer id return from accounting system
   CustSystemCode: string;
   CustSystemRefId: string;
 
   constructor(
-    systemCode: string,
-    accSystemCode: string,
+    sFinanceCompanyId: string,
     custSystemCode: string,
     custSystemRefId: string,
   ) {
     super();
     const financeCustomerData = this.financeCustomerRepository.findOne({
       where: {
-        SystemCode: systemCode,
-        AccSystemCode: accSystemCode,
-        AccSystemCustomerId: custSystemCode,
-        CustomerRefId: custSystemRefId,
+        CompanyId: sFinanceCompanyId,
+        CustSystemCode: custSystemCode,
+        CustSystemRefId: custSystemRefId,
       },
     });
     if (financeCustomerData) {
-      this.CustomerId = financeCustomerData.CustomerId;
-      this.AccSystemCode = accSystemCode;
-      this.AccSystemCustomerId = financeCustomerData.AccSystemCustomerId;
+      this.CompanyId = sFinanceCompanyId;
       this.CustSystemCode = custSystemCode;
       this.CustSystemRefId = custSystemRefId;
     } else {
@@ -50,7 +64,7 @@ export abstract class Customer extends LoginUserBase {
   /*
    * Get the billing address for a person.
    **/
-  abstract getBilligAddress(): Promise<IAddress>;
+  abstract getBillingAddress(): Promise<IAddress>;
 
   init(person: LoginUserBase) {
     this.FullName = person.FullName;
@@ -68,10 +82,8 @@ export abstract class Customer extends LoginUserBase {
     const data = await this.financeCustomerRepository.create(
       {
         CustomerId: customerId,
-        SystemCode: this.SystemCode,
-        AccSystemCode: this.SystemCode,
-        AccSystemCustomerId: this.AccSystemCustomerId,
-        CustomerRefId: this.CustSystemRefId,
+        CustSystemCode: this.CustSystemCode,
+        CustSystemRefId: this.CustSystemRefId,
       },
       dbTransaction,
     );

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

@@ -1,5 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { Column, DataType, Model, Table } from 'sequelize-typescript';
+import {
+  ForeignKey,
+  BelongsTo,
+  Column,
+  DataType,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { FinanceCompanyModel } from '../../finance-company/entities/finance-company.entity';
 
 @Table({ tableName: 'finance_Customer', createdAt: false, updatedAt: false })
 export class FinanceCustomerModel extends Model {
@@ -11,43 +19,75 @@ export class FinanceCustomerModel extends Model {
   })
   CustomerId: string;
 
+  @ApiProperty({ type: String, description: 'CompanyId' })
+  @ForeignKey(() => FinanceCompanyModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CompanyId: string;
+
   @ApiProperty({
     type: String,
-    description: 'System Code eg. "EZC", "CRM"',
+    description: 'Cust System Code eg. "EZC", "CRM"',
   })
   @Column({
     allowNull: false,
-    type: DataType.STRING(30),
+    type: DataType.STRING(10),
   })
-  SystemCode: string;
+  CustSystemCode: string;
 
   @ApiProperty({
     type: String,
-    description: 'Account System Code eg. "EZC", "CRM"',
+    description: 'CustSystemRefId',
   })
   @Column({
     allowNull: false,
     type: DataType.STRING(30),
   })
-  AccSystemCode: string;
+  CustSystemRefId: string;
 
   @ApiProperty({
     type: String,
-    description: 'Account Customer Id in Api',
+    description: 'Account Customer Id in API',
   })
   @Column({
     allowNull: false,
     type: DataType.STRING(30),
   })
-  AccSystemCustomerId: string;
+  AccSystemRefId: string;
 
   @ApiProperty({
     type: String,
-    description: 'Custoemr Ref Id',
+    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),
   })
-  CustomerRefId: string;
+  PostedById: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'PostedToAccSystem Date',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.DATE,
+  })
+  PostedDateTime: Date;
+
+  @BelongsTo(() => FinanceCompanyModel)
+  FinanceCompany: FinanceCompanyModel;
 }

package/src/customer/index.ts

@@ -1,15 +1,15 @@
+import { Customer } from './customer';
 import { IFinanceCustomerRepository } from './interfaces/finance-customer.repository.interface';
 import { IFinanceCustomerAttr } from './interfaces/finance-customer-attr.interface';
 import { FinanceCustomerModel } from './entities/customer.entity';
 import { ICustomerRepository } from './interfaces/customer.repository.interface';
 import { FinanceCustomerRepository } from './finance-customer.repository';
-import { Customer } from './customer';
 
 export {
+  Customer,
   IFinanceCustomerRepository,
   IFinanceCustomerAttr,
   FinanceCustomerModel,
   ICustomerRepository,
   FinanceCustomerRepository,
-  Customer,
 };

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

@@ -1,4 +1,10 @@
 export interface IFinanceCustomerAttr {
   CustomerId: string;
-  AccSystemId: string;
+  CompanyId: string;
+  CustSystemCode: string;
+  CustSystemRefId: string;
+  AccSystemRefId: string;
+  PostedToAccSystemYN: string;
+  PostedById: string;
+  PostedDateTime?: Date;
 }

package/src/document/document.ts

@@ -8,7 +8,7 @@ import {
   CommonService as MediaCommonService,
   MediaType,
 } from '@tomei/media';
-import { DocumentStatus, DocType } from 'src/enum';
+import { DocumentStatus, DocType } from '../enum';
 import { DocumentRepository } from './document.repository';
 import { IDocumentAttr } from './interfaces/document-attr.interface';
 import { DocumentItemRepository } from './document-item.repository';

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/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

@@ -88,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() {
@@ -133,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;