@tomei/finance 0.1.2 → 0.1.4

package/migrations/finance-account-migration.js

@@ -1,59 +1,59 @@
-'use strict';
-
-module.exports = {
-  async up(queryInterface, Sequelize) {
-    await queryInterface.createTable('finance_Account', {
-      AccountNo: {
-        type: Sequelize.STRING(30),
-        primaryKey: true,
-        allowNull: false,
-      },
-      SystemCode: {
-        type: Sequelize.STRING(10),
-        allowNull: false,
-      },
-      Name: {
-        type: Sequelize.STRING(200),
-        allowNull: true,
-      },
-      OwnerId: {
-        type: Sequelize.STRING(30),
-        allowNull: false,
-      },
-      OwnerType: {
-        type: Sequelize.STRING(200),
-        allowNull: false,
-      },
-      RelatedObjectId: {
-        type: Sequelize.STRING(30),
-        allowNull: false,
-      },
-      RelatedObjectType: {
-        type: Sequelize.STRING(200),
-        allowNull: false,
-      },
-      CreatedAt: {
-        allowNull: false,
-        defaultValue: new Date(),
-        type: Sequelize.DATE,
-      },
-      CreatedById: {
-        allowNull: false,
-        type: Sequelize.STRING,
-      },
-      UpdatedAt: {
-        allowNull: true,
-        defaultValue: new Date(),
-        type: Sequelize.DATE,
-      },
-      UpdatedById: {
-        allowNull: true,
-        type: Sequelize.STRING,
-      },
-    });
-  },
-
-  async down(queryInterface) {
-    await queryInterface.dropTable('finance_Account');
-  },
-};
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_Account', {
+      AccountNo: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      SystemCode: {
+        type: Sequelize.STRING(10),
+        allowNull: false,
+      },
+      Name: {
+        type: Sequelize.STRING(200),
+        allowNull: true,
+      },
+      OwnerId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      OwnerType: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      RelatedObjectId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      RelatedObjectType: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      CreatedAt: {
+        allowNull: false,
+        defaultValue: new Date(),
+        type: Sequelize.DATE,
+      },
+      CreatedById: {
+        allowNull: false,
+        type: Sequelize.STRING,
+      },
+      UpdatedAt: {
+        allowNull: true,
+        defaultValue: new Date(),
+        type: Sequelize.DATE,
+      },
+      UpdatedById: {
+        allowNull: true,
+        type: Sequelize.STRING,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_Account');
+  },
+};

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

@@ -0,0 +1,39 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_PaymentItem', {
+      PaymentId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+        primaryKey: true,
+        references: {
+          model: 'finance_Payment',
+          key: 'PaymentId',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
+      PayForObjectId: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      PayForObjectType: {
+        type: Sequelize.STRING(200),
+        allowNull: false,
+      },
+      Currency: {
+        type: Sequelize.CHAR(3),
+        allowNull: false,
+      },
+      Amount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: false,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_PaymentItem');
+  },
+};

package/migrations/finance-payment-migration.js

@@ -0,0 +1,89 @@
+'use strict';
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable('finance_Payment', {
+      PaymentId: {
+        type: Sequelize.STRING(30),
+        primaryKey: true,
+        allowNull: false,
+      },
+      AccountNo: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+        references: {
+          model: 'finance_Account',
+          key: 'AccountNo',
+        },
+        onUpdate: 'CASCADE',
+        onDelete: 'CASCADE',
+      },
+      PaymentType: {
+        type: Sequelize.ENUM(['Payment Received', 'Payout']),
+        defaultValue: 'Payment Received',
+        allowNull: false,
+      },
+      PaymentDate: {
+        type: Sequelize.DATE,
+        allowNull: false,
+      },
+      Currency: {
+        type: Sequelize.CHAR(3),
+        allowNull: false,
+      },
+      Amount: {
+        type: Sequelize.DECIMAL(10, 2),
+        allowNull: false,
+      },
+      Status: {
+        type: Sequelize.STRING(20),
+        allowNull: false,
+      },
+      Method: {
+        type: Sequelize.STRING,
+        allowNull: false,
+      },
+      MethodParty: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      MethodAccountName: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      MethodAccountNo: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      TransactionId: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      ApprovalId: {
+        type: Sequelize.STRING(100),
+        allowNull: true,
+      },
+      ReceivedBy: {
+        type: Sequelize.STRING(30),
+        allowNull: false,
+      },
+      UpdatedAt: {
+        allowNull: false,
+        defaultValue: new Date(),
+        type: Sequelize.DATE,
+      },
+      UpdatedBy: {
+        allowNull: false,
+        type: Sequelize.STRING,
+      },
+      Remarks: {
+        type: Sequelize.TEXT,
+        allowNull: true,
+      },
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.dropTable('finance_Payment');
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -70,6 +70,6 @@
     ]
   },
   "dependencies": {
-    "@tomei/general": "^0.0.7"
+    "@tomei/general": "^0.0.10"
   }
 }

package/src/account/account.ts

@@ -9,6 +9,7 @@ import { IAccountSystem } from 'src/interfaces';
 export class Account {
   accountRepository: IAccountRepository;
 
+  private AccountNo: string;
   private OwnerId: string;
   private OwnerType: string;
   private RelatedObjectId: string;
@@ -54,6 +55,28 @@ export class Account {
     this.isParamsInitialized = true;
   }
 
+  async getAccountNo() {
+    if (this.AccountNo) {
+      return this.AccountNo;
+    } else {
+      try {
+        const account = await this.accountRepository.findOne({
+          OwnerId: this.OwnerId,
+          AccSystemId: this.AccSystemId,
+        });
+
+        if (account) {
+          this.AccountNo = account.AccountNo;
+          return this.AccountNo;
+        } else {
+          throw new Error('Account need to be created first.');
+        }
+      } catch (error) {
+        throw error;
+      }
+    }
+  }
+
   async create(userId: string, client: IAccountSystem, dbOptions: any) {
     try {
       if (!this.Owner || !this.RelatedObject) {
@@ -107,13 +130,13 @@ export class Account {
         };
       }
 
-      const data = await client.createAccount(createAccountPayload);
+      const accountId = await client.createAccount(createAccountPayload);
 
       const account = await this.accountRepository.create(
         {
-          AccountNo: data.Id,
+          AccountNo: accountId,
           SystemCode: this.AccSystemId,
-          Name: data.AcctNum,
+          Name: this.Owner.FullName,
           OwnerId: this.OwnerId,
           OwnerType: this.OwnerType,
           RelatedObjectId: this.RelatedObjectId,

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

@@ -6,7 +6,9 @@ import {
   Table,
   DataType,
   UpdatedAt,
+  HasMany,
 } from 'sequelize-typescript';
+import { PaymentModel } from '../../payment/entities/payment.entity';
 
 @Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
 export class AccountModel extends Model {
@@ -99,4 +101,7 @@ export class AccountModel extends Model {
   })
   @Column({ allowNull: false, type: DataType.STRING(30) })
   UpdatedById: string;
+
+  @HasMany(() => PaymentModel)
+  PaymentModel: PaymentModel[];
 }

package/src/customer/customer.ts

@@ -1,146 +1,152 @@
-import { AddressBase, PersonBase } from '@tomei/general';
-import { IAccountSystem } from '../interfaces';
-import { Address } from '../base/base.address';
-import { FinanceCustomerRepository } from './finance-customer.repository';
-import { ICustomerRepository } from './interfaces/customer.repository.interface';
-import { getConfig } from '../config';
-
-export class Customer extends PersonBase {
-  private CustomerId: string;
-  private AccSystemId: string;
-
-  FullName: string;
-  IDNo: string;
-  IDType: string;
-  Email: string;
-  ContactNo: string;
-  Address: AddressBase;
-  Id: string;
-  Name: string;
-
-  financeCustomerRepository: FinanceCustomerRepository;
-  customerRepository: ICustomerRepository<any>;
-  customerAddressRepository: any;
-  client: IAccountSystem;
-  person: PersonBase;
-  systemCode: string;
-  constructor(
-    financeCustomerRepository: FinanceCustomerRepository,
-    customerRepository: ICustomerRepository<any>,
-    customerAddressRepository: any,
-    client: IAccountSystem,
-    systemCode: string,
-    person?: PersonBase,
-  ) {
-    super();
-    this.financeCustomerRepository = financeCustomerRepository;
-    this.customerRepository = customerRepository;
-    this.customerAddressRepository = customerAddressRepository;
-    this.client = client;
-    this.systemCode = systemCode;
-    if (person) {
-      this.person = person;
-      this.init(person);
-    }
-  }
-
-  init(person: PersonBase) {
-    this.FullName = person.FullName;
-    this.IDNo = person.IDNo;
-    this.IDType = person.IDType;
-    this.Email = person.Email;
-    this.ContactNo = person.ContactNo;
-    this.Address = person.Address;
-  }
-
-  async getDetails(): Promise<any> {
-    if (
-      !this.FullName ||
-      !this.IDNo ||
-      !this.IDType ||
-      !this.Email ||
-      !this.ContactNo ||
-      !this.Address
-    ) {
-      const customerData = await this.customerRepository.findOne({
-        where: { IdNo: this.IDNo },
-      });
-      if (!customerData) {
-        throw new Error('Customer must be created first.');
-      }
-
-      this.FullName = customerData.FullName;
-      this.IDNo = customerData.IDNo;
-      this.IDType = customerData.IDType;
-      this.Email = customerData.Email;
-      this.ContactNo = customerData.ContactNo;
-      this.Id = customerData.CustomerId;
-      this.Name = customerData.PreferredName;
-    }
-
-    return {
-      FullName: this.FullName,
-      IDNo: this.IDNo,
-      IDType: this.IDType,
-      Email: this.Email,
-      ContactNo: this.ContactNo,
-      Address: this.Address,
-      Id: this.Id,
-      Name: this.Name,
-    };
-  }
-
-  async getDefaultAddress(): Promise<any> {
-    if (
-      !this.Address.Line1 ||
-      !this.Address.City ||
-      !this.Address.PostalCode ||
-      !this.Address.Country
-    ) {
-      const addressData = await this.customerAddressRepository.findOne({
-        where: { CustomerId: this.Id, isDefaultYN: 'Y' },
-      });
-
-      if (!addressData) {
-        throw new Error('Address must be created first.');
-      }
-
-      this.Address = new Address(
-        addressData.Address,
-        addressData.City,
-        addressData.PostCode,
-        addressData.Country,
-      );
-    }
-    return {
-      Line1: this.Address.Line1,
-      City: this.Address.City,
-      PostalCode: this.Address.PostalCode,
-      Country: this.Address.Country,
-    };
-  }
-
-  async create() {
-    try {
-      await this.getDetails();
-      await this.getDefaultAddress();
-
-      const customerData = await this.client.createCustomer({
-        FullName: this.FullName,
-        Email: this.Email,
-        ContractNo: this.ContactNo,
-        Address: this.Address,
-      });
-
-      this.AccSystemId =
-        getConfig().systemConfig[this.systemCode].accountingSystem;
-      this.CustomerId = customerData.Id;
-      return await this.financeCustomerRepository.create({
-        CustomerId: customerData.Id,
-        AccSystemId: this.AccSystemId,
-      });
-    } catch (error) {
-      throw error;
-    }
-  }
-}
+import { AddressBase, PersonBase } from '@tomei/general';
+import { IAccountSystem } from '../interfaces';
+import { Address } from '../base/base.address';
+import { FinanceCustomerRepository } from './finance-customer.repository';
+import { ICustomerRepository } from './interfaces/customer.repository.interface';
+import { getConfig } from '../config';
+
+export class Customer extends PersonBase {
+  private CustomerId: string;
+  private AccSystemId: string;
+
+  FullName: string;
+  IDNo: string;
+  IDType: string;
+  public Email: string;
+  ContactNo: string;
+  Address: AddressBase;
+  Id: string;
+  Name: string;
+
+  financeCustomerRepository: FinanceCustomerRepository;
+  customerRepository: ICustomerRepository<any>;
+  customerAddressRepository: any;
+  accountingSystem: IAccountSystem;
+  person: PersonBase;
+  systemCode: string;
+  constructor(
+    financeCustomerRepository: FinanceCustomerRepository,
+    customerRepository: ICustomerRepository<any>,
+    customerAddressRepository: any,
+    accountingSystem: IAccountSystem,
+    systemCode: string,
+    person?: PersonBase,
+  ) {
+    super();
+    this.financeCustomerRepository = financeCustomerRepository;
+    this.customerRepository = customerRepository;
+    this.customerAddressRepository = customerAddressRepository;
+    this.accountingSystem = accountingSystem;
+    this.systemCode = systemCode;
+    if (person) {
+      this.person = person;
+      this.init(person);
+    }
+  }
+
+  init(person: PersonBase) {
+    this.FullName = person.FullName;
+    this.IDNo = person.IDNo;
+    this.IDType = person.IDType;
+    this.Email = person.Email;
+    this.ContactNo = person.ContactNo;
+    this.Address = person.Address;
+  }
+
+  async getDetails(): Promise<any> {
+    if (
+      !this.FullName ||
+      !this.IDNo ||
+      !this.IDType ||
+      !this.Email ||
+      !this.ContactNo ||
+      !this.Address
+    ) {
+      const customerData = await this.customerRepository.findOne({
+        where: { IdNo: this.IDNo },
+      });
+      if (!customerData) {
+        throw new Error('Customer must be created first.');
+      }
+
+      this.FullName = customerData.FullName;
+      this.IDNo = customerData.IDNo;
+      this.IDType = customerData.IDType;
+      this.Email = customerData.Email;
+      this.ContactNo = customerData.ContactNo;
+      this.Id = customerData.CustomerId;
+      this.Name = customerData.PreferredName;
+    }
+
+    return {
+      FullName: this.FullName,
+      IDNo: this.IDNo,
+      IDType: this.IDType,
+      Email: this.Email,
+      ContactNo: this.ContactNo,
+      Address: this.Address,
+      Id: this.Id,
+      Name: this.Name,
+    };
+  }
+
+  async getDefaultAddress(): Promise<any> {
+    if (
+      !this.Address.Line1 ||
+      !this.Address.City ||
+      !this.Address.PostalCode ||
+      !this.Address.Country
+    ) {
+      const addressData = await this.customerAddressRepository.findOne({
+        where: { CustomerId: this.Id, isDefaultYN: 'Y' },
+      });
+
+      if (!addressData) {
+        throw new Error('Address must be created first.');
+      }
+
+      this.Address = new Address(
+        addressData.Address,
+        addressData.City,
+        addressData.PostCode,
+        addressData.Country,
+      );
+    }
+    return {
+      Line1: this.Address.Line1,
+      City: this.Address.City,
+      PostalCode: this.Address.PostalCode,
+      Country: this.Address.Country,
+    };
+  }
+
+  async getCustomerId(): Promise<any> {
+    if (!this.CustomerId) {
+      throw new Error('Finance Customer must be created first.');
+    }
+    return this.CustomerId;
+  }
+
+  async create() {
+    try {
+      await this.getDetails();
+      await this.getDefaultAddress();
+
+      this.CustomerId = await this.accountingSystem.createCustomer({
+        FullName: this.FullName,
+        Email: this.Email,
+        ContractNo: this.ContactNo,
+        Address: this.Address,
+      });
+
+      this.AccSystemId =
+        getConfig().systemConfig[this.systemCode].accountingSystem;
+      return await this.financeCustomerRepository.create({
+        CustomerId: this.CustomerId,
+        AccSystemId: this.AccSystemId,
+      });
+    } catch (error) {
+      throw error;
+    }
+  }
+}

package/src/enum/index.ts

@@ -1,3 +1,5 @@
 import { ClientScopes } from './quick-book-client-scopes.enum';
+import { PaymentType } from './payment-type.enum';
+import { PaymentMethod } from './payment-method.enum';
 
-export { ClientScopes };
+export { ClientScopes, PaymentType, PaymentMethod };

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

@@ -0,0 +1,3 @@
+export enum PaymentMethod {
+  Cash = 'Cash', // example
+}

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

@@ -0,0 +1,4 @@
+export enum PaymentType {
+  PAYMENT_RECEIVED = 'Payment Received',
+  PAYOUT = 'Payout',
+}

package/src/interfaces/account-system.interface.ts

@@ -1,3 +1,6 @@
+import { Customer } from '../customer';
+import { Payment } from '../payment';
+
 export interface IAccountSystem {
   createAccount(payload: any): Promise<any>;
   createInvoice(payload: any): Promise<any>;
@@ -5,4 +8,6 @@ export interface IAccountSystem {
   createCreditNote(payload: any): Promise<any>;
   postTransaction(payload: any): Promise<any>;
   createCustomer(payload: any): Promise<any>;
+  makePayment(customer: Customer, paymentInfo: Payment): Promise<any>;
+  collectPayments(customer: Customer, paymentInfo: Payment): Promise<any>;
 }