feat: format amount rows of financial statemnets.

server/src/api/controllers/FinancialStatements/APAgingSummary.ts

@@ -1,11 +1,11 @@
 import { Router, Request, Response, NextFunction } from 'express';
 import { query } from 'express-validator';
 import { Inject } from 'typedi';
-import BaseController from 'api/controllers/BaseController';
 import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import APAgingSummaryReportService from 'services/FinancialStatements/AgingSummary/APAgingSummaryService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
-export default class APAgingSummaryReportController extends BaseController {
+export default class APAgingSummaryReportController extends BaseFinancialReportController {
   @Inject()
   APAgingSummaryService: APAgingSummaryReportService;
 
@@ -28,11 +28,10 @@ export default class APAgingSummaryReportController extends BaseController {
    */
   get validationSchema() {
     return [
+      ...this.sheetNumberFormatValidationSchema,
       query('as_date').optional().isISO8601(),
       query('aging_days_before').optional().isNumeric().toInt(),
       query('aging_periods').optional().isNumeric().toInt(),
-      query('number_format.no_cents').optional().isBoolean().toBoolean(),
-      query('number_format.1000_divide').optional().isBoolean().toBoolean(),
       query('vendors_ids').optional().isArray({ min: 1 }),
       query('vendors_ids.*').isInt({ min: 1 }).toInt(),
       query('none_zero').default(true).isBoolean().toBoolean(),

server/src/api/controllers/FinancialStatements/ARAgingSummary.ts

@@ -1,13 +1,11 @@
 import { Service, Inject } from 'typedi';
 import { Router, Request, Response } from 'express';
-import { castArray } from 'lodash';
-import { query, oneOf } from 'express-validator';
-import { IARAgingSummaryQuery } from 'interfaces';
-import BaseController from '../BaseController';
+import { query } from 'express-validator';
 import ARAgingSummaryService from 'services/FinancialStatements/AgingSummary/ARAgingSummaryService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
 @Service()
-export default class ARAgingSummaryReportController extends BaseController {
+export default class ARAgingSummaryReportController extends BaseFinancialReportController {
   @Inject()
   ARAgingSummaryService: ARAgingSummaryService;
 
@@ -31,11 +29,11 @@ export default class ARAgingSummaryReportController extends BaseController {
    */
   get validationSchema() {
     return [
+      ...this.sheetNumberFormatValidationSchema,
+
       query('as_date').optional().isISO8601(),
       query('aging_days_before').optional().isInt({ max: 500 }).toInt(),
       query('aging_periods').optional().isInt({ max: 12 }).toInt(),
-      query('number_format.no_cents').optional().isBoolean().toBoolean(),
-      query('number_format.1000_divide').optional().isBoolean().toBoolean(),
       query('customers_ids').optional().isArray({ min: 1 }),
       query('customers_ids.*').isInt({ min: 1 }).toInt(),
       query('none_zero').default(true).isBoolean().toBoolean(),

server/src/api/controllers/FinancialStatements/BalanceSheet.ts

@@ -3,11 +3,11 @@ import { Router, Request, Response, NextFunction } from 'express';
 import { query, ValidationChain } from 'express-validator';
 import { castArray } from 'lodash';
 import asyncMiddleware from 'api/middleware/asyncMiddleware';
-import BaseController from '../BaseController';
 import BalanceSheetStatementService from 'services/FinancialStatements/BalanceSheet/BalanceSheetService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
 @Service()
-export default class BalanceSheetStatementController extends BaseController {
+export default class BalanceSheetStatementController extends BaseFinancialReportController {
   @Inject()
   balanceSheetService: BalanceSheetStatementService;
 
@@ -32,6 +32,8 @@ export default class BalanceSheetStatementController extends BaseController {
    */
   get balanceSheetValidationSchema(): ValidationChain[] {
     return [
+      ...this.sheetNumberFormatValidationSchema,
+
       query('accounting_method').optional().isIn(['cash', 'accural']),
       query('from_date').optional(),
       query('to_date').optional(),
@@ -39,8 +41,6 @@ export default class BalanceSheetStatementController extends BaseController {
       query('display_columns_by')
         .optional({ nullable: true, checkFalsy: true })
         .isIn(['year', 'month', 'week', 'day', 'quarter']),
-      query('number_format.no_cents').optional().isBoolean().toBoolean(),
-      query('number_format.divide_1000').optional().isBoolean().toBoolean(),
       query('account_ids').isArray().optional(),
       query('account_ids.*').isNumeric().toInt(),
       query('none_zero').optional().isBoolean().toBoolean(),

server/src/api/controllers/FinancialStatements/BaseFinancialReportController.ts

@@ -0,0 +1,26 @@
+import { query } from 'express-validator';
+import BaseController from "../BaseController";
+
+export default class BaseFinancialReportController extends BaseController {
+
+
+  get sheetNumberFormatValidationSchema() {
+    return [
+      query('number_format.precision')
+        .optional()
+        .isInt({ min: 0, max: 5 })
+        .toInt(),
+      query('number_format.divide_on_1000').optional().isBoolean().toBoolean(),
+      query('number_format.show_zero').optional().isBoolean().toBoolean(),
+      query('number_format.format_money')
+        .optional()
+        .isIn(['total', 'always', 'none'])
+        .trim(),
+      query('number_format.negative_format')
+        .optional()
+        .isIn(['parentheses', 'mines'])
+        .trim()
+        .escape(),
+    ];
+  }
+}

server/src/api/controllers/FinancialStatements/GeneralLedger.ts

@@ -1,12 +1,12 @@
 import { Router, Request, Response, NextFunction } from 'express';
 import { query, ValidationChain } from 'express-validator';
-import asyncMiddleware from 'api/middleware/asyncMiddleware';
-import BaseController from '../BaseController';
 import { Inject, Service } from 'typedi';
+import asyncMiddleware from 'api/middleware/asyncMiddleware';
 import GeneralLedgerService from 'services/FinancialStatements/GeneralLedger/GeneralLedgerService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
 @Service()
-export default class GeneralLedgerReportController extends BaseController {
+export default class GeneralLedgerReportController extends BaseFinancialReportController {
   @Inject()
   generalLedgetService: GeneralLedgerService;
 

server/src/api/controllers/FinancialStatements/JournalSheet.ts

@@ -2,11 +2,11 @@ import { Inject, Service } from 'typedi';
 import { Request, Response, Router, NextFunction } from 'express';
 import { castArray } from 'lodash';
 import { query, oneOf } from 'express-validator';
+import BaseFinancialReportController from './BaseFinancialReportController';
 import JournalSheetService from 'services/FinancialStatements/JournalSheet/JournalSheetService';
-import BaseController from '../BaseController';
 
 @Service()
-export default class JournalSheetController extends BaseController {
+export default class JournalSheetController extends BaseFinancialReportController {
   @Inject()
   journalService: JournalSheetService;
 

server/src/api/controllers/FinancialStatements/ProfitLossSheet.ts

@@ -1,11 +1,11 @@
 import { Service, Inject } from 'typedi';
 import { Router, Request, Response, NextFunction } from 'express';
 import { query, ValidationChain } from 'express-validator';
-import BaseController from '../BaseController';
 import ProfitLossSheetService from 'services/FinancialStatements/ProfitLossSheet/ProfitLossSheetService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
 @Service()
-export default class ProfitLossSheetController extends BaseController {
+export default class ProfitLossSheetController extends BaseFinancialReportController {
   @Inject()
   profitLossSheetService: ProfitLossSheetService;
 
@@ -29,11 +29,10 @@ export default class ProfitLossSheetController extends BaseController {
    */
   get validationSchema(): ValidationChain[] {
     return [
+      ...this.sheetNumberFormatValidationSchema,
       query('basis').optional(),
       query('from_date').optional().isISO8601(),
       query('to_date').optional().isISO8601(),
-      query('number_format.no_cents').optional().isBoolean(),
-      query('number_format.divide_1000').optional().isBoolean(),
       query('basis').optional(),
       query('none_zero').optional().isBoolean().toBoolean(),
       query('none_transactions').optional().isBoolean().toBoolean(),

server/src/api/controllers/FinancialStatements/TrialBalanceSheet.ts

@@ -1,13 +1,13 @@
 import { Inject, Service } from 'typedi';
-import {  Request, Response, Router, NextFunction } from 'express';
+import { Request, Response, Router, NextFunction } from 'express';
 import { query, ValidationChain } from 'express-validator';
-import asyncMiddleware from 'api/middleware/asyncMiddleware';
-import BaseController from '../BaseController';
-import TrialBalanceSheetService from 'services/FinancialStatements/TrialBalanceSheet/TrialBalanceSheetService';
 import { castArray } from 'lodash';
+import asyncMiddleware from 'api/middleware/asyncMiddleware';
+import TrialBalanceSheetService from 'services/FinancialStatements/TrialBalanceSheet/TrialBalanceSheetService';
+import BaseFinancialReportController from './BaseFinancialReportController';
 
 @Service()
-export default class TrialBalanceSheetController extends BaseController {
+export default class TrialBalanceSheetController extends BaseFinancialReportController {
   @Inject()
   trialBalanceSheetService: TrialBalanceSheetService;
 
@@ -17,7 +17,8 @@ export default class TrialBalanceSheetController extends BaseController {
   router() {
     const router = Router();
 
-    router.get('/',
+    router.get(
+      '/',
       this.trialBalanceSheetValidationSchema,
       this.validationResult,
       asyncMiddleware(this.trialBalanceSheet.bind(this))
@@ -31,11 +32,10 @@ export default class TrialBalanceSheetController extends BaseController {
    */
   get trialBalanceSheetValidationSchema(): ValidationChain[] {
     return [
+      ...this.sheetNumberFormatValidationSchema,
       query('basis').optional(),
       query('from_date').optional().isISO8601(),
       query('to_date').optional().isISO8601(),
-      query('number_format.no_cents').optional().isBoolean().toBoolean(),
-      query('number_format.1000_divide').optional().isBoolean().toBoolean(),
       query('account_ids').isArray().optional(),
       query('account_ids.*').isNumeric().toInt(),
       query('basis').optional(),
@@ -46,7 +46,11 @@ export default class TrialBalanceSheetController extends BaseController {
   /**
    * Retrieve the trial balance sheet.
    */
-  public async trialBalanceSheet(req: Request, res: Response, next: NextFunction) {
+  public async trialBalanceSheet(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
     const { tenantId, settings } = req;
     let filter = this.matchedQueryData(req);
 
@@ -54,21 +58,32 @@ export default class TrialBalanceSheetController extends BaseController {
       ...filter,
       accountsIds: castArray(filter.accountsIds),
     };
-    const organizationName = settings.get({ group: 'organization', key: 'name' });
-    const baseCurrency = settings.get({ group: 'organization', key: 'base_currency' });
+    const organizationName = settings.get({
+      group: 'organization',
+      key: 'name',
+    });
+    const baseCurrency = settings.get({
+      group: 'organization',
+      key: 'base_currency',
+    });
 
     try {
-      const { data, query } = await this.trialBalanceSheetService
-        .trialBalanceSheet(tenantId, filter);
-      
+      const {
+        data,
+        query,
+      } = await this.trialBalanceSheetService.trialBalanceSheet(
+        tenantId,
+        filter
+      );
+
       return res.status(200).send({
         organization_name: organizationName,
         base_currency: baseCurrency,
         data: this.transfromToResponse(data),
-        query: this.transfromToResponse(query)
+        query: this.transfromToResponse(query),
       });
     } catch (error) {
       next(error);
     }
   }
-}
+}