mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-23 16:19:49 +00:00
Compare commits
81 Commits
big-126-in
...
big-150-ca
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
83fbb7225d | ||
|
|
b9a00418fa | ||
|
|
62d3e386dd | ||
|
|
d87d674aba | ||
|
|
a17b4f6a8a | ||
|
|
db839137d0 | ||
|
|
b602f28696 | ||
|
|
68f2f4ee84 | ||
|
|
f23e8d98f6 | ||
|
|
9db03350e0 | ||
|
|
0273714a07 | ||
|
|
ea497bfdea | ||
|
|
685a6150e6 | ||
|
|
daf87a8ec7 | ||
|
|
5b4ddadcf6 | ||
|
|
ea8c5458ff | ||
|
|
0833baabda | ||
|
|
ab7eb40ea9 | ||
|
|
00e6c141ee | ||
|
|
0aea339c1c | ||
|
|
2cf75e0136 | ||
|
|
5a8c394ad7 | ||
|
|
71742c3480 | ||
|
|
b340776278 | ||
|
|
6ea870edb2 | ||
|
|
dd072f8585 | ||
|
|
ecfdba9634 | ||
|
|
5be3ca75f4 | ||
|
|
7239b0ec7e | ||
|
|
2d3544fe37 | ||
|
|
3faeca20a9 | ||
|
|
b713b6922b | ||
|
|
4e40009ba0 | ||
|
|
e09f8e4334 | ||
|
|
1752c32eec | ||
|
|
d16ec7cda9 | ||
|
|
f6f6bc31b6 | ||
|
|
c06a8d9ca3 | ||
|
|
3509026ad8 | ||
|
|
465bb66d6b | ||
|
|
06e78db49d | ||
|
|
d2e6cc0036 | ||
|
|
7690789031 | ||
|
|
27fed5f18a | ||
|
|
1fd8a53ed1 | ||
|
|
d67189587e | ||
|
|
d229378957 | ||
|
|
eb4491f44a | ||
|
|
09ad725a67 | ||
|
|
b11c531cf5 | ||
|
|
0868eeaa0e | ||
|
|
9395ef094a | ||
|
|
a8671a8d99 | ||
|
|
cd8f64dfdc | ||
|
|
17dbe9713b | ||
|
|
706a324121 | ||
|
|
ecaf8c99bb | ||
|
|
90bde20674 | ||
|
|
0c61f85707 | ||
|
|
0f678e61c5 | ||
|
|
374f1acf8a | ||
|
|
ada1428193 | ||
|
|
528d447443 | ||
|
|
d6d67b9a51 | ||
|
|
f7f77b12c9 | ||
|
|
a6db4fb6df | ||
|
|
b38020d397 | ||
|
|
d090d5a026 | ||
|
|
00d9bc537c | ||
|
|
c688190acc | ||
|
|
2e0b3d0d5e | ||
|
|
6d888060d3 | ||
|
|
299a943153 | ||
|
|
e0ddcb022a | ||
|
|
b940c6dd17 | ||
|
|
b43cd26ecc | ||
|
|
b9886cfac3 | ||
|
|
63708ae839 | ||
|
|
760dbc6cfc | ||
|
|
9d4e7cec9e | ||
|
|
c8e7a2c7d9 |
33
.env.example
33
.env.example
@@ -63,4 +63,35 @@ GOTENBERG_DOCS_URL=http://server:3000/public/
|
|||||||
EXCHANGE_RATE_SERVICE=open-exchange-rate
|
EXCHANGE_RATE_SERVICE=open-exchange-rate
|
||||||
|
|
||||||
# Open Exchange Rate
|
# Open Exchange Rate
|
||||||
OPEN_EXCHANGE_RATE_APP_ID=
|
OPEN_EXCHANGE_RATE_APP_ID=
|
||||||
|
|
||||||
|
# The Plaid environment to use ('sandbox' or 'development').
|
||||||
|
# https://plaid.com/docs/#api-host
|
||||||
|
PLAID_ENV=sandbox
|
||||||
|
|
||||||
|
# Your Plaid keys, which can be found in the Plaid Dashboard.
|
||||||
|
# https://dashboard.plaid.com/account/keys
|
||||||
|
PLAID_CLIENT_ID=
|
||||||
|
PLAID_SECRET_DEVELOPMENT=
|
||||||
|
PLAID_SECRET_SANDBOX=
|
||||||
|
|
||||||
|
PLAID_LINK_WEBHOOK=
|
||||||
|
|
||||||
|
# (Optional) Redirect URI settings section
|
||||||
|
# Only required for OAuth redirect URI testing (not common on desktop):
|
||||||
|
# Sandbox Mode:
|
||||||
|
# Set the PLAID_SANDBOX_REDIRECT_URI below to 'http://localhost:3001/oauth-link'.
|
||||||
|
# The OAuth redirect flow requires an endpoint on the developer's website
|
||||||
|
# that the bank website should redirect to. You will also need to configure
|
||||||
|
# this redirect URI for your client ID through the Plaid developer dashboard
|
||||||
|
# at https://dashboard.plaid.com/team/api.
|
||||||
|
# Development mode:
|
||||||
|
# When running in development mode, you must use an https:// url.
|
||||||
|
# You will need to configure this https:// redirect URI in the Plaid developer dashboard.
|
||||||
|
# Instructions to create a self-signed certificate for localhost can be found at
|
||||||
|
# https://github.com/plaid/pattern/blob/master/README.md#testing-oauth.
|
||||||
|
# If your system is not set up to run localhost with https://, you will be unable to test
|
||||||
|
# the OAuth in development and should leave the PLAID_DEVELOPMENT_REDIRECT_URI blank.
|
||||||
|
|
||||||
|
PLAID_SANDBOX_REDIRECT_URI=
|
||||||
|
PLAID_DEVELOPMENT_REDIRECT_URI=
|
||||||
|
|||||||
@@ -91,12 +91,14 @@
|
|||||||
"pluralize": "^8.0.0",
|
"pluralize": "^8.0.0",
|
||||||
"pug": "^3.0.2",
|
"pug": "^3.0.2",
|
||||||
"puppeteer": "^10.2.0",
|
"puppeteer": "^10.2.0",
|
||||||
|
"plaid": "^10.3.0",
|
||||||
"qim": "0.0.52",
|
"qim": "0.0.52",
|
||||||
"ramda": "^0.27.1",
|
"ramda": "^0.27.1",
|
||||||
"rate-limiter-flexible": "^2.1.14",
|
"rate-limiter-flexible": "^2.1.14",
|
||||||
"reflect-metadata": "^0.1.13",
|
"reflect-metadata": "^0.1.13",
|
||||||
"rtl-detect": "^1.0.4",
|
"rtl-detect": "^1.0.4",
|
||||||
"source-map-loader": "^4.0.1",
|
"source-map-loader": "^4.0.1",
|
||||||
|
"socket.io": "^4.7.4",
|
||||||
"tmp-promise": "^3.0.3",
|
"tmp-promise": "^3.0.3",
|
||||||
"ts-transformer-keys": "^0.4.2",
|
"ts-transformer-keys": "^0.4.2",
|
||||||
"tsyringe": "^4.3.0",
|
"tsyringe": "^4.3.0",
|
||||||
|
|||||||
57
packages/server/resources/scss/modules/financial-sheet.scss
Normal file
57
packages/server/resources/scss/modules/financial-sheet.scss
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
@import "../base.scss";
|
||||||
|
|
||||||
|
html,
|
||||||
|
body {
|
||||||
|
font-size: 14px;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
font-weight: 400;
|
||||||
|
letter-spacing: 0;
|
||||||
|
line-height: 1.28581;
|
||||||
|
text-transform: none;
|
||||||
|
color: #000;
|
||||||
|
font-family: Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Open Sans, Helvetica Neue, Icons16, sans-serif;
|
||||||
|
}
|
||||||
|
.sheet{
|
||||||
|
padding: 20px;
|
||||||
|
}
|
||||||
|
.sheet__company-name{
|
||||||
|
margin: 0;
|
||||||
|
font-size: 1.4rem;
|
||||||
|
}
|
||||||
|
.sheet__sheet-type {
|
||||||
|
margin: 0
|
||||||
|
}
|
||||||
|
.sheet__sheet-date {
|
||||||
|
margin-top: 0.35rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sheet__header {
|
||||||
|
text-align: center;
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sheet__table {
|
||||||
|
border-top: 1px solid #000;
|
||||||
|
table-layout: fixed;
|
||||||
|
border-spacing: 0;
|
||||||
|
text-align: left;
|
||||||
|
font-size: inherit;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sheet__table thead th {
|
||||||
|
color: #000;
|
||||||
|
border-bottom: 1px solid #000000;
|
||||||
|
padding: 0.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sheet__table tbody td {
|
||||||
|
border-bottom: 0;
|
||||||
|
padding-top: 0.28rem;
|
||||||
|
padding-bottom: 0.28rem;
|
||||||
|
padding-left: 0.5rem;
|
||||||
|
padding-right: 0.5rem;
|
||||||
|
color: #252A31;
|
||||||
|
border-bottom: 1px solid transparent;
|
||||||
|
}
|
||||||
25
packages/server/resources/views/modules/financial-sheet.pug
Normal file
25
packages/server/resources/views/modules/financial-sheet.pug
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
block head
|
||||||
|
style
|
||||||
|
include ../../css/modules/financial-sheet.css
|
||||||
|
|
||||||
|
style.
|
||||||
|
!{customCSS}
|
||||||
|
|
||||||
|
block content
|
||||||
|
.sheet
|
||||||
|
.sheet__header
|
||||||
|
.sheet__company-name=organizationName
|
||||||
|
.sheet__sheet-type=sheetName
|
||||||
|
.sheet__sheet-date=sheetDate
|
||||||
|
|
||||||
|
table.sheet__table
|
||||||
|
thead
|
||||||
|
tr
|
||||||
|
each column in table.columns
|
||||||
|
th(style=column.style class='column--' + column.key)= column.label
|
||||||
|
tbody
|
||||||
|
each row in table.rows
|
||||||
|
tr(class=row.classNames)
|
||||||
|
each cell in row.cells
|
||||||
|
td(class='cell--' + cell.key)
|
||||||
|
span!= cell.value
|
||||||
@@ -66,12 +66,10 @@ module.exports = {
|
|||||||
// sourcemaps: true, // Allow to enable/disable sourcemaps or pass object to configure it.
|
// sourcemaps: true, // Allow to enable/disable sourcemaps or pass object to configure it.
|
||||||
// minify: true, // Allow to enable/disable minify the source.
|
// minify: true, // Allow to enable/disable minify the source.
|
||||||
},
|
},
|
||||||
// {
|
{
|
||||||
// src: './assets/sass/editor-style.scss',
|
src: `${RESOURCES_PATH}/scss/modules/financial-sheet.scss`,
|
||||||
// dest: './assets/css',
|
dest: `${RESOURCES_PATH}/css/modules`,
|
||||||
// sourcemaps: true,
|
},
|
||||||
// minify: true,
|
|
||||||
// },
|
|
||||||
],
|
],
|
||||||
// RTL builds.
|
// RTL builds.
|
||||||
rtl: [
|
rtl: [
|
||||||
@@ -114,7 +112,7 @@ module.exports = {
|
|||||||
// SASS Configuration for all builds.
|
// SASS Configuration for all builds.
|
||||||
sass: {
|
sass: {
|
||||||
errLogToConsole: true,
|
errLogToConsole: true,
|
||||||
// outputStyle: 'compact',
|
// outputStyle: 'compact',
|
||||||
},
|
},
|
||||||
|
|
||||||
// CSS MQ Packer configuration for all builds and style tasks.
|
// CSS MQ Packer configuration for all builds and style tasks.
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import Container, { Inject, Service } from 'typedi';
|
||||||
|
import { Router } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { PlaidBankingController } from './PlaidBankingController';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class BankingController extends BaseController {
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.use('/plaid', Container.get(PlaidBankingController).router());
|
||||||
|
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { Router, Request, Response } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { PlaidApplication } from '@/services/Banking/Plaid/PlaidApplication';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidBankingController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private plaidApp: PlaidApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.post('/link-token', this.linkToken.bind(this));
|
||||||
|
router.post('/exchange-token', this.exchangeToken.bind(this));
|
||||||
|
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the Plaid link token.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {response} res
|
||||||
|
* @returns {Response}
|
||||||
|
*/
|
||||||
|
private async linkToken(req: Request, res: Response) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
const linkToken = await this.plaidApp.getLinkToken(tenantId);
|
||||||
|
|
||||||
|
return res.status(200).send(linkToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the given public token.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {response} res
|
||||||
|
* @returns {Response}
|
||||||
|
*/
|
||||||
|
public async exchangeToken(req: Request, res: Response) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { public_token, institution_id } = req.body;
|
||||||
|
|
||||||
|
await this.plaidApp.exchangeToken(tenantId, {
|
||||||
|
institutionId: institution_id,
|
||||||
|
publicToken: public_token,
|
||||||
|
});
|
||||||
|
return res.status(200).send({});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,9 +13,9 @@ export default class CashflowController {
|
|||||||
router() {
|
router() {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
|
router.use(Container.get(CommandCashflowTransaction).router());
|
||||||
router.use(Container.get(GetCashflowTransaction).router());
|
router.use(Container.get(GetCashflowTransaction).router());
|
||||||
router.use(Container.get(GetCashflowAccounts).router());
|
router.use(Container.get(GetCashflowAccounts).router());
|
||||||
router.use(Container.get(CommandCashflowTransaction).router());
|
|
||||||
router.use(Container.get(DeleteCashflowTransaction).router());
|
router.use(Container.get(DeleteCashflowTransaction).router());
|
||||||
|
|
||||||
return router;
|
return router;
|
||||||
|
|||||||
@@ -3,14 +3,15 @@ import { Router, Request, Response, NextFunction } from 'express';
|
|||||||
import { param } from 'express-validator';
|
import { param } from 'express-validator';
|
||||||
import BaseController from '../BaseController';
|
import BaseController from '../BaseController';
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import DeleteCashflowTransactionService from '../../../services/Cashflow/DeleteCashflowTransactionService';
|
|
||||||
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
||||||
|
|
||||||
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class DeleteCashflowTransaction extends BaseController {
|
export default class DeleteCashflowTransactionController extends BaseController {
|
||||||
@Inject()
|
@Inject()
|
||||||
deleteCashflowService: DeleteCashflowTransactionService;
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller router.
|
* Controller router.
|
||||||
@@ -44,7 +45,7 @@ export default class DeleteCashflowTransaction extends BaseController {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
const { oldCashflowTransaction } =
|
const { oldCashflowTransaction } =
|
||||||
await this.deleteCashflowService.deleteCashflowTransaction(
|
await this.cashflowApplication.deleteTransaction(
|
||||||
tenantId,
|
tenantId,
|
||||||
transactionId
|
transactionId
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,20 +1,16 @@
|
|||||||
import { Service, Inject } from 'typedi';
|
import { Service, Inject } from 'typedi';
|
||||||
import { Router, Request, Response, NextFunction } from 'express';
|
import { Router, Request, Response, NextFunction } from 'express';
|
||||||
import { param, query } from 'express-validator';
|
import { query } from 'express-validator';
|
||||||
import GetCashflowAccountsService from '@/services/Cashflow/GetCashflowAccountsService';
|
|
||||||
import BaseController from '../BaseController';
|
import BaseController from '../BaseController';
|
||||||
import GetCashflowTransactionsService from '@/services/Cashflow/GetCashflowTransactionsService';
|
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
||||||
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class GetCashflowAccounts extends BaseController {
|
export default class GetCashflowAccounts extends BaseController {
|
||||||
@Inject()
|
@Inject()
|
||||||
getCashflowAccountsService: GetCashflowAccountsService;
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
@Inject()
|
|
||||||
getCashflowTransactionsService: GetCashflowTransactionsService;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller router.
|
* Controller router.
|
||||||
@@ -62,10 +58,7 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
const cashflowAccounts =
|
const cashflowAccounts =
|
||||||
await this.getCashflowAccountsService.getCashflowAccounts(
|
await this.cashflowApplication.getCashflowAccounts(tenantId, filter);
|
||||||
tenantId,
|
|
||||||
filter
|
|
||||||
);
|
|
||||||
|
|
||||||
return res.status(200).send({
|
return res.status(200).send({
|
||||||
cashflow_accounts: this.transfromToResponse(cashflowAccounts),
|
cashflow_accounts: this.transfromToResponse(cashflowAccounts),
|
||||||
|
|||||||
@@ -2,15 +2,15 @@ import { Service, Inject } from 'typedi';
|
|||||||
import { Router, Request, Response, NextFunction } from 'express';
|
import { Router, Request, Response, NextFunction } from 'express';
|
||||||
import { param } from 'express-validator';
|
import { param } from 'express-validator';
|
||||||
import BaseController from '../BaseController';
|
import BaseController from '../BaseController';
|
||||||
import GetCashflowTransactionsService from '@/services/Cashflow/GetCashflowTransactionsService';
|
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
||||||
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class GetCashflowAccounts extends BaseController {
|
export default class GetCashflowAccounts extends BaseController {
|
||||||
@Inject()
|
@Inject()
|
||||||
getCashflowTransactionsService: GetCashflowTransactionsService;
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller router.
|
* Controller router.
|
||||||
@@ -43,11 +43,10 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
const { transactionId } = req.params;
|
const { transactionId } = req.params;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const cashflowTransaction =
|
const cashflowTransaction = await this.cashflowApplication.getTransaction(
|
||||||
await this.getCashflowTransactionsService.getCashflowTransaction(
|
tenantId,
|
||||||
tenantId,
|
transactionId
|
||||||
transactionId
|
);
|
||||||
);
|
|
||||||
|
|
||||||
return res.status(200).send({
|
return res.status(200).send({
|
||||||
cashflow_transaction: this.transfromToResponse(cashflowTransaction),
|
cashflow_transaction: this.transfromToResponse(cashflowTransaction),
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
import { Service, Inject } from 'typedi';
|
import { Service, Inject } from 'typedi';
|
||||||
import { check } from 'express-validator';
|
import { ValidationChain, check, param, query } from 'express-validator';
|
||||||
import { Router, Request, Response, NextFunction } from 'express';
|
import { Router, Request, Response, NextFunction } from 'express';
|
||||||
import BaseController from '../BaseController';
|
import BaseController from '../BaseController';
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import NewCashflowTransactionService from '@/services/Cashflow/NewCashflowTransactionService';
|
|
||||||
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
||||||
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
import { AbilitySubject, CashflowAction } from '@/interfaces';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class NewCashflowTransactionController extends BaseController {
|
export default class NewCashflowTransactionController extends BaseController {
|
||||||
@Inject()
|
@Inject()
|
||||||
private newCashflowTranscationService: NewCashflowTransactionService;
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router constructor.
|
* Router constructor.
|
||||||
@@ -18,6 +18,18 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
public router() {
|
public router() {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
|
router.get(
|
||||||
|
'/transactions/uncategorized/:id',
|
||||||
|
this.asyncMiddleware(this.getUncategorizedCashflowTransaction),
|
||||||
|
this.catchServiceErrors
|
||||||
|
);
|
||||||
|
router.get(
|
||||||
|
'/transactions/:id/uncategorized',
|
||||||
|
this.getUncategorizedTransactionsValidationSchema,
|
||||||
|
this.validationResult,
|
||||||
|
this.asyncMiddleware(this.getUncategorizedCashflowTransactions),
|
||||||
|
this.catchServiceErrors
|
||||||
|
);
|
||||||
router.post(
|
router.post(
|
||||||
'/transactions',
|
'/transactions',
|
||||||
CheckPolicies(CashflowAction.Create, AbilitySubject.Cashflow),
|
CheckPolicies(CashflowAction.Create, AbilitySubject.Cashflow),
|
||||||
@@ -26,13 +38,72 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
this.asyncMiddleware(this.newCashflowTransaction),
|
this.asyncMiddleware(this.newCashflowTransaction),
|
||||||
this.catchServiceErrors
|
this.catchServiceErrors
|
||||||
);
|
);
|
||||||
|
router.post(
|
||||||
|
'/transactions/:id/uncategorize',
|
||||||
|
this.revertCategorizedCashflowTransaction,
|
||||||
|
this.catchServiceErrors
|
||||||
|
);
|
||||||
|
router.post(
|
||||||
|
'/transactions/:id/categorize',
|
||||||
|
this.categorizeCashflowTransactionValidationSchema,
|
||||||
|
this.validationResult,
|
||||||
|
this.categorizeCashflowTransaction,
|
||||||
|
this.catchServiceErrors
|
||||||
|
);
|
||||||
|
router.post(
|
||||||
|
'/transaction/:id/categorize/expense',
|
||||||
|
this.categorizeAsExpenseValidationSchema,
|
||||||
|
this.validationResult,
|
||||||
|
this.categorizesCashflowTransactionAsExpense,
|
||||||
|
this.catchServiceErrors
|
||||||
|
);
|
||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Getting uncategorized transactions validation schema.
|
||||||
|
* @returns {ValidationChain}
|
||||||
|
*/
|
||||||
|
public get getUncategorizedTransactionsValidationSchema() {
|
||||||
|
return [
|
||||||
|
param('id').exists().isNumeric().toInt(),
|
||||||
|
query('page').optional().isNumeric().toInt(),
|
||||||
|
query('page_size').optional().isNumeric().toInt(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize as expense validation schema.
|
||||||
|
*/
|
||||||
|
public get categorizeAsExpenseValidationSchema() {
|
||||||
|
return [
|
||||||
|
check('expense_account_id').exists(),
|
||||||
|
check('date').isISO8601().exists(),
|
||||||
|
check('reference_no').optional(),
|
||||||
|
check('exchange_rate').optional().isFloat({ gt: 0 }).toFloat(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize cashflow tranasction validation schema.
|
||||||
|
*/
|
||||||
|
public get categorizeCashflowTransactionValidationSchema() {
|
||||||
|
return [
|
||||||
|
check('date').exists().isISO8601().toDate(),
|
||||||
|
check('credit_account_id').exists().isInt().toInt(),
|
||||||
|
check('transaction_number').optional(),
|
||||||
|
check('transaction_type').exists(),
|
||||||
|
check('reference_no').optional(),
|
||||||
|
check('exchange_rate').optional().isFloat({ gt: 0 }).toFloat(),
|
||||||
|
check('description').optional(),
|
||||||
|
check('branch_id').optional({ nullable: true }).isNumeric().toInt(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* New cashflow transaction validation schema.
|
* New cashflow transaction validation schema.
|
||||||
*/
|
*/
|
||||||
get newTransactionValidationSchema() {
|
public get newTransactionValidationSchema() {
|
||||||
return [
|
return [
|
||||||
check('date').exists().isISO8601().toDate(),
|
check('date').exists().isISO8601().toDate(),
|
||||||
check('reference_no').optional({ nullable: true }).trim().escape(),
|
check('reference_no').optional({ nullable: true }).trim().escape(),
|
||||||
@@ -48,9 +119,7 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
check('credit_account_id').exists().isInt().toInt(),
|
check('credit_account_id').exists().isInt().toInt(),
|
||||||
|
|
||||||
check('exchange_rate').optional().isFloat({ gt: 0 }).toFloat(),
|
check('exchange_rate').optional().isFloat({ gt: 0 }).toFloat(),
|
||||||
|
|
||||||
check('branch_id').optional({ nullable: true }).isNumeric().toInt(),
|
check('branch_id').optional({ nullable: true }).isNumeric().toInt(),
|
||||||
|
|
||||||
check('publish').default(false).isBoolean().toBoolean(),
|
check('publish').default(false).isBoolean().toBoolean(),
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
@@ -70,13 +139,12 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
const ownerContributionDTO = this.matchedBodyData(req);
|
const ownerContributionDTO = this.matchedBodyData(req);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const { cashflowTransaction } =
|
const cashflowTransaction =
|
||||||
await this.newCashflowTranscationService.newCashflowTransaction(
|
await this.cashflowApplication.createTransaction(
|
||||||
tenantId,
|
tenantId,
|
||||||
ownerContributionDTO,
|
ownerContributionDTO,
|
||||||
userId
|
userId
|
||||||
);
|
);
|
||||||
|
|
||||||
return res.status(200).send({
|
return res.status(200).send({
|
||||||
id: cashflowTransaction.id,
|
id: cashflowTransaction.id,
|
||||||
message: 'New cashflow transaction has been created successfully.',
|
message: 'New cashflow transaction has been created successfully.',
|
||||||
@@ -86,11 +154,147 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Revert the categorized cashflow transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private revertCategorizedCashflowTransaction = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: cashflowTransactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data = await this.cashflowApplication.uncategorizeTransaction(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({ data });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize the cashflow transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private categorizeCashflowTransaction = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: cashflowTransactionId } = req.params;
|
||||||
|
const cashflowTransaction = this.matchedBodyData(req);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.cashflowApplication.categorizeTransaction(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId,
|
||||||
|
cashflowTransaction
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
message: 'The cashflow transaction has been created successfully.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize the transaction as expense transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private categorizesCashflowTransactionAsExpense = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: cashflowTransactionId } = req.params;
|
||||||
|
const cashflowTransaction = this.matchedBodyData(req);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.cashflowApplication.categorizeAsExpense(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId,
|
||||||
|
cashflowTransaction
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
message: 'The cashflow transaction has been created successfully.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the uncategorized cashflow transactions.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
public getUncategorizedCashflowTransaction = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: transactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data = await this.cashflowApplication.getUncategorizedTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({ data });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the uncategorized cashflow transactions.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
public getUncategorizedCashflowTransactions = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: accountId } = req.params;
|
||||||
|
const query = this.matchedQueryData(req);
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data = await this.cashflowApplication.getUncategorizedTransactions(
|
||||||
|
tenantId,
|
||||||
|
accountId,
|
||||||
|
query
|
||||||
|
);
|
||||||
|
|
||||||
|
return res.status(200).send(data);
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle the service errors.
|
* Handle the service errors.
|
||||||
* @param error
|
* @param error
|
||||||
* @param req
|
* @param {Request} req
|
||||||
* @param res
|
* @param {res
|
||||||
* @param next
|
* @param next
|
||||||
* @returns
|
* @returns
|
||||||
*/
|
*/
|
||||||
@@ -140,6 +344,16 @@ export default class NewCashflowTransactionController extends BaseController {
|
|||||||
],
|
],
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
if (error.errorType === 'UNCATEGORIZED_TRANSACTION_TYPE_INVALID') {
|
||||||
|
return res.boom.badRequest(null, {
|
||||||
|
errors: [
|
||||||
|
{
|
||||||
|
type: 'UNCATEGORIZED_TRANSACTION_TYPE_INVALID',
|
||||||
|
code: 4100,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
next(error);
|
next(error);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,27 +26,27 @@ export default class ContactsController extends BaseController {
|
|||||||
[...this.autocompleteQuerySchema],
|
[...this.autocompleteQuerySchema],
|
||||||
this.validationResult,
|
this.validationResult,
|
||||||
this.asyncMiddleware(this.autocompleteContacts.bind(this)),
|
this.asyncMiddleware(this.autocompleteContacts.bind(this)),
|
||||||
this.dynamicListService.handlerErrorsToResponse
|
this.dynamicListService.handlerErrorsToResponse,
|
||||||
);
|
);
|
||||||
router.get(
|
router.get(
|
||||||
'/:id',
|
'/:id',
|
||||||
[param('id').exists().isNumeric().toInt()],
|
[param('id').exists().isNumeric().toInt()],
|
||||||
this.validationResult,
|
this.validationResult,
|
||||||
this.asyncMiddleware(this.getContact.bind(this))
|
this.asyncMiddleware(this.getContact.bind(this)),
|
||||||
);
|
);
|
||||||
router.post(
|
router.post(
|
||||||
'/:id/inactivate',
|
'/:id/inactivate',
|
||||||
[param('id').exists().isNumeric().toInt()],
|
[param('id').exists().isNumeric().toInt()],
|
||||||
this.validationResult,
|
this.validationResult,
|
||||||
this.asyncMiddleware(this.inactivateContact.bind(this)),
|
this.asyncMiddleware(this.inactivateContact.bind(this)),
|
||||||
this.handlerServiceErrors
|
this.handlerServiceErrors,
|
||||||
);
|
);
|
||||||
router.post(
|
router.post(
|
||||||
'/:id/activate',
|
'/:id/activate',
|
||||||
[param('id').exists().isNumeric().toInt()],
|
[param('id').exists().isNumeric().toInt()],
|
||||||
this.validationResult,
|
this.validationResult,
|
||||||
this.asyncMiddleware(this.activateContact.bind(this)),
|
this.asyncMiddleware(this.activateContact.bind(this)),
|
||||||
this.handlerServiceErrors
|
this.handlerServiceErrors,
|
||||||
);
|
);
|
||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
@@ -77,7 +77,7 @@ export default class ContactsController extends BaseController {
|
|||||||
try {
|
try {
|
||||||
const contact = await this.contactsService.getContact(
|
const contact = await this.contactsService.getContact(
|
||||||
tenantId,
|
tenantId,
|
||||||
contactId
|
contactId,
|
||||||
);
|
);
|
||||||
return res.status(200).send({
|
return res.status(200).send({
|
||||||
customer: this.transfromToResponse(contact),
|
customer: this.transfromToResponse(contact),
|
||||||
@@ -105,7 +105,7 @@ export default class ContactsController extends BaseController {
|
|||||||
try {
|
try {
|
||||||
const contacts = await this.contactsService.autocompleteContacts(
|
const contacts = await this.contactsService.autocompleteContacts(
|
||||||
tenantId,
|
tenantId,
|
||||||
filter
|
filter,
|
||||||
);
|
);
|
||||||
return res.status(200).send({ contacts });
|
return res.status(200).send({ contacts });
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -153,7 +153,6 @@ export default class ContactsController extends BaseController {
|
|||||||
check('email')
|
check('email')
|
||||||
.optional({ nullable: true })
|
.optional({ nullable: true })
|
||||||
.isString()
|
.isString()
|
||||||
.normalizeEmail()
|
|
||||||
.isEmail()
|
.isEmail()
|
||||||
.isLength({ max: DATATYPES_LENGTH.STRING }),
|
.isLength({ max: DATATYPES_LENGTH.STRING }),
|
||||||
check('website')
|
check('website')
|
||||||
@@ -380,7 +379,7 @@ export default class ContactsController extends BaseController {
|
|||||||
error: Error,
|
error: Error,
|
||||||
req: Request,
|
req: Request,
|
||||||
res: Response,
|
res: Response,
|
||||||
next: NextFunction
|
next: NextFunction,
|
||||||
) {
|
) {
|
||||||
if (error instanceof ServiceError) {
|
if (error instanceof ServiceError) {
|
||||||
if (error.errorType === 'contact_not_found') {
|
if (error.errorType === 'contact_not_found') {
|
||||||
|
|||||||
@@ -71,6 +71,7 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF
|
||||||
]);
|
]);
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
||||||
@@ -98,6 +99,15 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.APAgingSummaryApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.APAgingSummaryApp.sheet(tenantId, filter);
|
const sheet = await this.APAgingSummaryApp.sheet(tenantId, filter);
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import { ACCEPT_TYPE } from '@/interfaces/Http';
|
|||||||
@Service()
|
@Service()
|
||||||
export default class ARAgingSummaryReportController extends BaseFinancialReportController {
|
export default class ARAgingSummaryReportController extends BaseFinancialReportController {
|
||||||
@Inject()
|
@Inject()
|
||||||
ARAgingSummaryApp: ARAgingSummaryApplication;
|
private ARAgingSummaryApp: ARAgingSummaryApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router constructor.
|
* Router constructor.
|
||||||
@@ -69,6 +69,7 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF
|
||||||
]);
|
]);
|
||||||
// Retrieves the xlsx format.
|
// Retrieves the xlsx format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
|
||||||
@@ -96,6 +97,15 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
|
|||||||
res.setHeader('Content-Type', 'text/csv');
|
res.setHeader('Content-Type', 'text/csv');
|
||||||
|
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.ARAgingSummaryApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.ARAgingSummaryApp.sheet(tenantId, filter);
|
const sheet = await this.ARAgingSummaryApp.sheet(tenantId, filter);
|
||||||
|
|||||||
@@ -101,6 +101,7 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE == acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE == acceptType) {
|
||||||
@@ -128,6 +129,15 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.balanceSheetApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
res.send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.balanceSheetApp.sheet(tenantId, filter);
|
const sheet = await this.balanceSheetApp.sheet(tenantId, filter);
|
||||||
|
|
||||||
|
|||||||
@@ -79,6 +79,7 @@ export default class CashFlowController extends BaseFinancialReportController {
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF
|
||||||
]);
|
]);
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
||||||
@@ -106,6 +107,15 @@ export default class CashFlowController extends BaseFinancialReportController {
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.cashflowSheetApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const cashflow = await this.cashflowSheetApp.sheet(tenantId, filter);
|
const cashflow = await this.cashflowSheetApp.sheet(tenantId, filter);
|
||||||
|
|||||||
@@ -75,6 +75,7 @@ export default class CustomerBalanceSummaryReportController extends BaseFinancia
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the xlsx format.
|
// Retrieves the xlsx format.
|
||||||
@@ -109,6 +110,19 @@ export default class CustomerBalanceSummaryReportController extends BaseFinancia
|
|||||||
filter
|
filter
|
||||||
);
|
);
|
||||||
return res.status(200).send(table);
|
return res.status(200).send(table);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const buffer = await this.customerBalanceSummaryApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': buffer.length,
|
||||||
|
});
|
||||||
|
return res.send(buffer);
|
||||||
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.customerBalanceSummaryApp.sheet(
|
const sheet = await this.customerBalanceSummaryApp.sheet(
|
||||||
tenantId,
|
tenantId,
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
|
|||||||
/**
|
/**
|
||||||
* Router constructor.
|
* Router constructor.
|
||||||
*/
|
*/
|
||||||
router() {
|
public router() {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
router.get(
|
router.get(
|
||||||
@@ -32,7 +32,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
|
|||||||
/**
|
/**
|
||||||
* Validation schema.
|
* Validation schema.
|
||||||
*/
|
*/
|
||||||
get validationSchema(): ValidationChain[] {
|
private get validationSchema(): ValidationChain[] {
|
||||||
return [
|
return [
|
||||||
query('from_date').optional().isISO8601(),
|
query('from_date').optional().isISO8601(),
|
||||||
query('to_date').optional().isISO8601(),
|
query('to_date').optional().isISO8601(),
|
||||||
@@ -61,7 +61,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
|
|||||||
* @param {Request} req -
|
* @param {Request} req -
|
||||||
* @param {Response} res -
|
* @param {Response} res -
|
||||||
*/
|
*/
|
||||||
async generalLedger(req: Request, res: Response, next: NextFunction) {
|
private async generalLedger(req: Request, res: Response, next: NextFunction) {
|
||||||
const { tenantId } = req;
|
const { tenantId } = req;
|
||||||
const filter = this.matchedQueryData(req);
|
const filter = this.matchedQueryData(req);
|
||||||
const accept = this.accepts(req);
|
const accept = this.accepts(req);
|
||||||
@@ -71,6 +71,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
// Retrieves the table format.
|
// Retrieves the table format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
||||||
@@ -95,6 +96,17 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.generalLedgerApplication.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.generalLedgerApplication.sheet(tenantId, filter);
|
const sheet = await this.generalLedgerApplication.sheet(tenantId, filter);
|
||||||
|
|||||||
@@ -96,6 +96,7 @@ export default class InventoryDetailsController extends BaseController {
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
// Retrieves the csv format.
|
// Retrieves the csv format.
|
||||||
if (acceptType === ACCEPT_TYPE.APPLICATION_CSV) {
|
if (acceptType === ACCEPT_TYPE.APPLICATION_CSV) {
|
||||||
@@ -127,6 +128,15 @@ export default class InventoryDetailsController extends BaseController {
|
|||||||
filter
|
filter
|
||||||
);
|
);
|
||||||
return res.status(200).send(table);
|
return res.status(200).send(table);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
|
||||||
|
const buffer = await this.inventoryItemDetailsApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': buffer.length,
|
||||||
|
});
|
||||||
|
return res.send(buffer);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.inventoryItemDetailsApp.sheet(
|
const sheet = await this.inventoryItemDetailsApp.sheet(
|
||||||
tenantId,
|
tenantId,
|
||||||
|
|||||||
@@ -79,6 +79,7 @@ export default class InventoryValuationReportController extends BaseFinancialRep
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
@@ -104,6 +105,15 @@ export default class InventoryValuationReportController extends BaseFinancialRep
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.inventoryValuationApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.status(200).send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const { data, query, meta } = await this.inventoryValuationApp.sheet(
|
const { data, query, meta } = await this.inventoryValuationApp.sheet(
|
||||||
|
|||||||
@@ -72,6 +72,7 @@ export default class JournalSheetController extends BaseFinancialReportControlle
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
@@ -81,7 +82,7 @@ export default class JournalSheetController extends BaseFinancialReportControlle
|
|||||||
// Retrieves the csv format.
|
// Retrieves the csv format.
|
||||||
} else if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
|
} else if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
|
||||||
const buffer = await this.journalSheetApp.csv(tenantId, filter);
|
const buffer = await this.journalSheetApp.csv(tenantId, filter);
|
||||||
|
|
||||||
res.setHeader('Content-Disposition', 'attachment; filename=output.csv');
|
res.setHeader('Content-Disposition', 'attachment; filename=output.csv');
|
||||||
res.setHeader('Content-Type', 'text/csv');
|
res.setHeader('Content-Type', 'text/csv');
|
||||||
|
|
||||||
@@ -97,6 +98,14 @@ export default class JournalSheetController extends BaseFinancialReportControlle
|
|||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.journalSheetApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
res.send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.journalSheetApp.sheet(tenantId, filter);
|
const sheet = await this.journalSheetApp.sheet(tenantId, filter);
|
||||||
|
|
||||||
|
|||||||
@@ -96,6 +96,7 @@ export default class ProfitLossSheetController extends BaseFinancialReportContro
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
try {
|
try {
|
||||||
// Retrieves the csv format.
|
// Retrieves the csv format.
|
||||||
@@ -125,6 +126,14 @@ export default class ProfitLossSheetController extends BaseFinancialReportContro
|
|||||||
);
|
);
|
||||||
return res.send(sheet);
|
return res.send(sheet);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
|
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
|
||||||
|
const pdfContent = await this.profitLossSheetApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.profitLossSheetApp.sheet(tenantId, filter);
|
const sheet = await this.profitLossSheetApp.sheet(tenantId, filter);
|
||||||
|
|
||||||
|
|||||||
@@ -75,8 +75,8 @@ export default class PurchasesByItemReportController extends BaseFinancialReport
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// JSON table response format.
|
// JSON table response format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
|
||||||
const table = await this.purchasesByItemsApp.table(tenantId, filter);
|
const table = await this.purchasesByItemsApp.table(tenantId, filter);
|
||||||
@@ -100,6 +100,15 @@ export default class PurchasesByItemReportController extends BaseFinancialReport
|
|||||||
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
|
||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// PDF response format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.purchasesByItemsApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Json response format.
|
// Json response format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.purchasesByItemsApp.sheet(tenantId, filter);
|
const sheet = await this.purchasesByItemsApp.sheet(tenantId, filter);
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import { SalesByItemsApplication } from '@/services/FinancialStatements/SalesByI
|
|||||||
@Service()
|
@Service()
|
||||||
export default class SalesByItemsReportController extends BaseFinancialReportController {
|
export default class SalesByItemsReportController extends BaseFinancialReportController {
|
||||||
@Inject()
|
@Inject()
|
||||||
salesByItemsApp: SalesByItemsApplication;
|
private salesByItemsApp: SalesByItemsApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Router constructor.
|
* Router constructor.
|
||||||
@@ -71,6 +71,7 @@ export default class SalesByItemsReportController extends BaseFinancialReportCon
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
// Retrieves the csv format.
|
// Retrieves the csv format.
|
||||||
if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
|
if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
|
||||||
@@ -96,6 +97,14 @@ export default class SalesByItemsReportController extends BaseFinancialReportCon
|
|||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.salesByItemsApp.pdf(tenantId, filter);
|
||||||
|
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.salesByItemsApp.sheet(tenantId, filter);
|
const sheet = await this.salesByItemsApp.sheet(tenantId, filter);
|
||||||
return res.status(200).send(sheet);
|
return res.status(200).send(sheet);
|
||||||
|
|||||||
@@ -62,6 +62,7 @@ export default class SalesTaxLiabilitySummary extends BaseFinancialReportControl
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
@@ -97,6 +98,16 @@ export default class SalesTaxLiabilitySummary extends BaseFinancialReportControl
|
|||||||
|
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
|
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
|
||||||
|
const pdfContent = await this.salesTaxLiabilitySummaryApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.status(200).send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.salesTaxLiabilitySummaryApp.sheet(
|
const sheet = await this.salesTaxLiabilitySummaryApp.sheet(
|
||||||
tenantId,
|
tenantId,
|
||||||
|
|||||||
@@ -70,6 +70,7 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
try {
|
try {
|
||||||
// Retrieves the json table format.
|
// Retrieves the json table format.
|
||||||
@@ -103,6 +104,16 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
|
|||||||
);
|
);
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
// Retrieve the json format.
|
// Retrieve the json format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.transactionsByCustomersApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.transactionsByCustomersApp.sheet(
|
const sheet = await this.transactionsByCustomersApp.sheet(
|
||||||
tenantId,
|
tenantId,
|
||||||
|
|||||||
@@ -71,6 +71,7 @@ export default class TransactionsByVendorsReportController extends BaseFinancial
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the xlsx format.
|
// Retrieves the xlsx format.
|
||||||
@@ -101,6 +102,17 @@ export default class TransactionsByVendorsReportController extends BaseFinancial
|
|||||||
filter
|
filter
|
||||||
);
|
);
|
||||||
return res.status(200).send(table);
|
return res.status(200).send(table);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
|
||||||
|
const pdfContent = await this.transactionsByVendorsApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.transactionsByVendorsApp.sheet(
|
const sheet = await this.transactionsByVendorsApp.sheet(
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ import { Request, Response, Router, NextFunction } from 'express';
|
|||||||
import { query, ValidationChain } from 'express-validator';
|
import { query, ValidationChain } from 'express-validator';
|
||||||
import { castArray } from 'lodash';
|
import { castArray } from 'lodash';
|
||||||
import asyncMiddleware from '@/api/middleware/asyncMiddleware';
|
import asyncMiddleware from '@/api/middleware/asyncMiddleware';
|
||||||
import TrialBalanceSheetService from '@/services/FinancialStatements/TrialBalanceSheet/TrialBalanceSheetInjectable';
|
|
||||||
import BaseFinancialReportController from './BaseFinancialReportController';
|
import BaseFinancialReportController from './BaseFinancialReportController';
|
||||||
import { AbilitySubject, ReportsAction } from '@/interfaces';
|
import { AbilitySubject, ReportsAction } from '@/interfaces';
|
||||||
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
import CheckPolicies from '@/api/middleware/CheckPolicies';
|
||||||
@@ -81,6 +80,7 @@ export default class TrialBalanceSheetController extends BaseFinancialReportCont
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
// Retrieves in json table format.
|
// Retrieves in json table format.
|
||||||
if (acceptType === ACCEPT_TYPE.APPLICATION_JSON_TABLE) {
|
if (acceptType === ACCEPT_TYPE.APPLICATION_JSON_TABLE) {
|
||||||
@@ -109,6 +109,17 @@ export default class TrialBalanceSheetController extends BaseFinancialReportCont
|
|||||||
res.setHeader('Content-Type', 'text/csv');
|
res.setHeader('Content-Type', 'text/csv');
|
||||||
|
|
||||||
return res.send(buffer);
|
return res.send(buffer);
|
||||||
|
// Retrieves in pdf format.
|
||||||
|
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
|
||||||
|
const pdfContent = await this.trialBalanceSheetApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
res.send(pdfContent);
|
||||||
// Retrieves in json format.
|
// Retrieves in json format.
|
||||||
} else {
|
} else {
|
||||||
const { data, query, meta } = await this.trialBalanceSheetApp.sheet(
|
const { data, query, meta } = await this.trialBalanceSheetApp.sheet(
|
||||||
|
|||||||
@@ -72,6 +72,7 @@ export default class VendorBalanceSummaryReportController extends BaseFinancialR
|
|||||||
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
ACCEPT_TYPE.APPLICATION_JSON_TABLE,
|
||||||
ACCEPT_TYPE.APPLICATION_CSV,
|
ACCEPT_TYPE.APPLICATION_CSV,
|
||||||
ACCEPT_TYPE.APPLICATION_XLSX,
|
ACCEPT_TYPE.APPLICATION_XLSX,
|
||||||
|
ACCEPT_TYPE.APPLICATION_PDF,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Retrieves the csv format.
|
// Retrieves the csv format.
|
||||||
@@ -100,6 +101,17 @@ export default class VendorBalanceSummaryReportController extends BaseFinancialR
|
|||||||
filter
|
filter
|
||||||
);
|
);
|
||||||
return res.status(200).send(table);
|
return res.status(200).send(table);
|
||||||
|
// Retrieves the pdf format.
|
||||||
|
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
|
||||||
|
const pdfContent = await this.vendorBalanceSummaryApp.pdf(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
res.set({
|
||||||
|
'Content-Type': 'application/pdf',
|
||||||
|
'Content-Length': pdfContent.length,
|
||||||
|
});
|
||||||
|
return res.send(pdfContent);
|
||||||
// Retrieves the json format.
|
// Retrieves the json format.
|
||||||
} else {
|
} else {
|
||||||
const sheet = await this.vendorBalanceSummaryApp.sheet(
|
const sheet = await this.vendorBalanceSummaryApp.sheet(
|
||||||
|
|||||||
47
packages/server/src/api/controllers/Webhooks/Webhooks.ts
Normal file
47
packages/server/src/api/controllers/Webhooks/Webhooks.ts
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
import { Router } from 'express';
|
||||||
|
import { PlaidApplication } from '@/services/Banking/Plaid/PlaidApplication';
|
||||||
|
import { Request, Response } from 'express';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import BaseController from '../BaseController';
|
||||||
|
import { PlaidWebhookTenantBootMiddleware } from '@/services/Banking/Plaid/PlaidWebhookTenantBootMiddleware';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class Webhooks extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private plaidApp: PlaidApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.use(PlaidWebhookTenantBootMiddleware);
|
||||||
|
router.post('/plaid', this.plaidWebhooks.bind(this));
|
||||||
|
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Listens to Plaid webhooks.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @returns {Response}
|
||||||
|
*/
|
||||||
|
public async plaidWebhooks(req: Request, res: Response) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const {
|
||||||
|
webhook_type: webhookType,
|
||||||
|
webhook_code: webhookCode,
|
||||||
|
item_id: plaidItemId,
|
||||||
|
} = req.body;
|
||||||
|
|
||||||
|
await this.plaidApp.webhooks(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId,
|
||||||
|
webhookType,
|
||||||
|
webhookCode
|
||||||
|
);
|
||||||
|
return res.status(200).send({ code: 200, message: 'ok' });
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -56,6 +56,8 @@ import { ProjectsController } from './controllers/Projects/Projects';
|
|||||||
import { ProjectTasksController } from './controllers/Projects/Tasks';
|
import { ProjectTasksController } from './controllers/Projects/Tasks';
|
||||||
import { ProjectTimesController } from './controllers/Projects/Times';
|
import { ProjectTimesController } from './controllers/Projects/Times';
|
||||||
import { TaxRatesController } from './controllers/TaxRates/TaxRates';
|
import { TaxRatesController } from './controllers/TaxRates/TaxRates';
|
||||||
|
import { BankingController } from './controllers/Banking/BankingController';
|
||||||
|
import { Webhooks } from './controllers/Webhooks/Webhooks';
|
||||||
|
|
||||||
export default () => {
|
export default () => {
|
||||||
const app = Router();
|
const app = Router();
|
||||||
@@ -71,6 +73,7 @@ export default () => {
|
|||||||
app.use('/ping', Container.get(Ping).router());
|
app.use('/ping', Container.get(Ping).router());
|
||||||
app.use('/jobs', Container.get(Jobs).router());
|
app.use('/jobs', Container.get(Jobs).router());
|
||||||
app.use('/account', Container.get(Account).router());
|
app.use('/account', Container.get(Account).router());
|
||||||
|
app.use('/webhooks', Container.get(Webhooks).router());
|
||||||
|
|
||||||
// - Dashboard routes.
|
// - Dashboard routes.
|
||||||
// ---------------------------
|
// ---------------------------
|
||||||
@@ -118,6 +121,7 @@ export default () => {
|
|||||||
Container.get(InventoryItemsCostController).router()
|
Container.get(InventoryItemsCostController).router()
|
||||||
);
|
);
|
||||||
dashboard.use('/cashflow', Container.get(CashflowController).router());
|
dashboard.use('/cashflow', Container.get(CashflowController).router());
|
||||||
|
dashboard.use('/banking', Container.get(BankingController).router());
|
||||||
dashboard.use('/roles', Container.get(RolesController).router());
|
dashboard.use('/roles', Container.get(RolesController).router());
|
||||||
dashboard.use(
|
dashboard.use(
|
||||||
'/transactions-locking',
|
'/transactions-locking',
|
||||||
|
|||||||
@@ -177,6 +177,19 @@ module.exports = {
|
|||||||
service: 'open-exchange-rate',
|
service: 'open-exchange-rate',
|
||||||
openExchangeRate: {
|
openExchangeRate: {
|
||||||
appId: process.env.OPEN_EXCHANGE_RATE_APP_ID,
|
appId: process.env.OPEN_EXCHANGE_RATE_APP_ID,
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plaid.
|
||||||
|
*/
|
||||||
|
plaid: {
|
||||||
|
env: process.env.PLAID_ENV || 'sandbox',
|
||||||
|
clientId: process.env.PLAID_CLIENT_ID,
|
||||||
|
secretDevelopment: process.env.PLAID_SECRET_DEVELOPMENT,
|
||||||
|
secretSandbox: process.env.PLAID_SECRET_SANDBOX,
|
||||||
|
redirectSandBox: process.env.PLAID_SANDBOX_REDIRECT_URI,
|
||||||
|
redirectDevelopment: process.env.PLAID_DEVELOPMENT_REDIRECT_URI,
|
||||||
|
linkWebhook: process.env.PLAID_LINK_WEBHOOK
|
||||||
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -136,6 +136,11 @@ export default {
|
|||||||
type: 'number',
|
type: 'number',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
inventory: {
|
||||||
|
cost_compute_running: {
|
||||||
|
type: 'boolean',
|
||||||
|
},
|
||||||
|
},
|
||||||
accounts: {
|
accounts: {
|
||||||
account_code_required: {
|
account_code_required: {
|
||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
|
|||||||
@@ -0,0 +1,14 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.createTable('plaid_items', (table) => {
|
||||||
|
table.increments('id');
|
||||||
|
table.integer('tenant_id').unsigned();
|
||||||
|
table.string('plaid_item_id');
|
||||||
|
table.string('plaid_institution_id');
|
||||||
|
table.string('plaid_access_token');
|
||||||
|
table.string('last_cursor');
|
||||||
|
table.string('status');
|
||||||
|
table.timestamps();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {};
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('accounts', (table) => {
|
||||||
|
table.string('plaid_account_id');
|
||||||
|
table.string('account_mask').nullable();
|
||||||
|
table.decimal('bank_balance', 15, 5);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {};
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('cashflow_transactions', (table) => {
|
||||||
|
table.string('plaid_transaction_id');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {};
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.createTable(
|
||||||
|
'uncategorized_cashflow_transactions',
|
||||||
|
(table) => {
|
||||||
|
table.increments('id');
|
||||||
|
table.date('date').index();
|
||||||
|
table.decimal('amount');
|
||||||
|
table.string('currency_code');
|
||||||
|
table.string('reference_no').index();
|
||||||
|
table.string('payee');
|
||||||
|
table
|
||||||
|
.integer('account_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('accounts');
|
||||||
|
table.string('description');
|
||||||
|
table.string('categorize_ref_type');
|
||||||
|
table.integer('categorize_ref_id').unsigned();
|
||||||
|
table.boolean('categorized').defaultTo(false);
|
||||||
|
table.string('plaid_transaction_id');
|
||||||
|
table.timestamps();
|
||||||
|
}
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.dropTableIfExists('uncategorized_cashflow_transactions');
|
||||||
|
};
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('accounts', (table) => {
|
||||||
|
table.integer('uncategorized_transactions').defaultTo(0);
|
||||||
|
table.boolean('is_system_account').defaultTo(true);
|
||||||
|
table.boolean('is_feeds_active').defaultTo(false);
|
||||||
|
table.datetime('last_feeds_updated_at').nullable();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {};
|
||||||
@@ -5,6 +5,7 @@ import {
|
|||||||
IAgingSummaryContact,
|
IAgingSummaryContact,
|
||||||
IAgingSummaryData,
|
IAgingSummaryData,
|
||||||
} from './AgingReport';
|
} from './AgingReport';
|
||||||
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IAPAgingSummaryQuery extends IAgingSummaryQuery {
|
export interface IAPAgingSummaryQuery extends IAgingSummaryQuery {
|
||||||
@@ -23,17 +24,22 @@ export interface IAPAgingSummaryData extends IAgingSummaryData {
|
|||||||
|
|
||||||
export type IAPAgingSummaryColumns = IAgingPeriod[];
|
export type IAPAgingSummaryColumns = IAgingPeriod[];
|
||||||
|
|
||||||
export interface IARAgingSummaryMeta {
|
export interface IARAgingSummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
baseCurrency: string;
|
formattedAsDate: string;
|
||||||
organizationName: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IAPAgingSummaryMeta {
|
export interface IAPAgingSummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
baseCurrency: string;
|
formattedAsDate: string;
|
||||||
organizationName: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IAPAgingSummaryTable extends IFinancialTable {
|
export interface IAPAgingSummaryTable extends IFinancialTable {
|
||||||
query: IAPAgingSummaryQuery;
|
query: IAPAgingSummaryQuery;
|
||||||
meta: IAPAgingSummaryMeta;
|
meta: IAPAgingSummaryMeta;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IAPAgingSummarySheet {
|
||||||
|
data: IAPAgingSummaryData;
|
||||||
|
meta: IAPAgingSummaryMeta;
|
||||||
|
query: IAPAgingSummaryQuery;
|
||||||
|
columns: any;
|
||||||
|
}
|
||||||
|
|||||||
@@ -32,3 +32,11 @@ export interface IARAgingSummaryTable extends IFinancialTable {
|
|||||||
meta: IARAgingSummaryMeta;
|
meta: IARAgingSummaryMeta;
|
||||||
query: IARAgingSummaryQuery;
|
query: IARAgingSummaryQuery;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IARAgingSummarySheet {
|
||||||
|
data: IARAgingSummaryData;
|
||||||
|
meta: IARAgingSummaryMeta;
|
||||||
|
query: IARAgingSummaryQuery;
|
||||||
|
columns: IARAgingSummaryColumns;
|
||||||
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,12 +6,15 @@ export interface IAccountDTO {
|
|||||||
code: string;
|
code: string;
|
||||||
description: string;
|
description: string;
|
||||||
accountType: string;
|
accountType: string;
|
||||||
parentAccountId: number;
|
parentAccountId?: number;
|
||||||
active: boolean;
|
active: boolean;
|
||||||
|
bankBalance?: number;
|
||||||
|
accountMask?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IAccountCreateDTO extends IAccountDTO {
|
export interface IAccountCreateDTO extends IAccountDTO {
|
||||||
currencyCode?: string;
|
currencyCode?: string;
|
||||||
|
plaidAccountId?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IAccountEditDTO extends IAccountDTO {}
|
export interface IAccountEditDTO extends IAccountDTO {}
|
||||||
@@ -33,6 +36,7 @@ export interface IAccount {
|
|||||||
type?: any[];
|
type?: any[];
|
||||||
accountNormal: string;
|
accountNormal: string;
|
||||||
accountParentType: string;
|
accountParentType: string;
|
||||||
|
bankBalance: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export enum AccountNormal {
|
export enum AccountNormal {
|
||||||
@@ -154,10 +158,9 @@ export enum AccountAction {
|
|||||||
TransactionsLocking = 'TransactionsLocking',
|
TransactionsLocking = 'TransactionsLocking',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
export enum TaxRateAction {
|
export enum TaxRateAction {
|
||||||
CREATE = 'Create',
|
CREATE = 'Create',
|
||||||
EDIT = 'Edit',
|
EDIT = 'Edit',
|
||||||
DELETE = 'Delete',
|
DELETE = 'Delete',
|
||||||
VIEW = 'View',
|
VIEW = 'View',
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
|
import {
|
||||||
import { INumberFormatQuery } from './FinancialStatements';
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
|
|
||||||
export interface IAgingPeriodTotal extends IAgingPeriod {
|
export interface IAgingPeriodTotal extends IAgingPeriod {
|
||||||
total: IAgingAmount;
|
total: IAgingAmount;
|
||||||
@@ -42,3 +44,8 @@ export interface IAgingSummaryTotal {
|
|||||||
export interface IAgingSummaryData {
|
export interface IAgingSummaryData {
|
||||||
total: IAgingSummaryTotal;
|
total: IAgingSummaryTotal;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IAgingSummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
|
formattedAsDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import {
|
|||||||
INumberFormatQuery,
|
INumberFormatQuery,
|
||||||
IFormatNumberSettings,
|
IFormatNumberSettings,
|
||||||
IFinancialSheetBranchesQuery,
|
IFinancialSheetBranchesQuery,
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
} from './FinancialStatements';
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
@@ -63,10 +64,9 @@ export interface IBalanceSheetQuery extends IFinancialSheetBranchesQuery {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Balance sheet meta.
|
// Balance sheet meta.
|
||||||
export interface IBalanceSheetMeta {
|
export interface IBalanceSheetMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean;
|
formattedAsDate: string;
|
||||||
organizationName: string;
|
formattedDateRange: string;
|
||||||
baseCurrency: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IBalanceSheetFormatNumberSettings
|
export interface IBalanceSheetFormatNumberSettings
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IAccount } from './Account';
|
import { IAccount } from './Account';
|
||||||
import { ILedger } from './Ledger';
|
import { ILedger } from './Ledger';
|
||||||
import { IFinancialTable, ITableRow } from './Table';
|
import { IFinancialTable, ITableRow } from './Table';
|
||||||
@@ -79,8 +82,8 @@ export interface ICashFlowStatementAggregateSection
|
|||||||
|
|
||||||
export interface ICashFlowCashBeginningNode
|
export interface ICashFlowCashBeginningNode
|
||||||
extends ICashFlowStatementCommonSection {
|
extends ICashFlowStatementCommonSection {
|
||||||
sectionType: ICashFlowStatementSectionType.CASH_AT_BEGINNING;
|
sectionType: ICashFlowStatementSectionType.CASH_AT_BEGINNING;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type ICashFlowStatementSection =
|
export type ICashFlowStatementSection =
|
||||||
| ICashFlowStatementAccountSection
|
| ICashFlowStatementAccountSection
|
||||||
@@ -89,10 +92,10 @@ export type ICashFlowStatementSection =
|
|||||||
| ICashFlowStatementCommonSection;
|
| ICashFlowStatementCommonSection;
|
||||||
|
|
||||||
export interface ICashFlowStatementColumn {}
|
export interface ICashFlowStatementColumn {}
|
||||||
export interface ICashFlowStatementMeta {
|
export interface ICashFlowStatementMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean;
|
formattedToDate: string;
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ICashFlowStatementDOO {
|
export interface ICashFlowStatementDOO {
|
||||||
@@ -230,3 +233,38 @@ export interface ICashflowTransactionSchema {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface ICashflowTransactionInput extends ICashflowTransactionSchema {}
|
export interface ICashflowTransactionInput extends ICashflowTransactionSchema {}
|
||||||
|
|
||||||
|
export interface ICategorizeCashflowTransactioDTO {
|
||||||
|
creditAccountId: number;
|
||||||
|
referenceNo: string;
|
||||||
|
transactionNumber: string;
|
||||||
|
transactionType: string;
|
||||||
|
exchangeRate: number;
|
||||||
|
description: string;
|
||||||
|
branchId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IUncategorizedCashflowTransaction {
|
||||||
|
id?: number;
|
||||||
|
amount: number;
|
||||||
|
date: Date;
|
||||||
|
currencyCode: string;
|
||||||
|
accountId: number;
|
||||||
|
description: string;
|
||||||
|
referenceNo: string;
|
||||||
|
categorizeRefType: string;
|
||||||
|
categorizeRefId: number;
|
||||||
|
categorized: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
export interface CreateUncategorizedTransactionDTO {
|
||||||
|
date: Date | string;
|
||||||
|
accountId: number;
|
||||||
|
amount: number;
|
||||||
|
currencyCode: string;
|
||||||
|
payee?: string;
|
||||||
|
description?: string;
|
||||||
|
referenceNo?: string | null;
|
||||||
|
plaidTransactionId?: string | null;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
import { IAccount } from './Account';
|
import { IAccount } from './Account';
|
||||||
|
import { IUncategorizedCashflowTransaction } from './CashFlow';
|
||||||
|
|
||||||
export interface ICashflowAccountTransactionsFilter {
|
export interface ICashflowAccountTransactionsFilter {
|
||||||
page: number;
|
page: number;
|
||||||
@@ -45,9 +46,12 @@ export interface ICashflowCommandDTO {
|
|||||||
|
|
||||||
publish: boolean;
|
publish: boolean;
|
||||||
branchId?: number;
|
branchId?: number;
|
||||||
|
plaidTransactionId?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ICashflowNewCommandDTO extends ICashflowCommandDTO {}
|
export interface ICashflowNewCommandDTO extends ICashflowCommandDTO {
|
||||||
|
plaidAccountId?: string;
|
||||||
|
}
|
||||||
|
|
||||||
export interface ICashflowTransaction {
|
export interface ICashflowTransaction {
|
||||||
id?: number;
|
id?: number;
|
||||||
@@ -121,8 +125,39 @@ export interface ICommandCashflowDeletedPayload {
|
|||||||
trx: Knex.Transaction;
|
trx: Knex.Transaction;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ICashflowTransactionCategorizedPayload {
|
||||||
|
tenantId: number;
|
||||||
|
cashflowTransactionId: number;
|
||||||
|
cashflowTransaction: ICashflowTransaction;
|
||||||
|
trx: Knex.Transaction;
|
||||||
|
}
|
||||||
|
export interface ICashflowTransactionUncategorizingPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransaction: IUncategorizedCashflowTransaction;
|
||||||
|
trx: Knex.Transaction;
|
||||||
|
}
|
||||||
|
export interface ICashflowTransactionUncategorizedPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransaction: IUncategorizedCashflowTransaction;
|
||||||
|
oldUncategorizedTransaction: IUncategorizedCashflowTransaction;
|
||||||
|
trx: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
export enum CashflowAction {
|
export enum CashflowAction {
|
||||||
Create = 'Create',
|
Create = 'Create',
|
||||||
Delete = 'Delete',
|
Delete = 'Delete',
|
||||||
View = 'View',
|
View = 'View',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface CategorizeTransactionAsExpenseDTO {
|
||||||
|
expenseAccountId: number;
|
||||||
|
exchangeRate: number;
|
||||||
|
referenceNo: string;
|
||||||
|
description: string;
|
||||||
|
branchId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IGetUncategorizedTransactionsQuery {
|
||||||
|
page?: number;
|
||||||
|
pageSize?: number;
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
IContactBalanceSummaryPercentage,
|
IContactBalanceSummaryPercentage,
|
||||||
IContactBalanceSummaryTotal,
|
IContactBalanceSummaryTotal,
|
||||||
} from './ContactBalanceSummary';
|
} from './ContactBalanceSummary';
|
||||||
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface ICustomerBalanceSummaryQuery
|
export interface ICustomerBalanceSummaryQuery
|
||||||
@@ -35,9 +36,15 @@ export interface ICustomerBalanceSummaryData {
|
|||||||
total: ICustomerBalanceSummaryTotal;
|
total: ICustomerBalanceSummaryTotal;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ICustomerBalanceSummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
|
formattedAsDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
|
}
|
||||||
|
|
||||||
export interface ICustomerBalanceSummaryStatement {
|
export interface ICustomerBalanceSummaryStatement {
|
||||||
data: ICustomerBalanceSummaryData;
|
data: ICustomerBalanceSummaryData;
|
||||||
query: ICustomerBalanceSummaryQuery;
|
query: ICustomerBalanceSummaryQuery;
|
||||||
|
meta: ICustomerBalanceSummaryMeta;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ICustomerBalanceSummaryService {
|
export interface ICustomerBalanceSummaryService {
|
||||||
@@ -49,4 +56,5 @@ export interface ICustomerBalanceSummaryService {
|
|||||||
|
|
||||||
export interface ICustomerBalanceSummaryTable extends IFinancialTable {
|
export interface ICustomerBalanceSummaryTable extends IFinancialTable {
|
||||||
query: ICustomerBalanceSummaryQuery;
|
query: ICustomerBalanceSummaryQuery;
|
||||||
|
meta: ICustomerBalanceSummaryMeta;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -42,4 +42,13 @@ export enum ReportsAction {
|
|||||||
|
|
||||||
export interface IFinancialSheetBranchesQuery {
|
export interface IFinancialSheetBranchesQuery {
|
||||||
branchesIds?: number[];
|
branchesIds?: number[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IFinancialSheetCommonMeta {
|
||||||
|
organizationName: string;
|
||||||
|
baseCurrency: string;
|
||||||
|
dateFormat: string;
|
||||||
|
isCostComputeRunning: boolean;
|
||||||
|
sheetName: string;
|
||||||
|
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,92 +1,90 @@
|
|||||||
import { IFinancialTable } from "./Table";
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IGeneralLedgerSheetQuery {
|
export interface IGeneralLedgerSheetQuery {
|
||||||
fromDate: Date | string,
|
fromDate: Date | string;
|
||||||
toDate: Date | string,
|
toDate: Date | string;
|
||||||
basis: string,
|
basis: string;
|
||||||
numberFormat: {
|
numberFormat: {
|
||||||
noCents: boolean,
|
noCents: boolean;
|
||||||
divideOn1000: boolean,
|
divideOn1000: boolean;
|
||||||
},
|
};
|
||||||
noneTransactions: boolean,
|
noneTransactions: boolean;
|
||||||
accountsIds: number[],
|
accountsIds: number[];
|
||||||
branchesIds?: number[];
|
branchesIds?: number[];
|
||||||
};
|
}
|
||||||
|
|
||||||
export interface IGeneralLedgerSheetAccountTransaction {
|
export interface IGeneralLedgerSheetAccountTransaction {
|
||||||
id: number,
|
id: number;
|
||||||
|
|
||||||
amount: number,
|
amount: number;
|
||||||
runningBalance: number,
|
runningBalance: number;
|
||||||
credit: number,
|
credit: number;
|
||||||
debit: number,
|
debit: number;
|
||||||
|
|
||||||
formattedAmount: string,
|
formattedAmount: string;
|
||||||
formattedCredit: string,
|
formattedCredit: string;
|
||||||
formattedDebit: string,
|
formattedDebit: string;
|
||||||
formattedRunningBalance: string,
|
formattedRunningBalance: string;
|
||||||
|
|
||||||
currencyCode: string,
|
currencyCode: string;
|
||||||
note?: string,
|
note?: string;
|
||||||
|
|
||||||
transactionType?: string,
|
transactionType?: string;
|
||||||
transactionNumber: string,
|
transactionNumber: string;
|
||||||
|
|
||||||
referenceId?: number,
|
referenceId?: number;
|
||||||
referenceType?: string,
|
referenceType?: string;
|
||||||
|
|
||||||
date: Date|string,
|
date: Date | string;
|
||||||
dateFormatted: string;
|
dateFormatted: string;
|
||||||
};
|
}
|
||||||
|
|
||||||
export interface IGeneralLedgerSheetAccountBalance {
|
export interface IGeneralLedgerSheetAccountBalance {
|
||||||
date: Date|string,
|
date: Date | string;
|
||||||
amount: number,
|
amount: number;
|
||||||
formattedAmount: string,
|
formattedAmount: string;
|
||||||
currencyCode: string,
|
currencyCode: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IGeneralLedgerSheetAccount {
|
export interface IGeneralLedgerSheetAccount {
|
||||||
id: number,
|
id: number;
|
||||||
name: string,
|
name: string;
|
||||||
code: string,
|
code: string;
|
||||||
index: number,
|
index: number;
|
||||||
parentAccountId: number,
|
parentAccountId: number;
|
||||||
transactions: IGeneralLedgerSheetAccountTransaction[],
|
transactions: IGeneralLedgerSheetAccountTransaction[];
|
||||||
openingBalance: IGeneralLedgerSheetAccountBalance,
|
openingBalance: IGeneralLedgerSheetAccountBalance;
|
||||||
closingBalance: IGeneralLedgerSheetAccountBalance,
|
closingBalance: IGeneralLedgerSheetAccountBalance;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[];
|
export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[];
|
||||||
|
|
||||||
export interface IAccountTransaction {
|
export interface IAccountTransaction {
|
||||||
id: number,
|
id: number;
|
||||||
index: number,
|
index: number;
|
||||||
draft: boolean,
|
draft: boolean;
|
||||||
note: string,
|
note: string;
|
||||||
accountId: number,
|
accountId: number;
|
||||||
transactionType: string,
|
transactionType: string;
|
||||||
referenceType: string,
|
referenceType: string;
|
||||||
referenceId: number,
|
referenceId: number;
|
||||||
contactId: number,
|
contactId: number;
|
||||||
contactType: string,
|
contactType: string;
|
||||||
credit: number,
|
credit: number;
|
||||||
debit: number,
|
debit: number;
|
||||||
date: string|Date,
|
date: string | Date;
|
||||||
createdAt: string|Date,
|
createdAt: string | Date;
|
||||||
updatedAt: string|Date,
|
updatedAt: string | Date;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IGeneralLedgerMeta {
|
export interface IGeneralLedgerMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean,
|
formattedFromDate: string;
|
||||||
organizationName: string,
|
formattedToDate: string;
|
||||||
baseCurrency: string,
|
formattedDateRange: string;
|
||||||
fromDate: string;
|
}
|
||||||
toDate: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export interface IGeneralLedgerTableData extends IFinancialTable {
|
export interface IGeneralLedgerTableData extends IFinancialTable {
|
||||||
meta: IGeneralLedgerMeta;
|
meta: IGeneralLedgerMeta;
|
||||||
query: IGeneralLedgerSheetQuery;
|
query: IGeneralLedgerSheetQuery;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IInventoryValuationReportQuery {
|
export interface IInventoryValuationReportQuery {
|
||||||
@@ -13,10 +16,10 @@ export interface IInventoryValuationReportQuery {
|
|||||||
branchesIds?: number[];
|
branchesIds?: number[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IInventoryValuationSheetMeta {
|
export interface IInventoryValuationSheetMeta
|
||||||
organizationName: string;
|
extends IFinancialSheetCommonMeta {
|
||||||
baseCurrency: string;
|
formattedAsDate: string;
|
||||||
isCostComputeRunning: boolean;
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IInventoryValuationItem {
|
export interface IInventoryValuationItem {
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IInventoryDetailsQuery {
|
export interface IInventoryDetailsQuery {
|
||||||
@@ -79,10 +82,10 @@ export type IInventoryDetailsNode =
|
|||||||
| IInventoryDetailsItemTransaction;
|
| IInventoryDetailsItemTransaction;
|
||||||
export type IInventoryDetailsData = IInventoryDetailsItem[];
|
export type IInventoryDetailsData = IInventoryDetailsItem[];
|
||||||
|
|
||||||
export interface IInventoryItemDetailMeta {
|
export interface IInventoryItemDetailMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean;
|
formattedFromDate: string;
|
||||||
organizationName: string;
|
formattedToDay: string;
|
||||||
baseCurrency: string;
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IInvetoryItemDetailDOO {
|
export interface IInvetoryItemDetailDOO {
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
import { IJournalEntry } from './Journal';
|
import { IJournalEntry } from './Journal';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
@@ -32,10 +33,10 @@ export interface IJournalReport {
|
|||||||
entries: IJournalReportEntriesGroup[];
|
entries: IJournalReportEntriesGroup[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IJournalSheetMeta {
|
export interface IJournalSheetMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean;
|
formattedDateRange: string;
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedToDate: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IJournalTable extends IFinancialTable {
|
export interface IJournalTable extends IFinancialTable {
|
||||||
|
|||||||
@@ -173,3 +173,9 @@ export type IPaymentReceiveGLCommonEntry = Pick<
|
|||||||
export interface PaymentReceiveMailOpts extends CommonMailOptions {}
|
export interface PaymentReceiveMailOpts extends CommonMailOptions {}
|
||||||
|
|
||||||
export interface PaymentReceiveMailOptsDTO extends CommonMailOptionsDTO {}
|
export interface PaymentReceiveMailOptsDTO extends CommonMailOptionsDTO {}
|
||||||
|
|
||||||
|
export interface PaymentReceiveMailPresendEvent {
|
||||||
|
tenantId: number;
|
||||||
|
paymentReceiveId: number;
|
||||||
|
messageOptions: PaymentReceiveMailOptsDTO;
|
||||||
|
}
|
||||||
|
|||||||
56
packages/server/src/interfaces/Plaid.ts
Normal file
56
packages/server/src/interfaces/Plaid.ts
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
export interface IPlaidItemCreatedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
plaidAccessToken: string;
|
||||||
|
plaidItemId: string;
|
||||||
|
plaidInstitutionId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PlaidItemDTO {
|
||||||
|
publicToken: string;
|
||||||
|
institutionId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PlaidAccount {
|
||||||
|
account_id: string;
|
||||||
|
balances: {
|
||||||
|
available: number;
|
||||||
|
current: number;
|
||||||
|
iso_currency_code: string;
|
||||||
|
limit: null;
|
||||||
|
unofficial_currency_code: null;
|
||||||
|
};
|
||||||
|
mask: string;
|
||||||
|
name: string;
|
||||||
|
official_name: string;
|
||||||
|
persistent_account_id: string;
|
||||||
|
subtype: string;
|
||||||
|
type: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PlaidTransaction {
|
||||||
|
date: string;
|
||||||
|
account_id: string;
|
||||||
|
amount: number;
|
||||||
|
authorized_date: string;
|
||||||
|
name: string;
|
||||||
|
category: string[];
|
||||||
|
check_number: number | null;
|
||||||
|
iso_currency_code: string;
|
||||||
|
transaction_id: string;
|
||||||
|
transaction_type: string;
|
||||||
|
payment_meta: { reference_number: string | null; payee: string | null };
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PlaidFetchedTransactionsUpdates {
|
||||||
|
added: any[];
|
||||||
|
modified: any[];
|
||||||
|
removed: any[];
|
||||||
|
accessToken: string;
|
||||||
|
cursor: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SyncAccountsTransactionsTask {
|
||||||
|
tenantId: number;
|
||||||
|
plaidAccountId: number;
|
||||||
|
plaidTransactions: PlaidTransaction[];
|
||||||
|
}
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
import {
|
import {
|
||||||
IFinancialSheetBranchesQuery,
|
IFinancialSheetBranchesQuery,
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
INumberFormatQuery,
|
INumberFormatQuery,
|
||||||
} from './FinancialStatements';
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
@@ -134,10 +135,10 @@ export type IProfitLossSheetNode =
|
|||||||
| IProfitLossSheetEquationNode
|
| IProfitLossSheetEquationNode
|
||||||
| IProfitLossSheetAccountNode;
|
| IProfitLossSheetAccountNode;
|
||||||
|
|
||||||
export interface IProfitLossSheetMeta {
|
export interface IProfitLossSheetMeta extends IFinancialSheetCommonMeta{
|
||||||
isCostComputeRunning: boolean;
|
formattedDateRange: string;
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedToDate: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
// ------------------------------------------------
|
// ------------------------------------------------
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IPurchasesByItemsReportQuery {
|
export interface IPurchasesByItemsReportQuery {
|
||||||
@@ -10,9 +13,10 @@ export interface IPurchasesByItemsReportQuery {
|
|||||||
onlyActive: boolean;
|
onlyActive: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IPurchasesByItemsSheetMeta {
|
export interface IPurchasesByItemsSheetMeta extends IFinancialSheetCommonMeta {
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedToDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IPurchasesByItemsItem {
|
export interface IPurchasesByItemsItem {
|
||||||
|
|||||||
@@ -132,4 +132,10 @@ export interface SaleEstimateMailOptions extends CommonMailOptions {
|
|||||||
|
|
||||||
export interface SaleEstimateMailOptionsDTO extends CommonMailOptionsDTO {
|
export interface SaleEstimateMailOptionsDTO extends CommonMailOptionsDTO {
|
||||||
attachEstimate?: boolean;
|
attachEstimate?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ISaleEstimateMailPresendEvent {
|
||||||
|
tenantId: number;
|
||||||
|
saleEstimateId: number;
|
||||||
|
messageOptions: SaleEstimateMailOptionsDTO;
|
||||||
|
}
|
||||||
|
|||||||
@@ -201,3 +201,15 @@ export interface ISaleInvoiceNotifyPayload {
|
|||||||
saleInvoiceId: number;
|
saleInvoiceId: number;
|
||||||
messageDTO: SendInvoiceMailDTO;
|
messageDTO: SendInvoiceMailDTO;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ISaleInvoiceMailSend {
|
||||||
|
tenantId: number;
|
||||||
|
saleInvoiceId: number;
|
||||||
|
messageOptions: SendInvoiceMailDTO;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ISaleInvoiceMailSent {
|
||||||
|
tenantId: number;
|
||||||
|
saleInvoiceId: number;
|
||||||
|
messageOptions: SendInvoiceMailDTO;
|
||||||
|
}
|
||||||
|
|||||||
@@ -143,3 +143,9 @@ export interface SaleReceiptMailOpts extends CommonMailOptions {
|
|||||||
export interface SaleReceiptMailOptsDTO extends CommonMailOptionsDTO {
|
export interface SaleReceiptMailOptsDTO extends CommonMailOptionsDTO {
|
||||||
attachReceipt?: boolean;
|
attachReceipt?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface ISaleReceiptMailPresend {
|
||||||
|
tenantId: number;
|
||||||
|
saleReceiptId: number;
|
||||||
|
messageOptions: SaleReceiptMailOptsDTO;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface ISalesByItemsReportQuery {
|
export interface ISalesByItemsReportQuery {
|
||||||
@@ -10,9 +13,10 @@ export interface ISalesByItemsReportQuery {
|
|||||||
onlyActive: boolean;
|
onlyActive: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ISalesByItemsSheetMeta {
|
export interface ISalesByItemsSheetMeta extends IFinancialSheetCommonMeta {
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedToDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ISalesByItemsItem {
|
export interface ISalesByItemsItem {
|
||||||
@@ -51,4 +55,4 @@ export interface ISalesByItemsSheet {
|
|||||||
export interface ISalesByItemsTable extends IFinancialTable {
|
export interface ISalesByItemsTable extends IFinancialTable {
|
||||||
query: ISalesByItemsReportQuery;
|
query: ISalesByItemsReportQuery;
|
||||||
meta: ISalesByItemsSheetMeta;
|
meta: ISalesByItemsSheetMeta;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { IFinancialSheetCommonMeta } from "./FinancialStatements";
|
||||||
import { IFinancialTable } from "./Table";
|
import { IFinancialTable } from "./Table";
|
||||||
|
|
||||||
export interface SalesTaxLiabilitySummaryQuery {
|
export interface SalesTaxLiabilitySummaryQuery {
|
||||||
@@ -47,9 +48,10 @@ export type SalesTaxLiabilitySummarySalesById = Record<
|
|||||||
{ taxRateId: number; credit: number; debit: number }
|
{ taxRateId: number; credit: number; debit: number }
|
||||||
>;
|
>;
|
||||||
|
|
||||||
export interface SalesTaxLiabilitySummaryMeta {
|
export interface SalesTaxLiabilitySummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
organizationName: string;
|
formattedFromDate: string;
|
||||||
baseCurrency: string;
|
formattedToDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ISalesTaxLiabilitySummaryTable extends IFinancialTable {
|
export interface ISalesTaxLiabilitySummaryTable extends IFinancialTable {
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
import { IFinancialTable, ITableData } from './Table';
|
import { IFinancialTable, ITableData } from './Table';
|
||||||
import {
|
import {
|
||||||
ITransactionsByContactsAmount,
|
ITransactionsByContactsAmount,
|
||||||
@@ -28,10 +29,12 @@ export type ITransactionsByCustomersData = ITransactionsByCustomersCustomer[];
|
|||||||
export interface ITransactionsByCustomersStatement {
|
export interface ITransactionsByCustomersStatement {
|
||||||
data: ITransactionsByCustomersData;
|
data: ITransactionsByCustomersData;
|
||||||
query: ITransactionsByCustomersFilter;
|
query: ITransactionsByCustomersFilter;
|
||||||
|
meta: ITransactionsByCustomersMeta;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITransactionsByCustomersTable extends IFinancialTable {
|
export interface ITransactionsByCustomersTable extends IFinancialTable {
|
||||||
query: ITransactionsByCustomersFilter;
|
query: ITransactionsByCustomersFilter;
|
||||||
|
meta: ITransactionsByCustomersMeta;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITransactionsByCustomersService {
|
export interface ITransactionsByCustomersService {
|
||||||
@@ -40,3 +43,9 @@ export interface ITransactionsByCustomersService {
|
|||||||
filter: ITransactionsByCustomersFilter
|
filter: ITransactionsByCustomersFilter
|
||||||
): Promise<ITransactionsByCustomersStatement>;
|
): Promise<ITransactionsByCustomersStatement>;
|
||||||
}
|
}
|
||||||
|
export interface ITransactionsByCustomersMeta
|
||||||
|
extends IFinancialSheetCommonMeta {
|
||||||
|
formattedFromDate: string;
|
||||||
|
formattedToDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { IFinancialSheetCommonMeta } from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
import {
|
import {
|
||||||
ITransactionsByContactsAmount,
|
ITransactionsByContactsAmount,
|
||||||
@@ -27,6 +28,8 @@ export type ITransactionsByVendorsData = ITransactionsByVendorsVendor[];
|
|||||||
|
|
||||||
export interface ITransactionsByVendorsStatement {
|
export interface ITransactionsByVendorsStatement {
|
||||||
data: ITransactionsByVendorsData;
|
data: ITransactionsByVendorsData;
|
||||||
|
query: ITransactionsByVendorsFilter;
|
||||||
|
meta: ITransactionsByVendorMeta;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITransactionsByVendorsService {
|
export interface ITransactionsByVendorsService {
|
||||||
@@ -38,4 +41,10 @@ export interface ITransactionsByVendorsService {
|
|||||||
|
|
||||||
export interface ITransactionsByVendorTable extends IFinancialTable {
|
export interface ITransactionsByVendorTable extends IFinancialTable {
|
||||||
query: ITransactionsByVendorsFilter;
|
query: ITransactionsByVendorsFilter;
|
||||||
}
|
meta: ITransactionsByVendorMeta;
|
||||||
|
}
|
||||||
|
export interface ITransactionsByVendorMeta extends IFinancialSheetCommonMeta {
|
||||||
|
formattedFromDate: string;
|
||||||
|
formattedToDate: string;
|
||||||
|
formattedDateRange: string;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface ITrialBalanceSheetQuery {
|
export interface ITrialBalanceSheetQuery {
|
||||||
@@ -24,10 +27,10 @@ export interface ITrialBalanceTotal {
|
|||||||
formattedBalance: string;
|
formattedBalance: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITrialBalanceSheetMeta {
|
export interface ITrialBalanceSheetMeta extends IFinancialSheetCommonMeta {
|
||||||
isCostComputeRunning: boolean;
|
formattedFromDate: string;
|
||||||
organizationName: string;
|
formattedToDate: string;
|
||||||
baseCurrency: string;
|
formattedDateRange: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITrialBalanceAccount extends ITrialBalanceTotal {
|
export interface ITrialBalanceAccount extends ITrialBalanceTotal {
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
import { INumberFormatQuery } from './FinancialStatements';
|
import {
|
||||||
|
IFinancialSheetCommonMeta,
|
||||||
|
INumberFormatQuery,
|
||||||
|
} from './FinancialStatements';
|
||||||
import { IFinancialTable } from './Table';
|
import { IFinancialTable } from './Table';
|
||||||
|
|
||||||
export interface IVendorBalanceSummaryQuery {
|
export interface IVendorBalanceSummaryQuery {
|
||||||
@@ -39,8 +42,9 @@ export interface IVendorBalanceSummaryData {
|
|||||||
|
|
||||||
export interface IVendorBalanceSummaryStatement {
|
export interface IVendorBalanceSummaryStatement {
|
||||||
data: IVendorBalanceSummaryData;
|
data: IVendorBalanceSummaryData;
|
||||||
columns: {};
|
|
||||||
query: IVendorBalanceSummaryQuery;
|
query: IVendorBalanceSummaryQuery;
|
||||||
|
meta: IVendorBalanceSummaryMeta;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IVendorBalanceSummaryService {
|
export interface IVendorBalanceSummaryService {
|
||||||
@@ -52,4 +56,9 @@ export interface IVendorBalanceSummaryService {
|
|||||||
|
|
||||||
export interface IVendorBalanceSummaryTable extends IFinancialTable {
|
export interface IVendorBalanceSummaryTable extends IFinancialTable {
|
||||||
query: IVendorBalanceSummaryQuery;
|
query: IVendorBalanceSummaryQuery;
|
||||||
|
meta: IVendorBalanceSummaryMeta;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IVendorBalanceSummaryMeta extends IFinancialSheetCommonMeta {
|
||||||
|
formattedAsDate: string;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -74,6 +74,7 @@ export * from './Tasks';
|
|||||||
export * from './Times';
|
export * from './Times';
|
||||||
export * from './ProjectProfitabilitySummary';
|
export * from './ProjectProfitabilitySummary';
|
||||||
export * from './TaxRate';
|
export * from './TaxRate';
|
||||||
|
export * from './Plaid';
|
||||||
|
|
||||||
export interface I18nService {
|
export interface I18nService {
|
||||||
__: (input: string) => string;
|
__: (input: string) => string;
|
||||||
|
|||||||
103
packages/server/src/lib/Plaid/Plaid.ts
Normal file
103
packages/server/src/lib/Plaid/Plaid.ts
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
import { forEach } from 'lodash';
|
||||||
|
import { Configuration, PlaidApi, PlaidEnvironments } from 'plaid';
|
||||||
|
import { createPlaidApiEvent } from './PlaidApiEventsDBSync';
|
||||||
|
import config from '@/config';
|
||||||
|
|
||||||
|
const OPTIONS = { clientApp: 'Plaid-Pattern' };
|
||||||
|
|
||||||
|
// We want to log requests to / responses from the Plaid API (via the Plaid client), as this data
|
||||||
|
// can be useful for troubleshooting.
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logging function for Plaid client methods that use an access_token as an argument. Associates
|
||||||
|
* the Plaid API event log entry with the item and user the request is for.
|
||||||
|
*
|
||||||
|
* @param {string} clientMethod the name of the Plaid client method called.
|
||||||
|
* @param {Array} clientMethodArgs the arguments passed to the Plaid client method.
|
||||||
|
* @param {Object} response the response from the Plaid client.
|
||||||
|
*/
|
||||||
|
const defaultLogger = async (clientMethod, clientMethodArgs, response) => {
|
||||||
|
const accessToken = clientMethodArgs[0].access_token;
|
||||||
|
// const { id: itemId, user_id: userId } = await retrieveItemByPlaidAccessToken(
|
||||||
|
// accessToken
|
||||||
|
// );
|
||||||
|
// await createPlaidApiEvent(1, 1, clientMethod, clientMethodArgs, response);
|
||||||
|
|
||||||
|
// console.log(response);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logging function for Plaid client methods that do not use access_token as an argument. These
|
||||||
|
* Plaid API event log entries will not be associated with an item or user.
|
||||||
|
*
|
||||||
|
* @param {string} clientMethod the name of the Plaid client method called.
|
||||||
|
* @param {Array} clientMethodArgs the arguments passed to the Plaid client method.
|
||||||
|
* @param {Object} response the response from the Plaid client.
|
||||||
|
*/
|
||||||
|
const noAccessTokenLogger = async (
|
||||||
|
clientMethod,
|
||||||
|
clientMethodArgs,
|
||||||
|
response
|
||||||
|
) => {
|
||||||
|
// console.log(response);
|
||||||
|
|
||||||
|
// await createPlaidApiEvent(
|
||||||
|
// undefined,
|
||||||
|
// undefined,
|
||||||
|
// clientMethod,
|
||||||
|
// clientMethodArgs,
|
||||||
|
// response
|
||||||
|
// );
|
||||||
|
};
|
||||||
|
|
||||||
|
// Plaid client methods used in this app, mapped to their appropriate logging functions.
|
||||||
|
const clientMethodLoggingFns = {
|
||||||
|
accountsGet: defaultLogger,
|
||||||
|
institutionsGet: noAccessTokenLogger,
|
||||||
|
institutionsGetById: noAccessTokenLogger,
|
||||||
|
itemPublicTokenExchange: noAccessTokenLogger,
|
||||||
|
itemRemove: defaultLogger,
|
||||||
|
linkTokenCreate: noAccessTokenLogger,
|
||||||
|
transactionsSync: defaultLogger,
|
||||||
|
sandboxItemResetLogin: defaultLogger,
|
||||||
|
};
|
||||||
|
// Wrapper for the Plaid client. This allows us to easily log data for all Plaid client requests.
|
||||||
|
export class PlaidClientWrapper {
|
||||||
|
constructor() {
|
||||||
|
// Initialize the Plaid client.
|
||||||
|
const configuration = new Configuration({
|
||||||
|
basePath: PlaidEnvironments[config.plaid.env],
|
||||||
|
baseOptions: {
|
||||||
|
headers: {
|
||||||
|
'PLAID-CLIENT-ID': config.plaid.clientId,
|
||||||
|
'PLAID-SECRET':
|
||||||
|
config.plaid.env === 'development'
|
||||||
|
? config.plaid.secretDevelopment
|
||||||
|
: config.plaid.secretSandbox,
|
||||||
|
'Plaid-Version': '2020-09-14',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.client = new PlaidApi(configuration);
|
||||||
|
|
||||||
|
// Wrap the Plaid client methods to add a logging function.
|
||||||
|
forEach(clientMethodLoggingFns, (logFn, method) => {
|
||||||
|
this[method] = this.createWrappedClientMethod(method, logFn);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Allows us to log API request data for troubleshooting purposes.
|
||||||
|
createWrappedClientMethod(clientMethod, log) {
|
||||||
|
return async (...args) => {
|
||||||
|
try {
|
||||||
|
const res = await this.client[clientMethod](...args);
|
||||||
|
await log(clientMethod, args, res);
|
||||||
|
return res;
|
||||||
|
} catch (err) {
|
||||||
|
await log(clientMethod, args, err?.response?.data);
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
48
packages/server/src/lib/Plaid/PlaidApiEventsDBSync.ts
Normal file
48
packages/server/src/lib/Plaid/PlaidApiEventsDBSync.ts
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
/**
|
||||||
|
* Creates a single Plaid api event log entry.
|
||||||
|
*
|
||||||
|
* @param {string} itemId the item id in the request.
|
||||||
|
* @param {string} userId the user id in the request.
|
||||||
|
* @param {string} plaidMethod the Plaid client method called.
|
||||||
|
* @param {Array} clientMethodArgs the arguments passed to the Plaid client method.
|
||||||
|
* @param {Object} response the Plaid api response object.
|
||||||
|
*/
|
||||||
|
export const createPlaidApiEvent = async (
|
||||||
|
itemId,
|
||||||
|
userId,
|
||||||
|
plaidMethod,
|
||||||
|
clientMethodArgs,
|
||||||
|
response
|
||||||
|
) => {
|
||||||
|
const {
|
||||||
|
error_code: errorCode,
|
||||||
|
error_type: errorType,
|
||||||
|
request_id: requestId,
|
||||||
|
} = response;
|
||||||
|
const query = {
|
||||||
|
text: `
|
||||||
|
INSERT INTO plaid_api_events_table
|
||||||
|
(
|
||||||
|
item_id,
|
||||||
|
user_id,
|
||||||
|
plaid_method,
|
||||||
|
arguments,
|
||||||
|
request_id,
|
||||||
|
error_type,
|
||||||
|
error_code
|
||||||
|
)
|
||||||
|
VALUES
|
||||||
|
($1, $2, $3, $4, $5, $6, $7);
|
||||||
|
`,
|
||||||
|
values: [
|
||||||
|
itemId,
|
||||||
|
userId,
|
||||||
|
plaidMethod,
|
||||||
|
JSON.stringify(clientMethodArgs),
|
||||||
|
requestId,
|
||||||
|
errorType,
|
||||||
|
errorCode,
|
||||||
|
],
|
||||||
|
};
|
||||||
|
// await db.query(query);
|
||||||
|
};
|
||||||
1
packages/server/src/lib/Plaid/index.ts
Normal file
1
packages/server/src/lib/Plaid/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './Plaid';
|
||||||
@@ -84,6 +84,11 @@ import { WriteInvoiceTaxTransactionsSubscriber } from '@/services/TaxRates/subsc
|
|||||||
import { BillTaxRateValidateSubscriber } from '@/services/TaxRates/subscribers/BillTaxRateValidateSubscriber';
|
import { BillTaxRateValidateSubscriber } from '@/services/TaxRates/subscribers/BillTaxRateValidateSubscriber';
|
||||||
import { WriteBillTaxTransactionsSubscriber } from '@/services/TaxRates/subscribers/WriteBillTaxTransactionsSubscriber';
|
import { WriteBillTaxTransactionsSubscriber } from '@/services/TaxRates/subscribers/WriteBillTaxTransactionsSubscriber';
|
||||||
import { SyncItemTaxRateOnEditTaxSubscriber } from '@/services/TaxRates/SyncItemTaxRateOnEditTaxSubscriber';
|
import { SyncItemTaxRateOnEditTaxSubscriber } from '@/services/TaxRates/SyncItemTaxRateOnEditTaxSubscriber';
|
||||||
|
import { PlaidUpdateTransactionsOnItemCreatedSubscriber } from '@/services/Banking/Plaid/subscribers/PlaidUpdateTransactionsOnItemCreatedSubscriber';
|
||||||
|
import { InvoiceChangeStatusOnMailSentSubscriber } from '@/services/Sales/Invoices/subscribers/InvoiceChangeStatusOnMailSentSubscriber';
|
||||||
|
import { SaleReceiptMarkClosedOnMailSentSubcriber } from '@/services/Sales/Receipts/subscribers/SaleReceiptMarkClosedOnMailSentSubcriber';
|
||||||
|
import { SaleEstimateMarkApprovedOnMailSent } from '@/services/Sales/Estimates/subscribers/SaleEstimateMarkApprovedOnMailSent';
|
||||||
|
import { DeleteCashflowTransactionOnUncategorize } from '@/services/Cashflow/subscribers/DeleteCashflowTransactionOnUncategorize';
|
||||||
|
|
||||||
export default () => {
|
export default () => {
|
||||||
return new EventPublisher();
|
return new EventPublisher();
|
||||||
@@ -104,8 +109,12 @@ export const susbcribers = () => {
|
|||||||
InventorySubscriber,
|
InventorySubscriber,
|
||||||
CustomerWriteGLOpeningBalanceSubscriber,
|
CustomerWriteGLOpeningBalanceSubscriber,
|
||||||
VendorsWriteGLOpeningSubscriber,
|
VendorsWriteGLOpeningSubscriber,
|
||||||
|
|
||||||
|
// # Estimate
|
||||||
SaleEstimateAutoSerialSubscriber,
|
SaleEstimateAutoSerialSubscriber,
|
||||||
SaleEstimateSmsNotificationSubscriber,
|
SaleEstimateSmsNotificationSubscriber,
|
||||||
|
SaleEstimateMarkApprovedOnMailSent,
|
||||||
|
|
||||||
ExpensesWriteGLSubscriber,
|
ExpensesWriteGLSubscriber,
|
||||||
SaleReceiptAutoSerialSubscriber,
|
SaleReceiptAutoSerialSubscriber,
|
||||||
SaleInvoiceAutoIncrementSubscriber,
|
SaleInvoiceAutoIncrementSubscriber,
|
||||||
@@ -152,11 +161,13 @@ export const susbcribers = () => {
|
|||||||
// #Invoices
|
// #Invoices
|
||||||
InvoicePaymentGLRewriteSubscriber,
|
InvoicePaymentGLRewriteSubscriber,
|
||||||
InvoiceCostGLEntriesSubscriber,
|
InvoiceCostGLEntriesSubscriber,
|
||||||
|
InvoiceChangeStatusOnMailSentSubscriber,
|
||||||
|
|
||||||
BillPaymentsGLEntriesRewriteSubscriber,
|
BillPaymentsGLEntriesRewriteSubscriber,
|
||||||
|
|
||||||
// # Receipts
|
// # Receipts
|
||||||
SaleReceiptCostGLEntriesSubscriber,
|
SaleReceiptCostGLEntriesSubscriber,
|
||||||
|
SaleReceiptMarkClosedOnMailSentSubcriber,
|
||||||
|
|
||||||
// Transaction locking.
|
// Transaction locking.
|
||||||
SalesTransactionLockingGuardSubscriber,
|
SalesTransactionLockingGuardSubscriber,
|
||||||
@@ -199,6 +210,12 @@ export const susbcribers = () => {
|
|||||||
BillTaxRateValidateSubscriber,
|
BillTaxRateValidateSubscriber,
|
||||||
WriteBillTaxTransactionsSubscriber,
|
WriteBillTaxTransactionsSubscriber,
|
||||||
|
|
||||||
SyncItemTaxRateOnEditTaxSubscriber
|
SyncItemTaxRateOnEditTaxSubscriber,
|
||||||
|
|
||||||
|
// Plaid
|
||||||
|
PlaidUpdateTransactionsOnItemCreatedSubscriber,
|
||||||
|
|
||||||
|
// Cashflow
|
||||||
|
DeleteCashflowTransactionOnUncategorize,
|
||||||
];
|
];
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ import boom from 'express-boom';
|
|||||||
import errorHandler from 'errorhandler';
|
import errorHandler from 'errorhandler';
|
||||||
import bodyParser from 'body-parser';
|
import bodyParser from 'body-parser';
|
||||||
import fileUpload from 'express-fileupload';
|
import fileUpload from 'express-fileupload';
|
||||||
|
import { Server } from 'socket.io';
|
||||||
|
import Container from 'typedi';
|
||||||
import routes from 'api';
|
import routes from 'api';
|
||||||
import LoggerMiddleware from '@/api/middleware/LoggerMiddleware';
|
import LoggerMiddleware from '@/api/middleware/LoggerMiddleware';
|
||||||
import AgendashController from '@/api/controllers/Agendash';
|
import AgendashController from '@/api/controllers/Agendash';
|
||||||
@@ -72,4 +74,32 @@ export default ({ app }) => {
|
|||||||
app.use((req: Request, res: Response, next: NextFunction) => {
|
app.use((req: Request, res: Response, next: NextFunction) => {
|
||||||
return res.boom.notFound();
|
return res.boom.notFound();
|
||||||
});
|
});
|
||||||
|
const server = app.listen(app.get('port'), (err) => {
|
||||||
|
if (err) {
|
||||||
|
console.log(err);
|
||||||
|
process.exit(1);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.log(`
|
||||||
|
################################################
|
||||||
|
Server listening on port: ${app.get('port')}
|
||||||
|
################################################
|
||||||
|
`);
|
||||||
|
});
|
||||||
|
const io = new Server(server, { path: '/socket' });
|
||||||
|
|
||||||
|
// Set socket.io listeners.
|
||||||
|
io.on('connection', (socket) => {
|
||||||
|
console.log('SOCKET CONNECTED');
|
||||||
|
|
||||||
|
socket.on('disconnect', () => {
|
||||||
|
console.log('SOCKET DISCONNECTED');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
// Middleware to pass socket to each request object.
|
||||||
|
app.use((req: Request, res: Response, next: NextFunction) => {
|
||||||
|
req.io = io;
|
||||||
|
next();
|
||||||
|
});
|
||||||
|
Container.set('socket', io);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import { SendSaleInvoiceReminderMailJob } from '@/services/Sales/Invoices/SendSa
|
|||||||
import { SendSaleEstimateMailJob } from '@/services/Sales/Estimates/SendSaleEstimateMailJob';
|
import { SendSaleEstimateMailJob } from '@/services/Sales/Estimates/SendSaleEstimateMailJob';
|
||||||
import { SaleReceiptMailNotificationJob } from '@/services/Sales/Receipts/SaleReceiptMailNotificationJob';
|
import { SaleReceiptMailNotificationJob } from '@/services/Sales/Receipts/SaleReceiptMailNotificationJob';
|
||||||
import { PaymentReceiveMailNotificationJob } from '@/services/Sales/PaymentReceives/PaymentReceiveMailNotificationJob';
|
import { PaymentReceiveMailNotificationJob } from '@/services/Sales/PaymentReceives/PaymentReceiveMailNotificationJob';
|
||||||
|
import { PlaidFetchTransactionsJob } from '@/services/Banking/Plaid/PlaidFetchTransactionsJob';
|
||||||
|
|
||||||
export default ({ agenda }: { agenda: Agenda }) => {
|
export default ({ agenda }: { agenda: Agenda }) => {
|
||||||
new ResetPasswordMailJob(agenda);
|
new ResetPasswordMailJob(agenda);
|
||||||
@@ -23,6 +24,7 @@ export default ({ agenda }: { agenda: Agenda }) => {
|
|||||||
new SendSaleEstimateMailJob(agenda);
|
new SendSaleEstimateMailJob(agenda);
|
||||||
new SaleReceiptMailNotificationJob(agenda);
|
new SaleReceiptMailNotificationJob(agenda);
|
||||||
new PaymentReceiveMailNotificationJob(agenda);
|
new PaymentReceiveMailNotificationJob(agenda);
|
||||||
|
new PlaidFetchTransactionsJob(agenda);
|
||||||
|
|
||||||
agenda.start();
|
agenda.start();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -61,6 +61,8 @@ import Task from 'models/Task';
|
|||||||
import TaxRate from 'models/TaxRate';
|
import TaxRate from 'models/TaxRate';
|
||||||
import TaxRateTransaction from 'models/TaxRateTransaction';
|
import TaxRateTransaction from 'models/TaxRateTransaction';
|
||||||
import Attachment from 'models/Attachment';
|
import Attachment from 'models/Attachment';
|
||||||
|
import PlaidItem from 'models/PlaidItem';
|
||||||
|
import UncategorizedCashflowTransaction from 'models/UncategorizedCashflowTransaction';
|
||||||
|
|
||||||
export default (knex) => {
|
export default (knex) => {
|
||||||
const models = {
|
const models = {
|
||||||
@@ -124,7 +126,9 @@ export default (knex) => {
|
|||||||
Task,
|
Task,
|
||||||
TaxRate,
|
TaxRate,
|
||||||
TaxRateTransaction,
|
TaxRateTransaction,
|
||||||
Attachment
|
Attachment,
|
||||||
|
PlaidItem,
|
||||||
|
UncategorizedCashflowTransaction
|
||||||
};
|
};
|
||||||
return mapValues(models, (model) => model.bindKnex(knex));
|
return mapValues(models, (model) => model.bindKnex(knex));
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -196,6 +196,7 @@ export default class Account extends mixin(TenantModel, [
|
|||||||
const Expense = require('models/Expense');
|
const Expense = require('models/Expense');
|
||||||
const ExpenseEntry = require('models/ExpenseCategory');
|
const ExpenseEntry = require('models/ExpenseCategory');
|
||||||
const ItemEntry = require('models/ItemEntry');
|
const ItemEntry = require('models/ItemEntry');
|
||||||
|
const UncategorizedTransaction = require('models/UncategorizedCashflowTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
@@ -305,6 +306,21 @@ export default class Account extends mixin(TenantModel, [
|
|||||||
to: 'items_entries.sellAccountId',
|
to: 'items_entries.sellAccountId',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Associated uncategorized transactions.
|
||||||
|
*/
|
||||||
|
uncategorizedTransactions: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: UncategorizedTransaction.default,
|
||||||
|
join: {
|
||||||
|
from: 'accounts.id',
|
||||||
|
to: 'uncategorized_cashflow_transactions.accountId',
|
||||||
|
},
|
||||||
|
filter: (query) => {
|
||||||
|
query.where('categorized', false);
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
transactionType: string;
|
transactionType: string;
|
||||||
amount: number;
|
amount: number;
|
||||||
exchangeRate: number;
|
exchangeRate: number;
|
||||||
|
uncategorize: boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Table name.
|
* Table name.
|
||||||
|
|||||||
@@ -215,6 +215,10 @@ export default class Expense extends mixin(TenantModel, [
|
|||||||
to: 'branches.id',
|
to: 'branches.id',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
media: {
|
media: {
|
||||||
relation: Model.ManyToManyRelation,
|
relation: Model.ManyToManyRelation,
|
||||||
modelClass: Media.default,
|
modelClass: Media.default,
|
||||||
|
|||||||
24
packages/server/src/models/PlaidItem.ts
Normal file
24
packages/server/src/models/PlaidItem.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
|
||||||
|
export default class PlaidItem extends TenantModel {
|
||||||
|
/**
|
||||||
|
* Table name.
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'plaid_items';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
get timestamps() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relationship mapping.
|
||||||
|
*/
|
||||||
|
static get relationMappings() {
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
}
|
||||||
140
packages/server/src/models/UncategorizedCashflowTransaction.ts
Normal file
140
packages/server/src/models/UncategorizedCashflowTransaction.ts
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
/* eslint-disable global-require */
|
||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
import { Model, ModelOptions, QueryContext } from 'objection';
|
||||||
|
import Account from './Account';
|
||||||
|
|
||||||
|
export default class UncategorizedCashflowTransaction extends TenantModel {
|
||||||
|
id!: number;
|
||||||
|
amount!: number;
|
||||||
|
categorized!: boolean;
|
||||||
|
accountId!: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Table name.
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'uncategorized_cashflow_transactions';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
static get timestamps() {
|
||||||
|
return ['createdAt', 'updatedAt'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Virtual attributes.
|
||||||
|
*/
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [
|
||||||
|
'withdrawal',
|
||||||
|
'deposit',
|
||||||
|
'isDepositTransaction',
|
||||||
|
'isWithdrawalTransaction',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the withdrawal amount.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
public get withdrawal() {
|
||||||
|
return this.amount < 0 ? Math.abs(this.amount) : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the deposit amount.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
public get deposit(): number {
|
||||||
|
return this.amount > 0 ? Math.abs(this.amount) : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detarmines whether the transaction is deposit transaction.
|
||||||
|
*/
|
||||||
|
public get isDepositTransaction(): boolean {
|
||||||
|
return 0 < this.deposit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detarmines whether the transaction is withdrawal transaction.
|
||||||
|
*/
|
||||||
|
public get isWithdrawalTransaction(): boolean {
|
||||||
|
return 0 < this.withdrawal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relationship mapping.
|
||||||
|
*/
|
||||||
|
static get relationMappings() {
|
||||||
|
const Account = require('models/Account');
|
||||||
|
|
||||||
|
return {
|
||||||
|
/**
|
||||||
|
* Transaction may has associated to account.
|
||||||
|
*/
|
||||||
|
account: {
|
||||||
|
relation: Model.BelongsToOneRelation,
|
||||||
|
modelClass: Account.default,
|
||||||
|
join: {
|
||||||
|
from: 'uncategorized_cashflow_transactions.accountId',
|
||||||
|
to: 'accounts.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the count of uncategorized transactions for the associated account
|
||||||
|
* based on the specified operation.
|
||||||
|
* @param {QueryContext} queryContext - The query context for the transaction.
|
||||||
|
* @param {boolean} increment - Indicates whether to increment or decrement the count.
|
||||||
|
*/
|
||||||
|
private async updateUncategorizedTransactionCount(
|
||||||
|
queryContext: QueryContext,
|
||||||
|
increment: boolean
|
||||||
|
) {
|
||||||
|
const operation = increment ? 'increment' : 'decrement';
|
||||||
|
const amount = increment ? 1 : -1;
|
||||||
|
|
||||||
|
await Account.query(queryContext.transaction)
|
||||||
|
.findById(this.accountId)
|
||||||
|
[operation]('uncategorized_transactions', amount);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs after insert.
|
||||||
|
* @param {QueryContext} queryContext
|
||||||
|
*/
|
||||||
|
public async $afterInsert(queryContext) {
|
||||||
|
await super.$afterInsert(queryContext);
|
||||||
|
await this.updateUncategorizedTransactionCount(queryContext, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs after update.
|
||||||
|
* @param {ModelOptions} opt
|
||||||
|
* @param {QueryContext} queryContext
|
||||||
|
*/
|
||||||
|
public async $afterUpdate(
|
||||||
|
opt: ModelOptions,
|
||||||
|
queryContext: QueryContext
|
||||||
|
): Promise<any> {
|
||||||
|
await super.$afterUpdate(opt, queryContext);
|
||||||
|
|
||||||
|
if (this.id && this.categorized) {
|
||||||
|
await this.updateUncategorizedTransactionCount(queryContext, false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs after delete.
|
||||||
|
* @param {QueryContext} queryContext
|
||||||
|
*/
|
||||||
|
public async $afterDelete(queryContext: QueryContext) {
|
||||||
|
await super.$afterDelete(queryContext);
|
||||||
|
await this.updateUncategorizedTransactionCount(queryContext, false);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,19 +10,6 @@ async function startServer() {
|
|||||||
|
|
||||||
// Intiialize all registered loaders.
|
// Intiialize all registered loaders.
|
||||||
await loadersFactory({ expressApp: app });
|
await loadersFactory({ expressApp: app });
|
||||||
|
|
||||||
app.listen(app.get('port'), (err) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err);
|
|
||||||
process.exit(1);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.log(`
|
|
||||||
################################################
|
|
||||||
Server listening on port: ${app.get('port')}
|
|
||||||
################################################
|
|
||||||
`);
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
startServer();
|
startServer();
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
import { IAccountTransaction } from '@/interfaces';
|
import { IAccountTransaction } from '@/interfaces';
|
||||||
import { Transformer } from '@/lib/Transformer/Transformer';
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
import { transaction } from 'objection';
|
|
||||||
|
|
||||||
export default class AccountTransactionTransformer extends Transformer {
|
export default class AccountTransactionTransformer extends Transformer {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ export class AccountTransformer extends Transformer {
|
|||||||
* @returns {Array}
|
* @returns {Array}
|
||||||
*/
|
*/
|
||||||
public includeAttributes = (): string[] => {
|
public includeAttributes = (): string[] => {
|
||||||
return ['formattedAmount', 'flattenName'];
|
return ['formattedAmount', 'flattenName', 'bankBalanceFormatted'];
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -34,13 +34,24 @@ export class AccountTransformer extends Transformer {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve formatted account amount.
|
* Retrieve formatted account amount.
|
||||||
* @param {IAccount} invoice
|
* @param {IAccount} invoice
|
||||||
* @returns {string}
|
* @returns {string}
|
||||||
*/
|
*/
|
||||||
protected formattedAmount = (account: IAccount): string => {
|
protected formattedAmount = (account: IAccount): string => {
|
||||||
return formatNumber(account.amount, { currencyCode: account.currencyCode });
|
return formatNumber(account.amount, { currencyCode: account.currencyCode });
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the formatted bank balance.
|
||||||
|
* @param {IAccount} account
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected bankBalanceFormatted = (account: IAccount): string => {
|
||||||
|
return formatNumber(account.bankBalance, {
|
||||||
|
currencyCode: account.currencyCode,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Transformes the accounts collection to flat or nested array.
|
* Transformes the accounts collection to flat or nested array.
|
||||||
* @param {IAccount[]}
|
* @param {IAccount[]}
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import { IAccountEventActivatedPayload } from '@/interfaces';
|
|||||||
import events from '@/subscribers/events';
|
import events from '@/subscribers/events';
|
||||||
import UnitOfWork from '@/services/UnitOfWork';
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
import { CommandAccountValidators } from './CommandAccountValidators';
|
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export class ActivateAccount {
|
export class ActivateAccount {
|
||||||
@@ -18,9 +17,6 @@ export class ActivateAccount {
|
|||||||
@Inject()
|
@Inject()
|
||||||
private uow: UnitOfWork;
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
@Inject()
|
|
||||||
private validator: CommandAccountValidators;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Activates/Inactivates the given account.
|
* Activates/Inactivates the given account.
|
||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
|
|||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PlaidLinkTokenService } from './PlaidLinkToken';
|
||||||
|
import { PlaidItemService } from './PlaidItem';
|
||||||
|
import { PlaidItemDTO } from '@/interfaces';
|
||||||
|
import { PlaidWebooks } from './PlaidWebhooks';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidApplication {
|
||||||
|
@Inject()
|
||||||
|
private getLinkTokenService: PlaidLinkTokenService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private plaidItemService: PlaidItemService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private plaidWebhooks: PlaidWebooks;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the Plaid link token.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} itemId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public getLinkToken(tenantId: number) {
|
||||||
|
return this.getLinkTokenService.getLinkToken(tenantId);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the Plaid access token.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {PlaidItemDTO} itemDTO
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public exchangeToken(tenantId: number, itemDTO: PlaidItemDTO): Promise<void> {
|
||||||
|
return this.plaidItemService.item(tenantId, itemDTO);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Listens to Plaid webhooks
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {string} webhookType
|
||||||
|
* @param {string} plaidItemId
|
||||||
|
* @param {string} webhookCode
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public webhooks(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
webhookType: string,
|
||||||
|
webhookCode: string
|
||||||
|
) {
|
||||||
|
return this.plaidWebhooks.webhooks(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId,
|
||||||
|
webhookType,
|
||||||
|
webhookCode
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
import Container, { Service } from 'typedi';
|
||||||
|
import { PlaidUpdateTransactions } from './PlaidUpdateTransactions';
|
||||||
|
import { IPlaidItemCreatedEventPayload } from '@/interfaces';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidFetchTransactionsJob {
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
constructor(agenda) {
|
||||||
|
agenda.define(
|
||||||
|
'plaid-update-account-transactions',
|
||||||
|
{ priority: 'high', concurrency: 2 },
|
||||||
|
this.handler
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers the function.
|
||||||
|
*/
|
||||||
|
private handler = async (job, done: Function) => {
|
||||||
|
const { tenantId, plaidItemId } = job.attrs
|
||||||
|
.data as IPlaidItemCreatedEventPayload;
|
||||||
|
|
||||||
|
const plaidFetchTransactionsService = Container.get(
|
||||||
|
PlaidUpdateTransactions
|
||||||
|
);
|
||||||
|
const io = Container.get('socket');
|
||||||
|
|
||||||
|
try {
|
||||||
|
await plaidFetchTransactionsService.updateTransactions(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
// Notify the frontend to reflect the new transactions changes.
|
||||||
|
io.emit('NEW_TRANSACTIONS_DATA', { plaidItemId });
|
||||||
|
done();
|
||||||
|
} catch (error) {
|
||||||
|
console.log(error);
|
||||||
|
done(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
58
packages/server/src/services/Banking/Plaid/PlaidItem.ts
Normal file
58
packages/server/src/services/Banking/Plaid/PlaidItem.ts
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PlaidClientWrapper } from '@/lib/Plaid';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import {
|
||||||
|
IPlaidItemCreatedEventPayload,
|
||||||
|
PlaidItemDTO,
|
||||||
|
} from '@/interfaces/Plaid';
|
||||||
|
import SystemPlaidItem from '@/system/models/SystemPlaidItem';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidItemService {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exchanges the public token to get access token and item id and then creates
|
||||||
|
* a new Plaid item.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {PlaidItemDTO} itemDTO
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async item(tenantId: number, itemDTO: PlaidItemDTO): Promise<void> {
|
||||||
|
const { PlaidItem } = this.tenancy.models(tenantId);
|
||||||
|
const { publicToken, institutionId } = itemDTO;
|
||||||
|
|
||||||
|
const plaidInstance = new PlaidClientWrapper();
|
||||||
|
|
||||||
|
// Exchange the public token for a private access token and store with the item.
|
||||||
|
const response = await plaidInstance.itemPublicTokenExchange({
|
||||||
|
public_token: publicToken,
|
||||||
|
});
|
||||||
|
const plaidAccessToken = response.data.access_token;
|
||||||
|
const plaidItemId = response.data.item_id;
|
||||||
|
|
||||||
|
// Store the Plaid item metadata on tenant scope.
|
||||||
|
const plaidItem = await PlaidItem.query().insertAndFetch({
|
||||||
|
tenantId,
|
||||||
|
plaidAccessToken,
|
||||||
|
plaidItemId,
|
||||||
|
plaidInstitutionId: institutionId,
|
||||||
|
});
|
||||||
|
// Stores the Plaid item id on system scope.
|
||||||
|
await SystemPlaidItem.query().insert({ tenantId, plaidItemId });
|
||||||
|
|
||||||
|
// Triggers `onPlaidItemCreated` event.
|
||||||
|
await this.eventPublisher.emitAsync(events.plaid.onItemCreated, {
|
||||||
|
tenantId,
|
||||||
|
plaidAccessToken,
|
||||||
|
plaidItemId,
|
||||||
|
plaidInstitutionId: institutionId,
|
||||||
|
} as IPlaidItemCreatedEventPayload);
|
||||||
|
}
|
||||||
|
}
|
||||||
34
packages/server/src/services/Banking/Plaid/PlaidLinkToken.ts
Normal file
34
packages/server/src/services/Banking/Plaid/PlaidLinkToken.ts
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { PlaidClientWrapper } from '@/lib/Plaid';
|
||||||
|
import { Service } from 'typedi';
|
||||||
|
import config from '@/config';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidLinkTokenService {
|
||||||
|
/**
|
||||||
|
* Retrieves the plaid link token.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getLinkToken(tenantId: number) {
|
||||||
|
const accessToken = null;
|
||||||
|
|
||||||
|
// Must include transactions in order to receive transactions webhooks
|
||||||
|
const products = ['transactions'];
|
||||||
|
const linkTokenParams = {
|
||||||
|
user: {
|
||||||
|
// This should correspond to a unique id for the current user.
|
||||||
|
client_user_id: 'uniqueId' + tenantId,
|
||||||
|
},
|
||||||
|
client_name: 'Pattern',
|
||||||
|
products,
|
||||||
|
country_codes: ['US'],
|
||||||
|
language: 'en',
|
||||||
|
webhook: config.plaid.linkWebhook,
|
||||||
|
access_token: accessToken,
|
||||||
|
};
|
||||||
|
const plaidInstance = new PlaidClientWrapper();
|
||||||
|
const createResponse = await plaidInstance.linkTokenCreate(linkTokenParams);
|
||||||
|
|
||||||
|
return createResponse.data;
|
||||||
|
}
|
||||||
|
}
|
||||||
198
packages/server/src/services/Banking/Plaid/PlaidSyncDB.ts
Normal file
198
packages/server/src/services/Banking/Plaid/PlaidSyncDB.ts
Normal file
@@ -0,0 +1,198 @@
|
|||||||
|
import * as R from 'ramda';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import bluebird from 'bluebird';
|
||||||
|
import { entries, groupBy } from 'lodash';
|
||||||
|
import { CreateAccount } from '@/services/Accounts/CreateAccount';
|
||||||
|
import { PlaidAccount, PlaidTransaction } from '@/interfaces';
|
||||||
|
import {
|
||||||
|
transformPlaidAccountToCreateAccount,
|
||||||
|
transformPlaidTrxsToCashflowCreate,
|
||||||
|
} from './utils';
|
||||||
|
import { DeleteCashflowTransaction } from '@/services/Cashflow/DeleteCashflowTransactionService';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
|
const CONCURRENCY_ASYNC = 10;
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidSyncDb {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private createAccountService: CreateAccount;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private cashflowApp: CashflowApplication;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private deleteCashflowTransactionService: DeleteCashflowTransaction;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syncs the plaid accounts to the system accounts.
|
||||||
|
* @param {number} tenantId Tenant ID.
|
||||||
|
* @param {PlaidAccount[]} plaidAccounts
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async syncBankAccounts(
|
||||||
|
tenantId: number,
|
||||||
|
plaidAccounts: PlaidAccount[],
|
||||||
|
institution: any
|
||||||
|
): Promise<void> {
|
||||||
|
const transformToPlaidAccounts =
|
||||||
|
transformPlaidAccountToCreateAccount(institution);
|
||||||
|
|
||||||
|
const accountCreateDTOs = R.map(transformToPlaidAccounts)(plaidAccounts);
|
||||||
|
|
||||||
|
await bluebird.map(
|
||||||
|
accountCreateDTOs,
|
||||||
|
(createAccountDTO: any) =>
|
||||||
|
this.createAccountService.createAccount(tenantId, createAccountDTO),
|
||||||
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Synsc the Plaid transactions to the system GL entries.
|
||||||
|
* @param {number} tenantId - Tenant ID.
|
||||||
|
* @param {number} plaidAccountId - Plaid account ID.
|
||||||
|
* @param {PlaidTransaction[]} plaidTranasctions - Plaid transactions
|
||||||
|
*/
|
||||||
|
public async syncAccountTranactions(
|
||||||
|
tenantId: number,
|
||||||
|
plaidAccountId: number,
|
||||||
|
plaidTranasctions: PlaidTransaction[]
|
||||||
|
): Promise<void> {
|
||||||
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const cashflowAccount = await Account.query()
|
||||||
|
.findOne({ plaidAccountId })
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
const openingEquityBalance = await Account.query().findOne(
|
||||||
|
'slug',
|
||||||
|
'opening-balance-equity'
|
||||||
|
);
|
||||||
|
// Transformes the Plaid transactions to cashflow create DTOs.
|
||||||
|
const transformTransaction = transformPlaidTrxsToCashflowCreate(
|
||||||
|
cashflowAccount.id,
|
||||||
|
openingEquityBalance.id
|
||||||
|
);
|
||||||
|
const uncategorizedTransDTOs =
|
||||||
|
R.map(transformTransaction)(plaidTranasctions);
|
||||||
|
|
||||||
|
// Creating account transaction queue.
|
||||||
|
await bluebird.map(
|
||||||
|
uncategorizedTransDTOs,
|
||||||
|
(uncategoriedDTO) =>
|
||||||
|
this.cashflowApp.createUncategorizedTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategoriedDTO
|
||||||
|
),
|
||||||
|
{ concurrency: 1 }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syncs the accounts transactions in paraller under controlled concurrency.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {PlaidTransaction[]} plaidTransactions
|
||||||
|
*/
|
||||||
|
public async syncAccountsTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
plaidAccountsTransactions: PlaidTransaction[]
|
||||||
|
): Promise<void> {
|
||||||
|
const groupedTrnsxByAccountId = entries(
|
||||||
|
groupBy(plaidAccountsTransactions, 'account_id')
|
||||||
|
);
|
||||||
|
await bluebird.map(
|
||||||
|
groupedTrnsxByAccountId,
|
||||||
|
([plaidAccountId, plaidTransactions]: [number, PlaidTransaction[]]) => {
|
||||||
|
return this.syncAccountTranactions(
|
||||||
|
tenantId,
|
||||||
|
plaidAccountId,
|
||||||
|
plaidTransactions
|
||||||
|
);
|
||||||
|
},
|
||||||
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syncs the removed Plaid transactions ids from the cashflow system transactions.
|
||||||
|
* @param {string[]} plaidTransactionsIds - Plaid Transactions IDs.
|
||||||
|
*/
|
||||||
|
public async syncRemoveTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
plaidTransactionsIds: string[]
|
||||||
|
) {
|
||||||
|
const { CashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const cashflowTransactions = await CashflowTransaction.query().whereIn(
|
||||||
|
'plaidTransactionId',
|
||||||
|
plaidTransactionsIds
|
||||||
|
);
|
||||||
|
const cashflowTransactionsIds = cashflowTransactions.map(
|
||||||
|
(trans) => trans.id
|
||||||
|
);
|
||||||
|
await bluebird.map(
|
||||||
|
cashflowTransactionsIds,
|
||||||
|
(transactionId: number) =>
|
||||||
|
this.deleteCashflowTransactionService.deleteCashflowTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId
|
||||||
|
),
|
||||||
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syncs the Plaid item last transaction cursor.
|
||||||
|
* @param {number} tenantId - Tenant ID.
|
||||||
|
* @param {string} itemId - Plaid item ID.
|
||||||
|
* @param {string} lastCursor - Last transaction cursor.
|
||||||
|
*/
|
||||||
|
public async syncTransactionsCursor(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
lastCursor: string
|
||||||
|
) {
|
||||||
|
const { PlaidItem } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
await PlaidItem.query().findOne({ plaidItemId }).patch({ lastCursor });
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the last feeds updated at of the given Plaid accounts ids.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {string[]} plaidAccountIds
|
||||||
|
*/
|
||||||
|
public async updateLastFeedsUpdatedAt(
|
||||||
|
tenantId: number,
|
||||||
|
plaidAccountIds: string[]
|
||||||
|
) {
|
||||||
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
await Account.query().whereIn('plaid_account_id', plaidAccountIds).patch({
|
||||||
|
lastFeedsUpdatedAt: new Date(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the accounts feed active status of the given Plaid accounts ids.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number[]} plaidAccountIds
|
||||||
|
* @param {boolean} isFeedsActive
|
||||||
|
*/
|
||||||
|
public async updateAccountsFeedsActive(
|
||||||
|
tenantId: number,
|
||||||
|
plaidAccountIds: string[],
|
||||||
|
isFeedsActive: boolean = true
|
||||||
|
) {
|
||||||
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
await Account.query().whereIn('plaid_account_id', plaidAccountIds).patch({
|
||||||
|
isFeedsActive,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PlaidClientWrapper } from '@/lib/Plaid/Plaid';
|
||||||
|
import { PlaidSyncDb } from './PlaidSyncDB';
|
||||||
|
import { PlaidFetchedTransactionsUpdates } from '@/interfaces';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidUpdateTransactions {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private plaidSync: PlaidSyncDb;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles the fetching and storing of new, modified, or removed transactions
|
||||||
|
* @param {number} tenantId Tenant ID.
|
||||||
|
* @param {string} plaidItemId the Plaid ID for the item.
|
||||||
|
*/
|
||||||
|
public async updateTransactions(tenantId: number, plaidItemId: string) {
|
||||||
|
// Fetch new transactions from plaid api.
|
||||||
|
const { added, modified, removed, cursor, accessToken } =
|
||||||
|
await this.fetchTransactionUpdates(tenantId, plaidItemId);
|
||||||
|
|
||||||
|
const request = { access_token: accessToken };
|
||||||
|
const plaidInstance = new PlaidClientWrapper();
|
||||||
|
const {
|
||||||
|
data: { accounts, item },
|
||||||
|
} = await plaidInstance.accountsGet(request);
|
||||||
|
|
||||||
|
const plaidAccountsIds = accounts.map((a) => a.account_id);
|
||||||
|
|
||||||
|
const {
|
||||||
|
data: { institution },
|
||||||
|
} = await plaidInstance.institutionsGetById({
|
||||||
|
institution_id: item.institution_id,
|
||||||
|
country_codes: ['US', 'UK'],
|
||||||
|
});
|
||||||
|
// Update the DB.
|
||||||
|
await this.plaidSync.syncBankAccounts(tenantId, accounts, institution);
|
||||||
|
await this.plaidSync.syncAccountsTransactions(
|
||||||
|
tenantId,
|
||||||
|
added.concat(modified)
|
||||||
|
);
|
||||||
|
await this.plaidSync.syncRemoveTransactions(tenantId, removed);
|
||||||
|
await this.plaidSync.syncTransactionsCursor(tenantId, plaidItemId, cursor);
|
||||||
|
|
||||||
|
// Update the last feeds updated at of the updated accounts.
|
||||||
|
await this.plaidSync.updateLastFeedsUpdatedAt(tenantId, plaidAccountsIds);
|
||||||
|
|
||||||
|
// Turn on the accounts feeds flag.
|
||||||
|
await this.plaidSync.updateAccountsFeedsActive(tenantId, plaidAccountsIds);
|
||||||
|
|
||||||
|
return {
|
||||||
|
addedCount: added.length,
|
||||||
|
modifiedCount: modified.length,
|
||||||
|
removedCount: removed.length,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetches transactions from the `Plaid API` for a given item.
|
||||||
|
* @param {number} tenantId - Tenant ID.
|
||||||
|
* @param {string} plaidItemId - The Plaid ID for the item.
|
||||||
|
* @returns {Promise<PlaidFetchedTransactionsUpdates>}
|
||||||
|
*/
|
||||||
|
private async fetchTransactionUpdates(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string
|
||||||
|
): Promise<PlaidFetchedTransactionsUpdates> {
|
||||||
|
// the transactions endpoint is paginated, so we may need to hit it multiple times to
|
||||||
|
// retrieve all available transactions.
|
||||||
|
const { PlaidItem } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const plaidItem = await PlaidItem.query().findOne(
|
||||||
|
'plaidItemId',
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
if (!plaidItem) {
|
||||||
|
throw new Error('The given Plaid item id is not found.');
|
||||||
|
}
|
||||||
|
const { plaidAccessToken, lastCursor } = plaidItem;
|
||||||
|
let cursor = lastCursor;
|
||||||
|
|
||||||
|
// New transaction updates since "cursor"
|
||||||
|
let added = [];
|
||||||
|
let modified = [];
|
||||||
|
// Removed transaction ids
|
||||||
|
let removed = [];
|
||||||
|
let hasMore = true;
|
||||||
|
|
||||||
|
const batchSize = 100;
|
||||||
|
try {
|
||||||
|
// Iterate through each page of new transaction updates for item
|
||||||
|
/* eslint-disable no-await-in-loop */
|
||||||
|
while (hasMore) {
|
||||||
|
const request = {
|
||||||
|
access_token: plaidAccessToken,
|
||||||
|
cursor: cursor,
|
||||||
|
count: batchSize,
|
||||||
|
};
|
||||||
|
const plaidInstance = new PlaidClientWrapper();
|
||||||
|
const response = await plaidInstance.transactionsSync(request);
|
||||||
|
const data = response.data;
|
||||||
|
// Add this page of results
|
||||||
|
added = added.concat(data.added);
|
||||||
|
modified = modified.concat(data.modified);
|
||||||
|
removed = removed.concat(data.removed);
|
||||||
|
hasMore = data.has_more;
|
||||||
|
// Update cursor to the next cursor
|
||||||
|
cursor = data.next_cursor;
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
console.error(`Error fetching transactions: ${err.message}`);
|
||||||
|
cursor = lastCursor;
|
||||||
|
}
|
||||||
|
return { added, modified, removed, cursor, accessToken: plaidAccessToken };
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import { Request, Response, NextFunction } from 'express';
|
||||||
|
import { SystemPlaidItem, Tenant } from '@/system/models';
|
||||||
|
import tenantDependencyInjection from '@/api/middleware/TenantDependencyInjection';
|
||||||
|
|
||||||
|
export const PlaidWebhookTenantBootMiddleware = async (
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) => {
|
||||||
|
const { item_id: plaidItemId } = req.body;
|
||||||
|
const plaidItem = await SystemPlaidItem.query().findOne({ plaidItemId });
|
||||||
|
|
||||||
|
const notFoundOrganization = () => {
|
||||||
|
return res.boom.unauthorized('Organization identication not found.', {
|
||||||
|
errors: [{ type: 'ORGANIZATION.ID.NOT.FOUND', code: 100 }],
|
||||||
|
});
|
||||||
|
};
|
||||||
|
// In case the given organization not found.
|
||||||
|
if (!plaidItem) {
|
||||||
|
return notFoundOrganization();
|
||||||
|
}
|
||||||
|
const tenant = await Tenant.query()
|
||||||
|
.findById(plaidItem.tenantId)
|
||||||
|
.withGraphFetched('metadata');
|
||||||
|
|
||||||
|
// When the given organization id not found on the system storage.
|
||||||
|
if (!tenant) {
|
||||||
|
return notFoundOrganization();
|
||||||
|
}
|
||||||
|
tenantDependencyInjection(req, tenant);
|
||||||
|
next();
|
||||||
|
};
|
||||||
140
packages/server/src/services/Banking/Plaid/PlaidWebhooks.ts
Normal file
140
packages/server/src/services/Banking/Plaid/PlaidWebhooks.ts
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PlaidUpdateTransactions } from './PlaidUpdateTransactions';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidWebooks {
|
||||||
|
@Inject()
|
||||||
|
private updateTransactionsService: PlaidUpdateTransactions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Listens to Plaid webhooks
|
||||||
|
* @param {number} tenantId - Tenant Id.
|
||||||
|
* @param {string} webhookType - Webhook type.
|
||||||
|
* @param {string} plaidItemId - Plaid item Id.
|
||||||
|
* @param {string} webhookCode - webhook code.
|
||||||
|
*/
|
||||||
|
public async webhooks(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
webhookType: string,
|
||||||
|
webhookCode: string
|
||||||
|
): Promise<void> {
|
||||||
|
const _webhookType = webhookType.toLowerCase();
|
||||||
|
|
||||||
|
// There are five types of webhooks: AUTH, TRANSACTIONS, ITEM, INCOME, and ASSETS.
|
||||||
|
// @TODO implement handling for remaining webhook types.
|
||||||
|
const webhookHandlerMap = {
|
||||||
|
transactions: this.handleTransactionsWebooks.bind(this),
|
||||||
|
item: this.itemsHandler.bind(this),
|
||||||
|
};
|
||||||
|
const webhookHandler =
|
||||||
|
webhookHandlerMap[_webhookType] || this.unhandledWebhook;
|
||||||
|
|
||||||
|
await webhookHandler(tenantId, plaidItemId, webhookCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles all unhandled/not yet implemented webhook events.
|
||||||
|
* @param {string} webhookType
|
||||||
|
* @param {string} webhookCode
|
||||||
|
* @param {string} plaidItemId
|
||||||
|
*/
|
||||||
|
private async unhandledWebhook(
|
||||||
|
webhookType: string,
|
||||||
|
webhookCode: string,
|
||||||
|
plaidItemId: string
|
||||||
|
): Promise<void> {
|
||||||
|
console.log(
|
||||||
|
`UNHANDLED ${webhookType} WEBHOOK: ${webhookCode}: Plaid item id ${plaidItemId}: unhandled webhook type received.`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Logs to console and emits to socket
|
||||||
|
* @param {string} additionalInfo
|
||||||
|
* @param {string} webhookCode
|
||||||
|
* @param {string} plaidItemId
|
||||||
|
*/
|
||||||
|
private serverLogAndEmitSocket(
|
||||||
|
additionalInfo: string,
|
||||||
|
webhookCode: string,
|
||||||
|
plaidItemId: string
|
||||||
|
): void {
|
||||||
|
console.log(
|
||||||
|
`WEBHOOK: TRANSACTIONS: ${webhookCode}: Plaid_item_id ${plaidItemId}: ${additionalInfo}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles all transaction webhook events. The transaction webhook notifies
|
||||||
|
* you that a single item has new transactions available.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {string} plaidItemId
|
||||||
|
* @param {string} webhookCode
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async handleTransactionsWebooks(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
webhookCode: string
|
||||||
|
): Promise<void> {
|
||||||
|
switch (webhookCode) {
|
||||||
|
case 'SYNC_UPDATES_AVAILABLE': {
|
||||||
|
// Fired when new transactions data becomes available.
|
||||||
|
const { addedCount, modifiedCount, removedCount } =
|
||||||
|
await this.updateTransactionsService.updateTransactions(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
this.serverLogAndEmitSocket(
|
||||||
|
`Transactions: ${addedCount} added, ${modifiedCount} modified, ${removedCount} removed`,
|
||||||
|
webhookCode,
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'DEFAULT_UPDATE':
|
||||||
|
case 'INITIAL_UPDATE':
|
||||||
|
case 'HISTORICAL_UPDATE':
|
||||||
|
/* ignore - not needed if using sync endpoint + webhook */
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
this.serverLogAndEmitSocket(
|
||||||
|
`unhandled webhook type received.`,
|
||||||
|
webhookCode,
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles all Item webhook events.
|
||||||
|
* @param {number} tenantId - Tenant ID
|
||||||
|
* @param {string} webhookCode - The webhook code
|
||||||
|
* @param {string} plaidItemId - The Plaid ID for the item
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async itemsHandler(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
webhookCode: string
|
||||||
|
): Promise<void> {
|
||||||
|
switch (webhookCode) {
|
||||||
|
case 'WEBHOOK_UPDATE_ACKNOWLEDGED':
|
||||||
|
this.serverLogAndEmitSocket('is updated', plaidItemId, error);
|
||||||
|
break;
|
||||||
|
case 'ERROR': {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'PENDING_EXPIRATION': {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
this.serverLogAndEmitSocket(
|
||||||
|
'unhandled webhook type received.',
|
||||||
|
webhookCode,
|
||||||
|
plaidItemId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { EventSubscriber } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import { IPlaidItemCreatedEventPayload } from '@/interfaces/Plaid';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class PlaidUpdateTransactionsOnItemCreatedSubscriber extends EventSubscriber {
|
||||||
|
@Inject('agenda')
|
||||||
|
private agenda: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.plaid.onItemCreated,
|
||||||
|
this.handleUpdateTransactionsOnItemCreated
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the Plaid item transactions
|
||||||
|
* @param {IPlaidItemCreatedEventPayload} payload - Event payload.
|
||||||
|
*/
|
||||||
|
private handleUpdateTransactionsOnItemCreated = async ({
|
||||||
|
tenantId,
|
||||||
|
plaidItemId,
|
||||||
|
plaidAccessToken,
|
||||||
|
plaidInstitutionId,
|
||||||
|
}: IPlaidItemCreatedEventPayload) => {
|
||||||
|
const payload = { tenantId, plaidItemId };
|
||||||
|
await this.agenda.now('plaid-update-account-transactions', payload);
|
||||||
|
};
|
||||||
|
}
|
||||||
54
packages/server/src/services/Banking/Plaid/utils.ts
Normal file
54
packages/server/src/services/Banking/Plaid/utils.ts
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import * as R from 'ramda';
|
||||||
|
import {
|
||||||
|
CreateUncategorizedTransactionDTO,
|
||||||
|
IAccountCreateDTO,
|
||||||
|
PlaidAccount,
|
||||||
|
PlaidTransaction,
|
||||||
|
} from '@/interfaces';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Transformes the Plaid account to create cashflow account DTO.
|
||||||
|
* @param {PlaidAccount} plaidAccount
|
||||||
|
* @returns {IAccountCreateDTO}
|
||||||
|
*/
|
||||||
|
export const transformPlaidAccountToCreateAccount = R.curry(
|
||||||
|
(institution: any, plaidAccount: PlaidAccount): IAccountCreateDTO => {
|
||||||
|
return {
|
||||||
|
name: `${institution.name} - ${plaidAccount.name}`,
|
||||||
|
code: '',
|
||||||
|
description: plaidAccount.official_name,
|
||||||
|
currencyCode: plaidAccount.balances.iso_currency_code,
|
||||||
|
accountType: 'cash',
|
||||||
|
active: true,
|
||||||
|
plaidAccountId: plaidAccount.account_id,
|
||||||
|
bankBalance: plaidAccount.balances.current,
|
||||||
|
accountMask: plaidAccount.mask,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Transformes the plaid transaction to cashflow create DTO.
|
||||||
|
* @param {number} cashflowAccountId - Cashflow account ID.
|
||||||
|
* @param {number} creditAccountId - Credit account ID.
|
||||||
|
* @param {PlaidTransaction} plaidTranasction - Plaid transaction.
|
||||||
|
* @returns {CreateUncategorizedTransactionDTO}
|
||||||
|
*/
|
||||||
|
export const transformPlaidTrxsToCashflowCreate = R.curry(
|
||||||
|
(
|
||||||
|
cashflowAccountId: number,
|
||||||
|
creditAccountId: number,
|
||||||
|
plaidTranasction: PlaidTransaction
|
||||||
|
): CreateUncategorizedTransactionDTO => {
|
||||||
|
return {
|
||||||
|
date: plaidTranasction.date,
|
||||||
|
amount: plaidTranasction.amount,
|
||||||
|
description: plaidTranasction.name,
|
||||||
|
payee: plaidTranasction.payment_meta?.payee,
|
||||||
|
currencyCode: plaidTranasction.iso_currency_code,
|
||||||
|
accountId: cashflowAccountId,
|
||||||
|
referenceNo: plaidTranasction.payment_meta?.reference_number,
|
||||||
|
plaidTransactionId: plaidTranasction.transaction_id,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
213
packages/server/src/services/Cashflow/CashflowApplication.ts
Normal file
213
packages/server/src/services/Cashflow/CashflowApplication.ts
Normal file
@@ -0,0 +1,213 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { DeleteCashflowTransaction } from './DeleteCashflowTransactionService';
|
||||||
|
import { UncategorizeCashflowTransaction } from './UncategorizeCashflowTransaction';
|
||||||
|
import { CategorizeCashflowTransaction } from './CategorizeCashflowTransaction';
|
||||||
|
import {
|
||||||
|
CategorizeTransactionAsExpenseDTO,
|
||||||
|
CreateUncategorizedTransactionDTO,
|
||||||
|
ICashflowAccountsFilter,
|
||||||
|
ICashflowNewCommandDTO,
|
||||||
|
ICategorizeCashflowTransactioDTO,
|
||||||
|
IGetUncategorizedTransactionsQuery,
|
||||||
|
} from '@/interfaces';
|
||||||
|
import { CategorizeTransactionAsExpense } from './CategorizeTransactionAsExpense';
|
||||||
|
import { GetUncategorizedTransactions } from './GetUncategorizedTransactions';
|
||||||
|
import { CreateUncategorizedTransaction } from './CreateUncategorizedTransaction';
|
||||||
|
import { GetUncategorizedTransaction } from './GetUncategorizedTransaction';
|
||||||
|
import NewCashflowTransactionService from './NewCashflowTransactionService';
|
||||||
|
import GetCashflowAccountsService from './GetCashflowAccountsService';
|
||||||
|
import { GetCashflowTransactionService } from './GetCashflowTransactionsService';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class CashflowApplication {
|
||||||
|
@Inject()
|
||||||
|
private createTransactionService: NewCashflowTransactionService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private deleteTransactionService: DeleteCashflowTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getCashflowAccountsService: GetCashflowAccountsService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getCashflowTransactionService: GetCashflowTransactionService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uncategorizeTransactionService: UncategorizeCashflowTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private categorizeTransactionService: CategorizeCashflowTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private categorizeAsExpenseService: CategorizeTransactionAsExpense;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getUncategorizedTransactionsService: GetUncategorizedTransactions;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getUncategorizedTransactionService: GetUncategorizedTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private createUncategorizedTransactionService: CreateUncategorizedTransaction;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {ICashflowNewCommandDTO} transactionDTO
|
||||||
|
* @param {number} userId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public createTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
transactionDTO: ICashflowNewCommandDTO,
|
||||||
|
userId?: number
|
||||||
|
) {
|
||||||
|
return this.createTransactionService.newCashflowTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionDTO,
|
||||||
|
userId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes the given cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public deleteTransaction(tenantId: number, cashflowTransactionId: number) {
|
||||||
|
return this.deleteTransactionService.deleteCashflowTransaction(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves specific cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public getTransaction(tenantId: number, cashflowTransactionId: number) {
|
||||||
|
return this.getCashflowTransactionService.getCashflowTransaction(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the cashflow accounts.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {ICashflowAccountsFilter} filterDTO
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public getCashflowAccounts(
|
||||||
|
tenantId: number,
|
||||||
|
filterDTO: ICashflowAccountsFilter
|
||||||
|
) {
|
||||||
|
return this.getCashflowAccountsService.getCashflowAccounts(
|
||||||
|
tenantId,
|
||||||
|
filterDTO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new uncategorized cash transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {CreateUncategorizedTransactionDTO} createUncategorizedTransactionDTO
|
||||||
|
* @returns {IUncategorizedCashflowTransaction}
|
||||||
|
*/
|
||||||
|
public createUncategorizedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
createUncategorizedTransactionDTO: CreateUncategorizedTransactionDTO
|
||||||
|
) {
|
||||||
|
return this.createUncategorizedTransactionService.create(
|
||||||
|
tenantId,
|
||||||
|
createUncategorizedTransactionDTO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Uncategorize the given cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public uncategorizeTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
cashflowTransactionId: number
|
||||||
|
) {
|
||||||
|
return this.uncategorizeTransactionService.uncategorize(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize the given cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @param {ICategorizeCashflowTransactioDTO} categorizeDTO
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public categorizeTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
cashflowTransactionId: number,
|
||||||
|
categorizeDTO: ICategorizeCashflowTransactioDTO
|
||||||
|
) {
|
||||||
|
return this.categorizeTransactionService.categorize(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId,
|
||||||
|
categorizeDTO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorizes the given cashflow transaction as expense transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @param {CategorizeTransactionAsExpenseDTO} transactionDTO
|
||||||
|
*/
|
||||||
|
public categorizeAsExpense(
|
||||||
|
tenantId: number,
|
||||||
|
cashflowTransactionId: number,
|
||||||
|
transactionDTO: CategorizeTransactionAsExpenseDTO
|
||||||
|
) {
|
||||||
|
return this.categorizeAsExpenseService.categorize(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionId,
|
||||||
|
transactionDTO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the uncategorized cashflow transactions.
|
||||||
|
* @param {number} tenantId
|
||||||
|
*/
|
||||||
|
public getUncategorizedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
accountId: number,
|
||||||
|
query: IGetUncategorizedTransactionsQuery
|
||||||
|
) {
|
||||||
|
return this.getUncategorizedTransactionsService.getTransactions(
|
||||||
|
tenantId,
|
||||||
|
accountId,
|
||||||
|
query
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves specific uncategorized transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
*/
|
||||||
|
public getUncategorizedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number
|
||||||
|
) {
|
||||||
|
return this.getUncategorizedTransactionService.getTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,11 +1,9 @@
|
|||||||
import { Inject, Service } from 'typedi';
|
import { Inject, Service } from 'typedi';
|
||||||
import { Knex } from 'knex';
|
import { Knex } from 'knex';
|
||||||
import * as R from 'ramda';
|
|
||||||
import {
|
import {
|
||||||
ILedgerEntry,
|
ILedgerEntry,
|
||||||
ICashflowTransaction,
|
ICashflowTransaction,
|
||||||
AccountNormal,
|
AccountNormal,
|
||||||
ICashflowTransactionLine,
|
|
||||||
} from '../../interfaces';
|
} from '../../interfaces';
|
||||||
import {
|
import {
|
||||||
transformCashflowTransactionType,
|
transformCashflowTransactionType,
|
||||||
|
|||||||
@@ -0,0 +1,101 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import HasTenancyService from '../Tenancy/TenancyService';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import UnitOfWork from '../UnitOfWork';
|
||||||
|
import {
|
||||||
|
ICashflowTransactionCategorizedPayload,
|
||||||
|
ICashflowTransactionUncategorizingPayload,
|
||||||
|
ICategorizeCashflowTransactioDTO,
|
||||||
|
} from '@/interfaces';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
import { transformCategorizeTransToCashflow } from './utils';
|
||||||
|
import { CommandCashflowValidator } from './CommandCasflowValidator';
|
||||||
|
import NewCashflowTransactionService from './NewCashflowTransactionService';
|
||||||
|
import { TransferAuthorizationGuaranteeDecision } from 'plaid';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class CategorizeCashflowTransaction {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private commandValidators: CommandCashflowValidator;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private createCashflow: NewCashflowTransactionService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize the given cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {ICategorizeCashflowTransactioDTO} categorizeDTO
|
||||||
|
*/
|
||||||
|
public async categorize(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
categorizeDTO: ICategorizeCashflowTransactioDTO
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
// Retrieves the uncategorized transaction or throw an error.
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query()
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
// Validates the transaction shouldn't be categorized before.
|
||||||
|
this.commandValidators.validateTransactionShouldNotCategorized(transaction);
|
||||||
|
|
||||||
|
// Validate the uncateogirzed transaction if it's deposit the transaction direction
|
||||||
|
// should `IN` and the same thing if it's withdrawal the direction should be OUT.
|
||||||
|
this.commandValidators.validateUncategorizeTransactionType(
|
||||||
|
transaction,
|
||||||
|
categorizeDTO.transactionType
|
||||||
|
);
|
||||||
|
// Edits the cashflow transaction under UOW env.
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
|
||||||
|
// Triggers `onTransactionCategorizing` event.
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.cashflow.onTransactionCategorizing,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
trx,
|
||||||
|
} as ICashflowTransactionUncategorizingPayload
|
||||||
|
);
|
||||||
|
// Transformes the categorize DTO to the cashflow transaction.
|
||||||
|
const cashflowTransactionDTO = transformCategorizeTransToCashflow(
|
||||||
|
transaction,
|
||||||
|
categorizeDTO
|
||||||
|
);
|
||||||
|
// Creates a new cashflow transaction.
|
||||||
|
const cashflowTransaction =
|
||||||
|
await this.createCashflow.newCashflowTransaction(
|
||||||
|
tenantId,
|
||||||
|
cashflowTransactionDTO
|
||||||
|
);
|
||||||
|
// Updates the uncategorized transaction as categorized.
|
||||||
|
await UncategorizedCashflowTransaction.query(trx).patchAndFetchById(
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
{
|
||||||
|
categorized: true,
|
||||||
|
categorizeRefType: 'CashflowTransaction',
|
||||||
|
categorizeRefId: cashflowTransaction.id,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
// Triggers `onCashflowTransactionCategorized` event.
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.cashflow.onTransactionCategorized,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
// cashflowTransaction,
|
||||||
|
trx,
|
||||||
|
} as ICashflowTransactionCategorizedPayload
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
import {
|
||||||
|
CategorizeTransactionAsExpenseDTO,
|
||||||
|
ICashflowTransactionCategorizedPayload,
|
||||||
|
} from '@/interfaces';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import UnitOfWork from '../UnitOfWork';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import HasTenancyService from '../Tenancy/TenancyService';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
import { CreateExpense } from '../Expenses/CRUD/CreateExpense';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class CategorizeTransactionAsExpense {
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private createExpenseService: CreateExpense;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Categorize the transaction as expense transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} cashflowTransactionId
|
||||||
|
* @param {CategorizeTransactionAsExpenseDTO} transactionDTO
|
||||||
|
*/
|
||||||
|
public async categorize(
|
||||||
|
tenantId: number,
|
||||||
|
cashflowTransactionId: number,
|
||||||
|
transactionDTO: CategorizeTransactionAsExpenseDTO
|
||||||
|
) {
|
||||||
|
const { CashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const transaction = await CashflowTransaction.query()
|
||||||
|
.findById(cashflowTransactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
|
||||||
|
// Triggers `onTransactionUncategorizing` event.
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.cashflow.onTransactionCategorizingAsExpense,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
trx,
|
||||||
|
} as ICashflowTransactionCategorizedPayload
|
||||||
|
);
|
||||||
|
// Creates a new expense transaction.
|
||||||
|
const expenseTransaction = await this.createExpenseService.newExpense(
|
||||||
|
tenantId,
|
||||||
|
{
|
||||||
|
|
||||||
|
},
|
||||||
|
1
|
||||||
|
);
|
||||||
|
// Updates the item on the storage and fetches the updated once.
|
||||||
|
const cashflowTransaction = await CashflowTransaction.query(
|
||||||
|
trx
|
||||||
|
).patchAndFetchById(cashflowTransactionId, {
|
||||||
|
categorizeRefType: 'Expense',
|
||||||
|
categorizeRefId: expenseTransaction.id,
|
||||||
|
uncategorized: true,
|
||||||
|
});
|
||||||
|
// Triggers `onTransactionUncategorized` event.
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.cashflow.onTransactionCategorizedAsExpense,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
cashflowTransaction,
|
||||||
|
trx,
|
||||||
|
} as ICashflowTransactionUncategorizedPayload
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,9 +1,14 @@
|
|||||||
import { Service } from 'typedi';
|
import { Service } from 'typedi';
|
||||||
import { includes, camelCase, upperFirst } from 'lodash';
|
import { includes, camelCase, upperFirst } from 'lodash';
|
||||||
import { IAccount } from '@/interfaces';
|
import { IAccount, IUncategorizedCashflowTransaction } from '@/interfaces';
|
||||||
import { getCashflowTransactionType } from './utils';
|
import { getCashflowTransactionType } from './utils';
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import { CASHFLOW_TRANSACTION_TYPE, ERRORS } from './constants';
|
import {
|
||||||
|
CASHFLOW_DIRECTION,
|
||||||
|
CASHFLOW_TRANSACTION_TYPE,
|
||||||
|
ERRORS,
|
||||||
|
} from './constants';
|
||||||
|
import CashflowTransaction from '@/models/CashflowTransaction';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export class CommandCashflowValidator {
|
export class CommandCashflowValidator {
|
||||||
@@ -46,4 +51,52 @@ export class CommandCashflowValidator {
|
|||||||
}
|
}
|
||||||
return transformedType;
|
return transformedType;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate the given transaction should be categorized.
|
||||||
|
* @param {CashflowTransaction} cashflowTransaction
|
||||||
|
*/
|
||||||
|
public validateTransactionShouldCategorized(
|
||||||
|
cashflowTransaction: CashflowTransaction
|
||||||
|
) {
|
||||||
|
if (!cashflowTransaction.uncategorize) {
|
||||||
|
throw new ServiceError(ERRORS.TRANSACTION_ALREADY_CATEGORIZED);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate the given transcation shouldn't be categorized.
|
||||||
|
* @param {CashflowTransaction} cashflowTransaction
|
||||||
|
*/
|
||||||
|
public validateTransactionShouldNotCategorized(
|
||||||
|
cashflowTransaction: CashflowTransaction
|
||||||
|
) {
|
||||||
|
if (cashflowTransaction.uncategorize) {
|
||||||
|
throw new ServiceError(ERRORS.TRANSACTION_ALREADY_CATEGORIZED);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {uncategorizeTransaction}
|
||||||
|
* @param {string} transactionType
|
||||||
|
* @throws {ServiceError(ERRORS.UNCATEGORIZED_TRANSACTION_TYPE_INVALID)}
|
||||||
|
*/
|
||||||
|
public validateUncategorizeTransactionType(
|
||||||
|
uncategorizeTransaction: IUncategorizedCashflowTransaction,
|
||||||
|
transactionType: string
|
||||||
|
) {
|
||||||
|
const type = getCashflowTransactionType(
|
||||||
|
upperFirst(camelCase(transactionType)) as CASHFLOW_TRANSACTION_TYPE
|
||||||
|
);
|
||||||
|
if (
|
||||||
|
(type.direction === CASHFLOW_DIRECTION.IN &&
|
||||||
|
uncategorizeTransaction.isDepositTransaction) ||
|
||||||
|
(type.direction === CASHFLOW_DIRECTION.OUT &&
|
||||||
|
uncategorizeTransaction.isWithdrawalTransaction)
|
||||||
|
) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw new ServiceError(ERRORS.UNCATEGORIZED_TRANSACTION_TYPE_INVALID);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import HasTenancyService from '../Tenancy/TenancyService';
|
||||||
|
import UnitOfWork, { IsolationLevel } from '../UnitOfWork';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
import { CreateUncategorizedTransactionDTO } from '@/interfaces';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class CreateUncategorizedTransaction {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an uncategorized cashflow transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {CreateUncategorizedTransactionDTO} createDTO
|
||||||
|
*/
|
||||||
|
public create(
|
||||||
|
tenantId: number,
|
||||||
|
createDTO: CreateUncategorizedTransactionDTO
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction, Account } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
return this.uow.withTransaction(
|
||||||
|
tenantId,
|
||||||
|
async (trx: Knex.Transaction) => {
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query(
|
||||||
|
trx
|
||||||
|
).insertAndFetch({
|
||||||
|
...createDTO,
|
||||||
|
});
|
||||||
|
|
||||||
|
return transaction;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,15 +13,15 @@ import UnitOfWork from '@/services/UnitOfWork';
|
|||||||
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class CommandCashflowTransactionService {
|
export class DeleteCashflowTransaction {
|
||||||
@Inject()
|
@Inject()
|
||||||
tenancy: HasTenancyService;
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
@Inject()
|
@Inject()
|
||||||
eventPublisher: EventPublisher;
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
@Inject()
|
@Inject()
|
||||||
uow: UnitOfWork;
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Deletes the cashflow transaction with associated journal entries.
|
* Deletes the cashflow transaction with associated journal entries.
|
||||||
|
|||||||
@@ -4,17 +4,13 @@ import { CashflowTransactionTransformer } from './CashflowTransactionTransformer
|
|||||||
import { ERRORS } from './constants';
|
import { ERRORS } from './constants';
|
||||||
import { ICashflowTransaction } from '@/interfaces';
|
import { ICashflowTransaction } from '@/interfaces';
|
||||||
import { ServiceError } from '@/exceptions';
|
import { ServiceError } from '@/exceptions';
|
||||||
import I18nService from '@/services/I18n/I18nService';
|
|
||||||
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class GetCashflowTransactionsService {
|
export class GetCashflowTransactionService {
|
||||||
@Inject()
|
@Inject()
|
||||||
private tenancy: HasTenancyService;
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
@Inject()
|
|
||||||
private i18nService: I18nService;
|
|
||||||
|
|
||||||
@Inject()
|
@Inject()
|
||||||
private transfromer: TransformerInjectable;
|
private transfromer: TransformerInjectable;
|
||||||
|
|
||||||
@@ -35,6 +31,7 @@ export default class GetCashflowTransactionsService {
|
|||||||
.withGraphFetched('entries.cashflowAccount')
|
.withGraphFetched('entries.cashflowAccount')
|
||||||
.withGraphFetched('entries.creditAccount')
|
.withGraphFetched('entries.creditAccount')
|
||||||
.withGraphFetched('transactions.account')
|
.withGraphFetched('transactions.account')
|
||||||
|
.orderBy('date', 'DESC')
|
||||||
.throwIfNotFound();
|
.throwIfNotFound();
|
||||||
|
|
||||||
this.throwErrorCashflowTranscationNotFound(cashflowTransaction);
|
this.throwErrorCashflowTranscationNotFound(cashflowTransaction);
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user