feat: advanced payments

packages/server/src/services/Sales/PaymentReceives/PaymentReceiveGLEntries.ts

@@ -1,19 +1,14 @@
 import { Service, Inject } from 'typedi';
-import { sumBy } from 'lodash';
 import { Knex } from 'knex';
 import Ledger from '@/services/Accounting/Ledger';
 import TenancyService from '@/services/Tenancy/TenancyService';
-import {
-  IPaymentReceive,
-  ILedgerEntry,
-  AccountNormal,
-  IPaymentReceiveGLCommonEntry,
-} from '@/interfaces';
+import { IPaymentReceive, ILedgerEntry, AccountNormal } from '@/interfaces';
 import LedgerStorageService from '@/services/Accounting/LedgerStorageService';
 import { TenantMetadata } from '@/system/models';
+import { PaymentReceivedGLCommon } from './PaymentReceivedGLCommon';
 
 @Service()
-export class PaymentReceiveGLEntries {
+export class PaymentReceiveGLEntries extends PaymentReceivedGLCommon {
   @Inject()
   private tenancy: TenancyService;
 
@@ -22,9 +17,9 @@ export class PaymentReceiveGLEntries {
 
   /**
    * Writes payment GL entries to the storage.
-   * @param   {number} tenantId
-   * @param   {number} paymentReceiveId
-   * @param   {Knex.Transaction} trx
+   * @param {number} tenantId - Tenant id.
+   * @param {number} paymentReceiveId - Payment received id.
+   * @param {Knex.Transaction} trx - Knex transaction.
    * @returns {Promise<void>}
    */
   public writePaymentGLEntries = async (
@@ -34,14 +29,19 @@ export class PaymentReceiveGLEntries {
   ): Promise<void> => {
     const { PaymentReceive } = this.tenancy.models(tenantId);
 
-    // Retrieves the given tenant metadata.
-    const tenantMeta = await TenantMetadata.query().findOne({ tenantId });
-
     // Retrieves the payment receive with associated entries.
     const paymentReceive = await PaymentReceive.query(trx)
       .findById(paymentReceiveId)
       .withGraphFetched('entries.invoice');
 
+      // Cannot continue if the received payment is unearned revenue type,
+      // that type of transactions have different type of GL entries.
+    if (paymentReceive.unearnedRevenueAccountId) {
+      return;
+    }
+    // Retrieves the given tenant metadata.
+    const tenantMeta = await TenantMetadata.query().findOne({ tenantId });
+
     // Retrives the payment receive ledger.
     const ledger = await this.getPaymentReceiveGLedger(
       tenantId,
@@ -53,25 +53,6 @@ export class PaymentReceiveGLEntries {
     await this.ledgerStorage.commit(tenantId, ledger, trx);
   };
 
-  /**
-   * Reverts the given payment receive GL entries.
-   * @param {number} tenantId
-   * @param {number} paymentReceiveId
-   * @param {Knex.Transaction} trx
-   */
-  public revertPaymentGLEntries = async (
-    tenantId: number,
-    paymentReceiveId: number,
-    trx?: Knex.Transaction
-  ) => {
-    await this.ledgerStorage.deleteByReference(
-      tenantId,
-      paymentReceiveId,
-      'PaymentReceive',
-      trx
-    );
-  };
-
   /**
    * Rewrites the given payment receive GL entries.
    * @param {number} tenantId
@@ -92,10 +73,10 @@ export class PaymentReceiveGLEntries {
 
   /**
    * Retrieves the payment receive general ledger.
-   * @param   {number} tenantId -
-   * @param   {IPaymentReceive} paymentReceive -
-   * @param   {string} baseCurrencyCode -
-   * @param   {Knex.Transaction} trx -
+   * @param {number} tenantId -
+   * @param {IPaymentReceive} paymentReceive -
+   * @param {string} baseCurrencyCode -
+   * @param {Knex.Transaction} trx -
    * @returns {Ledger}
    */
   public getPaymentReceiveGLedger = async (
@@ -126,100 +107,9 @@ export class PaymentReceiveGLEntries {
     return new Ledger(ledgerEntries);
   };
 
-  /**
-   * Calculates the payment total exchange gain/loss.
-   * @param   {IBillPayment} paymentReceive - Payment receive with entries.
-   * @returns {number}
-   */
-  private getPaymentExGainOrLoss = (
-    paymentReceive: IPaymentReceive
-  ): number => {
-    return sumBy(paymentReceive.entries, (entry) => {
-      const paymentLocalAmount =
-        entry.paymentAmount * paymentReceive.exchangeRate;
-      const invoicePayment = entry.paymentAmount * entry.invoice.exchangeRate;
-
-      return paymentLocalAmount - invoicePayment;
-    });
-  };
-
-  /**
-   * Retrieves the common entry of payment receive.
-   * @param   {IPaymentReceive} paymentReceive
-   * @returns {}
-   */
-  private getPaymentReceiveCommonEntry = (
-    paymentReceive: IPaymentReceive
-  ): IPaymentReceiveGLCommonEntry => {
-    return {
-      debit: 0,
-      credit: 0,
-
-      currencyCode: paymentReceive.currencyCode,
-      exchangeRate: paymentReceive.exchangeRate,
-
-      transactionId: paymentReceive.id,
-      transactionType: 'PaymentReceive',
-
-      transactionNumber: paymentReceive.paymentReceiveNo,
-      referenceNumber: paymentReceive.referenceNo,
-
-      date: paymentReceive.paymentDate,
-      userId: paymentReceive.userId,
-      createdAt: paymentReceive.createdAt,
-
-      branchId: paymentReceive.branchId,
-    };
-  };
-
-  /**
-   * Retrieves the payment exchange gain/loss entry.
-   * @param   {IPaymentReceive} paymentReceive -
-   * @param   {number} ARAccountId -
-   * @param   {number} exchangeGainOrLossAccountId -
-   * @param   {string} baseCurrencyCode -
-   * @returns {ILedgerEntry[]}
-   */
-  private getPaymentExchangeGainLossEntry = (
-    paymentReceive: IPaymentReceive,
-    ARAccountId: number,
-    exchangeGainOrLossAccountId: number,
-    baseCurrencyCode: string
-  ): ILedgerEntry[] => {
-    const commonJournal = this.getPaymentReceiveCommonEntry(paymentReceive);
-    const gainOrLoss = this.getPaymentExGainOrLoss(paymentReceive);
-    const absGainOrLoss = Math.abs(gainOrLoss);
-
-    return gainOrLoss
-      ? [
-          {
-            ...commonJournal,
-            currencyCode: baseCurrencyCode,
-            exchangeRate: 1,
-            debit: gainOrLoss > 0 ? absGainOrLoss : 0,
-            credit: gainOrLoss < 0 ? absGainOrLoss : 0,
-            accountId: ARAccountId,
-            contactId: paymentReceive.customerId,
-            index: 3,
-            accountNormal: AccountNormal.CREDIT,
-          },
-          {
-            ...commonJournal,
-            currencyCode: baseCurrencyCode,
-            exchangeRate: 1,
-            credit: gainOrLoss > 0 ? absGainOrLoss : 0,
-            debit: gainOrLoss < 0 ? absGainOrLoss : 0,
-            accountId: exchangeGainOrLossAccountId,
-            index: 3,
-            accountNormal: AccountNormal.DEBIT,
-          },
-        ]
-      : [];
-  };
-
   /**
    * Retrieves the payment deposit GL entry.
-   * @param   {IPaymentReceive} paymentReceive
+   * @param {IPaymentReceive} paymentReceive
    * @returns {ILedgerEntry}
    */
   private getPaymentDepositGLEntry = (
@@ -238,8 +128,8 @@ export class PaymentReceiveGLEntries {
 
   /**
    * Retrieves the payment receivable entry.
-   * @param   {IPaymentReceive} paymentReceive
-   * @param   {number} ARAccountId
+   * @param {IPaymentReceive} paymentReceive
+   * @param {number} ARAccountId
    * @returns {ILedgerEntry}
    */
   private getPaymentReceivableEntry = (
@@ -262,15 +152,15 @@ export class PaymentReceiveGLEntries {
    * Records payment receive journal transactions.
    *
    * Invoice payment journals.
-   * --------
-   * - Account receivable -> Debit
-   * - Payment account [current asset] -> Credit
+   * ------------
+   * - Account Receivable -> Debit
+   * - Payment Account [current asset] -> Credit
    *
-   * @param   {number} tenantId
-   * @param   {IPaymentReceive} paymentRecieve - Payment receive model.
-   * @param   {number} ARAccountId - A/R account id.
-   * @param   {number} exGainOrLossAccountId - Exchange gain/loss account id.
-   * @param   {string} baseCurrency - Base currency code.
+   * @param {number} tenantId
+   * @param {IPaymentReceive} paymentRecieve - Payment receive model.
+   * @param {number} ARAccountId - A/R account id.
+   * @param {number} exGainOrLossAccountId - Exchange gain/loss account id.
+   * @param {string} baseCurrency - Base currency code.
    * @returns {Promise<ILedgerEntry>}
    */
   public getPaymentReceiveGLEntries = (