Merge pull request #204 from bigcapitalhq/tax-compliance

feat: [wip] tax rates service
bigcapitalhq · Sep 23, 2023 · 5261d33 · 5261d33
2 parents a0a5d00 + f1e7d0f
commit 5261d33
Show file tree

Hide file tree

Showing 135 changed files with 6,080 additions and 328 deletions.
diff --git a/packages/server/src/api/controllers/FinancialStatements.ts b/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;
   }
 }
diff --git a/packages/server/src/api/controllers/FinancialStatements/SalesTaxLiabilitySummary/index.ts b/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 { SalesTaxLiabilitySummaryService } from '@/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryService';
+
+export default class SalesTaxLiabilitySummary extends BaseFinancialReportController {
+  @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(),
+    ];
+  }
+
+  /*
+   * Retrieves the sales tax liability summary.
+   * @param {Request} req -
+   * @param {Response} res -
+   * @param {NextFunction} next -
+   */
+  async salesTaxLiabilitySummary(
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) {
+    const { tenantId } = 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({
+            table: salesTaxLiabilityTable.table,
+            query: salesTaxLiabilityTable.query,
+            meta: salesTaxLiabilityTable.meta,
+          });
+        case 'json':
+        default:
+          const salesTaxLiability =
+            await this.salesTaxLiabilitySummaryService.salesTaxLiability(
+              tenantId,
+              filter
+            );
+          return res.status(200).send({
+            data: salesTaxLiability.data,
+            query: salesTaxLiability.query,
+            meta: salesTaxLiability.meta,
+          });
+      }
+    } catch (error) {
+      next(error);
+    }
+  }
+}
diff --git a/packages/server/src/api/controllers/Sales/SalesInvoices.ts b/packages/server/src/api/controllers/Sales/SalesInvoices.ts
@@ -169,8 +169,9 @@ export default class SaleInvoicesController extends BaseController {
       check('branch_id').optional({ nullable: true }).isNumeric().toInt(),
       check('project_id').optional({ nullable: true }).isNumeric().toInt(),
 
-      check('entries').exists().isArray({ min: 1 }),
+      check('is_inclusive_tax').optional().isBoolean().toBoolean(),
 
+      check('entries').exists().isArray({ min: 1 }),
       check('entries.*.index').exists().isNumeric().toInt(),
       check('entries.*.item_id').exists().isNumeric().toInt(),
       check('entries.*.rate').exists().isNumeric().toFloat(),
@@ -183,6 +184,15 @@ export default class SaleInvoicesController extends BaseController {
         .optional({ nullable: true })
         .trim()
         .escape(),
+      check('entries.*.tax_code')
+        .optional({ nullable: true })
+        .trim()
+        .escape()
+        .isString(),
+      check('entries.*.tax_rate_id')
+        .optional({ nullable: true })
+        .isNumeric()
+        .toInt(),
       check('entries.*.warehouse_id')
         .optional({ nullable: true })
         .isNumeric()
@@ -756,6 +766,16 @@ export default class SaleInvoicesController extends BaseController {
           ],
         });
       }
+      if (error.errorType === 'ITEM_ENTRY_TAX_RATE_CODE_NOT_FOUND') {
+        return res.boom.badRequest(null, {
+          errors: [{ type: 'ITEM_ENTRY_TAX_RATE_CODE_NOT_FOUND', code: 5000 }],
+        });
+      }
+      if (error.errorType === 'ITEM_ENTRY_TAX_RATE_ID_NOT_FOUND') {
+        return res.boom.badRequest(null, {
+          errors: [{ type: 'ITEM_ENTRY_TAX_RATE_ID_NOT_FOUND', code: 5100 }],
+        });
+      }
     }
     next(error);
   }