@tomei/finance 0.1.13 → 0.2.1

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

@@ -1,107 +1,111 @@
-import { ApiProperty } from '@nestjs/swagger';
-import {
-  Column,
-  CreatedAt,
-  Model,
-  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 {
-  @ApiProperty({ type: String, description: 'AccountNo' })
-  @Column({
-    primaryKey: true,
-    allowNull: false,
-    type: DataType.STRING(30),
-  })
-  AccountNo: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'System Code eg. "EZC", "CRM"',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(10),
-  })
-  SystemCode: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Name of the account',
-  })
-  @Column({
-    allowNull: true,
-    type: DataType.STRING(200),
-  })
-  Name: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Owner id of the account',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(30),
-  })
-  OwnerId: string;
-
-  @ApiProperty({
-    type: String,
-    description: 'Owner type',
-  })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(30),
-  })
-  OwnerType: string;
-
-  @ApiProperty({ type: String, description: 'Associated Object id' })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(30),
-  })
-  RelatedObjectId: string;
-
-  @ApiProperty({ type: String, description: 'Associated Object type' })
-  @Column({
-    allowNull: false,
-    type: DataType.STRING(200),
-  })
-  RelatedObjectType: string;
-
-  @ApiProperty({
-    example: new Date(),
-    description: 'Timestamp for data creation.',
-  })
-  @CreatedAt
-  CreatedAt: Date;
-
-  @ApiProperty({
-    example: '138140891dd211b288d34bc7b4312a49',
-    description: 'The CreatedById for Media.',
-  })
-  @Column({ allowNull: false, type: DataType.STRING(30) })
-  CreatedById: string;
-
-  @ApiProperty({
-    example: new Date(),
-    description: 'Timestamp for latest data modification',
-  })
-  @UpdatedAt
-  UpdatedAt: Date;
-
-  @ApiProperty({
-    example: '138140891dd211b288d34bc7b4312a49',
-    description: 'The UpdatedById for Media.',
-  })
-  @Column({ allowNull: false, type: DataType.STRING(30) })
-  UpdatedById: string;
-
-  @HasMany(() => PaymentModel)
-  PaymentModel: PaymentModel[];
-}
+import { ApiProperty } from '@nestjs/swagger';
+import {
+  Column,
+  CreatedAt,
+  Model,
+  Table,
+  DataType,
+  UpdatedAt,
+  HasMany,
+} from 'sequelize-typescript';
+import { LedgerTransactionModel } from 'src/ledger-transaction/entities/ledger-transaction.entity';
+import { PaymentModel } from '../../payment/entities/payment.entity';
+
+@Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
+export class AccountModel extends Model {
+  @ApiProperty({ type: String, description: 'AccountNo' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  AccountNo: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'System Code eg. "EZC", "CRM"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  SystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Name of the account',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(200),
+  })
+  Name: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Owner id of the account',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  OwnerId: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Owner type',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  OwnerType: string;
+
+  @ApiProperty({ type: String, description: 'Associated Object id' })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  RelatedObjectId: string;
+
+  @ApiProperty({ type: String, description: 'Associated Object type' })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(200),
+  })
+  RelatedObjectType: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'Timestamp for data creation.',
+  })
+  @CreatedAt
+  CreatedAt: Date;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'The CreatedById for Media.',
+  })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  CreatedById: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'Timestamp for latest data modification',
+  })
+  @UpdatedAt
+  UpdatedAt: Date;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'The UpdatedById for Media.',
+  })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  UpdatedById: string;
+
+  @HasMany(() => PaymentModel)
+  Payments: PaymentModel[];
+
+  @HasMany(() => LedgerTransactionModel)
+  LedgerTransactions: LedgerTransactionModel[];
+}

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

@@ -1,23 +1,23 @@
-import { ObjectBase, PersonBase } from '@tomei/general';
-
-export interface IAccountAttr {
-  AccountNo: string;
-  SystemCode: string;
-  Name: string;
-  OwnerId: string;
-  OwnerType: string;
-  RelatedObjectId: string;
-  RelatedObjectType: string;
-  CreatedAt: Date;
-  CreatedById: string;
-  UpdatedAt: Date;
-  UpdatedById: string;
-}
-
-export interface ICreateAccountAttr {
-  Owner: PersonBase;
-  RelatedObject?: ObjectBase;
-  AccountType?: string;
-  AccountSubType?: string;
-  ParentAccountNo?: string;
-}
+import { ObjectBase, PersonBase } from '@tomei/general';
+
+export interface IAccountAttr {
+  AccountNo: string;
+  SystemCode: string;
+  Name: string;
+  OwnerId: string;
+  OwnerType: string;
+  RelatedObjectId: string;
+  RelatedObjectType: string;
+  CreatedAt: Date;
+  CreatedById: string;
+  UpdatedAt: Date;
+  UpdatedById: string;
+}
+
+export interface ICreateAccountAttr {
+  Owner: PersonBase;
+  RelatedObject?: ObjectBase;
+  AccountType?: string;
+  AccountSubType?: string;
+  ParentAccountNo?: string;
+}

package/src/enum/index.ts

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

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

@@ -0,0 +1,4 @@
+export enum TransactionTypeOptions {
+  Debit = 1,
+  Credit = 2,
+}

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

@@ -0,0 +1,95 @@
+import { BadRequestException } from '@nestjs/common';
+import { IAccountSystem } from 'src/interfaces';
+import { JournalEntry, JournalEntryRepository } from 'src/journal-entry';
+import { LedgerTransactionRepository } from 'src/ledger-transaction';
+import * as uniqid from 'uniqid';
+import axios from 'axios';
+import { JournalEntryModel } from 'src/journal-entry';
+
+export class FinanceCompany {
+  journalEntryRepository: JournalEntryRepository;
+  ledgerTransactionRepository: LedgerTransactionRepository;
+
+  accountingSystem: IAccountSystem;
+
+  constructor(
+    journalEntryRepository: JournalEntryRepository,
+    ledgerTransactionRepository: LedgerTransactionRepository,
+    accountingSystem: IAccountSystem,
+  ) {
+    this.ledgerTransactionRepository = ledgerTransactionRepository;
+    this.journalEntryRepository = journalEntryRepository;
+    this.accountingSystem = accountingSystem;
+  }
+
+  async postJournal(journalEntryId: string, userId: string): Promise<any> {
+    const journalEntry = new JournalEntry(
+      this.journalEntryRepository,
+      this.ledgerTransactionRepository,
+    );
+
+    if (
+      journalEntry.CreditTransactions?.length < 1 ||
+      journalEntry.DebitTransactions?.length < 1
+    ) {
+      throw new BadRequestException(
+        'There should be at least 1 debit ledger transaction and 1 credit ledger transaction in the journal entry',
+      );
+    }
+
+    if (
+      journalEntry.CreditTransactions?.length !==
+      journalEntry.DebitTransactions?.length
+    ) {
+      throw new BadRequestException(
+        'Credit ledger transaction and debit ledger transaction should the same amount',
+      );
+    }
+
+    const matchingJournalEntry = await this.journalEntryRepository.findOne({
+      where: {
+        JournalEntryId: journalEntryId,
+      },
+    });
+
+    matchingJournalEntry.PostedById = userId;
+    await matchingJournalEntry.save();
+
+    const allLedgerTransactions =
+      await this.ledgerTransactionRepository.findAll();
+
+    for (const ledgerTransaction of allLedgerTransactions) {
+      ledgerTransaction.JournalEntryId = journalEntryId;
+      ledgerTransaction.save();
+    }
+
+    journalEntry.init({
+      JournalEntryId: uniqid(),
+      Date: new Date(),
+      Name: '',
+      Description: '',
+      PostedById: userId,
+      PostedToAccSystemYN: 'N',
+      DatePosted: null,
+    });
+
+    await this.accountingSystem.postJournalEntry(matchingJournalEntry);
+
+    const payload = {
+      Action: 'Create',
+      Activity: 'Post Journal Entry',
+      Description: `Journal Entry (ID: ${matchingJournalEntry.JournalEntryId}) has been created`,
+      EntityType: typeof JournalEntryModel,
+      EntityValueBefore: JSON.stringify({}),
+      EntityValueAfter: JSON.stringify(matchingJournalEntry),
+      PerformedById: userId,
+      PerformedAt: new Date(),
+      EntityId: matchingJournalEntry.JournalEntryId,
+    };
+
+    await axios.post(
+      `${process.env.COMMON_API_URL}/activity-histories`,
+      payload,
+    );
+  }
+}

package/src/finance-company/index.ts

@@ -0,0 +1,3 @@
+import { FinanceCompany } from './finance-company';
+
+export { FinanceCompany };

package/src/index.ts

@@ -1,6 +1,9 @@
-export * from './account';
-export * from './customer';
-export * from './enum';
-export * from './interfaces';
-export * from './payment';
-export { getConfig } from './config';
+export * from './account';
+export * from './customer';
+export * from './enum';
+export * from './interfaces';
+export * from './payment';
+export * from './ledger-transaction';
+export * from './journal-entry';
+export * from './finance-company';
+export { getConfig } from './config';

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

@@ -1,13 +1,14 @@
-import { Customer } from '../customer';
-import { Payment } from '../payment';
-
-export interface IAccountSystem {
-  createAccount(payload: any): Promise<any>;
-  createInvoice(payload: any): Promise<any>;
-  createDebitNote(payload: any): Promise<any>;
-  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>;
-}
+import { Customer } from '../customer';
+import { Payment } from '../payment';
+
+export interface IAccountSystem {
+  createAccount(payload: any): Promise<any>;
+  createInvoice(payload: any): Promise<any>;
+  createDebitNote(payload: any): Promise<any>;
+  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>;
+  postJournalEntry(payload: any): Promise<any>;
+}

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

@@ -0,0 +1,74 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Column, Model, Table, DataType, HasMany } from 'sequelize-typescript';
+import { LedgerTransactionModel } from 'src/ledger-transaction';
+
+@Table({
+  tableName: 'finance_JournalEntry',
+  timestamps: false,
+})
+export class JournalEntryModel extends Model {
+  @ApiProperty({ type: String, description: 'JournalEntryId' })
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  JournalEntryId: string;
+
+  @ApiProperty({ type: Date, description: 'Date' })
+  @Column({
+    allowNull: true,
+    type: DataType.DATE,
+  })
+  Date: Date;
+
+  @ApiProperty({
+    type: String,
+    description: 'Name of the journal entry',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(200),
+  })
+  Name: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Description of the journal entry',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(1000),
+  })
+  Description: string;
+
+  @ApiProperty({
+    example: '138140891dd211b288d34bc7b4312a49',
+    description: 'PostedById',
+  })
+  @Column({ allowNull: false, type: DataType.STRING(30) })
+  PostedById: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'PostedToAccSystemYN',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  PostedToAccSystemYN: string;
+
+  @ApiProperty({
+    example: new Date(),
+    description: 'PostedToAccSystem Date',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.DATE,
+  })
+  DatePostedToAccSystem: Date;
+
+  @HasMany(() => LedgerTransactionModel)
+  LedgerTransactions: LedgerTransactionModel[];
+}

package/src/journal-entry/index.ts

@@ -0,0 +1,13 @@
+import { JournalEntry } from './journal-entry';
+import { IJournalEntryRepository } from './interfaces/journal-entry.repository.interface';
+import { JournalEntryRepository } from './journal-entry.repository';
+import { JournalEntryModel } from './entities/journal-entry.entity';
+import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
+
+export {
+  JournalEntry,
+  IJournalEntryRepository,
+  JournalEntryRepository,
+  JournalEntryModel,
+  IJournalEntryAttr,
+};

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

@@ -0,0 +1,9 @@
+export interface IJournalEntryAttr {
+  JournalEntryId: string;
+  Date: Date;
+  Name: string;
+  Description: string;
+  PostedById: string;
+  PostedToAccSystemYN: string;
+  DatePosted?: string;
+}

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

@@ -0,0 +1,11 @@
+export interface IJournalEntryRepository<T> {
+  create?(data: T | any, options?: any): Promise<T> | any;
+
+  findAll?(options?: any): Promise<T[]>;
+
+  findAllWithPagination(options: any): Promise<{ count: number; rows: T[] }>;
+
+  findOne?(options: any): Promise<T>;
+
+  update?(data: any, options?: any): Promise<any>;
+}

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

@@ -0,0 +1,38 @@
+import { InjectModel } from '@nestjs/sequelize';
+import { JournalEntryModel } from './entities/journal-entry.entity';
+import { IJournalEntryRepository } from './interfaces/journal-entry.repository.interface';
+import { IJournalEntryAttr } from './interfaces/journal-entry-attr.interface';
+
+export class JournalEntryRepository
+  implements IJournalEntryRepository<JournalEntryModel>
+{
+  constructor(
+    @InjectModel(JournalEntryModel)
+    private readonly journalEntryModel: typeof JournalEntryModel,
+  ) {}
+
+  create(
+    data: IJournalEntryAttr | any,
+    options?: any,
+  ): Promise<JournalEntryModel> | any {
+    return this.journalEntryModel.create(data, options);
+  }
+
+  findAll(options?: any): Promise<JournalEntryModel[]> {
+    return this.journalEntryModel.findAll(options);
+  }
+
+  findAllWithPagination(
+    options: any,
+  ): Promise<{ count: number; rows: JournalEntryModel[] }> {
+    return this.journalEntryModel.findAndCountAll(options);
+  }
+
+  findOne(options: any): Promise<JournalEntryModel> {
+    return this.journalEntryModel.findOne(options);
+  }
+
+  update(data: IJournalEntryAttr, options?: any): any {
+    return this.journalEntryModel.update({ ...data }, options);
+  }
+}