add server to monorepo.

2026-02-20 14:50:32 +00:00 · 2023-02-03 11:57:50 +02:00
parent 28e309981b
commit 80b97b5fdc
1303 changed files with 137049 additions and 0 deletions
--- a/packages/server/src/services/Purchases/VendorCredits/VendorCreditGLEntries.ts
+++ b/packages/server/src/services/Purchases/VendorCredits/VendorCreditGLEntries.ts
@@ -0,0 +1,189 @@
+import { Inject, Service } from 'typedi';
+import { Knex } from 'knex';
+import * as R from 'ramda';
+import {
+  IVendorCredit,
+  ILedgerEntry,
+  AccountNormal,
+  IItemEntry,
+} from '@/interfaces';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import LedgerStorageService from '@/services/Accounting/LedgerStorageService';
+import Ledger from '@/services/Accounting/Ledger';
+
+@Service()
+export default class VendorCreditGLEntries {
+  @Inject()
+  private ledgerStorage: LedgerStorageService;
+
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  /**
+   * Retrieve the vendor credit GL common entry.
+   * @param   {IVendorCredit} vendorCredit
+   * @returns {}
+   */
+  public getVendorCreditGLCommonEntry = (vendorCredit: IVendorCredit) => {
+    return {
+      date: vendorCredit.vendorCreditDate,
+      currencyCode: vendorCredit.currencyCode,
+      exchangeRate: vendorCredit.exchangeRate,
+
+      transactionId: vendorCredit.id,
+      transactionType: 'VendorCredit',
+      transactionNumber: vendorCredit.vendorCreditNumber,
+      referenceNumber: vendorCredit.referenceNo,
+
+      credit: 0,
+      debit: 0,
+
+      branchId: vendorCredit.branchId,
+    };
+  };
+
+  /**
+   * Retrieves the vendor credit payable GL entry.
+   * @param   {IVendorCredit} vendorCredit
+   * @param   {number} APAccountId
+   * @returns {ILedgerEntry}
+   */
+  public getVendorCreditPayableGLEntry = (
+    vendorCredit: IVendorCredit,
+    APAccountId: number
+  ): ILedgerEntry => {
+    const commonEntity = this.getVendorCreditGLCommonEntry(vendorCredit);
+
+    return {
+      ...commonEntity,
+      debit: vendorCredit.localAmount,
+      accountId: APAccountId,
+      contactId: vendorCredit.vendorId,
+      accountNormal: AccountNormal.CREDIT,
+      index: 1,
+    };
+  };
+
+  /**
+   * Retrieves the vendor credit item GL entry.
+   * @param   {IVendorCredit} vendorCredit
+   * @param   {IItemEntry} entry
+   * @returns {ILedgerEntry}
+   */
+  public getVendorCreditGLItemEntry = R.curry(
+    (
+      vendorCredit: IVendorCredit,
+      entry: IItemEntry,
+      index: number
+    ): ILedgerEntry => {
+      const commonEntity = this.getVendorCreditGLCommonEntry(vendorCredit);
+      const localAmount = entry.amount * vendorCredit.exchangeRate;
+
+      return {
+        ...commonEntity,
+        credit: localAmount,
+        index: index + 2,
+        itemId: entry.itemId,
+        itemQuantity: entry.quantity,
+        accountId:
+          'inventory' === entry.item.type
+            ? entry.item.inventoryAccountId
+            : entry.costAccountId || entry.item.costAccountId,
+        accountNormal: AccountNormal.DEBIT,
+      };
+    }
+  );
+
+  /**
+   * Retrieve the vendor credit GL entries.
+   * @param  {IVendorCredit} vendorCredit -
+   * @param  {number} receivableAccount -
+   * @return {ILedgerEntry[]}
+   */
+  public getVendorCreditGLEntries = (
+    vendorCredit: IVendorCredit,
+    payableAccountId: number
+  ): ILedgerEntry[] => {
+    const payableEntry = this.getVendorCreditPayableGLEntry(
+      vendorCredit,
+      payableAccountId
+    );
+    const getItemEntry = this.getVendorCreditGLItemEntry(vendorCredit);
+    const itemsEntries = vendorCredit.entries.map(getItemEntry);
+
+    return [payableEntry, ...itemsEntries];
+  };
+
+  /**
+   * Reverts the vendor credit associated GL entries.
+   * @param {number} tenantId
+   * @param {number} vendorCreditId
+   * @param {Knex.Transaction} trx
+   */
+  public revertVendorCreditGLEntries = async (
+    tenantId: number,
+    vendorCreditId: number,
+    trx?: Knex.Transaction
+  ): Promise<void> => {
+    await this.ledgerStorage.deleteByReference(
+      tenantId,
+      vendorCreditId,
+      'VendorCredit',
+      trx
+    );
+  };
+
+  /**
+   * Creates vendor credit associated GL entries.
+   * @param {number} tenantId
+   * @param {number} vendorCreditId
+   * @param {Knex.Transaction} trx
+   */
+  public writeVendorCreditGLEntries = async (
+    tenantId: number,
+    vendorCreditId: number,
+    trx?: Knex.Transaction
+  ) => {
+    const { accountRepository } = this.tenancy.repositories(tenantId);
+    const { VendorCredit } = this.tenancy.models(tenantId);
+
+    // Vendor credit with entries items.
+    const vendorCredit = await VendorCredit.query(trx)
+      .findById(vendorCreditId)
+      .withGraphFetched('entries.item');
+
+    // Retrieve the payable account (A/P) account.
+    const APAccount = await accountRepository.findOrCreateAccountsPayable(
+      vendorCredit.currencyCode,
+      {},
+      trx
+    );
+    // Saves the vendor credit GL entries.
+    const ledgerEntries = this.getVendorCreditGLEntries(
+      vendorCredit,
+      APAccount.id
+    );
+    const ledger = new Ledger(ledgerEntries);
+
+    // Commits the ledger entries to the storage.
+    await this.ledgerStorage.commit(tenantId, ledger, trx);
+  };
+
+  /**
+   * Edits vendor credit associated GL entries.
+   * @param {number} tenantId
+   * @param {number} vendorCreditId
+   * @param {Knex.Transaction} trx
+   */
+  public rewriteVendorCreditGLEntries = async (
+    tenantId: number,
+    vendorCreditId: number,
+    trx?: Knex.Transaction
+  ) => {
+    // Reverts the GL entries.
+    await this.revertVendorCreditGLEntries(tenantId, vendorCreditId, trx);
+
+    // Re-write the GL entries.
+    await this.writeVendorCreditGLEntries(tenantId, vendorCreditId, trx);
+  };
+}