feat(server): wip sales tax liability summary report

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

@@ -20,6 +20,7 @@ import InventoryDetailsController from './FinancialStatements/InventoryDetails';
 import TransactionsByReferenceController from './FinancialStatements/TransactionsByReference';
 import CashflowAccountTransactions from './FinancialStatements/CashflowAccountTransactions';
 import ProjectProfitabilityController from './FinancialStatements/ProjectProfitabilitySummary';
+import SalesTaxLiabilitySummary from './FinancialStatements/SalesTaxLiabilitySummary';
 
 @Service()
 export default class FinancialStatementsService {
@@ -68,40 +69,44 @@ export default class FinancialStatementsService {
     );
     router.use(
       '/customer-balance-summary',
-      Container.get(CustomerBalanceSummaryController).router(),
+      Container.get(CustomerBalanceSummaryController).router()
     );
     router.use(
       '/vendor-balance-summary',
-      Container.get(VendorBalanceSummaryController).router(),
+      Container.get(VendorBalanceSummaryController).router()
     );
     router.use(
       '/transactions-by-customers',
-      Container.get(TransactionsByCustomers).router(),
+      Container.get(TransactionsByCustomers).router()
     );
     router.use(
       '/transactions-by-vendors',
-      Container.get(TransactionsByVendors).router(),
+      Container.get(TransactionsByVendors).router()
     );
     router.use(
       '/cash-flow',
-      Container.get(CashFlowStatementController).router(),
+      Container.get(CashFlowStatementController).router()
     );
     router.use(
       '/inventory-item-details',
-      Container.get(InventoryDetailsController).router(),
+      Container.get(InventoryDetailsController).router()
     );
     router.use(
       '/transactions-by-reference',
-      Container.get(TransactionsByReferenceController).router(),
+      Container.get(TransactionsByReferenceController).router()
     );
     router.use(
       '/cashflow-account-transactions',
-      Container.get(CashflowAccountTransactions).router(),
+      Container.get(CashflowAccountTransactions).router()
     );
     router.use(
       '/project-profitability-summary',
-      Container.get(ProjectProfitabilityController).router(),
-    )
+      Container.get(ProjectProfitabilityController).router()
+    );
+    router.use(
+      '/sales-tax-liability-summary',
+      Container.get(SalesTaxLiabilitySummary).router()
+    );
     return router;
   }
 }

packages/server/src/api/controllers/FinancialStatements/SalesTaxLiabilitySummary/index.ts

@@ -0,0 +1,90 @@
+import { Router, Request, Response, NextFunction } from 'express';
+import { query } from 'express-validator';
+import { Inject } from 'typedi';
+import asyncMiddleware from '@/api/middleware/asyncMiddleware';
+import BaseFinancialReportController from '../BaseFinancialReportController';
+import { AbilitySubject, ReportsAction } from '@/interfaces';
+import CheckPolicies from '@/api/middleware/CheckPolicies';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { SalesTaxLiabilitySummaryService } from '@/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryService';
+
+export default class SalesTaxLiabilitySummary extends BaseFinancialReportController {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private salesTaxLiabilitySummaryService: SalesTaxLiabilitySummaryService;
+
+  /**
+   * Router constructor.
+   */
+  router() {
+    const router = Router();
+
+    router.get(
+      '/',
+      CheckPolicies(
+        ReportsAction.READ_SALES_TAX_LIABILITY_SUMMARY,
+        AbilitySubject.Report
+      ),
+      this.validationSchema,
+      asyncMiddleware(this.salesTaxLiabilitySummary.bind(this))
+    );
+    return router;
+  }
+
+  /**
+   * Validation schema.
+   */
+  get validationSchema() {
+    return [
+      query('from_date').optional().isISO8601(),
+      query('to_date').optional().isISO8601(),
+    ];
+  }
+
+  /*
+   *
+   * @param {Request} req -
+   * @param {Response} res -
+   * @param {NextFunction} next -
+   */
+  async salesTaxLiabilitySummary(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
+    const { tenantId, settings } = req;
+    const filter = this.matchedQueryData(req);
+
+    try {
+      const accept = this.accepts(req);
+      const acceptType = accept.types(['json', 'application/json+table']);
+
+      switch (acceptType) {
+        case 'application/json+table':
+          const salesTaxLiabilityTable =
+            await this.salesTaxLiabilitySummaryService.salesTaxLiabilitySummaryTable(
+              tenantId,
+              filter
+            );
+
+          return res.status(200).send({
+            data: salesTaxLiabilityTable
+          });
+        case 'json':
+        default:
+          const salesTaxLiability =
+            await this.salesTaxLiabilitySummaryService.salesTaxLiability(
+              tenantId,
+              filter
+            );
+          return res.status(200).send({
+            data: salesTaxLiability,
+          });
+      }
+    } catch (error) {
+      next(error);
+    }
+  }
+}