@tomei/finance 0.1.10 → 0.1.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/finance",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "NestJS package for finance module",
   "main": "dist/index.js",
   "scripts": {
@@ -34,15 +34,15 @@
     "@nestjs/core": "^9.0.8",
     "@nestjs/platform-express": "^9.0.8",
     "@nestjs/sequelize": "^9.0.0",
-    "@tomei/general": "^0.0.10",
+    "@tomei/general": "^0.0.11",
     "axios": "^1.1.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
+    "cuid": "^2.1.8",
     "dotenv": "^16.0.3",
     "intuit-oauth": "^4.0.0",
     "sequelize-typescript": "^2.1.3",
-    "uniqid": "^5.4.0",
-    "cuid": "^2.1.8"
+    "uniqid": "^5.4.0"
   },
   "devDependencies": {
     "@nestjs/swagger": "^6.0.4",

package/src/account/account.ts

@@ -1,4 +1,3 @@
-import { RelatedObject, Owner } from '../base';
 import { ICreateAccountAttr } from './interfaces/account-attr.interface';
 import { IAccountRepository } from './interfaces/account.repository.interface';
 import * as uniqid from 'uniqid';
@@ -6,6 +5,7 @@ import { AccountModel } from './entities/account.entity';
 import axios from 'axios';
 import { getConfig } from '../config';
 import { IAccountSystem } from 'src/interfaces';
+import { ObjectBase, PersonBase } from '@tomei/general';
 export class Account {
   accountRepository: IAccountRepository;
 
@@ -17,8 +17,8 @@ export class Account {
   private AccSystemId: string;
 
   ParentAccountNo: string;
-  Owner: Owner;
-  RelatedObject: RelatedObject;
+  Owner: PersonBase;
+  RelatedObject: ObjectBase;
   AccountType: string;
   AccountSubType: string;
   AccountingSystem: IAccountSystem;
@@ -28,12 +28,12 @@ export class Account {
   constructor(
     accountRepository: IAccountRepository,
     accountingSystem: IAccountSystem,
-    SysCode: string,
+    SystemCode: string,
     params?: ICreateAccountAttr,
   ) {
     this.accountRepository = accountRepository;
     this.AccountingSystem = accountingSystem;
-    this.AccSystemId = getConfig().systemConfig[SysCode].accountingSystem;
+    this.AccSystemId = getConfig().systemConfig[SystemCode].accountingSystem;
     if (params) {
       this.init(params);
     }
@@ -41,12 +41,12 @@ export class Account {
 
   init(params: ICreateAccountAttr) {
     this.Owner = params.Owner;
-    this.OwnerId = params.Owner.Id;
+    this.OwnerId = params.Owner.ObjectId;
     this.OwnerType = typeof params.Owner;
 
     if (params.RelatedObject) {
       this.RelatedObject = params.RelatedObject;
-      this.RelatedObjectId = params.RelatedObject.Id;
+      this.RelatedObjectId = params.RelatedObject.ObjectId;
       this.RelatedObjectType = typeof params.RelatedObject;
     }
     if (params.AccountType) this.AccountType = params.AccountType;
@@ -63,7 +63,11 @@ export class Account {
     }
   }
 
-  async getAccountNo() {
+  /**
+   * This method will return finance_Account.AccountNo
+   * @returns {Promise<string>} AccountNo
+   */
+  async getAccountNo(): Promise<string> {
     if (this.AccountNo) {
       return this.AccountNo;
     } else {
@@ -85,7 +89,11 @@ export class Account {
     }
   }
 
-  async create(userId: string) {
+  /**
+   * This method will return finance_Account.AccountNo
+   * @returns {Promise<string>} AccountNo
+   */
+  async create() {
     try {
       if (!this.Owner || !this.RelatedObject) {
         throw new Error(
@@ -151,9 +159,9 @@ export class Account {
         RelatedObjectId: this.RelatedObjectId,
         RelatedObjectType: this.RelatedObjectType,
         CreatedAt: new Date(),
-        CreatedById: userId,
+        CreatedById: 'System',
         UpdatedAt: new Date(),
-        UpdatedById: userId,
+        UpdatedById: 'System',
       });
 
       const payload = {

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

@@ -1,4 +1,4 @@
-import { Owner, RelatedObject } from 'src/base';
+import { ObjectBase, PersonBase } from '@tomei/general';
 
 export interface IAccountAttr {
   AccountNo: string;
@@ -15,8 +15,8 @@ export interface IAccountAttr {
 }
 
 export interface ICreateAccountAttr {
-  Owner: Owner;
-  RelatedObject?: RelatedObject;
+  Owner: PersonBase;
+  RelatedObject?: ObjectBase;
   AccountType?: string;
   AccountSubType?: string;
   ParentAccountNo?: string;

package/src/customer/customer.ts

@@ -1,177 +1,93 @@
 import { AddressBase, PersonBase } from '@tomei/general';
 import { IAccountSystem } from '../interfaces';
-import { Address } from '../base/base.address';
 import { getConfig } from '../config';
-import { IBaseRepository } from '@tomei/general';
 import * as cuid from 'cuid';
-import axios from 'axios';
-import { FinanceCustomerModel } from './entities/customer.entity';
 
-export class Customer extends PersonBase {
-  private CustomerId: string;
+export abstract class Customer extends PersonBase {
+  ObjectId: string; // Finance_Customer.CustomerId
+  ObjectName: string;
 
-  Id: string; // Finance_Customer.CustomerId
-  AccSystemCustomerId: string; //customer id return from accounting system
-  CustomerRefId: string | undefined; //CRM customer CustomerId
-  SystemCode: string;
-  AccSystemCode: string;
+  private AccSystemCustomerId: string; //customer id return from accounting system
+  private CustomerRefId: string | undefined; //CRM customer CustomerId
+  private SystemCode: string;
+  private AccSystemCode: string;
 
   FullName: string;
-  Name: string;
   IDNo: string;
   IDType: string;
   public Email: string;
   ContactNo: string;
-  Address: AddressBase;
+  DefaultAddress: AddressBase;
 
-  financeCustomerRepository: IBaseRepository<any>;
-  customerRepository: IBaseRepository<any>;
-  customerAddressRepository: any;
   accountingSystem: IAccountSystem;
 
   constructor(
-    financeCustomerRepository: IBaseRepository<any>,
-    customerRepository: IBaseRepository<any>,
-    customerAddressRepository: any,
     accountingSystem: IAccountSystem,
     systemCode: string,
     email: string,
   ) {
     super();
-    this.financeCustomerRepository = financeCustomerRepository;
-    this.customerRepository = customerRepository;
-    this.customerAddressRepository = customerAddressRepository;
     this.accountingSystem = accountingSystem;
     this.SystemCode = systemCode;
     this.AccSystemCode = getConfig().systemConfig[systemCode].accountingSystem;
     this.Email = email;
   }
 
-  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;
-  }
+  /*
+   * Get the billing address for a person.
+   **/
+  abstract getBilligAddress(): Promise<AddressBase>;
 
-  async getDetails(): Promise<any> {
-    if (
-      !this.FullName ||
-      !this.IDNo ||
-      !this.IDType ||
-      !this.Email ||
-      !this.ContactNo ||
-      !this.Address
-    ) {
-      const customerData = await this.customerRepository.findOne({
-        where: { Email: this.Email },
-      });
-      if (!customerData) {
-        throw new Error('Customer must be created first.');
-      }
-
-      this.FullName = customerData.FullName;
-      this.IDNo = customerData.IDNo;
-      this.IDType = customerData.IDType;
-      this.ContactNo = customerData.ContactNo;
-      this.CustomerRefId = customerData.Id;
-      this.Name = customerData.PreferredName;
-    }
-
-    return {
-      FullName: this.FullName,
-      IDNo: this.IDNo,
-      IDType: this.IDType,
-      Email: this.Email,
-      ContactNo: this.ContactNo,
-      Address: this.Address,
-      CustomerRefId: this.CustomerRefId,
-      Name: this.Name,
-    };
+  get objectId() {
+    return this.ObjectId;
   }
 
-  async getDefaultAddress(): Promise<any> {
-    if (!this.CustomerRefId) {
-      await this.getDetails();
-    }
+  set objectId(value) {
+    this.ObjectId = value;
+  }
 
-    if (
-      !this.Address.Line1 ||
-      !this.Address.City ||
-      !this.Address.PostalCode ||
-      !this.Address.Country
-    ) {
-      const addressData = await this.customerAddressRepository.findOne({
-        CustomerId: this.CustomerRefId,
-        IsDefaultYN: 'Y',
-      });
+  get objectName() {
+    return this.ObjectName;
+  }
 
-      if (!addressData) {
-        throw new Error('Address must be created first.');
-      }
+  set objectName(value) {
+    this.ObjectName = value;
+  }
 
-      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,
-    };
+  init(person: PersonBase) {
+    this.FullName = person.FullName;
+    this.IDNo = person.IDNo;
+    this.IDType = person.IDType;
+    this.Email = person.Email;
+    this.ContactNo = person.ContactNo;
+    this.DefaultAddress = person.DefaultAddress;
   }
 
-  async getCustomerId(): Promise<any> {
-    if (!this.CustomerId) {
+  /**
+   *
+   * @returns {string} - Return Finance CustomerId
+   */
+  getCustomerId(): string {
+    if (!this.ObjectId) {
       throw new Error('Finance Customer must be created first.');
     }
-    return this.CustomerId;
+    return this.ObjectId;
   }
 
+  /**
+   * Create customer in accounting system
+   *
+   */
   async create() {
     try {
-      await this.getDetails();
-      await this.getDefaultAddress();
-
       this.AccSystemCustomerId = await this.accountingSystem.createCustomer({
         FullName: this.FullName,
         Email: this.Email,
         ContractNo: this.ContactNo,
-        Address: this.Address,
+        DefaultAddress: this.DefaultAddress,
       });
 
-      this.Id = cuid();
-
-      const customerData = await this.financeCustomerRepository.create({
-        CustomerId: this.Id,
-        SystemCode: this.SystemCode,
-        AccSystemCode: this.AccSystemCode,
-        AccSystemCustomerId: this.AccSystemCustomerId,
-        CustomerRefId: this.CustomerRefId,
-      });
-
-      const payload = {
-        Action: 'Create',
-        Activity: 'Account Created',
-        Description: `Customer (ID: ${this.Id}) has been created`,
-        EntityType: typeof FinanceCustomerModel,
-        EntityValueBefore: JSON.stringify({}),
-        EntityValueAfter: JSON.stringify(customerData),
-        PerformedById: this.SystemCode,
-        PerformedAt: new Date(),
-        EntityId: this.Id,
-      };
-
-      await axios.post(
-        `${process.env.COMMON_API_URL}/activity-histories`,
-        payload,
-      );
+      this.ObjectId = cuid();
     } catch (error) {
       throw error;
     }

package/src/index.ts

@@ -1,7 +1,5 @@
-export * from './base';
 export * from './account';
 export * from './customer';
-export * from './quickbook-client';
 export * from './enum';
 export * from './interfaces';
 export * from './payment';

package/src/payment/payment.ts

@@ -11,8 +11,8 @@ import { PaymentModel } from './entities/payment.entity';
 import axios from 'axios';
 import { IPaymentParams } from './interfaces/payment-params.interface';
 export class Payment extends ObjectBase {
-  Id: string;
-  Name: string;
+  ObjectId: string;
+  ObjectName: string;
 
   private Amount: number;
   private Currency: string;
@@ -71,6 +71,13 @@ export class Payment extends ObjectBase {
     }
   }
 
+  get objectId(): string {
+    return this.ObjectId;
+  }
+  get objectName(): string {
+    return this.ObjectName;
+  }
+
   init(Params: IPaymentParams): void {
     if (Params.Currency) this.Currency = Params.Currency;
     if (Params.Method) this.Method = Params.Method;
@@ -138,11 +145,14 @@ export class Payment extends ObjectBase {
       this.ReceivableAccountNo = await this.ReceivableAccount.getAccountNo();
       this.DepositAccountNo = await this.DepositAccount.getAccountNo();
 
-      this.Id = await this.AccountingSystem.makePayment(this.Customer, this);
+      this.ObjectId = await this.AccountingSystem.makePayment(
+        this.Customer,
+        this,
+      );
 
       this.Status = 'Successfull';
       const paymentAttribute: IPaymentAttr = {
-        PaymentId: this.Id,
+        PaymentId: this.ObjectId,
         AccountNo: this.DepositAccountNo,
         PaymentType: this.PaymentType,
         PaymentDate: new Date(),
@@ -161,8 +171,8 @@ export class Payment extends ObjectBase {
       const paymentItemsData = [];
       this.PaymentItems.forEach(async (paymentItem) => {
         paymentItemsData.push({
-          PaymentId: this.Id,
-          PayForObjectId: paymentItem.Id,
+          PaymentId: this.ObjectId,
+          PayForObjectId: paymentItem.ObjectId,
           PayForObjectType: paymentItem.Type,
           Amount: paymentItem.Amount,
           Currency: paymentItem.Currency,
@@ -176,13 +186,13 @@ export class Payment extends ObjectBase {
       const payload = {
         Action: 'Create',
         Activity: 'Payment Created',
-        Description: `Account (ID: ${this.Id}) has been created`,
+        Description: `Account (ID: ${this.ObjectId}) has been created`,
         EntityType: typeof PaymentModel,
         EntityValueBefore: JSON.stringify({}),
         EntityValueAfter: JSON.stringify(payment),
         PerformedById: payment.UpdatedBy,
         PerformedAt: payment.UpdatedAt,
-        EntityId: this.Id,
+        EntityId: this.ObjectId,
       };
 
       await axios.post(

package/src/base/base.address.ts

@@ -1,21 +0,0 @@
-import { AddressBase } from '@tomei/general';
-
-export class Address extends AddressBase {
-  Line1: string;
-  City: string;
-  PostalCode: string;
-  Country: string;
-
-  constructor(
-    line1: string,
-    city: string,
-    postalCode: string,
-    country: string,
-  ) {
-    super();
-    this.Line1 = line1;
-    this.City = city;
-    this.PostalCode = postalCode;
-    this.Country = country;
-  }
-}

package/src/base/base.object.ts

@@ -1,14 +0,0 @@
-import { ObjectBase } from '@tomei/general';
-
-export class RelatedObject extends ObjectBase {
-  Id: string;
-  Name: string;
-  Type: string;
-
-  constructor(id: string, name: string) {
-    super();
-    this.Id = id;
-    this.Name = name;
-    this.Type = 'RelatedObject';
-  }
-}

package/src/base/base.owner.ts

@@ -1,59 +0,0 @@
-import { PersonBase, AddressBase } from '@tomei/general';
-
-export class Owner extends PersonBase {
-  FullName: string;
-  IDNo: string;
-  IDType: string;
-  Email: string;
-  ContactNo: string;
-  Address: AddressBase;
-  Id: string;
-  Name: string;
-
-  constructor(
-    fullName: string,
-    idNo: string,
-    idType: string,
-    email: string,
-    contactNo: string,
-    address: AddressBase,
-    id: string,
-    name: string,
-  ) {
-    super();
-    this.FullName = fullName;
-    this.IDNo = idNo;
-    this.IDType = idType;
-    this.Email = email;
-    this.ContactNo = contactNo;
-    this.Address = address;
-    this.Id = id;
-    this.Name = name;
-  }
-
-  getDetails(): {
-    FullName: string;
-    IDNo: string;
-    IDType: string;
-    Email: string;
-    ContactNo: string;
-    Address: AddressBase;
-    Id: string;
-    Name: string;
-  } {
-    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,
-    };
-  }
-
-  getDefaultAddress() {
-    return this.Address;
-  }
-}

package/src/base/index.ts

@@ -1,4 +0,0 @@
-import { RelatedObject } from './base.object';
-import { Owner } from './base.owner';
-import { Address } from './base.address';
-export { RelatedObject, Owner, Address };