feat(server): financial reports meta

packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryApplication.ts

@@ -15,7 +15,7 @@ export class CustomerBalanceSummaryApplication {
 
   @Inject()
   private customerBalanceSummarySheet: CustomerBalanceSummaryService;
-
+  
   @Inject()
   private customerBalanceSummaryPdf: CustomerBalanceSummaryPdf;
 

packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryMeta.ts

@@ -0,0 +1,35 @@
+import moment from 'moment';
+import { Inject, Service } from 'typedi';
+import {
+  ICustomerBalanceSummaryMeta,
+  ICustomerBalanceSummaryQuery,
+} from '@/interfaces';
+import { FinancialSheetMeta } from '../FinancialSheetMeta';
+
+@Service()
+export class CustomerBalanceSummaryMeta {
+  @Inject()
+  private financialSheetMeta: FinancialSheetMeta;
+
+  /**
+   * Retrieves the customer balance summary meta.
+   * @param {number} tenantId
+   * @param {ICustomerBalanceSummaryQuery} query
+   * @returns {Promise<ICustomerBalanceSummaryMeta>}
+   */
+  async meta(
+    tenantId: number,
+    query: ICustomerBalanceSummaryQuery
+  ): Promise<ICustomerBalanceSummaryMeta> {
+    const commonMeta = await this.financialSheetMeta.meta(tenantId);
+    const formattedAsDate = moment(query.asDate).format('YYYY/MM/DD');
+    const formattedDateRange = `As ${formattedAsDate}`;
+
+    return {
+      ...commonMeta,
+      sheetName: 'Customer Balance Summary',
+      formattedAsDate,
+      formattedDateRange,
+    };
+  }
+}

packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryPdf.ts

@@ -1,5 +1,6 @@
 import { Inject, Service } from 'typedi';
-import { IAPAgingSummaryQuery, ICustomerBalanceSummaryQuery } from '@/interfaces';
+import { ICustomerBalanceSummaryQuery } from '@/interfaces';
+
 import { TableSheetPdf } from '../TableSheetPdf';
 import { CustomerBalanceSummaryTableInjectable } from './CustomerBalanceSummaryTableInjectable';
 
@@ -12,7 +13,7 @@ export class CustomerBalanceSummaryPdf {
   private tableSheetPdf: TableSheetPdf;
 
   /**
-   * Converts the given A/P aging summary sheet table to pdf.
+   * Converts the given customer balance summary sheet table to pdf.
    * @param {number} tenantId - Tenant ID.
    * @param {IAPAgingSummaryQuery} query - Balance sheet query.
    * @returns {Promise<Buffer>}
@@ -22,13 +23,12 @@ export class CustomerBalanceSummaryPdf {
     query: ICustomerBalanceSummaryQuery
   ): Promise<Buffer> {
     const table = await this.customerBalanceSummaryTable.table(tenantId, query);
-    const sheetName = 'Customer Balance Summary';
 
     return this.tableSheetPdf.convertToPdf(
       tenantId,
       table.table,
-      sheetName,
-      table.meta.baseCurrency
+      table.meta.sheetName,
+      table.meta.formattedDateRange
     );
   }
 }

packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryService.ts

@@ -1,4 +1,4 @@
-import { Inject } from 'typedi';
+import { Inject, Service } from 'typedi';
 import moment from 'moment';
 import * as R from 'ramda';
 import {
@@ -12,13 +12,18 @@ import { CustomerBalanceSummaryReport } from './CustomerBalanceSummary';
 import Ledger from '@/services/Accounting/Ledger';
 import CustomerBalanceSummaryRepository from './CustomerBalanceSummaryRepository';
 import { Tenant } from '@/system/models';
+import { CustomerBalanceSummaryMeta } from './CustomerBalanceSummaryMeta';
 
+@Service()
 export class CustomerBalanceSummaryService
   implements ICustomerBalanceSummaryService
 {
   @Inject()
   private reportRepository: CustomerBalanceSummaryRepository;
 
+  @Inject()
+  private customerBalanceSummaryMeta: CustomerBalanceSummaryMeta;
+
   /**
    * Defaults balance sheet filter query.
    * @return {ICustomerBalanceSummaryQuery}
@@ -96,11 +101,13 @@ export class CustomerBalanceSummaryService
       filter,
       tenant.metadata.baseCurrency
     );
+    // Retrieve the customer balance summary meta.
+    const meta = await this.customerBalanceSummaryMeta.meta(tenantId, filter);
 
     return {
       data: report.reportData(),
       query: filter,
-      meta: {}
+      meta,
     };
   }
 }

packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryTableInjectable.ts

@@ -25,6 +25,7 @@ export class CustomerBalanceSummaryTableInjectable {
     tenantId: number,
     filter: ICustomerBalanceSummaryQuery
   ): Promise<ICustomerBalanceSummaryTable> {
+    
     const i18n = this.tenancy.i18n(tenantId);
     const { data, query, meta } =
       await this.customerBalanceSummaryService.customerBalanceSummary(