@tomei/finance 0.2.1 → 0.2.2

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

@@ -10,7 +10,7 @@ import {
 } from 'sequelize-typescript';
 import { LedgerTransactionModel } from 'src/ledger-transaction/entities/ledger-transaction.entity';
 import { PaymentModel } from '../../payment/entities/payment.entity';
-
+import { DocumentItemModel } from '../../document/entities/document-item.entity';
 @Table({ tableName: 'finance_Account', createdAt: false, updatedAt: false })
 export class AccountModel extends Model {
   @ApiProperty({ type: String, description: 'AccountNo' })
@@ -21,6 +21,13 @@ export class AccountModel extends Model {
   })
   AccountNo: string;
 
+  //copy from finance account migration table
+  @ApiProperty({ type: String, description: 'Parent account of this object' })
+  @Column({
+    type: DataType.STRING(30),
+  })
+  ParentAccountNo: string;
+
   @ApiProperty({
     type: String,
     description: 'System Code eg. "EZC", "CRM"',
@@ -31,6 +38,26 @@ export class AccountModel extends Model {
   })
   SystemCode: string;
 
+  @ApiProperty({
+    type: String,
+    description: 'Finance account system code eg. "quickbook"',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemCode: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account id in finance system',
+  })
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemAccountId: string;
+
   @ApiProperty({
     type: String,
     description: 'Name of the account',
@@ -41,12 +68,42 @@ export class AccountModel extends Model {
   })
   Name: string;
 
+  @ApiProperty({
+    type: String,
+    description: 'Account description',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.TEXT,
+  })
+  Description: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account Type',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(100),
+  })
+  AccountType: string;
+
+  @ApiProperty({
+    type: String,
+    description: 'Account Sub Type',
+  })
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(100),
+  })
+  AccountSubType: string;
+
   @ApiProperty({
     type: String,
     description: 'Owner id of the account',
   })
   @Column({
-    allowNull: false,
+    allowNull: true,
     type: DataType.STRING(30),
   })
   OwnerId: string;
@@ -56,21 +113,21 @@ export class AccountModel extends Model {
     description: 'Owner type',
   })
   @Column({
-    allowNull: false,
-    type: DataType.STRING(30),
+    allowNull: true,
+    type: DataType.STRING(200),
   })
   OwnerType: string;
 
   @ApiProperty({ type: String, description: 'Associated Object id' })
   @Column({
-    allowNull: false,
+    allowNull: true,
     type: DataType.STRING(30),
   })
   RelatedObjectId: string;
 
   @ApiProperty({ type: String, description: 'Associated Object type' })
   @Column({
-    allowNull: false,
+    allowNull: true,
     type: DataType.STRING(200),
   })
   RelatedObjectType: string;
@@ -106,6 +163,9 @@ export class AccountModel extends Model {
   @HasMany(() => PaymentModel)
   Payments: PaymentModel[];
 
+  @HasMany(() => DocumentItemModel)
+  DocumentItems: DocumentItemModel[];
+
   @HasMany(() => LedgerTransactionModel)
   LedgerTransactions: LedgerTransactionModel[];
 }

package/src/document/document-item.repository.ts

@@ -0,0 +1,49 @@
+import { Injectable } from '@nestjs/common';
+import { InjectModel } from '@nestjs/sequelize';
+import { BaseRepository } from '@tomei/general';
+import { DocumentItemModel } from './entities/document-item.entity';
+import { IDocumentItemAttr } from './interfaces/document-item-attr.interface';
+import { IDocumentItemRepository } from './interfaces/document-item.repository.interface';
+
+@Injectable()
+export class DocumentItemRepository
+  extends BaseRepository<DocumentItemModel>
+  implements IDocumentItemRepository
+{
+  constructor(
+    @InjectModel(DocumentItemModel)
+    private readonly documentItemModel: typeof DocumentItemModel,
+  ) {
+    super(documentItemModel);
+  }
+
+  create(
+    data: IDocumentItemAttr,
+    options?: any,
+  ): Promise<DocumentItemModel> | any {
+    return this.documentItemModel.create({ ...data }, options);
+  }
+
+  bulkCreate(data: IDocumentItemAttr[], options?: any): any {
+    const payload: any = [...data];
+    return this.documentItemModel.bulkCreate(payload, options);
+  }
+
+  findAll(options: any): Promise<DocumentItemModel[]> {
+    return this.documentItemModel.findAll(options);
+  }
+
+  findAllWithPagination(
+    options: any,
+  ): Promise<{ count: number; rows: DocumentItemModel[] }> {
+    return this.documentItemModel.findAndCountAll(options);
+  }
+
+  findOne(options: any): Promise<DocumentItemModel> {
+    return this.documentItemModel.findOne(options);
+  }
+
+  update(data: IDocumentItemAttr, options?: any): any {
+    return this.documentItemModel.update({ ...data }, options);
+  }
+}

package/src/document/document.repository.ts

@@ -0,0 +1,41 @@
+import { Injectable } from '@nestjs/common';
+import { InjectModel } from '@nestjs/sequelize';
+import { BaseRepository } from '@tomei/general';
+import { DocumentModel } from './entities/document.entity';
+import { IDocumentAttr } from './interfaces/document-attr.interface';
+import { IDocumentRepository } from './interfaces/document.repository.interface';
+
+@Injectable()
+export class DocumentRepository
+  extends BaseRepository<DocumentModel>
+  implements IDocumentRepository
+{
+  constructor(
+    @InjectModel(DocumentModel)
+    private readonly documentModel: typeof DocumentModel,
+  ) {
+    super(documentModel);
+  }
+
+  create(data: IDocumentAttr, options?: any): Promise<DocumentModel> | any {
+    return this.documentModel.create({ ...data }, options);
+  }
+
+  findAll(options: any): Promise<DocumentModel[]> {
+    return this.documentModel.findAll(options);
+  }
+
+  findAllWithPagination(
+    options: any,
+  ): Promise<{ count: number; rows: DocumentModel[] }> {
+    return this.documentModel.findAndCountAll(options);
+  }
+
+  findOne(options: any): Promise<DocumentModel> {
+    return this.documentModel.findOne(options);
+  }
+
+  update(data: IDocumentAttr, options?: any): any {
+    return this.documentModel.update({ ...data }, options);
+  }
+}

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

@@ -0,0 +1,125 @@
+import {
+  BelongsTo,
+  Column,
+  DataType,
+  ForeignKey,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { DocumentModel } from './document.entity';
+import { AccountModel } from '../../account/entities/account.entity';
+
+@Table({ tableName: 'finance_DocumentItem', timestamps: false })
+export class DocumentItemModel extends Model {
+  @Column({
+    type: DataType.STRING(30),
+    allowNull: false,
+    primaryKey: true,
+  })
+  DocumentItemId: string;
+
+  @ForeignKey(() => DocumentModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  DocNo: string;
+
+  @Column({
+    type: DataType.STRING(200),
+    allowNull: false,
+  })
+  Name: string;
+
+  @Column({
+    type: DataType.STRING(200),
+    allowNull: false,
+  })
+  NameBM: string;
+
+  @Column({
+    type: DataType.STRING(1000),
+    allowNull: true,
+  })
+  Description: string;
+
+  @Column({
+    type: DataType.STRING(30),
+    allowNull: true,
+  })
+  ItemId: string;
+
+  @Column({
+    type: DataType.STRING(200),
+    allowNull: true,
+  })
+  ItemType: string;
+
+  @Column({
+    type: DataType.STRING(30),
+    allowNull: true,
+  })
+  ItemSKU: string;
+
+  @Column({
+    type: DataType.STRING(30),
+    allowNull: true,
+  })
+  ItemSerialNo: string;
+
+  @Column({
+    type: DataType.CHAR(3),
+    allowNull: false,
+  })
+  Currency: string;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    allowNull: true,
+  })
+  UnitPrice: number;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    allowNull: false,
+  })
+  Quantity: number;
+
+  @Column({
+    type: DataType.STRING(20),
+    allowNull: true,
+  })
+  QuantityUOM: string;
+
+  @Column({
+    type: DataType.DECIMAL(10, 2),
+    allowNull: false,
+  })
+  Amount: number;
+
+  @Column({
+    allowNull: true,
+    type: DataType.STRING(30),
+  })
+  TaxCode: string;
+
+  @ForeignKey(() => AccountModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  DtAccountNo: string;
+
+  @ForeignKey(() => AccountModel)
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  CtAccountNo: string;
+
+  @BelongsTo(() => DocumentModel)
+  Document: DocumentModel;
+
+  @BelongsTo(() => AccountModel)
+  Account: AccountModel;
+}

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

@@ -0,0 +1,106 @@
+import { Column, DataType, HasMany, Model, Table } from 'sequelize-typescript';
+import { DocumentType, DocumentStatus } from '../../enum';
+import { DocumentItemModel } from './document-item.entity';
+
+@Table({ tableName: 'finance_Document', timestamps: false })
+export class DocumentModel extends Model {
+  @Column({
+    primaryKey: true,
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  DocNo: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  DocType: DocumentType;
+
+  @Column({
+    allowNull: false,
+    type: DataType.DATE,
+  })
+  DocDate: Date;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  SystemCode: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(3),
+  })
+  Currency: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.DECIMAL(10, 2),
+  })
+  Amount: number;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(1000),
+  })
+  Description: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  Status: DocumentStatus;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  IssuedById: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(30),
+  })
+  IssuedToId: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(200),
+  })
+  IssuedToType: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(10),
+  })
+  AccSystemCode: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  PostedToAccYN: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.CHAR(1),
+  })
+  UseAccSystemDocYN: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(500),
+  })
+  DocPDFFilePath: string;
+
+  @Column({
+    allowNull: false,
+    type: DataType.STRING(500),
+  })
+  DocHTMLFilePath: string;
+
+  @HasMany(() => DocumentItemModel)
+  DocumentItems: DocumentItemModel[];
+}

package/src/document/index.ts

@@ -0,0 +1,19 @@
+import { DocumentModel } from './entities/document.entity';
+import { IDocumentAttr } from './interfaces/document-attr.interface';
+import { IDocumentRepository } from './interfaces/document.repository.interface';
+import { DocumentItemModel } from './entities/document-item.entity';
+import { IDocumentItemAttr } from './interfaces/document-item-attr.interface';
+import { IDocumentItemRepository } from './interfaces/document-item.repository.interface';
+import { DocumentRepository } from './document.repository';
+import { DocumentItemRepository } from './document-item.repository';
+
+export {
+  DocumentModel,
+  DocumentItemModel,
+  DocumentRepository,
+  DocumentItemRepository,
+  IDocumentRepository,
+  IDocumentItemRepository,
+  IDocumentAttr,
+  IDocumentItemAttr,
+};

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

@@ -0,0 +1,20 @@
+import { DocumentType, DocumentStatus } from '../../enum';
+
+export class IDocumentAttr {
+  DocNo: string;
+  DocType: DocumentType;
+  DocDate: Date;
+  SystemCode: string;
+  Currency: string;
+  Amount: number;
+  Description: string;
+  Status: DocumentStatus;
+  IssuedById: string;
+  IssuedToId: string;
+  IssuedToType: string;
+  AccSystemCode: string;
+  PostedToAccYN: string;
+  UseAccSystemDocYN: string;
+  DocPDFFilePath: string;
+  DocHTMLFilePath: string;
+}

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

@@ -0,0 +1,19 @@
+export class IDocumentItemAttr {
+  DocumentItemId: string;
+  DocNo: string;
+  Name: string;
+  NameBM: string;
+  Description?: string;
+  ItemId?: string;
+  ItemType?: string;
+  ItemSKU?: string;
+  ItemSerialNo?: string;
+  Currency: string;
+  UnitPrice?: number;
+  Quantity: number;
+  QuantityUOM?: string;
+  Amount: number;
+  TaxCode?: string;
+  DtAccountNo: string;
+  CtAccountNo: string;
+}

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

@@ -0,0 +1,4 @@
+import { IBaseRepository } from '@tomei/general';
+import { DocumentItemModel } from '../entities/document-item.entity';
+
+export type IDocumentItemRepository = IBaseRepository<DocumentItemModel>;

package/src/document/interfaces/document.repository.interface.ts

@@ -0,0 +1,4 @@
+import { IBaseRepository } from '@tomei/general';
+import { DocumentModel } from '../entities/document.entity'
+
+export type IDocumentRepository = IBaseRepository<DocumentModel>;

package/src/enum/document-status.enum.ts

@@ -0,0 +1,4 @@
+export enum DocumentStatus {
+  ACTIVE = 'Active',
+  CANCELED = 'Canceled',
+}

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

@@ -0,0 +1,7 @@
+export enum DocumentType {
+  INVOICE = 'Invoice',
+  DEBIT_NOTE = 'Debit Note',
+  CREDIT_NOTE = 'Credit Note',
+  QUOTATION = 'Quotation',
+  RECEIPT = 'Receipt',
+}

package/src/enum/index.ts

@@ -2,5 +2,14 @@ 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';
+import { DocumentType } from './document-type.enum';
+import { DocumentStatus } from './document-status.enum';
 
-export { ClientScopes, PaymentType, PaymentMethod, TransactionTypeOptions };
+export {
+  ClientScopes,
+  PaymentType,
+  PaymentMethod,
+  TransactionTypeOptions,
+  DocumentType,
+  DocumentStatus,
+};

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

@@ -5,6 +5,7 @@ import { LedgerTransactionRepository } from 'src/ledger-transaction';
 import * as uniqid from 'uniqid';
 import axios from 'axios';
 import { JournalEntryModel } from 'src/journal-entry';
+import { Account } from 'src/account';
 
 export class FinanceCompany {
   journalEntryRepository: JournalEntryRepository;
@@ -92,4 +93,57 @@ export class FinanceCompany {
       payload,
     );
   }
+
+  async createAccount(dbTransaction: any, account: Account) {
+    try {
+      account.validateAccountValue();
+
+      let createAccountPayload: any = {
+        Name: account.name,
+        AcctNum: account.AccountNo,
+        AccountType: account.accountType,
+        AccountSubType: account.accountSubType,
+      };
+
+      if (account.isParentAccountExsits()) {
+        createAccountPayload = {
+          ...createAccountPayload,
+          CurrencyRef: 'MYR',
+          ParentRef: account.parentAccountNo,
+          SubAccount: true,
+        };
+      }
+
+      const accSystemAccountId = await this.accountingSystem.createAccount(
+        createAccountPayload,
+      );
+
+      const newAccount = await account.save(
+        accSystemAccountId,
+        'test',
+        dbTransaction,
+      );
+
+      const payload = {
+        Action: 'Create',
+        Activity: 'Account Created',
+        Description: `Account (ID: ${newAccount.AccountNo}) has been created`,
+        EntityType: 'Account',
+        EntityValueBefore: JSON.stringify({}),
+        EntityValueAfter: JSON.stringify(newAccount),
+        PerformedById: 'test',
+        PerformedAt: new Date(),
+        EntityId: newAccount.AccountNo,
+      };
+
+      await axios.post(
+        `${process.env.COMMON_API_URL}/activity-histories`,
+        payload,
+      );
+
+      return account;
+    } catch (error) {
+      throw error;
+    }
+  }
 }