@tomei/finance 0.6.114 → 0.8.0

package/src/document/document.ts

@@ -1,1328 +0,0 @@
-import * as util from 'util';
-import * as path from 'path';
-import * as fs from 'fs';
-import * as puppeteer from 'puppeteer';
-import {
-  Medias,
-  InternalMediaDto,
-  CommonService as MediaCommonService,
-  MediaType,
-  MediasModel,
-  MediasRepository,
-} from '@tomei/media';
-import { DocumentStatus, DocType } from '../enum';
-import { IDocumentAttr } from './interfaces/document-attr.interface';
-import { IDocumentFindAll } from './interfaces/document-find-all.interface';
-import { DocumentItemRepository } from './document-item.repository';
-import DocumentItem from './document-item';
-import { AccountSystemEntity } from '../account-system-entity/account-system-entity';
-import { DocumentRepository } from './document.repository';
-import FinanceCustomerBase from '../customer/customer';
-import DocumentModel from '../models/document.entity';
-import DocumentItemModel from '../models/document-item.entity';
-import { ClassError, LoginUserBase } from '@tomei/general';
-import { ApplicationConfig } from '@tomei/config';
-import { Op } from 'sequelize';
-import { LoginUser } from '../helpers/login-user';
-import { ActionEnum, Activity } from '@tomei/activity-history';
-import { IAccountSystem } from '../interfaces/account-system.interface';
-
-export default class Document extends AccountSystemEntity {
-  DocNo = 'New';
-  private _DocType: DocType;
-  private _DocDate = new Date();
-  Currency = 'MYR';
-  private _Amount = 0;
-  Description = '';
-  private _Status = DocumentStatus.UNPAID;
-  IssuedById = '';
-  IssuedToId = '';
-  IssuedToType = '';
-  RelatedObjectId = '';
-  RelatedObjectType = '';
-  CreatedById = '';
-  CreatedAt: Date;
-  UpdatedById = '';
-  UpdatedAt: Date;
-  UseAccSystemDocYN = 'N';
-  protected _ObjectType = 'Document';
-
-  get ObjectType() {
-    return this._ObjectType;
-  }
-
-  private _DocHTMLFileMediaId = '';
-  private _DocPDFFileMediaId = '';
-
-  private static _RepositoryBase = new DocumentRepository();
-  private static _DocumentItemRepository = new DocumentItemRepository();
-  private static _AccountingSystem: IAccountSystem;
-
-  private _DbTransaction: any;
-  private _IsNewRecord = true;
-  private _DocumentItems = [];
-
-  private static _MediaRepository = new MediasRepository();
-  mediaCommonService: MediaCommonService;
-
-  private get IsNewRecord() {
-    return this._IsNewRecord;
-  }
-
-  private set IsNewRecord(record: boolean) {
-    this._IsNewRecord = record;
-  }
-
-  public get DocType() {
-    return this._DocType;
-  }
-
-  public set DocType(docType: DocType) {
-    this._DocType = docType;
-  }
-
-  public get DocDate() {
-    return this._DocDate;
-  }
-
-  public set DocDate(date: Date) {
-    this._DocDate = date;
-  }
-
-  public get DocHTMLFileMediaId() {
-    return this._DocHTMLFileMediaId;
-  }
-
-  public set DocHTMLFileMediaId(mediaId: string) {
-    this._DocHTMLFileMediaId = mediaId;
-  }
-
-  public get DocPDFFileMediaId() {
-    return this._DocPDFFileMediaId;
-  }
-
-  public set DocPDFFileMediaId(mediaId: string) {
-    this._DocPDFFileMediaId = mediaId;
-  }
-
-  public get Amount() {
-    return this._Amount;
-  }
-
-  private set Amount(amount: number) {
-    this._Amount = amount;
-  }
-
-  public get Status() {
-    return this._Status;
-  }
-
-  public set Status(status: DocumentStatus) {
-    this._Status = status;
-  }
-
-  /* AccountSystemEntity Implementation */
-  get RepositoryBase() {
-    return Document._RepositoryBase;
-  }
-
-  /* ObjectBase Implementation */
-  get ObjectId() {
-    return this.DocNo;
-  }
-
-  get ObjectName() {
-    return this.DocNo;
-  }
-
-  get TableName() {
-    return 'finance_Document';
-  }
-
-  constructor(dbTransaction?: any, documentData?: any) {
-    super();
-    if (dbTransaction) {
-      this._DbTransaction = dbTransaction;
-    }
-    if (documentData) {
-      this.DocNo = documentData.DocNo;
-      this.DocType = documentData.DocType;
-      this.DocDate = documentData.DocDate;
-      this.CompanyId = documentData.CompanyId;
-      this.Currency = documentData.Currency;
-      this.Amount = documentData.Amount;
-      this.Description = documentData.Description;
-      this.Status = documentData.Status;
-      this.IssuedById = documentData.IssuedById;
-      this.IssuedToId = documentData.IssuedToId;
-      this.IssuedToType = documentData.IssuedToType;
-      this.RelatedObjectId = documentData.RelatedObjectId;
-      this.RelatedObjectType = documentData.RelatedObjectType;
-      this.CreatedById = documentData.CreatedById;
-      this.CreatedAt = documentData.CreatedAt;
-      this.UpdatedById = documentData.UpdatedById;
-      this.UpdatedAt = documentData.UpdatedAt;
-      this.DocPDFFileMediaId = documentData.DocPDFFileMediaId;
-      this.DocHTMLFileMediaId = documentData.DocHTMLFileMediaId;
-      this.AccSystemRefId = documentData.AccSystemRefId;
-      this.PostedToAccSystemYN = documentData.PostedToAccSystemYN;
-      this.PostedById = documentData.PostedById;
-      this.PostedDateTime = documentData.PostedDateTime;
-      this.UseAccSystemDocYN = documentData.UseAccSystemDocYN;
-      this.IsNewRecord = false;
-    }
-  }
-
-  init(params: IDocumentAttr) {
-    this.DocNo = params.DocNo;
-    this.DocType = params.DocType;
-    this.DocDate = params.DocDate;
-    this.CompanyId = params.CompanyId;
-    this.Currency = params.Currency;
-    this.Amount = params.Amount;
-    this.Description = params.Description;
-    this.Status = params.Status;
-    this.IssuedById = params.IssuedById;
-    this.IssuedToId = params.IssuedToId;
-    this.IssuedToType = params.IssuedToType;
-    this.RelatedObjectId = params.RelatedObjectId;
-    this.RelatedObjectType = params.RelatedObjectType;
-    this.CreatedById = params.CreatedById;
-    this.CreatedAt = params.CreatedAt;
-    this.UpdatedById = params.UpdatedById;
-    this.UpdatedAt = params.UpdatedAt;
-    this.DocPDFFileMediaId = params.DocPDFFileMediaId;
-    this.DocHTMLFileMediaId = params.DocHTMLFileMediaId;
-    this.AccSystemRefId = params.AccSystemRefId;
-    this.PostedToAccSystemYN = params.PostedToAccSystemYN;
-    this.PostedById = params.PostedById;
-    this.PostedDateTime = params.PostedDateTime;
-    this.UseAccSystemDocYN = params.UseAccSystemDocYN;
-  }
-
-  public static async initDocument(dbTransaction: any, docNo: string) {
-    try {
-      const documentData = await this._RepositoryBase.findOne({
-        where: {
-          DocNo: docNo,
-        },
-        include: [
-          {
-            model: DocumentItemModel,
-          },
-        ],
-        transaction: dbTransaction,
-      });
-      if (documentData) {
-        const document = new Document(dbTransaction, {
-          DocNo: documentData.DocNo,
-          DocType: documentData.DocType,
-          CompanyId: documentData.CompanyId,
-          DocDate: documentData.DocDate,
-          Currency: documentData.Currency,
-          Amount: documentData.Amount,
-          Description: documentData.Description,
-          Status: documentData.Status,
-          IssuedById: documentData.IssuedById,
-          IssuedToId: documentData.IssuedToId,
-          IssuedToType: documentData.IssuedToType,
-          RelatedObjectId: documentData.RelatedObjectId,
-          RelatedObjectType: documentData.RelatedObjectType,
-          CreatedById: documentData.CreatedById,
-          CreatedAt: documentData.CreatedAt,
-          UpdatedById: documentData.UpdatedById,
-          UpdatedAt: documentData.UpdatedAt,
-          DocPDFFileMediaId: documentData.DocPDFFileMediaId,
-          DocHTMLFileMediaId: documentData.DocHTMLFileMediaId,
-          AccSystemRefId: documentData.AccSystemRefId,
-          PostedToAccSystemYN: documentData.PostedToAccSystemYN,
-          PostedById: documentData.PostedById,
-          PostedDateTime: documentData.PostedDateTime,
-          UseAccSystemDocYN: documentData.UseAccSystemDocYN,
-        });
-
-        return document;
-      } else {
-        const notFoundError = new ClassError(
-          'Document',
-          'InitDocumentErrMsg00',
-          `No Document record found.`,
-        );
-
-        throw notFoundError;
-      }
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  /**
-   * Recalculate the Amount of the Document based on all the amount of the Document Items
-   *
-   * @returns {void}
-   */
-  async reCalculateAmount(): Promise<void> {
-    const roundToTwoDecimals = (value: number): number =>
-      Math.round(value * 100) / 100;
-
-    this.Amount = 0;
-    for (const documentItem of this._DocumentItems) {
-      this.Amount = roundToTwoDecimals(this.Amount + documentItem.Amount);
-    }
-  }
-
-  get DocumentItems(): Promise<DocumentItem[]> {
-    return new Promise((resolve, reject) => {
-      if (!this.IsNewRecord) {
-        DocumentItem.initDocumentItems(this._DbTransaction, this)
-          .then((documentItems) => {
-            resolve(documentItems);
-          })
-          .catch((err) => {
-            reject(err);
-          });
-      } else {
-        resolve(this._DocumentItems);
-      }
-    });
-  }
-
-  public async getDocumentItems(dbTransaction?: any) {
-    try {
-      if (!this.IsNewRecord) {
-        const documentItems = await DocumentItem.initDocumentItems(
-          dbTransaction,
-          this,
-        );
-        this._DocumentItems = documentItems;
-      }
-      return this._DocumentItems;
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  public static async settleByCreditNote(
-    loginUser: LoginUserBase,
-    dbTransaction: any,
-    DocNo: string,
-    AmountToReduce: number,
-  ) {
-    //This method will update the document info when issue credit note event happens.
-
-    //Part 1: Validation
-    //Instantiate existing Document by passing:
-    const document = await this.initDocument(dbTransaction, DocNo);
-
-    //Make sure document.DocType equals to DocumentType.INVOICE. If not, throw new ClassError
-    if (document.DocType !== DocType.INVOICE) {
-      throw new ClassError(
-        'Document',
-        'SettleByCreditNoteErrMsgXX',
-        'Only Invoice can be issued credit note.',
-      );
-    }
-
-    //Check Params.AmountToReduce not more than document.Amount. If yes, throw ClassError
-    if (AmountToReduce > document.Amount) {
-      throw new ClassError(
-        'Document',
-        'SettleByCreditNoteErrMsgXX',
-        'Amount to reduce is more than the document amount.',
-      );
-    }
-
-    //Part 2: Update Record
-    //Set EntityValueBefore to document
-    const EntityValueBefore = {
-      DocNo: document.DocNo,
-      DocType: document.DocType,
-      CompanyId: document.CompanyId,
-      DocDate: document.DocDate,
-      Currency: document.Currency,
-      Amount: document.Amount,
-      Description: document.Description,
-      Status: document.Status,
-      IssuedById: document.IssuedById,
-      IssuedToId: document.IssuedToId,
-      IssuedToType: document.IssuedToType,
-      RelatedObjectId: document.RelatedObjectId,
-      RelatedObjectType: document.RelatedObjectType,
-      CreatedById: document.CreatedById,
-      CreatedAt: document.CreatedAt,
-      UpdatedById: document.UpdatedById,
-      UpdatedAt: document.UpdatedAt,
-      DocPDFFileMediaId: document.DocPDFFileMediaId,
-      DocHTMLFileMediaId: document.DocHTMLFileMediaId,
-      AccSystemRefId: document.AccSystemRefId,
-      PostedToAccSystemYN: document.PostedToAccSystemYN,
-      PostedById: document.PostedById,
-      PostedDateTime: document.PostedDateTime,
-      UseAccSystemDocYN: document.UseAccSystemDocYN,
-    };
-
-    //updated Status to DocumentStatus.SETTLED if Params.AmountToReduce equals to document.Amount.
-    let updatedStatus;
-    if (AmountToReduce == document.Amount) {
-      updatedStatus = DocumentStatus.SETTLED;
-    } else {
-      updatedStatus = DocumentStatus.PARTIALSETTLED;
-    }
-
-    //Call Document._Repo update method
-    await this._RepositoryBase.update(
-      {
-        Amount: AmountToReduce,
-        Status: updatedStatus,
-        UpdatedAt: document.UpdatedAt,
-        UpdatedById: document.UpdatedById,
-      },
-      {
-        where: {
-          DocNo: document.DocNo,
-        },
-        transaction: dbTransaction,
-      },
-    );
-
-    const UpdatedDocument = await this.initDocument(dbTransaction, DocNo);
-
-    //Part 3: Record Update Document Activity
-    //Initialise EntityValueAfter to UpdatedDocument
-    const EntityValueAfter = {
-      DocNo: UpdatedDocument.DocNo,
-      DocType: UpdatedDocument.DocType,
-      CompanyId: UpdatedDocument.CompanyId,
-      DocDate: UpdatedDocument.DocDate,
-      Currency: UpdatedDocument.Currency,
-      Amount: UpdatedDocument.Amount,
-      Description: UpdatedDocument.Description,
-      Status: UpdatedDocument.Status,
-      IssuedById: UpdatedDocument.IssuedById,
-      IssuedToId: UpdatedDocument.IssuedToId,
-      IssuedToType: UpdatedDocument.IssuedToType,
-      RelatedObjectId: UpdatedDocument.RelatedObjectId,
-      RelatedObjectType: UpdatedDocument.RelatedObjectType,
-      CreatedById: UpdatedDocument.CreatedById,
-      CreatedAt: UpdatedDocument.CreatedAt,
-      UpdatedById: UpdatedDocument.UpdatedById,
-      UpdatedAt: UpdatedDocument.UpdatedAt,
-      DocPDFFileMediaId: UpdatedDocument.DocPDFFileMediaId,
-      DocHTMLFileMediaId: UpdatedDocument.DocHTMLFileMediaId,
-      AccSystemRefId: UpdatedDocument.AccSystemRefId,
-      PostedToAccSystemYN: UpdatedDocument.PostedToAccSystemYN,
-      PostedById: UpdatedDocument.PostedById,
-      PostedDateTime: UpdatedDocument.PostedDateTime,
-      UseAccSystemDocYN: UpdatedDocument.UseAccSystemDocYN,
-    };
-    //Instantiate new activity
-    const activity = new Activity();
-    activity.ActivityId = activity.createId();
-    activity.Action = ActionEnum.UPDATE;
-    activity.Description = `Settle Finance Document (${UpdatedDocument._DocType}) from Credit Note.`;
-    activity.EntityType = 'FinanceCustomer';
-    activity.EntityId = DocNo;
-    activity.EntityValueBefore = JSON.stringify(EntityValueBefore);
-    activity.EntityValueAfter = JSON.stringify(EntityValueAfter);
-
-    //Call activity._Repo create method
-    await activity.create(loginUser.ObjectId, dbTransaction);
-
-    return UpdatedDocument;
-  }
-
-  /**
-   * Returns HTML template file for invoice generation
-   *
-   * @see generateInvoice - for implementation
-   *
-   * @returns {Express.Multer.File} - HTML File
-   */
-  public static async DEFAULT_INVOICE_TEMPLATE_HTML(): Promise<Express.Multer.File> {
-    /* getting invoice template in HTML format */
-    const templateLocation = path.resolve('./invoice-template/index.html');
-    const readFileContent = util.promisify(fs.readFile);
-    const htmlBuffer = await readFileContent(templateLocation);
-
-    const htmlStream: Express.Multer.File = {
-      buffer: htmlBuffer,
-      fieldname: 'FileStream',
-      originalname: 'index.html',
-      mimetype: 'text/html',
-      size: htmlBuffer.length,
-      encoding: '8bit',
-      filename: 'sample-invoice.html',
-      destination: path.dirname(templateLocation),
-      path: '',
-      stream: null,
-    };
-
-    return htmlStream;
-  }
-
-  /**
-   * Returns PDF template file for invoice generation
-   *
-   * @remarks - This function is converting generated HTML into PDF
-   *
-   * @see generateInvoice - for implementation
-   *
-   * @returns {Express.Multer.File} - PDF File
-   */
-  public async DEFAULT_INVOICE_TEMPLATE_PDF(
-    customer: FinanceCustomerBase,
-    date: Date = new Date(),
-  ): Promise<Express.Multer.File> {
-    /* prepping HTML conversion by getting its URL and String */
-
-    /* todo: needs to generate HTML first before converting to PDF */
-    const templateLocation = path.resolve('./invoice-template/index.html');
-    const cssLocation = path.resolve('./invoice-template/assets/css/style.css');
-    const readFileContent = util.promisify(fs.readFile);
-    // const htmlString = await readFileContent(templateLocation, 'utf8');
-    const [htmlString] = await Promise.all([
-      readFileContent(templateLocation, 'utf8'),
-    ]);
-
-    /* converting HTML to PDF */
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: ['--no-sandbox', '--disable-setuid-sandbox'],
-    });
-    const page = await browser.newPage();
-
-    const imagePath = path.resolve(
-      './invoice-template/assets/img/ezcash-logo.svg',
-    );
-    const imageBuffer = await readFileContent(imagePath);
-    const imageDataUrl = `data:image/svg+xml;base64,${imageBuffer.toString(
-      'base64',
-    )}`;
-
-    const imgTag = `<img src="${imageDataUrl}" alt="Logo">`;
-
-    await page.setContent(htmlString);
-    await page.addStyleTag({ path: cssLocation });
-
-    // Replace the <img> tag with the new image
-    const divHandle = await page.$('.tm_logo');
-    await divHandle.evaluate((div, imgTag) => {
-      div.innerHTML = imgTag;
-    }, imgTag);
-
-    // Get the current date and invoice number from customer
-    const currentDate = date.toLocaleDateString('en-GB');
-    const invoiceNo = this.DocNo;
-
-    // Update the invoice number and date in the HTML content
-    const invoiceTitleInfo = `
-    <div class="tm_invoice_seperator tm_gray_bg"></div>
-    <div class="tm_invoice_info_list">
-      <p class="tm_invoice_number tm_m0">
-        Invoice No: <b class="tm_primary_color">${invoiceNo}</b>
-      </p>
-      <p class="tm_invoice_date tm_m0">
-        Date: <b class="tm_primary_color">${currentDate}</b>
-      </p>
-    </div>
-  `;
-    const invoiceTitleInfoHandle = await page.$('.tm_invoice_info');
-    await invoiceTitleInfoHandle.evaluate((invoice, invoiceTitleInfo) => {
-      invoice.innerHTML = invoiceTitleInfo;
-    }, invoiceTitleInfo);
-
-    // Update the invoice customer detail in the HTML content
-    const invoiceCustomerContent = `
-    <p class="tm_mb2">
-      <b class="tm_primary_color">Invoice To:</b>
-    </p>
-    <p>
-      ${customer.FullName} <br />
-      ${customer.DefaultAddress.Address}, ${customer.DefaultAddress.City} <br />
-      ${customer.DefaultAddress.Country} <br />
-      ${customer.Email}
-    </p>
-    `;
-    const invoiceCustomerHandle = await page.$('.tm_customer_detail');
-    await invoiceCustomerHandle.evaluate((invoice, invoiceCustomerContent) => {
-      invoice.innerHTML = invoiceCustomerContent;
-    }, invoiceCustomerContent);
-
-    // Update the invoice Pay To details in the HTML content
-    const invoicePayToContent = ``;
-    const invoicePayToHandle = await page.$('.tm_payto_detail');
-    await invoicePayToHandle.evaluate((invoice, invoicePayToContent) => {
-      invoice.innerHTML = invoicePayToContent;
-    }, invoicePayToContent);
-
-    // Update the invoice payment info in the HTML content
-    const invoicePaymentInfoContent = ``;
-    const invoicePaymentInfoHandle = await page.$('.tm_payment_info');
-    await invoicePaymentInfoHandle.evaluate(
-      (invoice, invoicePaymentInfoContent) => {
-        invoice.innerHTML = invoicePaymentInfoContent;
-      },
-      invoicePaymentInfoContent,
-    );
-
-    // Update the invoice right footer content in the HTML content
-    const invoiceSubtotal = +this.Amount;
-    const invoiceTax = 0;
-    const invoiceRightFooterContent = `
-    <table>
-      <tbody>
-        <tr>
-          <td
-            class="tm_width_3 tm_primary_color tm_border_none tm_bold"
-          >
-            Subtotal
-          </td>
-          <td
-            class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_bold"
-          >
-            ${this.Currency} ${invoiceSubtotal.toFixed(2)}
-          </td>
-        </tr>
-        <tr>
-          <td
-            class="tm_width_3 tm_primary_color tm_border_none tm_pt0"
-          >
-            Tax <span class="tm_ternary_color">(0%)</span>
-          </td>
-          <td
-            class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_pt0"
-          >
-            ${this.Currency} ${invoiceTax.toFixed(2)}
-          </td>
-        </tr>
-        <tr class="tm_border_top tm_border_bottom">
-          <td
-            class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color"
-          >
-            Grand Total
-          </td>
-          <td
-            class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color tm_text_right"
-          >
-            ${this.Currency} ${(invoiceSubtotal + invoiceTax).toFixed(2)}
-          </td>
-        </tr>
-      </tbody>
-    </table>
-    `;
-    const invoiceRightFooterHandle = await page.$('.tm_item_total_section');
-    await invoiceRightFooterHandle.evaluate(
-      (invoice, invoiceRightFooterContent) => {
-        invoice.innerHTML = invoiceRightFooterContent;
-      },
-      invoiceRightFooterContent,
-    );
-
-    // Update the invoice Terms & Agreement content in the HTML content
-    const invoiceTNCContent = `
-    <li>
-      All payment must be made to:
-      <ul>
-        <li>Bank: <b>RHB BANK BHD</b></li>
-        <li>Account Name: <b>TXG Financial Solutions Sdn Bhd</b></li>
-        <li>Account No.: <b>2142 13000 17954</b></li>
-      </ul>
-    </li>
-    <li>
-      Once payment has been made, please email your transaction confirmation slip to <i>payment@ezcash.com.my</i>
-    </li>
-    `;
-    const invoiceTNCHandle = await page.$('.tm_tnc_content');
-    await invoiceTNCHandle.evaluate((invoice, invoiceTNCContent) => {
-      invoice.innerHTML = invoiceTNCContent;
-    }, invoiceTNCContent);
-
-    // Update the invoice items content in the HTML content
-    const invoiceDocumentItems = await this.DocumentItems;
-
-    let invoiceItemContent = ``;
-    invoiceDocumentItems.forEach((documentItem, i) => {
-      invoiceItemContent += `
-      <tr>
-        <td class="tm_width_3">${i + 1}. ${documentItem.Name}</td>
-        <td class="tm_width_4">
-          ${documentItem.Description}
-        </td>
-        <td class="tm_width_2">${documentItem.Currency} ${
-          documentItem.UnitPrice
-        }</td>
-        <td class="tm_width_1">${documentItem.Quantity}</td>
-        <td class="tm_width_2 tm_text_right">${documentItem.Currency} ${(
-          +documentItem.UnitPrice * +documentItem.Quantity
-        ).toFixed(2)}</td>
-      </tr>
-      `;
-    });
-    const invoiceDocumentItemHandle = await page.$('.tm_items_content');
-    await invoiceDocumentItemHandle.evaluate((invoice, invoiceItemContent) => {
-      invoice.innerHTML = invoiceItemContent;
-    }, invoiceItemContent);
-
-    const pdfBuffer = await page.pdf({
-      format: 'a4',
-      printBackground: true,
-      margin: {
-        left: '0px',
-        top: '0px',
-        right: '0px',
-        bottom: '0px',
-      },
-    });
-
-    // Convert Uint8Array to Buffer
-    const pdfBufferAsBuffer = Buffer.from(pdfBuffer);
-
-    const pdfStream: Express.Multer.File = {
-      buffer: pdfBufferAsBuffer,
-      fieldname: 'FileStream',
-      originalname: 'sample-invoice.pdf',
-      mimetype: 'application/pdf',
-      size: pdfBuffer.length,
-      encoding: '8bit',
-      filename: 'sample-invoice.pdf',
-      destination: '',
-      path: '',
-      stream: null,
-    };
-
-    return pdfStream;
-  }
-
-  /**
-   * Returns PDF template file for receipt generation
-   *
-   * @remarks - This function is converting generated HTML into PDF
-   *
-   * @see generateReceipt - for implementation
-   *
-   * @returns {Express.Multer.File} - PDF File
-   */
-  public async DEFAULT_RECEIPT_TEMPLATE_PDF(
-    customer: FinanceCustomerBase,
-    date: Date = new Date(),
-  ): Promise<Express.Multer.File> {
-    /* prepping HTML conversion by getting its URL and String */
-
-    /* todo: needs to generate HTML first before converting to PDF */
-    const templateLocation = path.resolve('./invoice-template/index.html');
-    const cssLocation = path.resolve('./invoice-template/assets/css/style.css');
-    const readFileContent = util.promisify(fs.readFile);
-    // const htmlString = await readFileContent(templateLocation, 'utf8');
-    const [htmlString] = await Promise.all([
-      readFileContent(templateLocation, 'utf8'),
-    ]);
-
-    /* converting HTML to PDF */
-    const browser = await puppeteer.launch({
-      headless: true,
-      args: ['--no-sandbox', '--disable-setuid-sandbox'],
-    });
-    const page = await browser.newPage();
-
-    const imagePath = path.resolve(
-      './invoice-template/assets/img/ezcash-logo.svg',
-    );
-    const imageBuffer = await readFileContent(imagePath);
-    const imageDataUrl = `data:image/svg+xml;base64,${imageBuffer.toString(
-      'base64',
-    )}`;
-
-    const imgTag = `<img src="${imageDataUrl}" alt="Logo">`;
-
-    await page.setContent(htmlString);
-    await page.addStyleTag({ path: cssLocation });
-
-    // Replace the <img> tag with the new image
-    const divHandle = await page.$('.tm_logo');
-    await divHandle.evaluate((div, imgTag) => {
-      div.innerHTML = imgTag;
-    }, imgTag);
-
-    // Get the current date and recei[t] number from customer
-    const currentDate = date.toLocaleDateString('en-GB');
-    const receiptNo = this.DocNo;
-
-    // Change and update from invoice template title to receipt title
-    const receiptTitle = `
-    <div class="tm_primary_color tm_f50 tm_text_uppercase">
-      Receipt
-    </div>
-    `;
-    const receiptTitleHandle = await page.$('.tm_invoice_title');
-    await receiptTitleHandle.evaluate((receipt, receiptTitle) => {
-      receipt.innerHTML = receiptTitle;
-    }, receiptTitle);
-
-    // Update the receipt number and date in the HTML content
-    const receiptTitleInfo = `
-  <div class="tm_invoice_seperator tm_gray_bg"></div>
-  <div class="tm_invoice_info_list">
-    <p class="tm_invoice_number tm_m0">
-      Receipt No: <b class="tm_primary_color">${receiptNo}</b>
-    </p>
-    <p class="tm_invoice_date tm_m0">
-      Date: <b class="tm_primary_color">${currentDate}</b>
-    </p>
-  </div>
-`;
-    const receiptTitleInfoHandle = await page.$('.tm_invoice_info');
-    await receiptTitleInfoHandle.evaluate((receipt, receiptTitleInfo) => {
-      receipt.innerHTML = receiptTitleInfo;
-    }, receiptTitleInfo);
-
-    // Update the receipt customer detail in the HTML content
-    const receiptCustomerContent = `
-  <p class="tm_mb2">
-    <b class="tm_primary_color">Issued To:</b>
-  </p>
-  <p>
-    ${customer.FullName} <br />
-    ${customer.DefaultAddress.Address}, ${customer.DefaultAddress.City} <br />
-    ${customer.DefaultAddress.Country} <br />
-    ${customer.Email}
-  </p>
-  `;
-    const receiptCustomerHandle = await page.$('.tm_customer_detail');
-    await receiptCustomerHandle.evaluate((receipt, receiptCustomerContent) => {
-      receipt.innerHTML = receiptCustomerContent;
-    }, receiptCustomerContent);
-
-    // Remove the receipt Pay To details in the HTML content
-    const receiptPayToContent = ``;
-    const receiptPayToHandle = await page.$('.tm_payto_detail');
-    await receiptPayToHandle.evaluate((receipt, receiptPayToContent) => {
-      receipt.innerHTML = receiptPayToContent;
-    }, receiptPayToContent);
-
-    // Remove the receipt payment info in the HTML content
-    const receiptPaymentInfoContent = ``;
-    const receiptPaymentInfoHandle = await page.$('.tm_payment_info');
-    await receiptPaymentInfoHandle.evaluate(
-      (receipt, receiptPaymentInfoContent) => {
-        receipt.innerHTML = receiptPaymentInfoContent;
-      },
-      receiptPaymentInfoContent,
-    );
-
-    // Update the receipt right footer content in the HTML content
-    const receiptSubtotal = +this.Amount;
-    const receiptTax = 0;
-    const receiptRightFooterContent = `
-  <table>
-    <tbody>
-      <tr>
-        <td
-          class="tm_width_3 tm_primary_color tm_border_none tm_bold"
-        >
-          Subtotal
-        </td>
-        <td
-          class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_bold"
-        >
-          ${this.Currency} ${receiptSubtotal}
-        </td>
-      </tr>
-      <tr>
-        <td
-          class="tm_width_3 tm_primary_color tm_border_none tm_pt0"
-        >
-          Tax <span class="tm_ternary_color">(0%)</span>
-        </td>
-        <td
-          class="tm_width_3 tm_primary_color tm_text_right tm_border_none tm_pt0"
-        >
-          ${this.Currency} ${receiptTax}
-        </td>
-      </tr>
-      <tr class="tm_border_top tm_border_bottom">
-        <td
-          class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color"
-        >
-          Grand Total
-        </td>
-        <td
-          class="tm_width_3 tm_border_top_0 tm_bold tm_f16 tm_primary_color tm_text_right"
-        >
-          ${this.Currency} ${receiptSubtotal + receiptTax}
-        </td>
-      </tr>
-    </tbody>
-  </table>
-  `;
-    const receiptRightFooterHandle = await page.$('.tm_item_total_section');
-    await receiptRightFooterHandle.evaluate(
-      (receipt, receiptRightFooterContent) => {
-        receipt.innerHTML = receiptRightFooterContent;
-      },
-      receiptRightFooterContent,
-    );
-
-    // Update the receipt items content in the HTML content
-    const receiptDocumentItems = await this.DocumentItems;
-
-    let receiptItemContent = ``;
-    receiptDocumentItems.forEach((documentItem, i) => {
-      receiptItemContent += `
-    <tr>
-      <td class="tm_width_3">${i + 1}. ${documentItem.Name}</td>
-      <td class="tm_width_4">
-        ${documentItem.Description}
-      </td>
-      <td class="tm_width_2">${documentItem.Currency} ${
-        documentItem.UnitPrice
-      }</td>
-      <td class="tm_width_1">${documentItem.Quantity}</td>
-      <td class="tm_width_2 tm_text_right">${documentItem.Currency} ${
-        +documentItem.UnitPrice * +documentItem.Quantity
-      }</td>
-    </tr>
-    `;
-    });
-    const receiptDocumentItemHandle = await page.$('.tm_items_content');
-    await receiptDocumentItemHandle.evaluate((receipt, receiptItemContent) => {
-      receipt.innerHTML = receiptItemContent;
-    }, receiptItemContent);
-
-    // Update the receipt Terms & Agreement content in the HTML content
-    const receiptFooterContent = `
-    <p class="tm_mb5 tm_text_center tm_f11">
-      <i>
-       Thank you for your payment. This is computer generated receipt
-       - no signature is required.
-     </i>
-   </p>
-    `;
-    const receiptFooterHandle = await page.$('.tm_footer_section');
-    await receiptFooterHandle.evaluate((receipt, receiptFooterContent) => {
-      receipt.innerHTML = receiptFooterContent;
-    }, receiptFooterContent);
-
-    const pdfBuffer = await page.pdf({
-      format: 'a4',
-      printBackground: true,
-      margin: {
-        left: '0px',
-        top: '0px',
-        right: '0px',
-        bottom: '0px',
-      },
-    });
-
-    // Convert Uint8Array to Buffer
-    const pdfBufferAsBuffer = Buffer.from(pdfBuffer);
-
-    const pdfStream: Express.Multer.File = {
-      buffer: pdfBufferAsBuffer,
-      fieldname: 'FileStream',
-      originalname: 'sample-invoice.pdf',
-      mimetype: 'application/pdf',
-      size: pdfBuffer.length,
-      encoding: '8bit',
-      filename: 'sample-invoice.pdf',
-      destination: '',
-      path: '',
-      stream: null,
-    };
-
-    return pdfStream;
-  }
-
-  /**
-   * Returns the media representing the document in HTML format
-   *
-   * @returns {MediasModel} - Invoice Media in HTML Format
-   */
-  public get DocumentFileInHTML(): Promise<MediasModel> {
-    return (async () => {
-      const { HTMLMedia } = await this.generateInvoice();
-
-      return HTMLMedia;
-    })();
-  }
-
-  /**
-   * Returns the media representing the document in PDF format
-   *
-   * @returns {MediasModel} - Invoice Media in PDF Format
-   */
-  public get DocumentFileInPDF(): Promise<MediasModel> {
-    return (async () => {
-      const { PDFMedia } = await this.generateInvoice();
-
-      return PDFMedia;
-    })();
-  }
-
-  /**
-   * Returns generated HTML & PDF Invoice Media
-   *
-   * @remarks - This function also create each media element in common_Media table
-   *
-   * @see DocumentFileInHTML - for implementation
-   * @see DocumentFileInPDF - for implementation
-   *
-   * @see {@link FinanceCompany.issueInvoice} - for implementation
-   *
-   * @param userId - userId that trigger this function
-   *
-   * @returns {MediasModel} - HTML & PDF Media
-   */
-  async generateInvoice(
-    userId?: string,
-    customer?: FinanceCustomerBase,
-    dbTransaction?: any,
-    date?: Date,
-  ): Promise<{
-    HTMLMedia: MediasModel;
-    PDFMedia: MediasModel;
-  }> {
-    const media: Medias = new Medias(this.mediaCommonService);
-
-    /* insert FileStream on htmlPayload  */
-    const htmlPayload: InternalMediaDto = {
-      ObjectId: this.DocNo,
-      ObjectType: 'Document',
-      Type: MediaType.Document,
-      FileName: `${this.DocType}-${this.DocNo}`,
-      FileStream: await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
-      FileExtension: 'html',
-      Title: `${this.DocType}-${this.DocNo}.html`,
-      Description: `HTML ${this.DocType}`,
-      IsEncryptedYN: 'N',
-    };
-    const user = new LoginUser(userId ?? 'System', null, null);
-
-    /* create HTML media of the generated HTML */
-    const HTMLInvoiceMedia = await media.postInternal(
-      await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
-      htmlPayload,
-      user as any,
-      dbTransaction,
-    );
-
-    /* insert FileStream on pdfPayload  */
-    const pdfPayload: InternalMediaDto = {
-      ObjectId: this.DocNo,
-      ObjectType: 'Document',
-      Type: MediaType.Document,
-      FileName: `${this.DocType}-${this.DocNo}`,
-      FileStream: await this.DEFAULT_INVOICE_TEMPLATE_PDF(customer, date),
-      FileExtension: 'pdf',
-      Title: `${this.DocType}-${this.DocNo}.pdf`,
-      Description: `PDF ${this.DocType}`,
-      IsEncryptedYN: 'N',
-    };
-
-    /* create PDF media from the converted HTML */
-    const PDFInvoiceMedia = await media.postInternal(
-      await this.DEFAULT_INVOICE_TEMPLATE_PDF(customer, date),
-      pdfPayload,
-      user as any,
-      dbTransaction,
-    );
-
-    /*Below is commented because the current implentation flow does not add up (PLEASE DON'T DELETE)*/
-    // try {
-    //   const document = await this.RepositoryBase.findOne({
-    //     where: {
-    //       DocNo: this.DocNo,
-    //     },
-    //     transaction: this._DbTransaction,
-    //   });
-
-    //   /* storing HTML & PDF MediaId to finance_Document */
-    //   document.DocHTMLFileMediaId = HTMLInvoiceMedia.MediaId;
-    //   document.DocPDFFileMediaId = PDFInvoiceMedia.MediaId;
-
-    //   await document.save({ transaction: this._DbTransaction });
-    // } catch (err) {
-    //   // tslint:disable-next-line:no-console
-    //   console.log(err);
-    // }
-
-    return {
-      HTMLMedia: HTMLInvoiceMedia,
-      PDFMedia: PDFInvoiceMedia,
-    };
-  }
-
-  /**
-   * Returns generated HTML & PDF Receipt Media
-   *
-   * @remarks - This function also create each media element in common_Media table
-   *
-   * @see DocumentFileInHTML - for implementation
-   *
-   * @param userId - userId that trigger this function
-   *
-   * @returns {MediasModel} - HTML & PDF Media
-   */
-  async generateReceipt(
-    userId?: string,
-    customer?: FinanceCustomerBase,
-    transaction?: any,
-    date?: Date,
-  ): Promise<{
-    HTMLMedia: MediasModel;
-    PDFMedia: MediasModel;
-  }> {
-    const media: Medias = new Medias(this.mediaCommonService);
-    const user = new LoginUser(userId ?? 'System', null, null);
-    /* insert FileStream on htmlPayload  */
-    const htmlPayload: InternalMediaDto = {
-      ObjectId: this.DocNo,
-      ObjectType: 'Document',
-      Type: MediaType.Document,
-      FileName: `${this.DocType}-${this.DocNo}`,
-      FileStream: await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
-      FileExtension: 'html',
-      Title: `${this.DocType}-${this.DocNo}.html`,
-      Description: `HTML ${this.DocType}`,
-      IsEncryptedYN: 'N',
-    };
-
-    /* create HTML media of the generated HTML */
-    const HTMLInvoiceMedia = await media.postInternal(
-      await Document.DEFAULT_INVOICE_TEMPLATE_HTML(),
-      htmlPayload,
-      user as any,
-      transaction,
-    );
-
-    /* insert FileStream on pdfPayload  */
-    const pdfPayload: InternalMediaDto = {
-      ObjectId: this.DocNo,
-      ObjectType: 'Document',
-      Type: MediaType.Document,
-      FileName: `${this.DocType}-${this.DocNo}`,
-      FileStream: await this.DEFAULT_RECEIPT_TEMPLATE_PDF(customer, date),
-      FileExtension: 'pdf',
-      Title: `${this.DocType}-${this.DocNo}.pdf`,
-      Description: `PDF ${this.DocType}`,
-      IsEncryptedYN: 'N',
-    };
-
-    /* create PDF media from the converted HTML */
-    const PDFInvoiceMedia = await media.postInternal(
-      await this.DEFAULT_RECEIPT_TEMPLATE_PDF(customer, date),
-      pdfPayload,
-      user as any,
-      transaction,
-    );
-
-    return {
-      HTMLMedia: HTMLInvoiceMedia,
-      PDFMedia: PDFInvoiceMedia,
-    };
-  }
-
-  async generateCreditNote(userId?: string, customer?: FinanceCustomerBase) {
-    console.log(userId, customer, '<< generateCreditNote');
-  }
-
-  /**
-   * Create a new Document Item which is automatically added to the DocumentItems list
-   * @param documentItem
-   *
-   * @returns {DocumentItem}
-   */
-  async newDocumentItem(documentItem?: DocumentItem): Promise<DocumentItem> {
-    let di: DocumentItem;
-    if (documentItem) {
-      di = documentItem;
-    } else {
-      di = new DocumentItem(this._DbTransaction, this);
-    }
-    di.DocNo = this.DocNo;
-    this._DocumentItems.push(di);
-    this.reCalculateAmount();
-    return documentItem;
-  }
-
-  /**
-   * this is temporary method to get the latest previous document
-   *
-   * @see SimpleLoans.BillLatePaymentCharges - for implementation
-   *
-   * @param docType - The document type
-   *
-   * @returns {DocumentModel}
-   */
-  async getPreviousDocument(docType: DocType): Promise<DocumentModel> {
-    return await this.RepositoryBase.findOne({
-      where: {
-        DocType: docType,
-      },
-      order: [['CreatedAt', 'DESC']],
-    });
-  }
-
-  /**
-   * Retrieve a list of documents from the database.
-   *
-   * @param loginUser - The user who is issuing the request.
-   * @param dbTransaction - The database transaction to be used, if any.
-   * @param page - Optional. The page number for paginated results.
-   * @param row - Optional. The number of rows to retrieve per page.
-   * @param search - Optional. An object containing search criteria.
-   *
-   * @returns {count: number, rows: DocumentModel[]} - An object containing the count of matching documents and an array of DocumentModel objects.
-   * @throws {Error} - If the user does not have the required privilege or if an error occurs during the operation.
-   */
-  public static async findAll(
-    loginUser: LoginUserBase,
-    dbTransaction: any,
-    page?: number,
-    row?: number,
-    search?: IDocumentFindAll,
-    order?: [string, string][],
-    accountingSystem?: IAccountSystem,
-  ): Promise<{ count: number; rows: DocumentModel[] }> {
-    try {
-      const systemCode =
-        ApplicationConfig.getComponentConfigValue('system-code');
-
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'Invoice - View',
-      );
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Document',
-          'DocumentFindAllErrMsg00',
-          `You do not have 'Invoice - View' privilege.`,
-        );
-      }
-
-      let options: any = {
-        transaction: dbTransaction,
-        order: [['CreatedAt', 'DESC']],
-      };
-
-      /*Create an object to store search criteria*/
-      const searchObj: IDocumentFindAll | any = {};
-
-      /*Apply search filters if they are provided*/
-      if (search?.DocNo) {
-        searchObj.DocNo = search.DocNo;
-      }
-
-      if (search?.DocType) {
-        searchObj.DocType = search.DocType;
-      }
-
-      if (search?.StartDate) {
-        searchObj.DocDate = {
-          ...searchObj.DocDate,
-          [Op.gte]: new Date(search.StartDate).toISOString(),
-        };
-      }
-
-      if (search?.EndDate) {
-        searchObj.DocDate = {
-          ...searchObj.DocDate,
-          [Op.lte]: new Date(search.EndDate).toISOString(),
-        };
-      }
-
-      if (search?.IssuedToId) {
-        searchObj.IssuedToId = search.IssuedToId;
-      }
-
-      if (search?.IssuedToType) {
-        searchObj.IssuedToType = search.IssuedToType;
-      }
-
-      if (search?.Status) {
-        searchObj.Status = search.Status;
-      }
-
-      if (search?.RelatedObjectId) {
-        searchObj.RelatedObjectId = search.RelatedObjectId;
-      }
-      if (search?.RelatedObjectType) {
-        searchObj.RelatedObjectType = search.RelatedObjectType;
-      }
-      if (search?.Description) {
-        searchObj.Description = search.Description;
-      }
-
-      /*If pagination is requested, update query options*/
-      if (page && row) {
-        options = {
-          ...options,
-          limit: row,
-          offset: row * (page - 1),
-        };
-      }
-
-      if (order) {
-        options = {
-          ...options,
-          order: order,
-        };
-      }
-
-      /*If search criteria exist, add them to the query options*/
-      if (Object.keys(searchObj).length) {
-        options = {
-          ...options,
-          where: searchObj,
-        };
-      }
-
-      /*Retrieve documents from the database with pagination and search filters applied*/
-      let documents =
-        await Document._RepositoryBase.findAllWithPagination(options);
-
-      let isChangesExit = false;
-
-      for (let i = 0; i < documents?.rows?.length; i++) {
-        const doc = await documents?.rows[i];
-        if (doc.UseAccSystemDocYN.toLowerCase() === 'y') {
-          console.log(doc.UseAccSystemDocYN.toLowerCase());
-
-          if (accountingSystem === null || accountingSystem === undefined) {
-            throw new ClassError(
-              'Document',
-              'DocumentFindAllErrMsg01',
-              `Accounting System is not set`,
-            );
-          }
-          const invoiceStatus = await accountingSystem.getInvoiceStatus(
-            doc.AccSystemRefId,
-          );
-          if (doc.Status !== invoiceStatus) {
-            doc.Status = invoiceStatus;
-            await this._RepositoryBase.update(
-              {
-                Status: invoiceStatus,
-              },
-              {
-                where: {
-                  DocNo: doc.DocNo,
-                },
-                transaction: dbTransaction,
-              },
-            );
-            isChangesExit = true;
-          }
-        }
-      }
-
-      if (isChangesExit) {
-        documents =
-          await Document._RepositoryBase.findAllWithPagination(options);
-      }
-
-      return documents; // make sure the returned data is updated
-    } catch (error) {
-      throw error;
-    }
-  }
-}