Merge pull request #180 from bigcapitalhq/abouhuolia/big-40-storing-cash-flow-transaction-description

fix: Storing cash flow transaction description

packages/server/src/interfaces/Ledger.ts

@@ -41,6 +41,8 @@ export interface ILedgerEntry {
   index: number;
   indexGroup?: number;
 
+  note?: string;
+
   userId?: number;
   itemId?: number;
   branchId?: number;

packages/server/src/services/Accounting/utils.ts

@@ -21,6 +21,8 @@ export const transformLedgerEntryToTransaction = (
     transactionNumber: entry.transactionNumber,
     referenceNumber: entry.referenceNumber,
 
+    note: entry.note,
+
     index: entry.index,
     indexGroup: entry.indexGroup,
 

packages/server/src/services/Cashflow/CashflowTransactionJournalEntries.ts

@@ -25,8 +25,8 @@ export default class CashflowTransactionJournalEntries {
 
   /**
    * Retrieves the common entry of cashflow transaction.
-   * @param   {ICashflowTransaction} cashflowTransaction
-   * @returns {}
+   * @param {ICashflowTransaction} cashflowTransaction
+   * @returns {Partial<ILedgerEntry>}
    */
   private getCommonEntry = (cashflowTransaction: ICashflowTransaction) => {
     const { entries, ...transaction } = cashflowTransaction;
@@ -41,7 +41,9 @@ export default class CashflowTransactionJournalEntries {
       ),
       transactionId: transaction.id,
       transactionNumber: transaction.transactionNumber,
-      referenceNo: transaction.referenceNo,
+      referenceNumber: transaction.referenceNo,
+
+      note: transaction.description,
 
       branchId: cashflowTransaction.branchId,
       userId: cashflowTransaction.userId,
@@ -76,9 +78,9 @@ export default class CashflowTransactionJournalEntries {
 
   /**
    * Retrieves the cashflow credit GL entry.
-   * @param   {ICashflowTransaction} cashflowTransaction
-   * @param   {ICashflowTransactionLine} entry
-   * @param   {number} index
+   * @param {ICashflowTransaction} cashflowTransaction
+   * @param {ICashflowTransactionLine} entry
+   * @param {number} index
    * @returns {ILedgerEntry}
    */
   private getCashflowCreditGLEntry = (
@@ -102,10 +104,10 @@ export default class CashflowTransactionJournalEntries {
 
   /**
    * Retrieves the cashflow transaction GL entry.
-   * @param   {ICashflowTransaction} cashflowTransaction
-   * @param   {ICashflowTransactionLine} entry
-   * @param   {number} index
-   * @returns
+   * @param {ICashflowTransaction} cashflowTransaction
+   * @param {ICashflowTransactionLine} entry
+   * @param {number} index
+   * @returns {ILedgerEntry[]}
    */
   private getJournalEntries = (
     cashflowTransaction: ICashflowTransaction
@@ -118,7 +120,7 @@ export default class CashflowTransactionJournalEntries {
 
   /**
    * Retrieves the cashflow GL ledger.
-   * @param   {ICashflowTransaction} cashflowTransaction
+   * @param {ICashflowTransaction} cashflowTransaction
    * @returns {Ledger}
    */
   private getCashflowLedger = (cashflowTransaction: ICashflowTransaction) => {
@@ -130,6 +132,7 @@ export default class CashflowTransactionJournalEntries {
    * Write the journal entries of the given cashflow transaction.
    * @param {number} tenantId
    * @param {ICashflowTransaction} cashflowTransaction
+   * @return {Promise<void>}
    */
   public writeJournalEntries = async (
     tenantId: number,
@@ -153,6 +156,7 @@ export default class CashflowTransactionJournalEntries {
    * Delete the journal entries.
    * @param {number} tenantId - Tenant id.
    * @param {number} cashflowTransactionId - Cashflow transaction id.
+   * @return {Promise<void>}
    */
   public revertJournalEntries = async (
     tenantId: number,

packages/webapp/src/containers/CashFlow/MoneyInDialog/OtherIncome/OtherIncomeFormFields.tsx

@@ -106,11 +106,13 @@ export default function OtherIncomeFormFields() {
             )}
           </FastField>
         </Col>
+
         <Col xs={5}>
           {/*------------ Transaction number -----------*/}
           <MoneyInOutTransactionNoField />
         </Col>
       </Row>
+
       {/*------------ amount -----------*/}
       <FastField name={'amount'}>
         {({

packages/webapp/src/containers/Drawers/CashflowTransactionDetailDrawer/CashflowTransactionDrawerDetails.tsx

@@ -1,12 +1,13 @@
 // @ts-nocheck
 import React from 'react';
 
-import { Card } from '@/components';
+import { Card, CommercialDocBox } from '@/components';
 
 import CashflowTransactionDrawerActionBar from './CashflowTransactionDrawerActionBar';
 import CashflowTransactionDrawerHeader from './CashflowTransactionDrawerHeader';
 import CashflowTransactionDrawerTable from './CashflowTransactionDrawerTable';
-import CashflowTransactionDrawerFooter from './CashflowTransactionDrawerFooter';
+import CashflowTransactionDrawerTableFooter from './CashflowTransactionDrawerTableFooter';
+import { CashflowTransactionDrawerFooter } from './CashflowTransactionDrawerFooter';
 /**
  * Cashflow transaction view details.
  */
@@ -16,11 +17,12 @@ export default function CashflowTransactionDrawerDetails() {
       <CashflowTransactionDrawerActionBar />
 
       <div className="cashflow-drawer__content">
-        <Card>
+        <CommercialDocBox>
           <CashflowTransactionDrawerHeader />
           <CashflowTransactionDrawerTable />
+          <CashflowTransactionDrawerTableFooter />
           <CashflowTransactionDrawerFooter />
-        </Card>
+        </CommercialDocBox>
       </div>
     </div>
   );

packages/webapp/src/containers/Drawers/CashflowTransactionDetailDrawer/CashflowTransactionDrawerFooter.tsx

@@ -1,35 +1,18 @@
 // @ts-nocheck
 import React from 'react';
+import { CommercialDocFooter, DetailsMenu, DetailItem, T } from '@/components';
 import { useCashflowTransactionDrawerContext } from './CashflowTransactionDrawerProvider';
-import { T, FormatNumber } from '@/components';
 
-export default function CashflowTransactionDrawerFooter() {
-  const {
-    cashflowTransaction: { formatted_amount },
-  } = useCashflowTransactionDrawerContext();
+export function CashflowTransactionDrawerFooter() {
+  const { cashflowTransaction } = useCashflowTransactionDrawerContext();
 
   return (
-    <div className="cashflow-drawer__content-footer">
-      <div class="total-lines">
-        <div class="total-lines__line total-lines__line--subtotal">
-          <div class="title">
-            <T id={'manual_journal.details.subtotal'} />
-          </div>
-          <div class="debit">
-            <FormatNumber value={formatted_amount} />
-          </div>
-          <div class="credit">
-            <FormatNumber value={formatted_amount} />
-          </div>
-        </div>
-        <div class="total-lines__line total-lines__line--total">
-          <div class="title">
-            <T id={'manual_journal.details.total'} />
-          </div>
-          <div class="debit">{formatted_amount}</div>
-          <div class="credit">{formatted_amount}</div>
-        </div>
-      </div>
-    </div>
+    <CommercialDocFooter>
+      <DetailsMenu direction={'horizantal'} minLabelSize={'180px'}>
+        <DetailItem label={<T id={'cash_flow.drawer.label.statement'} />}>
+          {cashflowTransaction.description}
+        </DetailItem>
+      </DetailsMenu>
+    </CommercialDocFooter>
   );
 }

packages/webapp/src/containers/Drawers/CashflowTransactionDetailDrawer/CashflowTransactionDrawerTableFooter.tsx

@@ -0,0 +1,35 @@
+// @ts-nocheck
+import React from 'react';
+import { useCashflowTransactionDrawerContext } from './CashflowTransactionDrawerProvider';
+import { T, FormatNumber } from '@/components';
+
+export default function CashflowTransactionDrawerTableFooter() {
+  const {
+    cashflowTransaction: { formatted_amount },
+  } = useCashflowTransactionDrawerContext();
+
+  return (
+    <div className="cashflow-drawer__content-footer">
+      <div class="total-lines">
+        <div class="total-lines__line total-lines__line--subtotal">
+          <div class="title">
+            <T id={'manual_journal.details.subtotal'} />
+          </div>
+          <div class="debit">
+            <FormatNumber value={formatted_amount} />
+          </div>
+          <div class="credit">
+            <FormatNumber value={formatted_amount} />
+          </div>
+        </div>
+        <div class="total-lines__line total-lines__line--total">
+          <div class="title">
+            <T id={'manual_journal.details.total'} />
+          </div>
+          <div class="debit">{formatted_amount}</div>
+          <div class="credit">{formatted_amount}</div>
+        </div>
+      </div>
+    </div>
+  );
+}

packages/webapp/src/containers/Drawers/InvoiceDetailDrawer/InvoiceDetailFooter.tsx

@@ -1,6 +1,5 @@
 // @ts-nocheck
 import React from 'react';
-
 import {
   CommercialDocFooter,
   T,

packages/webapp/src/lang/en/index.json

@@ -1452,6 +1452,7 @@
   "cash_flow.setting_your_auto_generated_transaction_number": "Setting your auto-generated transaction number",
   "cash_flow_drawer.label_transaction_type": "Transaction type",
   "cash_flow.drawer.label_transaction_no": "Transaction number",
+  "cash_flow.drawer.label.statement": "Statement",
   "cash_flow.drawer.label_transaction": "Cash flow Transaction {number}",
   "cash_flow.account_transactions.no_results": "There are no deposit/withdrawal transactions on the current account.",
   "cash_flow_balance_in": "Balance in {name}",