mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-18 05:40:31 +00:00
Compare commits
105 Commits
v0.17.1
...
fix-plaid-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
59168bc691 | ||
|
|
81b26c6f13 | ||
|
|
da435d85d9 | ||
|
|
533006b90e | ||
|
|
d096e49d45 | ||
|
|
73acdb6240 | ||
|
|
38d4122d11 | ||
|
|
24a77c81b3 | ||
|
|
7f41b4280e | ||
|
|
aa89653967 | ||
|
|
b80bc95fa5 | ||
|
|
9a5befbee7 | ||
|
|
b7487f19d3 | ||
|
|
cd9039fe16 | ||
|
|
87f60f7461 | ||
|
|
202179ec0b | ||
|
|
168883a933 | ||
|
|
f62ec83e29 | ||
|
|
eff8b41720 | ||
|
|
632cc3d72e | ||
|
|
aefdaac68d | ||
|
|
b8a0a5509d | ||
|
|
a5eb42edaf | ||
|
|
67b519db61 | ||
|
|
91730d204e | ||
|
|
8a09de9771 | ||
|
|
50861940a8 | ||
|
|
55caf037cd | ||
|
|
c95eec565d | ||
|
|
79616cf1eb | ||
|
|
c27458ebcc | ||
|
|
da0fab9a58 | ||
|
|
5bbcb7913d | ||
|
|
48ff93b6ab | ||
|
|
f816e7f25c | ||
|
|
3cd66ba4d6 | ||
|
|
5d5d4a1972 | ||
|
|
b01528c06b | ||
|
|
cb1f587637 | ||
|
|
978ce6c441 | ||
|
|
fab22c9820 | ||
|
|
7edf268e75 | ||
|
|
87bf29f28c | ||
|
|
d305c7ad32 | ||
|
|
7a9c7209bc | ||
|
|
d2d37820f5 | ||
|
|
1889969191 | ||
|
|
8c2888fcd8 | ||
|
|
47879d04b2 | ||
|
|
f1f52ce972 | ||
|
|
dad8aeaff1 | ||
|
|
5aae45c8a8 | ||
|
|
3e437a041c | ||
|
|
e783cfeafa | ||
|
|
5dde7f5584 | ||
|
|
8e0911ec85 | ||
|
|
66d2d6a612 | ||
|
|
8dc2b18707 | ||
|
|
589b29bbdd | ||
|
|
ca403872b3 | ||
|
|
738a84bb4b | ||
|
|
b37002bea6 | ||
|
|
b6deb842ff | ||
|
|
d3230767dd | ||
|
|
6c4b0cdac5 | ||
|
|
0b5cee070a | ||
|
|
906835c396 | ||
|
|
7b4afd3859 | ||
|
|
590715037b | ||
|
|
1e53a8e85e | ||
|
|
2ad77103ac | ||
|
|
c1fc70863b | ||
|
|
125dff8376 | ||
|
|
84da7b7df5 | ||
|
|
4c82f6f8ad | ||
|
|
0d7aad5448 | ||
|
|
74b74a2722 | ||
|
|
3a0a0db8a7 | ||
|
|
265ea9ca48 | ||
|
|
cfd37f8894 | ||
|
|
d1caa5c5ce | ||
|
|
d998d716b7 | ||
|
|
031ccc4a0b | ||
|
|
e4f61823b3 | ||
|
|
1cbc1c056f | ||
|
|
4d4ef54c56 | ||
|
|
f7fcfefc78 | ||
|
|
858f347fd4 | ||
|
|
4d73b59cf3 | ||
|
|
bc67f0cca8 | ||
|
|
ef2d1ff141 | ||
|
|
dc4cdb2a8f | ||
|
|
8862810706 | ||
|
|
3dadbeac4d | ||
|
|
494d2c1fe0 | ||
|
|
d27562bd43 | ||
|
|
8b99e0938d | ||
|
|
94192bfc29 | ||
|
|
708a4dda9e | ||
|
|
10fcf94c92 | ||
|
|
fc9995c4da | ||
|
|
7dc769004d | ||
|
|
5dbfd36415 | ||
|
|
044f11ff74 | ||
|
|
6afe1a09c6 |
@@ -84,8 +84,8 @@ LEMONSQUEEZY_STORE_ID=
|
|||||||
LEMONSQUEEZY_WEBHOOK_SECRET=
|
LEMONSQUEEZY_WEBHOOK_SECRET=
|
||||||
|
|
||||||
# S3 documents and attachments
|
# S3 documents and attachments
|
||||||
S3_REGION=
|
S3_REGION=US
|
||||||
S3_ACCESS_KEY_ID=
|
S3_ACCESS_KEY_ID=
|
||||||
S3_SECRET_ACCESS_KEY=
|
S3_SECRET_ACCESS_KEY=
|
||||||
S3_ENDPOINT=
|
S3_ENDPOINT=
|
||||||
S3_BUCKET=
|
S3_BUCKET=
|
||||||
|
|||||||
43
CHANGELOG.md
43
CHANGELOG.md
@@ -2,6 +2,49 @@
|
|||||||
|
|
||||||
All notable changes to Bigcapital server-side will be in this file.
|
All notable changes to Bigcapital server-side will be in this file.
|
||||||
|
|
||||||
|
## [v0.17.5] - 17-06-2024
|
||||||
|
|
||||||
|
* fix: Balance sheet and P/L nested accounts by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/501
|
||||||
|
* fix: add space between buttons on floating actions bar by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/508
|
||||||
|
* feat: Migrating to Envoy proxy instead of Nginx by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/509
|
||||||
|
* fix: Disable email confirmation does not work with invited users by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/497
|
||||||
|
* feat: Setting up the date format in the whole system dates by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/506
|
||||||
|
|
||||||
|
## [0.17.0] - 04-06-2024
|
||||||
|
|
||||||
|
### New
|
||||||
|
|
||||||
|
* feat: Upload and attach documents by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/461
|
||||||
|
* feat: Export resource tables to pdf by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/460
|
||||||
|
* feat: Build and deploy develop Docker container by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/476
|
||||||
|
* feat: Internal docker virtual network by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/478
|
||||||
|
|
||||||
|
### Fixes
|
||||||
|
|
||||||
|
* fix: Skip send confirmation email if disabled by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/459
|
||||||
|
* fix: Lemon Squeezy redirect to base url by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/479
|
||||||
|
* fix: Organize Plaid env variables for development and sandbox envs by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/480
|
||||||
|
* fix: Plaid syncs deposit imports as withdrawals by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/481
|
||||||
|
* fix: Validate the s3 configures exist by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/482
|
||||||
|
* fix: Run migrations only for initialized tenants by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/484
|
||||||
|
|
||||||
|
## [0.16.16] -
|
||||||
|
|
||||||
|
* feat: handle http exceptions by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/456
|
||||||
|
* feat: add the missing Newrelic env vars to docker-compose.prod file by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/457
|
||||||
|
* fix: add the signup email confirmation env var by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/458
|
||||||
|
|
||||||
|
## [0.16.14] -
|
||||||
|
|
||||||
|
* fix: Typo in setup wizard by @ccantrell72 in https://github.com/bigcapitalhq/bigcapital/pull/440
|
||||||
|
* fix: Showing the real mail address on email confirmation view by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/445
|
||||||
|
* fix: Auto-increment setting parsing by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/453
|
||||||
|
|
||||||
|
## [0.16.12] -
|
||||||
|
|
||||||
|
* feat: Create a manifest list for `webapp` Docker image and push it to DockerHub. by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/436
|
||||||
|
* feat: Combine arm64 and amd64 in one Github action runner by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/437
|
||||||
|
|
||||||
## [0.16.11] - 06-05-2024
|
## [0.16.11] - 06-05-2024
|
||||||
|
|
||||||
### improvements
|
### improvements
|
||||||
|
|||||||
@@ -3,24 +3,17 @@
|
|||||||
version: '3.3'
|
version: '3.3'
|
||||||
|
|
||||||
services:
|
services:
|
||||||
nginx:
|
proxy:
|
||||||
container_name: bigcapital-nginx-gateway
|
image: envoyproxy/envoy:v1.30-latest
|
||||||
build:
|
depends_on:
|
||||||
context: ./docker/nginx
|
- server
|
||||||
args:
|
- webapp
|
||||||
- SERVER_PROXY_PORT=3000
|
|
||||||
- WEB_SSL=false
|
|
||||||
- SELF_SIGNED=false
|
|
||||||
volumes:
|
|
||||||
- ./data/logs/nginx/:/var/log/nginx
|
|
||||||
- ./docker/certbot/certs/:/var/certs
|
|
||||||
ports:
|
ports:
|
||||||
- '${PUBLIC_PROXY_PORT:-80}:80'
|
- '${PUBLIC_PROXY_PORT:-80}:80'
|
||||||
- '${PUBLIC_PROXY_SSL_PORT:-443}:443'
|
- '${PUBLIC_PROXY_SSL_PORT:-443}:443'
|
||||||
tty: true
|
tty: true
|
||||||
depends_on:
|
volumes:
|
||||||
- server
|
- ./docker/envoy/envoy.yaml:/etc/envoy/envoy.yaml
|
||||||
- webapp
|
|
||||||
restart: on-failure
|
restart: on-failure
|
||||||
networks:
|
networks:
|
||||||
- bigcapital_network
|
- bigcapital_network
|
||||||
@@ -46,6 +39,8 @@ services:
|
|||||||
- mongo
|
- mongo
|
||||||
- redis
|
- redis
|
||||||
restart: on-failure
|
restart: on-failure
|
||||||
|
networks:
|
||||||
|
- bigcapital_network
|
||||||
environment:
|
environment:
|
||||||
# Mail
|
# Mail
|
||||||
- MAIL_HOST=${MAIL_HOST}
|
- MAIL_HOST=${MAIL_HOST}
|
||||||
@@ -127,8 +122,6 @@ services:
|
|||||||
- S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY}
|
- S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY}
|
||||||
- S3_ENDPOINT=${S3_ENDPOINT}
|
- S3_ENDPOINT=${S3_ENDPOINT}
|
||||||
- S3_BUCKET=${S3_BUCKET}
|
- S3_BUCKET=${S3_BUCKET}
|
||||||
networks:
|
|
||||||
- bigcapital_network
|
|
||||||
|
|
||||||
database_migration:
|
database_migration:
|
||||||
container_name: bigcapital-database-migration
|
container_name: bigcapital-database-migration
|
||||||
|
|||||||
62
docker/envoy/envoy.yaml
Normal file
62
docker/envoy/envoy.yaml
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
static_resources:
|
||||||
|
listeners:
|
||||||
|
- name: listener_0
|
||||||
|
address:
|
||||||
|
socket_address:
|
||||||
|
address: 0.0.0.0
|
||||||
|
port_value: 80
|
||||||
|
filter_chains:
|
||||||
|
- filters:
|
||||||
|
- name: envoy.filters.network.http_connection_manager
|
||||||
|
typed_config:
|
||||||
|
'@type': type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
|
||||||
|
stat_prefix: ingress_http
|
||||||
|
route_config:
|
||||||
|
name: local_route
|
||||||
|
virtual_hosts:
|
||||||
|
- name: backend
|
||||||
|
domains: ['*']
|
||||||
|
routes:
|
||||||
|
- match:
|
||||||
|
prefix: '/api'
|
||||||
|
route:
|
||||||
|
cluster: dynamic_server
|
||||||
|
- match:
|
||||||
|
prefix: '/'
|
||||||
|
route:
|
||||||
|
cluster: webapp
|
||||||
|
http_filters:
|
||||||
|
- name: envoy.filters.http.router
|
||||||
|
typed_config:
|
||||||
|
"@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
|
||||||
|
|
||||||
|
clusters:
|
||||||
|
- name: dynamic_server
|
||||||
|
connect_timeout: 0.25s
|
||||||
|
type: STRICT_DNS
|
||||||
|
dns_lookup_family: V4_ONLY
|
||||||
|
lb_policy: ROUND_ROBIN
|
||||||
|
load_assignment:
|
||||||
|
cluster_name: dynamic_server
|
||||||
|
endpoints:
|
||||||
|
- lb_endpoints:
|
||||||
|
- endpoint:
|
||||||
|
address:
|
||||||
|
socket_address:
|
||||||
|
address: server
|
||||||
|
port_value: 3000
|
||||||
|
|
||||||
|
- name: webapp
|
||||||
|
connect_timeout: 0.25s
|
||||||
|
type: STRICT_DNS
|
||||||
|
dns_lookup_family: V4_ONLY
|
||||||
|
lb_policy: ROUND_ROBIN
|
||||||
|
load_assignment:
|
||||||
|
cluster_name: webapp
|
||||||
|
endpoints:
|
||||||
|
- lb_endpoints:
|
||||||
|
- endpoint:
|
||||||
|
address:
|
||||||
|
socket_address:
|
||||||
|
address: webapp
|
||||||
|
port_value: 80
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
FROM nginx:1.11
|
|
||||||
|
|
||||||
RUN mkdir /etc/nginx/sites-available && rm /etc/nginx/conf.d/default.conf
|
|
||||||
ADD nginx.conf /etc/nginx/
|
|
||||||
|
|
||||||
COPY scripts /root/scripts/
|
|
||||||
COPY certs /etc/ssl/
|
|
||||||
|
|
||||||
COPY sites /etc/nginx/templates
|
|
||||||
|
|
||||||
ARG SERVER_PROXY_PORT=3000
|
|
||||||
ARG WEB_SSL=false
|
|
||||||
ARG SELF_SIGNED=false
|
|
||||||
|
|
||||||
ENV SERVER_PROXY_PORT=$SERVER_PROXY_PORT
|
|
||||||
ENV WEB_SSL=$WEB_SSL
|
|
||||||
ENV SELF_SIGNED=$SELF_SIGNED
|
|
||||||
|
|
||||||
RUN /bin/bash /root/scripts/build-nginx.sh
|
|
||||||
|
|
||||||
CMD nginx
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
user www-data;
|
|
||||||
worker_processes auto;
|
|
||||||
pid /run/nginx.pid;
|
|
||||||
daemon off;
|
|
||||||
|
|
||||||
events {
|
|
||||||
worker_connections 2048;
|
|
||||||
use epoll;
|
|
||||||
}
|
|
||||||
|
|
||||||
http {
|
|
||||||
server_tokens off;
|
|
||||||
sendfile on;
|
|
||||||
tcp_nopush on;
|
|
||||||
tcp_nodelay on;
|
|
||||||
keepalive_timeout 15;
|
|
||||||
types_hash_max_size 2048;
|
|
||||||
client_max_body_size 20M;
|
|
||||||
open_file_cache max=100;
|
|
||||||
gzip on;
|
|
||||||
gzip_disable "msie6";
|
|
||||||
|
|
||||||
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
|
|
||||||
ssl_ciphers 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS';
|
|
||||||
|
|
||||||
include /etc/nginx/mime.types;
|
|
||||||
default_type application/octet-stream;
|
|
||||||
|
|
||||||
include /etc/nginx/conf.d/*.conf;
|
|
||||||
include /etc/nginx/sites-available/*;
|
|
||||||
access_log /var/log/nginx/access.log;
|
|
||||||
error_log /var/log/nginx/error.log;
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
for conf in /etc/nginx/templates/*.conf; do
|
|
||||||
mv $conf "/etc/nginx/sites-available/"$(basename $conf) > /dev/null
|
|
||||||
done
|
|
||||||
|
|
||||||
for template in /etc/nginx/templates/*.template; do
|
|
||||||
envsubst < $template > "/etc/nginx/sites-available/"$(basename $template)".conf"
|
|
||||||
done
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
server {
|
|
||||||
listen 80 default_server;
|
|
||||||
|
|
||||||
location /api {
|
|
||||||
proxy_pass http://server:${SERVER_PROXY_PORT};
|
|
||||||
}
|
|
||||||
|
|
||||||
location / {
|
|
||||||
proxy_pass http://webapp;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /.well-known/acme-challenge/ {
|
|
||||||
root /var/www/letsencrypt/;
|
|
||||||
log_not_found off;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -25,6 +25,7 @@
|
|||||||
"@casl/ability": "^5.4.3",
|
"@casl/ability": "^5.4.3",
|
||||||
"@hapi/boom": "^7.4.3",
|
"@hapi/boom": "^7.4.3",
|
||||||
"@lemonsqueezy/lemonsqueezy.js": "^2.2.0",
|
"@lemonsqueezy/lemonsqueezy.js": "^2.2.0",
|
||||||
|
"@supercharge/promise-pool": "^3.2.0",
|
||||||
"@types/express": "^4.17.21",
|
"@types/express": "^4.17.21",
|
||||||
"@types/i18n": "^0.8.7",
|
"@types/i18n": "^0.8.7",
|
||||||
"@types/knex": "^0.16.1",
|
"@types/knex": "^0.16.1",
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { NextFunction, Request, Response, Router } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
import { GetBankAccountSummary } from '@/services/Banking/BankAccounts/GetBankAccountSummary';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class BankAccountsController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private getBankAccountSummaryService: GetBankAccountSummary;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.get('/:bankAccountId/meta', this.getBankAccountSummary.bind(this));
|
||||||
|
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the bank account meta summary.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
async getBankAccountSummary(
|
||||||
|
req: Request<{ bankAccountId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { bankAccountId } = req.params;
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data =
|
||||||
|
await this.getBankAccountSummaryService.getBankAccountSummary(
|
||||||
|
tenantId,
|
||||||
|
bankAccountId
|
||||||
|
);
|
||||||
|
return res.status(200).send({ data });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { NextFunction, Request, Response, Router } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { MatchBankTransactionsApplication } from '@/services/Banking/Matching/MatchBankTransactionsApplication';
|
||||||
|
import { body, param } from 'express-validator';
|
||||||
|
import {
|
||||||
|
GetMatchedTransactionsFilter,
|
||||||
|
IMatchTransactionsDTO,
|
||||||
|
} from '@/services/Banking/Matching/types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class BankTransactionsMatchingController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private bankTransactionsMatchingApp: MatchBankTransactionsApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
public router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.post(
|
||||||
|
'/:transactionId',
|
||||||
|
[
|
||||||
|
param('transactionId').exists(),
|
||||||
|
body('matchedTransactions').isArray({ min: 1 }),
|
||||||
|
body('matchedTransactions.*.reference_type').exists(),
|
||||||
|
body('matchedTransactions.*.reference_id').isNumeric().toInt(),
|
||||||
|
],
|
||||||
|
this.validationResult,
|
||||||
|
this.matchBankTransaction.bind(this)
|
||||||
|
);
|
||||||
|
router.post(
|
||||||
|
'/unmatch/:transactionId',
|
||||||
|
[param('transactionId').exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.unmatchMatchedBankTransaction.bind(this)
|
||||||
|
);
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches the given bank transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
private async matchBankTransaction(
|
||||||
|
req: Request<{ transactionId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { transactionId } = req.params;
|
||||||
|
const matchTransactionDTO = this.matchedBodyData(
|
||||||
|
req
|
||||||
|
) as IMatchTransactionsDTO;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.bankTransactionsMatchingApp.matchTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId,
|
||||||
|
matchTransactionDTO
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
id: transactionId,
|
||||||
|
message: 'The bank transaction has been matched.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unmatches the matched bank transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
private async unmatchMatchedBankTransaction(
|
||||||
|
req: Request<{ transactionId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { transactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.bankTransactionsMatchingApp.unmatchMatchedTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
id: transactionId,
|
||||||
|
message: 'The bank matched transaction has been unmatched.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,17 +2,33 @@ import Container, { Inject, Service } from 'typedi';
|
|||||||
import { Router } from 'express';
|
import { Router } from 'express';
|
||||||
import BaseController from '@/api/controllers/BaseController';
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
import { PlaidBankingController } from './PlaidBankingController';
|
import { PlaidBankingController } from './PlaidBankingController';
|
||||||
|
import { BankingRulesController } from './BankingRulesController';
|
||||||
|
import { BankTransactionsMatchingController } from './BankTransactionsMatchingController';
|
||||||
|
import { RecognizedTransactionsController } from './RecognizedTransactionsController';
|
||||||
|
import { BankAccountsController } from './BankAccountsController';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export class BankingController extends BaseController {
|
export class BankingController extends BaseController {
|
||||||
/**
|
/**
|
||||||
* Router constructor.
|
* Router constructor.
|
||||||
*/
|
*/
|
||||||
router() {
|
public router() {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
router.use('/plaid', Container.get(PlaidBankingController).router());
|
router.use('/plaid', Container.get(PlaidBankingController).router());
|
||||||
|
router.use('/rules', Container.get(BankingRulesController).router());
|
||||||
|
router.use(
|
||||||
|
'/matches',
|
||||||
|
Container.get(BankTransactionsMatchingController).router()
|
||||||
|
);
|
||||||
|
router.use(
|
||||||
|
'/recognized',
|
||||||
|
Container.get(RecognizedTransactionsController).router()
|
||||||
|
);
|
||||||
|
router.use(
|
||||||
|
'/bank_accounts',
|
||||||
|
Container.get(BankAccountsController).router()
|
||||||
|
);
|
||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,206 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { NextFunction, Request, Response, Router } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { BankRulesApplication } from '@/services/Banking/Rules/BankRulesApplication';
|
||||||
|
import { body, param } from 'express-validator';
|
||||||
|
import {
|
||||||
|
ICreateBankRuleDTO,
|
||||||
|
IEditBankRuleDTO,
|
||||||
|
} from '@/services/Banking/Rules/types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class BankingRulesController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private bankRulesApplication: BankRulesApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bank rule DTO validation schema.
|
||||||
|
*/
|
||||||
|
private get bankRuleValidationSchema() {
|
||||||
|
return [
|
||||||
|
body('name').isString().exists(),
|
||||||
|
body('order').isInt({ min: 0 }),
|
||||||
|
|
||||||
|
// Apply to if transaction is.
|
||||||
|
body('apply_if_account_id')
|
||||||
|
.isInt({ min: 0 })
|
||||||
|
.optional({ nullable: true }),
|
||||||
|
body('apply_if_transaction_type').isIn(['deposit', 'withdrawal']),
|
||||||
|
|
||||||
|
// Conditions
|
||||||
|
body('conditions_type').isString().isIn(['and', 'or']).default('and'),
|
||||||
|
body('conditions').isArray({ min: 1 }),
|
||||||
|
body('conditions.*.field').exists().isIn(['description', 'amount']),
|
||||||
|
body('conditions.*.comparator')
|
||||||
|
.exists()
|
||||||
|
.isIn(['equals', 'contains', 'not_contain'])
|
||||||
|
.default('contain'),
|
||||||
|
body('conditions.*.value').exists(),
|
||||||
|
|
||||||
|
// Assign
|
||||||
|
body('assign_category').isString(),
|
||||||
|
body('assign_account_id').isInt({ min: 0 }),
|
||||||
|
body('assign_payee').isString().optional({ nullable: true }),
|
||||||
|
body('assign_memo').isString().optional({ nullable: true }),
|
||||||
|
|
||||||
|
body('recognition').isBoolean().toBoolean().optional({ nullable: true }),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
public router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.post(
|
||||||
|
'/',
|
||||||
|
[...this.bankRuleValidationSchema],
|
||||||
|
this.validationResult,
|
||||||
|
this.createBankRule.bind(this)
|
||||||
|
);
|
||||||
|
router.post(
|
||||||
|
'/:id',
|
||||||
|
[param('id').toInt().exists(), ...this.bankRuleValidationSchema],
|
||||||
|
this.validationResult,
|
||||||
|
this.editBankRule.bind(this)
|
||||||
|
);
|
||||||
|
router.delete(
|
||||||
|
'/:id',
|
||||||
|
[param('id').toInt().exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.deleteBankRule.bind(this)
|
||||||
|
);
|
||||||
|
router.get(
|
||||||
|
'/:id',
|
||||||
|
[param('id').toInt().exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.getBankRule.bind(this)
|
||||||
|
);
|
||||||
|
router.get(
|
||||||
|
'/',
|
||||||
|
[param('id').toInt().exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.getBankRules.bind(this)
|
||||||
|
);
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new bank rule.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async createBankRule(
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const createBankRuleDTO = this.matchedBodyData(req) as ICreateBankRuleDTO;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const bankRule = await this.bankRulesApplication.createBankRule(
|
||||||
|
tenantId,
|
||||||
|
createBankRuleDTO
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
id: bankRule.id,
|
||||||
|
message: 'The bank rule has been created successfully.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Edits the given bank rule.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async editBankRule(req: Request, res: Response, next: NextFunction) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { id: ruleId } = req.params;
|
||||||
|
const editBankRuleDTO = this.matchedBodyData(req) as IEditBankRuleDTO;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.bankRulesApplication.editBankRule(
|
||||||
|
tenantId,
|
||||||
|
ruleId,
|
||||||
|
editBankRuleDTO
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
id: ruleId,
|
||||||
|
message: 'The bank rule has been updated successfully.',
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes the given bank rule.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async deleteBankRule(
|
||||||
|
req: Request<{ id: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { id: ruleId } = req.params;
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.bankRulesApplication.deleteBankRule(tenantId, ruleId);
|
||||||
|
|
||||||
|
return res
|
||||||
|
.status(200)
|
||||||
|
.send({ message: 'The bank rule has been deleted.', id: ruleId });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the given bank rule.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async getBankRule(req: Request, res: Response, next: NextFunction) {
|
||||||
|
const { id: ruleId } = req.params;
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const bankRule = await this.bankRulesApplication.getBankRule(
|
||||||
|
tenantId,
|
||||||
|
ruleId
|
||||||
|
);
|
||||||
|
|
||||||
|
return res.status(200).send({ bankRule });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the bank rules.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async getBankRules(req: Request, res: Response, next: NextFunction) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const bankRules = await this.bankRulesApplication.getBankRules(tenantId);
|
||||||
|
return res.status(200).send({ bankRules });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { param } from 'express-validator';
|
||||||
|
import { NextFunction, Request, Response, Router, query } from 'express';
|
||||||
|
import BaseController from '../BaseController';
|
||||||
|
import { ExcludeBankTransactionsApplication } from '@/services/Banking/Exclude/ExcludeBankTransactionsApplication';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ExcludeBankTransactionsController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private excludeBankTransactionApp: ExcludeBankTransactionsApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
public router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.put(
|
||||||
|
'/transactions/:transactionId/exclude',
|
||||||
|
[param('transactionId').exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.excludeBankTransaction.bind(this)
|
||||||
|
);
|
||||||
|
router.put(
|
||||||
|
'/transactions/:transactionId/unexclude',
|
||||||
|
[param('transactionId').exists()],
|
||||||
|
this.validationResult,
|
||||||
|
this.unexcludeBankTransaction.bind(this)
|
||||||
|
);
|
||||||
|
router.get(
|
||||||
|
'/excluded',
|
||||||
|
[],
|
||||||
|
this.validationResult,
|
||||||
|
this.getExcludedBankTransactions.bind(this)
|
||||||
|
);
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks a bank transaction as excluded.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
private async excludeBankTransaction(
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
): Promise<Response | void> {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { transactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.excludeBankTransactionApp.excludeBankTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
message: 'The bank transaction has been excluded.',
|
||||||
|
id: transactionId,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks a bank transaction as not excluded.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|void>}
|
||||||
|
*/
|
||||||
|
private async unexcludeBankTransaction(
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
): Promise<Response | void> {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { transactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await this.excludeBankTransactionApp.unexcludeBankTransaction(
|
||||||
|
tenantId,
|
||||||
|
transactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({
|
||||||
|
message: 'The bank transaction has been unexcluded.',
|
||||||
|
id: transactionId,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the excluded uncategorized bank transactions.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
private async getExcludedBankTransactions(
|
||||||
|
req: Request,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
): Promise<Response | void> {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const filter = this.matchedBodyData(req);
|
||||||
|
|
||||||
|
console.log('123');
|
||||||
|
try {
|
||||||
|
const data =
|
||||||
|
await this.excludeBankTransactionApp.getExcludedBankTransactions(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
return res.status(200).send(data);
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { NextFunction, Request, Response, Router } from 'express';
|
||||||
|
import BaseController from '@/api/controllers/BaseController';
|
||||||
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class RecognizedTransactionsController extends BaseController {
|
||||||
|
@Inject()
|
||||||
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Router constructor.
|
||||||
|
*/
|
||||||
|
router() {
|
||||||
|
const router = Router();
|
||||||
|
|
||||||
|
router.get('/', this.getRecognizedTransactions.bind(this));
|
||||||
|
router.get(
|
||||||
|
'/transactions/:uncategorizedTransactionId',
|
||||||
|
this.getRecognizedTransaction.bind(this)
|
||||||
|
);
|
||||||
|
|
||||||
|
return router;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the recognized bank transactions.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
async getRecognizedTransactions(
|
||||||
|
req: Request<{ accountId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const filter = this.matchedQueryData(req);
|
||||||
|
const { tenantId } = req;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data = await this.cashflowApplication.getRecognizedTransactions(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
return res.status(200).send(data);
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the recognized transaction of the ginen uncategorized transaction.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
* @returns {Promise<Response|null>}
|
||||||
|
*/
|
||||||
|
async getRecognizedTransaction(
|
||||||
|
req: Request<{ uncategorizedTransactionId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { uncategorizedTransactionId } = req.params;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data = await this.cashflowApplication.getRecognizedTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
return res.status(200).send({ data });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ import CommandCashflowTransaction from './NewCashflowTransaction';
|
|||||||
import DeleteCashflowTransaction from './DeleteCashflowTransaction';
|
import DeleteCashflowTransaction from './DeleteCashflowTransaction';
|
||||||
import GetCashflowTransaction from './GetCashflowTransaction';
|
import GetCashflowTransaction from './GetCashflowTransaction';
|
||||||
import GetCashflowAccounts from './GetCashflowAccounts';
|
import GetCashflowAccounts from './GetCashflowAccounts';
|
||||||
|
import { ExcludeBankTransactionsController } from '../Banking/ExcludeBankTransactionsController';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class CashflowController {
|
export default class CashflowController {
|
||||||
@@ -14,6 +15,7 @@ export default class CashflowController {
|
|||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
router.use(Container.get(CommandCashflowTransaction).router());
|
router.use(Container.get(CommandCashflowTransaction).router());
|
||||||
|
router.use(Container.get(ExcludeBankTransactionsController).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(DeleteCashflowTransaction).router());
|
router.use(Container.get(DeleteCashflowTransaction).router());
|
||||||
|
|||||||
@@ -31,7 +31,6 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
query('search_keyword').optional({ nullable: true }).isString().trim(),
|
query('search_keyword').optional({ nullable: true }).isString().trim(),
|
||||||
],
|
],
|
||||||
this.asyncMiddleware(this.getCashflowAccounts),
|
this.asyncMiddleware(this.getCashflowAccounts),
|
||||||
this.catchServiceErrors
|
|
||||||
);
|
);
|
||||||
return router;
|
return router;
|
||||||
}
|
}
|
||||||
@@ -67,22 +66,4 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
next(error);
|
next(error);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Catches the service errors.
|
|
||||||
* @param {Error} error - Error.
|
|
||||||
* @param {Request} req - Request.
|
|
||||||
* @param {Response} res - Response.
|
|
||||||
* @param {NextFunction} next -
|
|
||||||
*/
|
|
||||||
private catchServiceErrors(
|
|
||||||
error,
|
|
||||||
req: Request,
|
|
||||||
res: Response,
|
|
||||||
next: NextFunction
|
|
||||||
) {
|
|
||||||
if (error instanceof ServiceError) {
|
|
||||||
}
|
|
||||||
next(error);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,18 +6,27 @@ 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';
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
import { GetMatchedTransactionsFilter } from '@/services/Banking/Matching/types';
|
||||||
|
import { MatchBankTransactionsApplication } from '@/services/Banking/Matching/MatchBankTransactionsApplication';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export default class GetCashflowAccounts extends BaseController {
|
export default class GetCashflowAccounts extends BaseController {
|
||||||
@Inject()
|
@Inject()
|
||||||
private cashflowApplication: CashflowApplication;
|
private cashflowApplication: CashflowApplication;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private bankTransactionsMatchingApp: MatchBankTransactionsApplication;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Controller router.
|
* Controller router.
|
||||||
*/
|
*/
|
||||||
public router() {
|
public router() {
|
||||||
const router = Router();
|
const router = Router();
|
||||||
|
|
||||||
|
router.get(
|
||||||
|
'/transactions/:transactionId/matches',
|
||||||
|
this.getMatchedTransactions.bind(this)
|
||||||
|
);
|
||||||
router.get(
|
router.get(
|
||||||
'/transactions/:transactionId',
|
'/transactions/:transactionId',
|
||||||
CheckPolicies(CashflowAction.View, AbilitySubject.Cashflow),
|
CheckPolicies(CashflowAction.View, AbilitySubject.Cashflow),
|
||||||
@@ -47,7 +56,6 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
tenantId,
|
tenantId,
|
||||||
transactionId
|
transactionId
|
||||||
);
|
);
|
||||||
|
|
||||||
return res.status(200).send({
|
return res.status(200).send({
|
||||||
cashflow_transaction: this.transfromToResponse(cashflowTransaction),
|
cashflow_transaction: this.transfromToResponse(cashflowTransaction),
|
||||||
});
|
});
|
||||||
@@ -56,6 +64,34 @@ export default class GetCashflowAccounts extends BaseController {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {Request} req
|
||||||
|
* @param {Response} res
|
||||||
|
* @param {NextFunction} next
|
||||||
|
*/
|
||||||
|
private async getMatchedTransactions(
|
||||||
|
req: Request<{ transactionId: number }>,
|
||||||
|
res: Response,
|
||||||
|
next: NextFunction
|
||||||
|
) {
|
||||||
|
const { tenantId } = req;
|
||||||
|
const { transactionId } = req.params;
|
||||||
|
const filter = this.matchedQueryData(req) as GetMatchedTransactionsFilter;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const data =
|
||||||
|
await this.bankTransactionsMatchingApp.getMatchedTransactions(
|
||||||
|
tenantId,
|
||||||
|
transactionId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
return res.status(200).send(data);
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Catches the service errors.
|
* Catches the service errors.
|
||||||
* @param {Error} error - Error.
|
* @param {Error} error - Error.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import DashboardService from '@/services/Dashboard/DashboardService';
|
|||||||
@Service()
|
@Service()
|
||||||
export default class DashboardMetaController {
|
export default class DashboardMetaController {
|
||||||
@Inject()
|
@Inject()
|
||||||
dashboardService: DashboardService;
|
private dashboardService: DashboardService;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor router.
|
* Constructor router.
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import { Router } from 'express';
|
import { NextFunction, Router, Request, Response } from 'express';
|
||||||
import { PlaidApplication } from '@/services/Banking/Plaid/PlaidApplication';
|
|
||||||
import { Request, Response } from 'express';
|
|
||||||
import { Inject, Service } from 'typedi';
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PlaidApplication } from '@/services/Banking/Plaid/PlaidApplication';
|
||||||
import BaseController from '../BaseController';
|
import BaseController from '../BaseController';
|
||||||
import { LemonSqueezyWebhooks } from '@/services/Subscription/LemonSqueezyWebhooks';
|
import { LemonSqueezyWebhooks } from '@/services/Subscription/LemonSqueezyWebhooks';
|
||||||
import { PlaidWebhookTenantBootMiddleware } from '@/services/Banking/Plaid/PlaidWebhookTenantBootMiddleware';
|
import { PlaidWebhookTenantBootMiddleware } from '@/services/Banking/Plaid/PlaidWebhookTenantBootMiddleware';
|
||||||
@@ -34,7 +33,7 @@ export class Webhooks extends BaseController {
|
|||||||
* @param {Response} res
|
* @param {Response} res
|
||||||
* @returns {Response}
|
* @returns {Response}
|
||||||
*/
|
*/
|
||||||
public async lemonWebhooks(req: Request, res: Response, next: any) {
|
public async lemonWebhooks(req: Request, res: Response, next: NextFunction) {
|
||||||
const data = req.body;
|
const data = req.body;
|
||||||
const signature = req.headers['x-signature'] ?? '';
|
const signature = req.headers['x-signature'] ?? '';
|
||||||
const rawBody = req.rawBody;
|
const rawBody = req.rawBody;
|
||||||
@@ -57,20 +56,25 @@ export class Webhooks extends BaseController {
|
|||||||
* @param {Response} res
|
* @param {Response} res
|
||||||
* @returns {Response}
|
* @returns {Response}
|
||||||
*/
|
*/
|
||||||
public async plaidWebhooks(req: Request, res: Response) {
|
public async plaidWebhooks(req: Request, res: Response, next: NextFunction) {
|
||||||
const { tenantId } = req;
|
const { tenantId } = req;
|
||||||
const {
|
|
||||||
webhook_type: webhookType,
|
|
||||||
webhook_code: webhookCode,
|
|
||||||
item_id: plaidItemId,
|
|
||||||
} = req.body;
|
|
||||||
|
|
||||||
await this.plaidApp.webhooks(
|
try {
|
||||||
tenantId,
|
const {
|
||||||
plaidItemId,
|
webhook_type: webhookType,
|
||||||
webhookType,
|
webhook_code: webhookCode,
|
||||||
webhookCode
|
item_id: plaidItemId,
|
||||||
);
|
} = req.body;
|
||||||
return res.status(200).send({ code: 200, message: 'ok' });
|
|
||||||
|
await this.plaidApp.webhooks(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId,
|
||||||
|
webhookType,
|
||||||
|
webhookCode
|
||||||
|
);
|
||||||
|
return res.status(200).send({ code: 200, message: 'ok' });
|
||||||
|
} catch (error) {
|
||||||
|
next(error);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import color from 'colorette';
|
|||||||
import argv from 'getopts';
|
import argv from 'getopts';
|
||||||
import Knex from 'knex';
|
import Knex from 'knex';
|
||||||
import { knexSnakeCaseMappers } from 'objection';
|
import { knexSnakeCaseMappers } from 'objection';
|
||||||
|
import { PromisePool } from '@supercharge/promise-pool';
|
||||||
import '../before';
|
import '../before';
|
||||||
import config from '../config';
|
import config from '../config';
|
||||||
|
|
||||||
@@ -28,7 +29,7 @@ function initSystemKnex() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
function initTenantKnex(organizationId) {
|
function initTenantKnex(organizationId: string = '') {
|
||||||
return Knex({
|
return Knex({
|
||||||
client: config.tenant.db_client,
|
client: config.tenant.db_client,
|
||||||
connection: {
|
connection: {
|
||||||
@@ -71,10 +72,12 @@ function getAllSystemTenants(knex) {
|
|||||||
return knex('tenants');
|
return knex('tenants');
|
||||||
}
|
}
|
||||||
|
|
||||||
function getAllInitializedSystemTenants(knex) {
|
function getAllInitializedTenants(knex) {
|
||||||
return knex('tenants').whereNotNull('initializedAt');
|
return knex('tenants').whereNotNull('initializedAt');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const MIGRATION_CONCURRENCY = 10;
|
||||||
|
|
||||||
// module.exports = {
|
// module.exports = {
|
||||||
// log,
|
// log,
|
||||||
// success,
|
// success,
|
||||||
@@ -91,6 +94,7 @@ function getAllInitializedSystemTenants(knex) {
|
|||||||
// - bigcapital tenants:migrate:make
|
// - bigcapital tenants:migrate:make
|
||||||
// - bigcapital system:migrate:make
|
// - bigcapital system:migrate:make
|
||||||
// - bigcapital tenants:list
|
// - bigcapital tenants:list
|
||||||
|
// - bigcapital tenants:list --all
|
||||||
|
|
||||||
commander
|
commander
|
||||||
.command('system:migrate:rollback')
|
.command('system:migrate:rollback')
|
||||||
@@ -149,10 +153,13 @@ commander
|
|||||||
commander
|
commander
|
||||||
.command('tenants:list')
|
.command('tenants:list')
|
||||||
.description('Retrieve a list of all system tenants databases.')
|
.description('Retrieve a list of all system tenants databases.')
|
||||||
|
.option('-a, --all', 'All tenants even are not initialized.')
|
||||||
.action(async (cmd) => {
|
.action(async (cmd) => {
|
||||||
try {
|
try {
|
||||||
const sysKnex = await initSystemKnex();
|
const sysKnex = await initSystemKnex();
|
||||||
const tenants = await getAllSystemTenants(sysKnex);
|
const tenants = cmd?.all
|
||||||
|
? await getAllSystemTenants(sysKnex)
|
||||||
|
: await getAllInitializedTenants(sysKnex);
|
||||||
|
|
||||||
tenants.forEach((tenant) => {
|
tenants.forEach((tenant) => {
|
||||||
const dbName = `${config.tenant.db_name_prefix}${tenant.organizationId}`;
|
const dbName = `${config.tenant.db_name_prefix}${tenant.organizationId}`;
|
||||||
@@ -183,18 +190,20 @@ commander
|
|||||||
commander
|
commander
|
||||||
.command('tenants:migrate:latest')
|
.command('tenants:migrate:latest')
|
||||||
.description('Migrate all tenants or the given tenant id.')
|
.description('Migrate all tenants or the given tenant id.')
|
||||||
.option('-t, --tenant_id [tenant_id]', 'Which tenant id do you migrate.')
|
.option(
|
||||||
|
'-t, --tenant_id [tenant_id]',
|
||||||
|
'Which organization id do you migrate.'
|
||||||
|
)
|
||||||
.action(async (cmd) => {
|
.action(async (cmd) => {
|
||||||
try {
|
try {
|
||||||
const sysKnex = await initSystemKnex();
|
const sysKnex = await initSystemKnex();
|
||||||
const tenants = await getAllInitializedSystemTenants(sysKnex);
|
const tenants = await getAllInitializedTenants(sysKnex);
|
||||||
const tenantsOrgsIds = tenants.map((tenant) => tenant.organizationId);
|
const tenantsOrgsIds = tenants.map((tenant) => tenant.organizationId);
|
||||||
|
|
||||||
if (cmd.tenant_id && tenantsOrgsIds.indexOf(cmd.tenant_id) === -1) {
|
if (cmd.tenant_id && tenantsOrgsIds.indexOf(cmd.tenant_id) === -1) {
|
||||||
exit(`The given tenant id ${cmd.tenant_id} is not exists.`);
|
exit(`The given tenant id ${cmd.tenant_id} is not exists.`);
|
||||||
}
|
}
|
||||||
// Validate the tenant id exist first of all.
|
// Validate the tenant id exist first of all.
|
||||||
const migrateOpers = [];
|
|
||||||
const migrateTenant = async (organizationId) => {
|
const migrateTenant = async (organizationId) => {
|
||||||
try {
|
try {
|
||||||
const tenantKnex = await initTenantKnex(organizationId);
|
const tenantKnex = await initTenantKnex(organizationId);
|
||||||
@@ -216,17 +225,17 @@ commander
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
if (!cmd.tenant_id) {
|
if (!cmd.tenant_id) {
|
||||||
tenants.forEach((tenant) => {
|
await PromisePool.withConcurrency(MIGRATION_CONCURRENCY)
|
||||||
const oper = migrateTenant(tenant.organizationId);
|
.for(tenants)
|
||||||
migrateOpers.push(oper);
|
.process((tenant, index, pool) => {
|
||||||
});
|
return migrateTenant(tenant.organizationId);
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
success('All tenants are migrated.');
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
const oper = migrateTenant(cmd.tenant_id);
|
await migrateTenant(cmd.tenant_id);
|
||||||
migrateOpers.push(oper);
|
|
||||||
}
|
}
|
||||||
Promise.all(migrateOpers).then(() => {
|
|
||||||
success('All tenants are migrated.');
|
|
||||||
});
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
exit(error);
|
exit(error);
|
||||||
}
|
}
|
||||||
@@ -235,19 +244,21 @@ commander
|
|||||||
commander
|
commander
|
||||||
.command('tenants:migrate:rollback')
|
.command('tenants:migrate:rollback')
|
||||||
.description('Rollback the last batch of tenants migrations.')
|
.description('Rollback the last batch of tenants migrations.')
|
||||||
.option('-t, --tenant_id [tenant_id]', 'Which tenant id do you migrate.')
|
.option(
|
||||||
|
'-t, --tenant_id [tenant_id]',
|
||||||
|
'Which organization id do you migrate.'
|
||||||
|
)
|
||||||
.action(async (cmd) => {
|
.action(async (cmd) => {
|
||||||
try {
|
try {
|
||||||
const sysKnex = await initSystemKnex();
|
const sysKnex = await initSystemKnex();
|
||||||
const tenants = await getAllSystemTenants(sysKnex);
|
const tenants = await getAllInitializedTenants(sysKnex);
|
||||||
const tenantsOrgsIds = tenants.map((tenant) => tenant.organizationId);
|
const tenantsOrgsIds = tenants.map((tenant) => tenant.organizationId);
|
||||||
|
|
||||||
if (cmd.tenant_id && tenantsOrgsIds.indexOf(cmd.tenant_id) === -1) {
|
if (cmd.tenant_id && tenantsOrgsIds.indexOf(cmd.tenant_id) === -1) {
|
||||||
exit(`The given tenant id ${cmd.tenant_id} is not exists.`);
|
exit(`The given tenant id ${cmd.tenant_id} is not exists.`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const migrateOpers = [];
|
const migrateTenant = async (organizationId: string) => {
|
||||||
const migrateTenant = async (organizationId) => {
|
|
||||||
try {
|
try {
|
||||||
const tenantKnex = await initTenantKnex(organizationId);
|
const tenantKnex = await initTenantKnex(organizationId);
|
||||||
const [batchNo, _log] = await tenantKnex.migrate.rollback();
|
const [batchNo, _log] = await tenantKnex.migrate.rollback();
|
||||||
@@ -268,17 +279,17 @@ commander
|
|||||||
};
|
};
|
||||||
|
|
||||||
if (!cmd.tenant_id) {
|
if (!cmd.tenant_id) {
|
||||||
tenants.forEach((tenant) => {
|
await PromisePool.withConcurrency(MIGRATION_CONCURRENCY)
|
||||||
const oper = migrateTenant(tenant.organizationId);
|
.for(tenants)
|
||||||
migrateOpers.push(oper);
|
.process((tenant, index, pool) => {
|
||||||
});
|
return migrateTenant(tenant.organizationId);
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
success('All tenants are rollbacked.');
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
const oper = migrateTenant(cmd.tenant_id);
|
await migrateTenant(cmd.tenant_id);
|
||||||
migrateOpers.push(oper);
|
|
||||||
}
|
}
|
||||||
Promise.all(migrateOpers).then(() => {
|
|
||||||
success('All tenants are rollbacked.');
|
|
||||||
});
|
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
exit(error);
|
exit(error);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,16 @@
|
|||||||
|
export const CashflowTransactionTypes = {
|
||||||
|
OtherIncome: 'Other income',
|
||||||
|
OtherExpense: 'Other expense',
|
||||||
|
OwnerDrawing: 'Owner drawing',
|
||||||
|
OwnerContribution: 'Owner contribution',
|
||||||
|
TransferToAccount: 'Transfer to account',
|
||||||
|
TransferFromAccount: 'Transfer from account',
|
||||||
|
};
|
||||||
|
|
||||||
export const TransactionTypes = {
|
export const TransactionTypes = {
|
||||||
SaleInvoice: 'Sale invoice',
|
SaleInvoice: 'Sale invoice',
|
||||||
SaleReceipt: 'Sale receipt',
|
SaleReceipt: 'Sale receipt',
|
||||||
PaymentReceive: 'Payment receive',
|
PaymentReceive: 'Payment received',
|
||||||
Bill: 'Bill',
|
Bill: 'Bill',
|
||||||
BillPayment: 'Payment made',
|
BillPayment: 'Payment made',
|
||||||
VendorOpeningBalance: 'Vendor opening balance',
|
VendorOpeningBalance: 'Vendor opening balance',
|
||||||
@@ -17,12 +26,10 @@ export const TransactionTypes = {
|
|||||||
OtherExpense: 'Other expense',
|
OtherExpense: 'Other expense',
|
||||||
OwnerDrawing: 'Owner drawing',
|
OwnerDrawing: 'Owner drawing',
|
||||||
InvoiceWriteOff: 'Invoice write-off',
|
InvoiceWriteOff: 'Invoice write-off',
|
||||||
|
|
||||||
CreditNote: 'transaction_type.credit_note',
|
CreditNote: 'transaction_type.credit_note',
|
||||||
VendorCredit: 'transaction_type.vendor_credit',
|
VendorCredit: 'transaction_type.vendor_credit',
|
||||||
|
|
||||||
RefundCreditNote: 'transaction_type.refund_credit_note',
|
RefundCreditNote: 'transaction_type.refund_credit_note',
|
||||||
RefundVendorCredit: 'transaction_type.refund_vendor_credit',
|
RefundVendorCredit: 'transaction_type.refund_vendor_credit',
|
||||||
|
|
||||||
LandedCost: 'transaction_type.landed_cost',
|
LandedCost: 'transaction_type.landed_cost',
|
||||||
|
CashflowTransaction: CashflowTransactionTypes,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema
|
||||||
|
.createTable('bank_rules', (table) => {
|
||||||
|
table.increments('id').primary();
|
||||||
|
table.string('name');
|
||||||
|
table.integer('order').unsigned();
|
||||||
|
|
||||||
|
table
|
||||||
|
.integer('apply_if_account_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('accounts');
|
||||||
|
table.string('apply_if_transaction_type');
|
||||||
|
|
||||||
|
table.string('assign_category');
|
||||||
|
table
|
||||||
|
.integer('assign_account_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('accounts');
|
||||||
|
table.string('assign_payee');
|
||||||
|
table.string('assign_memo');
|
||||||
|
|
||||||
|
table.string('conditions_type');
|
||||||
|
|
||||||
|
table.timestamps();
|
||||||
|
})
|
||||||
|
.createTable('bank_rule_conditions', (table) => {
|
||||||
|
table.increments('id').primary();
|
||||||
|
table
|
||||||
|
.integer('rule_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('bank_rules');
|
||||||
|
table.string('field');
|
||||||
|
table.string('comparator');
|
||||||
|
table.string('value');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema
|
||||||
|
.dropTableIfExists('bank_rules')
|
||||||
|
.dropTableIfExists('bank_rule_conditions');
|
||||||
|
};
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.createTable('recognized_bank_transactions', (table) => {
|
||||||
|
table.increments('id');
|
||||||
|
table
|
||||||
|
.integer('uncategorized_transaction_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('uncategorized_cashflow_transactions')
|
||||||
|
.withKeyName('recognizedBankTransactionsUncategorizedTransIdForeign');
|
||||||
|
table
|
||||||
|
.integer('bank_rule_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('bank_rules');
|
||||||
|
|
||||||
|
table.string('assigned_category');
|
||||||
|
table
|
||||||
|
.integer('assigned_account_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('accounts');
|
||||||
|
table.string('assigned_payee');
|
||||||
|
table.string('assigned_memo');
|
||||||
|
|
||||||
|
table.timestamps();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.dropTableIfExists('recognized_bank_transactions');
|
||||||
|
};
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table
|
||||||
|
.integer('recognized_transaction_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('recognized_bank_transactions')
|
||||||
|
.withKeyName('uncategorizedCashflowTransRecognizedTranIdForeign');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table.dropColumn('recognized_transaction_id');
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.createTable('matched_bank_transactions', (table) => {
|
||||||
|
table.increments('id');
|
||||||
|
table
|
||||||
|
.integer('uncategorized_transaction_id')
|
||||||
|
.unsigned()
|
||||||
|
.references('id')
|
||||||
|
.inTable('uncategorized_cashflow_transactions');
|
||||||
|
table.string('reference_type');
|
||||||
|
table.integer('reference_id').unsigned();
|
||||||
|
table.decimal('amount');
|
||||||
|
table.timestamps();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.dropTableIfExists('matched_bank_transactions');
|
||||||
|
};
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table.datetime('excluded_at');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table.dropColumn('excluded_at');
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table.string('batch');
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.table('uncategorized_cashflow_transactions', (table) => {
|
||||||
|
table.dropColumn('batch');
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.table('settings', (table) => {
|
||||||
|
table.text('value').alter();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = (knex) => {
|
||||||
|
return knex.schema.table('settings', (table) => {
|
||||||
|
table.string('value').alter();
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex('accounts_transactions')
|
||||||
|
.whereIn('referenceType', [
|
||||||
|
'OtherIncome',
|
||||||
|
'OtherExpense',
|
||||||
|
'OwnerDrawing',
|
||||||
|
'OwnerContribution',
|
||||||
|
'TransferToAccount',
|
||||||
|
'TransferFromAccount',
|
||||||
|
])
|
||||||
|
.update({
|
||||||
|
transactionType: knex.raw(`
|
||||||
|
CASE
|
||||||
|
WHEN REFERENCE_TYPE = 'OtherIncome' THEN 'OtherIncome'
|
||||||
|
WHEN REFERENCE_TYPE = 'OtherExpense' THEN 'OtherExpense'
|
||||||
|
WHEN REFERENCE_TYPE = 'OwnerDrawing' THEN 'OwnerDrawing'
|
||||||
|
WHEN REFERENCE_TYPE = 'OwnerContribution' THEN 'OwnerContribution'
|
||||||
|
WHEN REFERENCE_TYPE = 'TransferToAccount' THEN 'TransferToAccount'
|
||||||
|
WHEN REFERENCE_TYPE = 'TransferFromAccount' THEN 'TransferFromAccount'
|
||||||
|
END
|
||||||
|
`),
|
||||||
|
referenceType: knex.raw(`
|
||||||
|
CASE
|
||||||
|
WHEN REFERENCE_TYPE IN ('OtherIncome', 'OtherExpense', 'OwnerDrawing', 'OwnerContribution', 'TransferToAccount', 'TransferFromAccount') THEN 'CashflowTransaction'
|
||||||
|
ELSE REFERENCE_TYPE
|
||||||
|
END
|
||||||
|
`),
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex('accounts_transactions')
|
||||||
|
.whereIn('transactionType', [
|
||||||
|
'OtherIncome',
|
||||||
|
'OtherExpense',
|
||||||
|
'OwnerDrawing',
|
||||||
|
'OwnerContribution',
|
||||||
|
'TransferToAccount',
|
||||||
|
'TransferFromAccount',
|
||||||
|
])
|
||||||
|
.update({
|
||||||
|
referenceType: knex.raw(`
|
||||||
|
CASE
|
||||||
|
WHEN TRANSACTION_TYPE = 'OtherIncome' THEN 'OtherIncome'
|
||||||
|
WHEN TRANSACTION_TYPE = 'OtherExpense' THEN 'OtherExpense'
|
||||||
|
WHEN TRANSACTION_TYPE = 'OwnerDrawing' THEN 'OwnerDrawing'
|
||||||
|
WHEN TRANSACTION_TYPE = 'OwnerContribution' THEN 'OwnerContribution'
|
||||||
|
WHEN TRANSACTION_TYPE = 'TransferToAccount' THEN 'TransferToAccount'
|
||||||
|
WHEN TRANSACTION_TYPE = 'TransferFromAccount' THEN 'TransferFromAccount'
|
||||||
|
ELSE REFERENCE_TYPE
|
||||||
|
END
|
||||||
|
`),
|
||||||
|
transactionType: knex.raw(`
|
||||||
|
CASE
|
||||||
|
WHEN TRANSACTION_TYPE IN ('OtherIncome', 'OtherExpense', 'OwnerDrawing', 'OwnerContribution', 'TransferToAccount', 'TransferFromAccount') THEN NULL
|
||||||
|
ELSE TRANSACTION_TYPE
|
||||||
|
END
|
||||||
|
`),
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -66,7 +66,9 @@ export interface IAccountTransaction {
|
|||||||
referenceId: number;
|
referenceId: number;
|
||||||
|
|
||||||
referenceNumber?: string;
|
referenceNumber?: string;
|
||||||
|
|
||||||
transactionNumber?: string;
|
transactionNumber?: string;
|
||||||
|
transactionType?: string;
|
||||||
|
|
||||||
note?: string;
|
note?: string;
|
||||||
|
|
||||||
@@ -164,3 +166,7 @@ export enum TaxRateAction {
|
|||||||
DELETE = 'Delete',
|
DELETE = 'Delete',
|
||||||
VIEW = 'View',
|
VIEW = 'View',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface CreateAccountParams {
|
||||||
|
ignoreUniqueName: boolean;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { Knex } from 'knex';
|
||||||
import {
|
import {
|
||||||
IFinancialSheetCommonMeta,
|
IFinancialSheetCommonMeta,
|
||||||
INumberFormatQuery,
|
INumberFormatQuery,
|
||||||
@@ -257,7 +258,6 @@ export interface IUncategorizedCashflowTransaction {
|
|||||||
categorized: boolean;
|
categorized: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
export interface CreateUncategorizedTransactionDTO {
|
export interface CreateUncategorizedTransactionDTO {
|
||||||
date: Date | string;
|
date: Date | string;
|
||||||
accountId: number;
|
accountId: number;
|
||||||
@@ -267,4 +267,18 @@ export interface CreateUncategorizedTransactionDTO {
|
|||||||
description?: string;
|
description?: string;
|
||||||
referenceNo?: string | null;
|
referenceNo?: string | null;
|
||||||
plaidTransactionId?: string | null;
|
plaidTransactionId?: string | null;
|
||||||
|
batch?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IUncategorizedTransactionCreatingEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
createUncategorizedTransactionDTO: CreateUncategorizedTransactionDTO;
|
||||||
|
trx: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IUncategorizedTransactionCreatedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransaction: any;
|
||||||
|
createUncategorizedTransactionDTO: CreateUncategorizedTransactionDTO;
|
||||||
|
trx: Knex.Transaction;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -130,8 +130,9 @@ export interface ICommandCashflowDeletedPayload {
|
|||||||
|
|
||||||
export interface ICashflowTransactionCategorizedPayload {
|
export interface ICashflowTransactionCategorizedPayload {
|
||||||
tenantId: number;
|
tenantId: number;
|
||||||
cashflowTransactionId: number;
|
uncategorizedTransaction: any;
|
||||||
cashflowTransaction: ICashflowTransaction;
|
cashflowTransaction: ICashflowTransaction;
|
||||||
|
categorizeDTO: any;
|
||||||
trx: Knex.Transaction;
|
trx: Knex.Transaction;
|
||||||
}
|
}
|
||||||
export interface ICashflowTransactionUncategorizingPayload {
|
export interface ICashflowTransactionUncategorizingPayload {
|
||||||
@@ -164,3 +165,10 @@ export interface IGetUncategorizedTransactionsQuery {
|
|||||||
page?: number;
|
page?: number;
|
||||||
pageSize?: number;
|
pageSize?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
export interface IGetRecognizedTransactionsQuery {
|
||||||
|
page?: number;
|
||||||
|
pageSize?: number;
|
||||||
|
accountId?: number;
|
||||||
|
}
|
||||||
@@ -29,4 +29,9 @@ export interface ICashflowAccountTransaction {
|
|||||||
|
|
||||||
date: Date;
|
date: Date;
|
||||||
formattedDate: string;
|
formattedDate: string;
|
||||||
|
|
||||||
|
status: string;
|
||||||
|
formattedStatus: string;
|
||||||
|
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -56,6 +56,8 @@ export interface IGeneralLedgerSheetAccount {
|
|||||||
transactions: IGeneralLedgerSheetAccountTransaction[];
|
transactions: IGeneralLedgerSheetAccountTransaction[];
|
||||||
openingBalance: IGeneralLedgerSheetAccountBalance;
|
openingBalance: IGeneralLedgerSheetAccountBalance;
|
||||||
closingBalance: IGeneralLedgerSheetAccountBalance;
|
closingBalance: IGeneralLedgerSheetAccountBalance;
|
||||||
|
closingBalanceSubaccounts?: IGeneralLedgerSheetAccountBalance;
|
||||||
|
children?: IGeneralLedgerSheetAccount[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[];
|
export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[];
|
||||||
|
|||||||
8
packages/server/src/interfaces/Import.ts
Normal file
8
packages/server/src/interfaces/Import.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
import { ImportFilePreviewPOJO } from "@/services/Import/interfaces";
|
||||||
|
|
||||||
|
|
||||||
|
export interface IImportFileCommitedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
importId: number;
|
||||||
|
meta: ImportFilePreviewPOJO;
|
||||||
|
}
|
||||||
@@ -40,6 +40,8 @@ export interface ILedgerEntry {
|
|||||||
date: Date | string;
|
date: Date | string;
|
||||||
|
|
||||||
transactionType: string;
|
transactionType: string;
|
||||||
|
transactionSubType: string;
|
||||||
|
|
||||||
transactionId: number;
|
transactionId: number;
|
||||||
|
|
||||||
transactionNumber?: string;
|
transactionNumber?: string;
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
import { Knex } from "knex";
|
||||||
|
|
||||||
export interface IPlaidItemCreatedEventPayload {
|
export interface IPlaidItemCreatedEventPayload {
|
||||||
tenantId: number;
|
tenantId: number;
|
||||||
plaidAccessToken: string;
|
plaidAccessToken: string;
|
||||||
@@ -54,3 +56,10 @@ export interface SyncAccountsTransactionsTask {
|
|||||||
plaidAccountId: number;
|
plaidAccountId: number;
|
||||||
plaidTransactions: PlaidTransaction[];
|
plaidTransactions: PlaidTransaction[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface IPlaidTransactionsSyncedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
plaidAccountId: number;
|
||||||
|
batch: string;
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
}
|
||||||
|
|||||||
@@ -149,13 +149,19 @@ export class Transformer {
|
|||||||
return this.excludeAttributes().length > 0;
|
return this.excludeAttributes().length > 0;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
private dateFormat = 'YYYY MMM DD';
|
||||||
|
|
||||||
|
setDateFormat(format: string) {
|
||||||
|
this.dateFormat = format;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param date
|
* @param date
|
||||||
* @returns
|
* @returns
|
||||||
*/
|
*/
|
||||||
protected formatDate(date) {
|
protected formatDate(date) {
|
||||||
return date ? moment(date).format('YYYY/MM/DD') : '';
|
return date ? moment(date).format(this.dateFormat) : '';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -163,8 +169,8 @@ export class Transformer {
|
|||||||
* @param number
|
* @param number
|
||||||
* @returns
|
* @returns
|
||||||
*/
|
*/
|
||||||
protected formatNumber(number) {
|
protected formatNumber(number, props?) {
|
||||||
return formatNumber(number, { money: false });
|
return formatNumber(number, { money: false, ...props });
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -193,6 +199,7 @@ export class Transformer {
|
|||||||
) {
|
) {
|
||||||
transformer.setOptions(options);
|
transformer.setOptions(options);
|
||||||
transformer.setContext(this.context);
|
transformer.setContext(this.context);
|
||||||
|
transformer.setDateFormat(this.dateFormat);
|
||||||
|
|
||||||
return transformer.work(obj);
|
return transformer.work(obj);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,17 @@ export class TransformerInjectable {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the given tenatn date format.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
async getTenantDateFormat(tenantId: number) {
|
||||||
|
const metadata = await TenantMetadata.query().findOne('tenantId', tenantId);
|
||||||
|
|
||||||
|
return metadata.dateFormat;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Transformes the given transformer after inject the tenant context.
|
* Transformes the given transformer after inject the tenant context.
|
||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
@@ -41,7 +52,11 @@ export class TransformerInjectable {
|
|||||||
if (!isNull(tenantId)) {
|
if (!isNull(tenantId)) {
|
||||||
const context = await this.getApplicationContext(tenantId);
|
const context = await this.getApplicationContext(tenantId);
|
||||||
transformer.setContext(context);
|
transformer.setContext(context);
|
||||||
|
|
||||||
|
const dateFormat = await this.getTenantDateFormat(tenantId);
|
||||||
|
transformer.setDateFormat(dateFormat);
|
||||||
}
|
}
|
||||||
|
|
||||||
transformer.setOptions(options);
|
transformer.setOptions(options);
|
||||||
|
|
||||||
return transformer.work(object);
|
return transformer.work(object);
|
||||||
|
|||||||
@@ -102,6 +102,17 @@ import { AttachmentsOnVendorCredits } from '@/services/Attachments/events/Attach
|
|||||||
import { AttachmentsOnCreditNote } from '@/services/Attachments/events/AttachmentsOnCreditNote';
|
import { AttachmentsOnCreditNote } from '@/services/Attachments/events/AttachmentsOnCreditNote';
|
||||||
import { AttachmentsOnBillPayments } from '@/services/Attachments/events/AttachmentsOnPaymentsMade';
|
import { AttachmentsOnBillPayments } from '@/services/Attachments/events/AttachmentsOnPaymentsMade';
|
||||||
import { AttachmentsOnSaleEstimates } from '@/services/Attachments/events/AttachmentsOnSaleEstimates';
|
import { AttachmentsOnSaleEstimates } from '@/services/Attachments/events/AttachmentsOnSaleEstimates';
|
||||||
|
import { TriggerRecognizedTransactions } from '@/services/Banking/RegonizeTranasctions/events/TriggerRecognizedTransactions';
|
||||||
|
import { ValidateMatchingOnExpenseDelete } from '@/services/Banking/Matching/events/ValidateMatchingOnExpenseDelete';
|
||||||
|
import { ValidateMatchingOnManualJournalDelete } from '@/services/Banking/Matching/events/ValidateMatchingOnManualJournalDelete';
|
||||||
|
import { ValidateMatchingOnPaymentReceivedDelete } from '@/services/Banking/Matching/events/ValidateMatchingOnPaymentReceivedDelete';
|
||||||
|
import { ValidateMatchingOnPaymentMadeDelete } from '@/services/Banking/Matching/events/ValidateMatchingOnPaymentMadeDelete';
|
||||||
|
import { ValidateMatchingOnCashflowDelete } from '@/services/Banking/Matching/events/ValidateMatchingOnCashflowDelete';
|
||||||
|
import { RecognizeSyncedBankTranasctions } from '@/services/Banking/Plaid/subscribers/RecognizeSyncedBankTransactions';
|
||||||
|
import { UnlinkBankRuleOnDeleteBankRule } from '@/services/Banking/Rules/events/UnlinkBankRuleOnDeleteBankRule';
|
||||||
|
import { DecrementUncategorizedTransactionOnMatching } from '@/services/Banking/Matching/events/DecrementUncategorizedTransactionsOnMatch';
|
||||||
|
import { DecrementUncategorizedTransactionOnExclude } from '@/services/Banking/Exclude/events/DecrementUncategorizedTransactionOnExclude';
|
||||||
|
import { DecrementUncategorizedTransactionOnCategorize } from '@/services/Cashflow/subscribers/DecrementUncategorizedTransactionOnCategorize';
|
||||||
|
|
||||||
export default () => {
|
export default () => {
|
||||||
return new EventPublisher();
|
return new EventPublisher();
|
||||||
@@ -246,5 +257,22 @@ export const susbcribers = () => {
|
|||||||
AttachmentsOnBillPayments,
|
AttachmentsOnBillPayments,
|
||||||
AttachmentsOnManualJournals,
|
AttachmentsOnManualJournals,
|
||||||
AttachmentsOnExpenses,
|
AttachmentsOnExpenses,
|
||||||
|
|
||||||
|
// Bank Rules
|
||||||
|
TriggerRecognizedTransactions,
|
||||||
|
UnlinkBankRuleOnDeleteBankRule,
|
||||||
|
DecrementUncategorizedTransactionOnMatching,
|
||||||
|
DecrementUncategorizedTransactionOnExclude,
|
||||||
|
DecrementUncategorizedTransactionOnCategorize,
|
||||||
|
|
||||||
|
// Validate matching
|
||||||
|
ValidateMatchingOnCashflowDelete,
|
||||||
|
ValidateMatchingOnExpenseDelete,
|
||||||
|
ValidateMatchingOnManualJournalDelete,
|
||||||
|
ValidateMatchingOnPaymentReceivedDelete,
|
||||||
|
ValidateMatchingOnPaymentMadeDelete,
|
||||||
|
|
||||||
|
// Plaid
|
||||||
|
RecognizeSyncedBankTranasctions,
|
||||||
];
|
];
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import { PaymentReceiveMailNotificationJob } from '@/services/Sales/PaymentRecei
|
|||||||
import { PlaidFetchTransactionsJob } from '@/services/Banking/Plaid/PlaidFetchTransactionsJob';
|
import { PlaidFetchTransactionsJob } from '@/services/Banking/Plaid/PlaidFetchTransactionsJob';
|
||||||
import { ImportDeleteExpiredFilesJobs } from '@/services/Import/jobs/ImportDeleteExpiredFilesJob';
|
import { ImportDeleteExpiredFilesJobs } from '@/services/Import/jobs/ImportDeleteExpiredFilesJob';
|
||||||
import { SendVerifyMailJob } from '@/services/Authentication/jobs/SendVerifyMailJob';
|
import { SendVerifyMailJob } from '@/services/Authentication/jobs/SendVerifyMailJob';
|
||||||
|
import { RegonizeTransactionsJob } from '@/services/Banking/RegonizeTranasctions/RecognizeTransactionsJob';
|
||||||
|
|
||||||
export default ({ agenda }: { agenda: Agenda }) => {
|
export default ({ agenda }: { agenda: Agenda }) => {
|
||||||
new ResetPasswordMailJob(agenda);
|
new ResetPasswordMailJob(agenda);
|
||||||
@@ -29,6 +30,7 @@ export default ({ agenda }: { agenda: Agenda }) => {
|
|||||||
new PlaidFetchTransactionsJob(agenda);
|
new PlaidFetchTransactionsJob(agenda);
|
||||||
new ImportDeleteExpiredFilesJobs(agenda);
|
new ImportDeleteExpiredFilesJobs(agenda);
|
||||||
new SendVerifyMailJob(agenda);
|
new SendVerifyMailJob(agenda);
|
||||||
|
new RegonizeTransactionsJob(agenda);
|
||||||
|
|
||||||
agenda.start().then(() => {
|
agenda.start().then(() => {
|
||||||
agenda.every('1 hours', 'delete-expired-imported-files', {});
|
agenda.every('1 hours', 'delete-expired-imported-files', {});
|
||||||
|
|||||||
@@ -64,6 +64,10 @@ import PlaidItem from 'models/PlaidItem';
|
|||||||
import UncategorizedCashflowTransaction from 'models/UncategorizedCashflowTransaction';
|
import UncategorizedCashflowTransaction from 'models/UncategorizedCashflowTransaction';
|
||||||
import Document from '@/models/Document';
|
import Document from '@/models/Document';
|
||||||
import DocumentLink from '@/models/DocumentLink';
|
import DocumentLink from '@/models/DocumentLink';
|
||||||
|
import { BankRule } from '@/models/BankRule';
|
||||||
|
import { BankRuleCondition } from '@/models/BankRuleCondition';
|
||||||
|
import { RecognizedBankTransaction } from '@/models/RecognizedBankTransaction';
|
||||||
|
import { MatchedBankTransaction } from '@/models/MatchedBankTransaction';
|
||||||
|
|
||||||
export default (knex) => {
|
export default (knex) => {
|
||||||
const models = {
|
const models = {
|
||||||
@@ -131,6 +135,10 @@ export default (knex) => {
|
|||||||
DocumentLink,
|
DocumentLink,
|
||||||
PlaidItem,
|
PlaidItem,
|
||||||
UncategorizedCashflowTransaction,
|
UncategorizedCashflowTransaction,
|
||||||
|
BankRule,
|
||||||
|
BankRuleCondition,
|
||||||
|
RecognizedBankTransaction,
|
||||||
|
MatchedBankTransaction,
|
||||||
};
|
};
|
||||||
return mapValues(models, (model) => model.bindKnex(knex));
|
return mapValues(models, (model) => model.bindKnex(knex));
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ export default class AccountTransaction extends TenantModel {
|
|||||||
debit: number;
|
debit: number;
|
||||||
exchangeRate: number;
|
exchangeRate: number;
|
||||||
taxRate: number;
|
taxRate: number;
|
||||||
|
transactionType: string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Table name
|
* Table name
|
||||||
@@ -53,7 +54,7 @@ export default class AccountTransaction extends TenantModel {
|
|||||||
* @return {string}
|
* @return {string}
|
||||||
*/
|
*/
|
||||||
get referenceTypeFormatted() {
|
get referenceTypeFormatted() {
|
||||||
return getTransactionTypeLabel(this.referenceType);
|
return getTransactionTypeLabel(this.referenceType, this.transactionType);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
70
packages/server/src/models/BankRule.ts
Normal file
70
packages/server/src/models/BankRule.ts
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
import { Model } from 'objection';
|
||||||
|
|
||||||
|
export class BankRule extends TenantModel {
|
||||||
|
id!: number;
|
||||||
|
name!: string;
|
||||||
|
order!: number;
|
||||||
|
applyIfAccountId!: number;
|
||||||
|
applyIfTransactionType!: string;
|
||||||
|
assignCategory!: string;
|
||||||
|
assignAccountId!: number;
|
||||||
|
assignPayee!: string;
|
||||||
|
assignMemo!: string;
|
||||||
|
conditionsType!: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Table name
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'bank_rules';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
get timestamps() {
|
||||||
|
return ['created_at', 'updated_at'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Virtual attributes.
|
||||||
|
*/
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relationship mapping.
|
||||||
|
*/
|
||||||
|
static get relationMappings() {
|
||||||
|
const { BankRuleCondition } = require('models/BankRuleCondition');
|
||||||
|
const Account = require('models/Account');
|
||||||
|
|
||||||
|
return {
|
||||||
|
/**
|
||||||
|
* Sale invoice associated entries.
|
||||||
|
*/
|
||||||
|
conditions: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: BankRuleCondition,
|
||||||
|
join: {
|
||||||
|
from: 'bank_rules.id',
|
||||||
|
to: 'bank_rule_conditions.ruleId',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bank rule may associated to the assign account.
|
||||||
|
*/
|
||||||
|
assignAccount: {
|
||||||
|
relation: Model.BelongsToOneRelation,
|
||||||
|
modelClass: Account.default,
|
||||||
|
join: {
|
||||||
|
from: 'bank_rules.assignAccountId',
|
||||||
|
to: 'accounts.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
24
packages/server/src/models/BankRuleCondition.ts
Normal file
24
packages/server/src/models/BankRuleCondition.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
|
||||||
|
export class BankRuleCondition extends TenantModel {
|
||||||
|
/**
|
||||||
|
* Table name.
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'bank_rule_conditions';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
get timestamps() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Virtual attributes.
|
||||||
|
*/
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -404,6 +404,7 @@ export default class Bill extends mixin(TenantModel, [
|
|||||||
const Branch = require('models/Branch');
|
const Branch = require('models/Branch');
|
||||||
const TaxRateTransaction = require('models/TaxRateTransaction');
|
const TaxRateTransaction = require('models/TaxRateTransaction');
|
||||||
const Document = require('models/Document');
|
const Document = require('models/Document');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
vendor: {
|
vendor: {
|
||||||
@@ -485,6 +486,21 @@ export default class Bill extends mixin(TenantModel, [
|
|||||||
query.where('model_ref', 'Bill');
|
query.where('model_ref', 'Bill');
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bill may belongs to matched bank transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransaction: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'bills.id',
|
||||||
|
to: 'matched_bank_transactions.referenceId',
|
||||||
|
},
|
||||||
|
filter(query) {
|
||||||
|
query.where('reference_type', 'Bill');
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,9 +5,9 @@ import {
|
|||||||
getCashflowAccountTransactionsTypes,
|
getCashflowAccountTransactionsTypes,
|
||||||
getCashflowTransactionType,
|
getCashflowTransactionType,
|
||||||
} from '@/services/Cashflow/utils';
|
} from '@/services/Cashflow/utils';
|
||||||
import AccountTransaction from './AccountTransaction';
|
|
||||||
import { CASHFLOW_DIRECTION } from '@/services/Cashflow/constants';
|
import { CASHFLOW_DIRECTION } from '@/services/Cashflow/constants';
|
||||||
import { getTransactionTypeLabel } from '@/utils/transactions-types';
|
import { getCashflowTransactionFormattedType } from '@/utils/transactions-types';
|
||||||
|
|
||||||
export default class CashflowTransaction extends TenantModel {
|
export default class CashflowTransaction extends TenantModel {
|
||||||
transactionType: string;
|
transactionType: string;
|
||||||
amount: number;
|
amount: number;
|
||||||
@@ -64,7 +64,7 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
* @returns {string}
|
* @returns {string}
|
||||||
*/
|
*/
|
||||||
get transactionTypeFormatted() {
|
get transactionTypeFormatted() {
|
||||||
return getTransactionTypeLabel(this.transactionType);
|
return getCashflowTransactionFormattedType(this.transactionType);
|
||||||
}
|
}
|
||||||
|
|
||||||
get typeMeta() {
|
get typeMeta() {
|
||||||
@@ -95,6 +95,34 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
return !!this.uncategorizedTransaction;
|
return !!this.uncategorizedTransaction;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Model modifiers.
|
||||||
|
*/
|
||||||
|
static get modifiers() {
|
||||||
|
return {
|
||||||
|
/**
|
||||||
|
* Filter the published transactions.
|
||||||
|
*/
|
||||||
|
published(query) {
|
||||||
|
query.whereNot('published_at', null);
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the not categorized transactions.
|
||||||
|
*/
|
||||||
|
notCategorized(query) {
|
||||||
|
query.whereNull('cashflowTransactions.uncategorizedTransactionId');
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the categorized transactions.
|
||||||
|
*/
|
||||||
|
categorized(query) {
|
||||||
|
query.whereNotNull('cashflowTransactions.uncategorizedTransactionId');
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Relationship mapping.
|
* Relationship mapping.
|
||||||
*/
|
*/
|
||||||
@@ -102,6 +130,7 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
const CashflowTransactionLine = require('models/CashflowTransactionLine');
|
const CashflowTransactionLine = require('models/CashflowTransactionLine');
|
||||||
const AccountTransaction = require('models/AccountTransaction');
|
const AccountTransaction = require('models/AccountTransaction');
|
||||||
const Account = require('models/Account');
|
const Account = require('models/Account');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
@@ -130,8 +159,7 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
to: 'accounts_transactions.referenceId',
|
to: 'accounts_transactions.referenceId',
|
||||||
},
|
},
|
||||||
filter(builder) {
|
filter(builder) {
|
||||||
const referenceTypes = getCashflowAccountTransactionsTypes();
|
builder.where('reference_type', 'CashflowTransaction');
|
||||||
builder.whereIn('reference_type', referenceTypes);
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -158,6 +186,22 @@ export default class CashflowTransaction extends TenantModel {
|
|||||||
to: 'accounts.id',
|
to: 'accounts.id',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cashflow transaction may belongs to matched bank transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransaction: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'cashflow_transactions.id',
|
||||||
|
to: 'matched_bank_transactions.referenceId',
|
||||||
|
},
|
||||||
|
filter: (query) => {
|
||||||
|
const referenceTypes = getCashflowAccountTransactionsTypes();
|
||||||
|
query.whereIn('reference_type', referenceTypes);
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -182,6 +182,7 @@ export default class Expense extends mixin(TenantModel, [
|
|||||||
const ExpenseCategory = require('models/ExpenseCategory');
|
const ExpenseCategory = require('models/ExpenseCategory');
|
||||||
const Document = require('models/Document');
|
const Document = require('models/Document');
|
||||||
const Branch = require('models/Branch');
|
const Branch = require('models/Branch');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
paymentAccount: {
|
paymentAccount: {
|
||||||
@@ -234,6 +235,21 @@ export default class Expense extends mixin(TenantModel, [
|
|||||||
query.where('model_ref', 'Expense');
|
query.where('model_ref', 'Expense');
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Expense may belongs to matched bank transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransaction: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'expenses_transactions.id',
|
||||||
|
to: 'matched_bank_transactions.referenceId',
|
||||||
|
},
|
||||||
|
filter(query) {
|
||||||
|
query.where('reference_type', 'Expense');
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -97,6 +97,7 @@ export default class ManualJournal extends mixin(TenantModel, [
|
|||||||
const AccountTransaction = require('models/AccountTransaction');
|
const AccountTransaction = require('models/AccountTransaction');
|
||||||
const ManualJournalEntry = require('models/ManualJournalEntry');
|
const ManualJournalEntry = require('models/ManualJournalEntry');
|
||||||
const Document = require('models/Document');
|
const Document = require('models/Document');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
entries: {
|
entries: {
|
||||||
@@ -140,6 +141,21 @@ export default class ManualJournal extends mixin(TenantModel, [
|
|||||||
query.where('model_ref', 'ManualJournal');
|
query.where('model_ref', 'ManualJournal');
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manual journal may belongs to matched bank transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransaction: {
|
||||||
|
relation: Model.BelongsToOneRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'manual_journals.id',
|
||||||
|
to: 'matched_bank_transactions.referenceId',
|
||||||
|
},
|
||||||
|
filter(query) {
|
||||||
|
query.where('reference_type', 'ManualJournal');
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
32
packages/server/src/models/MatchedBankTransaction.ts
Normal file
32
packages/server/src/models/MatchedBankTransaction.ts
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
import { Model } from 'objection';
|
||||||
|
|
||||||
|
export class MatchedBankTransaction extends TenantModel {
|
||||||
|
/**
|
||||||
|
* Table name.
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'matched_bank_transactions';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
get timestamps() {
|
||||||
|
return ['createdAt', 'updatedAt'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Virtual attributes.
|
||||||
|
*/
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relationship mapping.
|
||||||
|
*/
|
||||||
|
static get relationMappings() {
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
}
|
||||||
72
packages/server/src/models/RecognizedBankTransaction.ts
Normal file
72
packages/server/src/models/RecognizedBankTransaction.ts
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
import TenantModel from 'models/TenantModel';
|
||||||
|
import { Model } from 'objection';
|
||||||
|
|
||||||
|
export class RecognizedBankTransaction extends TenantModel {
|
||||||
|
/**
|
||||||
|
* Table name.
|
||||||
|
*/
|
||||||
|
static get tableName() {
|
||||||
|
return 'recognized_bank_transactions';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Timestamps columns.
|
||||||
|
*/
|
||||||
|
get timestamps() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Virtual attributes.
|
||||||
|
*/
|
||||||
|
static get virtualAttributes() {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relationship mapping.
|
||||||
|
*/
|
||||||
|
static get relationMappings() {
|
||||||
|
const UncategorizedCashflowTransaction = require('./UncategorizedCashflowTransaction');
|
||||||
|
const Account = require('./Account');
|
||||||
|
const { BankRule } = require('./BankRule');
|
||||||
|
|
||||||
|
return {
|
||||||
|
/**
|
||||||
|
* Recognized bank transaction may belongs to uncategorized transactions.
|
||||||
|
*/
|
||||||
|
uncategorizedTransactions: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: UncategorizedCashflowTransaction.default,
|
||||||
|
join: {
|
||||||
|
from: 'recognized_bank_transactions.uncategorizedTransactionId',
|
||||||
|
to: 'uncategorized_cashflow_transactions.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recognized bank transaction may belongs to assign account.
|
||||||
|
*/
|
||||||
|
assignAccount: {
|
||||||
|
relation: Model.BelongsToOneRelation,
|
||||||
|
modelClass: Account.default,
|
||||||
|
join: {
|
||||||
|
from: 'recognized_bank_transactions.assignedAccountId',
|
||||||
|
to: 'accounts.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recognized bank transaction may belongs to bank rule.
|
||||||
|
*/
|
||||||
|
bankRule: {
|
||||||
|
relation: Model.BelongsToOneRelation,
|
||||||
|
modelClass: BankRule,
|
||||||
|
join: {
|
||||||
|
from: 'recognized_bank_transactions.bankRuleId',
|
||||||
|
to: 'bank_rules.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -411,6 +411,7 @@ export default class SaleInvoice extends mixin(TenantModel, [
|
|||||||
const Account = require('models/Account');
|
const Account = require('models/Account');
|
||||||
const TaxRateTransaction = require('models/TaxRateTransaction');
|
const TaxRateTransaction = require('models/TaxRateTransaction');
|
||||||
const Document = require('models/Document');
|
const Document = require('models/Document');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
@@ -543,6 +544,21 @@ export default class SaleInvoice extends mixin(TenantModel, [
|
|||||||
query.where('model_ref', 'SaleInvoice');
|
query.where('model_ref', 'SaleInvoice');
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sale invocie may belongs to matched bank transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransaction: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'sales_invoices.id',
|
||||||
|
to: "matched_bank_transactions.referenceId",
|
||||||
|
},
|
||||||
|
filter(query) {
|
||||||
|
query.where('reference_type', 'SaleInvoice');
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,15 @@ export default class UncategorizedCashflowTransaction extends mixin(
|
|||||||
[ModelSettings]
|
[ModelSettings]
|
||||||
) {
|
) {
|
||||||
id!: number;
|
id!: number;
|
||||||
|
date!: Date | string;
|
||||||
amount!: number;
|
amount!: number;
|
||||||
categorized!: boolean;
|
categorized!: boolean;
|
||||||
accountId!: number;
|
accountId!: number;
|
||||||
|
referenceNo!: string;
|
||||||
|
payee!: string;
|
||||||
|
description!: string;
|
||||||
|
plaidTransactionId!: string;
|
||||||
|
recognizedTransactionId!: number;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Table name.
|
* Table name.
|
||||||
@@ -38,6 +44,7 @@ export default class UncategorizedCashflowTransaction extends mixin(
|
|||||||
'deposit',
|
'deposit',
|
||||||
'isDepositTransaction',
|
'isDepositTransaction',
|
||||||
'isWithdrawalTransaction',
|
'isWithdrawalTransaction',
|
||||||
|
'isRecognized',
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,11 +82,69 @@ export default class UncategorizedCashflowTransaction extends mixin(
|
|||||||
return 0 < this.withdrawal;
|
return 0 < this.withdrawal;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detarmines whether the transaction is recognized.
|
||||||
|
*/
|
||||||
|
public get isRecognized(): boolean {
|
||||||
|
return !!this.recognizedTransactionId;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Model modifiers.
|
||||||
|
*/
|
||||||
|
static get modifiers() {
|
||||||
|
return {
|
||||||
|
/**
|
||||||
|
* Filters the not excluded transactions.
|
||||||
|
*/
|
||||||
|
notExcluded(query) {
|
||||||
|
query.whereNull('excluded_at');
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters the excluded transactions.
|
||||||
|
*/
|
||||||
|
excluded(query) {
|
||||||
|
query.whereNotNull('excluded_at');
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter out the recognized transactions.
|
||||||
|
* @param query
|
||||||
|
*/
|
||||||
|
recognized(query) {
|
||||||
|
query.whereNotNull('recognizedTransactionId');
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter out the not recognized transactions.
|
||||||
|
* @param query
|
||||||
|
*/
|
||||||
|
notRecognized(query) {
|
||||||
|
query.whereNull('recognizedTransactionId');
|
||||||
|
},
|
||||||
|
|
||||||
|
categorized(query) {
|
||||||
|
query.whereNotNull('categorizeRefType');
|
||||||
|
query.whereNotNull('categorizeRefId');
|
||||||
|
},
|
||||||
|
|
||||||
|
notCategorized(query) {
|
||||||
|
query.whereNull('categorizeRefType');
|
||||||
|
query.whereNull('categorizeRefId');
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Relationship mapping.
|
* Relationship mapping.
|
||||||
*/
|
*/
|
||||||
static get relationMappings() {
|
static get relationMappings() {
|
||||||
const Account = require('models/Account');
|
const Account = require('models/Account');
|
||||||
|
const {
|
||||||
|
RecognizedBankTransaction,
|
||||||
|
} = require('models/RecognizedBankTransaction');
|
||||||
|
const { MatchedBankTransaction } = require('models/MatchedBankTransaction');
|
||||||
|
|
||||||
return {
|
return {
|
||||||
/**
|
/**
|
||||||
@@ -93,58 +158,30 @@ export default class UncategorizedCashflowTransaction extends mixin(
|
|||||||
to: 'accounts.id',
|
to: 'accounts.id',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Transaction may has association to recognized transaction.
|
||||||
|
*/
|
||||||
|
recognizedTransaction: {
|
||||||
|
relation: Model.HasOneRelation,
|
||||||
|
modelClass: RecognizedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'uncategorized_cashflow_transactions.recognizedTransactionId',
|
||||||
|
to: 'recognized_bank_transactions.id',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Uncategorized transaction may has association to matched transaction.
|
||||||
|
*/
|
||||||
|
matchedBankTransactions: {
|
||||||
|
relation: Model.HasManyRelation,
|
||||||
|
modelClass: MatchedBankTransaction,
|
||||||
|
join: {
|
||||||
|
from: 'uncategorized_cashflow_transactions.id',
|
||||||
|
to: 'matched_bank_transactions.uncategorizedTransactionId',
|
||||||
|
},
|
||||||
|
},
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* 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);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ export default class Ledger implements ILedger {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Filters entries by the given accounts ids then returns a new ledger.
|
* Filters entries by the given accounts ids then returns a new ledger.
|
||||||
* @param {number[]} accountIds
|
* @param {number[]} accountIds
|
||||||
* @returns {ILedger}
|
* @returns {ILedger}
|
||||||
*/
|
*/
|
||||||
public whereAccountsIds(accountIds: number[]): ILedger {
|
public whereAccountsIds(accountIds: number[]): ILedger {
|
||||||
@@ -274,4 +274,14 @@ export default class Ledger implements ILedger {
|
|||||||
const entries = Ledger.mappingTransactions(transactions);
|
const entries = Ledger.mappingTransactions(transactions);
|
||||||
return new Ledger(entries);
|
return new Ledger(entries);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction amount.
|
||||||
|
* @param {number} credit - Credit amount.
|
||||||
|
* @param {number} debit - Debit amount.
|
||||||
|
* @param {string} normal - Credit or debit.
|
||||||
|
*/
|
||||||
|
static getAmount(credit: number, debit: number, normal: string) {
|
||||||
|
return normal === 'credit' ? credit - debit : debit - credit;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,6 +19,8 @@ export const transformLedgerEntryToTransaction = (
|
|||||||
referenceId: entry.transactionId,
|
referenceId: entry.transactionId,
|
||||||
|
|
||||||
transactionNumber: entry.transactionNumber,
|
transactionNumber: entry.transactionNumber,
|
||||||
|
transactionType: entry.transactionSubType,
|
||||||
|
|
||||||
referenceNumber: entry.referenceNumber,
|
referenceNumber: entry.referenceNumber,
|
||||||
|
|
||||||
note: entry.note,
|
note: entry.note,
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import {
|
|||||||
IAccountEventCreatedPayload,
|
IAccountEventCreatedPayload,
|
||||||
IAccountEventCreatingPayload,
|
IAccountEventCreatingPayload,
|
||||||
IAccountCreateDTO,
|
IAccountCreateDTO,
|
||||||
|
CreateAccountParams,
|
||||||
} from '@/interfaces';
|
} from '@/interfaces';
|
||||||
import events from '@/subscribers/events';
|
import events from '@/subscribers/events';
|
||||||
import UnitOfWork from '@/services/UnitOfWork';
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
@@ -30,19 +31,22 @@ export class CreateAccount {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Authorize the account creation.
|
* Authorize the account creation.
|
||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
* @param {IAccountCreateDTO} accountDTO
|
* @param {IAccountCreateDTO} accountDTO
|
||||||
*/
|
*/
|
||||||
private authorize = async (
|
private authorize = async (
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
accountDTO: IAccountCreateDTO,
|
accountDTO: IAccountCreateDTO,
|
||||||
baseCurrency: string
|
baseCurrency: string,
|
||||||
|
params?: CreateAccountParams
|
||||||
) => {
|
) => {
|
||||||
// Validate account name uniquiness.
|
// Validate account name uniquiness.
|
||||||
await this.validator.validateAccountNameUniquiness(
|
if (!params.ignoreUniqueName) {
|
||||||
tenantId,
|
await this.validator.validateAccountNameUniquiness(
|
||||||
accountDTO.name
|
tenantId,
|
||||||
);
|
accountDTO.name
|
||||||
|
);
|
||||||
|
}
|
||||||
// Validate the account code uniquiness.
|
// Validate the account code uniquiness.
|
||||||
if (accountDTO.code) {
|
if (accountDTO.code) {
|
||||||
await this.validator.isAccountCodeUniqueOrThrowError(
|
await this.validator.isAccountCodeUniqueOrThrowError(
|
||||||
@@ -82,7 +86,7 @@ export class CreateAccount {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Transformes the create account DTO to input model.
|
* Transformes the create account DTO to input model.
|
||||||
* @param {IAccountCreateDTO} createAccountDTO
|
* @param {IAccountCreateDTO} createAccountDTO
|
||||||
*/
|
*/
|
||||||
private transformDTOToModel = (
|
private transformDTOToModel = (
|
||||||
createAccountDTO: IAccountCreateDTO,
|
createAccountDTO: IAccountCreateDTO,
|
||||||
@@ -104,7 +108,8 @@ export class CreateAccount {
|
|||||||
public createAccount = async (
|
public createAccount = async (
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
accountDTO: IAccountCreateDTO,
|
accountDTO: IAccountCreateDTO,
|
||||||
trx?: Knex.Transaction
|
trx?: Knex.Transaction,
|
||||||
|
params: CreateAccountParams = { ignoreUniqueName: false }
|
||||||
): Promise<IAccount> => {
|
): Promise<IAccount> => {
|
||||||
const { Account } = this.tenancy.models(tenantId);
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
@@ -112,8 +117,12 @@ export class CreateAccount {
|
|||||||
const tenantMeta = await TenantMetadata.query().findOne({ tenantId });
|
const tenantMeta = await TenantMetadata.query().findOne({ tenantId });
|
||||||
|
|
||||||
// Authorize the account creation.
|
// Authorize the account creation.
|
||||||
await this.authorize(tenantId, accountDTO, tenantMeta.baseCurrency);
|
await this.authorize(
|
||||||
|
tenantId,
|
||||||
|
accountDTO,
|
||||||
|
tenantMeta.baseCurrency,
|
||||||
|
params
|
||||||
|
);
|
||||||
// Transformes the DTO to model.
|
// Transformes the DTO to model.
|
||||||
const accountInputModel = this.transformDTOToModel(
|
const accountInputModel = this.transformDTOToModel(
|
||||||
accountDTO,
|
accountDTO,
|
||||||
@@ -148,3 +157,4 @@ export class CreateAccount {
|
|||||||
);
|
);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { Container, Inject } from 'typedi';
|
import { Container, Inject } from 'typedi';
|
||||||
import { cloneDeep } from 'lodash';
|
import { cloneDeep } from 'lodash';
|
||||||
import { Tenant } from '@/system/models';
|
import { SystemUser, Tenant } from '@/system/models';
|
||||||
import {
|
import {
|
||||||
IAuthSignedInEventPayload,
|
IAuthSignedInEventPayload,
|
||||||
IAuthSigningInEventPayload,
|
IAuthSigningInEventPayload,
|
||||||
@@ -64,7 +64,9 @@ export class AuthSigninService {
|
|||||||
const { systemUserRepository } = this.sysRepositories;
|
const { systemUserRepository } = this.sysRepositories;
|
||||||
|
|
||||||
// Finds the user of the given email address.
|
// Finds the user of the given email address.
|
||||||
const user = await systemUserRepository.findOneByEmail(email);
|
const user = await SystemUser.query()
|
||||||
|
.findOne('email', email)
|
||||||
|
.modify('inviteAccepted');
|
||||||
|
|
||||||
// Validate the given email and password.
|
// Validate the given email and password.
|
||||||
await this.validateSignIn(user, email, password);
|
await this.validateSignIn(user, email, password);
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetBankAccountSummary {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the bank account meta summary
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} bankAccountId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public async getBankAccountSummary(tenantId: number, bankAccountId: number) {
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
const {
|
||||||
|
Account,
|
||||||
|
UncategorizedCashflowTransaction,
|
||||||
|
RecognizedBankTransaction,
|
||||||
|
MatchedBankTransaction,
|
||||||
|
} = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
await initialize(knex, [
|
||||||
|
UncategorizedCashflowTransaction,
|
||||||
|
RecognizedBankTransaction,
|
||||||
|
MatchedBankTransaction,
|
||||||
|
]);
|
||||||
|
const bankAccount = await Account.query()
|
||||||
|
.findById(bankAccountId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
// Retrieves the uncategorized transactions count of the given bank account.
|
||||||
|
const uncategorizedTranasctionsCount =
|
||||||
|
await UncategorizedCashflowTransaction.query().onBuild((q) => {
|
||||||
|
// Include just the given account.
|
||||||
|
q.where('accountId', bankAccountId);
|
||||||
|
|
||||||
|
// Only the not excluded.
|
||||||
|
q.modify('notExcluded');
|
||||||
|
|
||||||
|
// Only the not categorized.
|
||||||
|
q.modify('notCategorized');
|
||||||
|
|
||||||
|
// Only the not matched bank transactions.
|
||||||
|
q.withGraphJoined('matchedBankTransactions');
|
||||||
|
q.whereNull('matchedBankTransactions.id');
|
||||||
|
|
||||||
|
// Count the results.
|
||||||
|
q.count('uncategorized_cashflow_transactions.id as total');
|
||||||
|
q.first();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Retrieves the recognized transactions count of the given bank account.
|
||||||
|
const recognizedTransactionsCount = await RecognizedBankTransaction.query()
|
||||||
|
.whereExists(
|
||||||
|
UncategorizedCashflowTransaction.query().where(
|
||||||
|
'accountId',
|
||||||
|
bankAccountId
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.count('id as total')
|
||||||
|
.first();
|
||||||
|
|
||||||
|
const totalUncategorizedTransactions =
|
||||||
|
uncategorizedTranasctionsCount?.total || 0;
|
||||||
|
const totalRecognizedTransactions = recognizedTransactionsCount?.total || 0;
|
||||||
|
|
||||||
|
return {
|
||||||
|
name: bankAccount.name,
|
||||||
|
totalUncategorizedTransactions,
|
||||||
|
totalRecognizedTransactions,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { validateTransactionNotCategorized } from './utils';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import {
|
||||||
|
IBankTransactionUnexcludedEventPayload,
|
||||||
|
IBankTransactionUnexcludingEventPayload,
|
||||||
|
} from './_types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ExcludeBankTransaction {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks the given bank transaction as excluded.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} bankTransactionId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async excludeBankTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const oldUncategorizedTransaction =
|
||||||
|
await UncategorizedCashflowTransaction.query()
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
validateTransactionNotCategorized(oldUncategorizedTransaction);
|
||||||
|
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx) => {
|
||||||
|
await this.eventPublisher.emitAsync(events.bankTransactions.onExcluding, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionUnexcludingEventPayload);
|
||||||
|
|
||||||
|
await UncategorizedCashflowTransaction.query(trx)
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.patch({
|
||||||
|
excludedAt: new Date(),
|
||||||
|
});
|
||||||
|
|
||||||
|
await this.eventPublisher.emitAsync(events.bankTransactions.onExcluded, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionUnexcludedEventPayload);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { ExcludeBankTransaction } from './ExcludeBankTransaction';
|
||||||
|
import { UnexcludeBankTransaction } from './UnexcludeBankTransaction';
|
||||||
|
import { GetExcludedBankTransactionsService } from './GetExcludedBankTransactions';
|
||||||
|
import { ExcludedBankTransactionsQuery } from './_types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ExcludeBankTransactionsApplication {
|
||||||
|
@Inject()
|
||||||
|
private excludeBankTransactionService: ExcludeBankTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private unexcludeBankTransactionService: UnexcludeBankTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getExcludedBankTransactionsService: GetExcludedBankTransactionsService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks a bank transaction as excluded.
|
||||||
|
* @param {number} tenantId - The ID of the tenant.
|
||||||
|
* @param {number} bankTransactionId - The ID of the bank transaction to exclude.
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public excludeBankTransaction(tenantId: number, bankTransactionId: number) {
|
||||||
|
return this.excludeBankTransactionService.excludeBankTransaction(
|
||||||
|
tenantId,
|
||||||
|
bankTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks a bank transaction as not excluded.
|
||||||
|
* @param {number} tenantId - The ID of the tenant.
|
||||||
|
* @param {number} bankTransactionId - The ID of the bank transaction to exclude.
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public unexcludeBankTransaction(tenantId: number, bankTransactionId: number) {
|
||||||
|
return this.unexcludeBankTransactionService.unexcludeBankTransaction(
|
||||||
|
tenantId,
|
||||||
|
bankTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the excluded bank transactions.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {ExcludedBankTransactionsQuery} filter
|
||||||
|
* @returns {}
|
||||||
|
*/
|
||||||
|
public getExcludedBankTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: ExcludedBankTransactionsQuery
|
||||||
|
) {
|
||||||
|
return this.getExcludedBankTransactionsService.getExcludedBankTransactions(
|
||||||
|
tenantId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { ExcludedBankTransactionsQuery } from './_types';
|
||||||
|
import { UncategorizedTransactionTransformer } from '@/services/Cashflow/UncategorizedTransactionTransformer';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetExcludedBankTransactionsService {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the excluded uncategorized bank transactions.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {ExcludedBankTransactionsQuery} filter
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public async getExcludedBankTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: ExcludedBankTransactionsQuery
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
// Parsed query with default values.
|
||||||
|
const _query = {
|
||||||
|
page: 1,
|
||||||
|
pageSize: 20,
|
||||||
|
...filter,
|
||||||
|
};
|
||||||
|
const { results, pagination } =
|
||||||
|
await UncategorizedCashflowTransaction.query()
|
||||||
|
.onBuild((q) => {
|
||||||
|
q.modify('excluded');
|
||||||
|
q.orderBy('date', 'DESC');
|
||||||
|
|
||||||
|
if (_query.accountId) {
|
||||||
|
q.where('account_id', _query.accountId);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.pagination(_query.page - 1, _query.pageSize);
|
||||||
|
|
||||||
|
const data = await this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
results,
|
||||||
|
new UncategorizedTransactionTransformer()
|
||||||
|
);
|
||||||
|
return { data, pagination };
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { validateTransactionNotCategorized } from './utils';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import {
|
||||||
|
IBankTransactionExcludedEventPayload,
|
||||||
|
IBankTransactionExcludingEventPayload,
|
||||||
|
} from './_types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class UnexcludeBankTransaction {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks the given bank transaction as excluded.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} bankTransactionId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async unexcludeBankTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number
|
||||||
|
): Promise<void> {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const oldUncategorizedTransaction =
|
||||||
|
await UncategorizedCashflowTransaction.query()
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
validateTransactionNotCategorized(oldUncategorizedTransaction);
|
||||||
|
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx) => {
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.bankTransactions.onUnexcluding,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
} as IBankTransactionExcludingEventPayload
|
||||||
|
);
|
||||||
|
|
||||||
|
await UncategorizedCashflowTransaction.query(trx)
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.patch({
|
||||||
|
excludedAt: null,
|
||||||
|
});
|
||||||
|
|
||||||
|
await this.eventPublisher.emitAsync(
|
||||||
|
events.bankTransactions.onUnexcluded,
|
||||||
|
{
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
} as IBankTransactionExcludedEventPayload
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
30
packages/server/src/services/Banking/Exclude/_types.ts
Normal file
30
packages/server/src/services/Banking/Exclude/_types.ts
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
import { Knex } from "knex";
|
||||||
|
|
||||||
|
export interface ExcludedBankTransactionsQuery {
|
||||||
|
page?: number;
|
||||||
|
pageSize?: number;
|
||||||
|
accountId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionUnexcludingEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionUnexcludedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionExcludingEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
}
|
||||||
|
export interface IBankTransactionExcludedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
}
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import {
|
||||||
|
IBankTransactionExcludedEventPayload,
|
||||||
|
IBankTransactionUnexcludedEventPayload,
|
||||||
|
} from '../_types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class DecrementUncategorizedTransactionOnExclude {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.bankTransactions.onExcluded,
|
||||||
|
this.decrementUnCategorizedTransactionsOnExclude.bind(this)
|
||||||
|
);
|
||||||
|
bus.subscribe(
|
||||||
|
events.bankTransactions.onUnexcluded,
|
||||||
|
this.incrementUnCategorizedTransactionsOnUnexclude.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the cashflow transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async decrementUnCategorizedTransactionsOnExclude({
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
}: IBankTransactionExcludedEventPayload) {
|
||||||
|
const { UncategorizedCashflowTransaction, Account } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query(
|
||||||
|
trx
|
||||||
|
).findById(uncategorizedTransactionId);
|
||||||
|
|
||||||
|
await Account.query(trx)
|
||||||
|
.findById(transaction.accountId)
|
||||||
|
.decrement('uncategorizedTransactions', 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the cashflow transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async incrementUnCategorizedTransactionsOnUnexclude({
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
}: IBankTransactionUnexcludedEventPayload) {
|
||||||
|
const { UncategorizedCashflowTransaction, Account } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query().findById(
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
//
|
||||||
|
await Account.query(trx)
|
||||||
|
.findById(transaction.accountId)
|
||||||
|
.increment('uncategorizedTransactions', 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
14
packages/server/src/services/Banking/Exclude/utils.ts
Normal file
14
packages/server/src/services/Banking/Exclude/utils.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { ServiceError } from '@/exceptions';
|
||||||
|
import UncategorizedCashflowTransaction from '@/models/UncategorizedCashflowTransaction';
|
||||||
|
|
||||||
|
const ERRORS = {
|
||||||
|
TRANSACTION_ALREADY_CATEGORIZED: 'TRANSACTION_ALREADY_CATEGORIZED',
|
||||||
|
};
|
||||||
|
|
||||||
|
export const validateTransactionNotCategorized = (
|
||||||
|
transaction: UncategorizedCashflowTransaction
|
||||||
|
) => {
|
||||||
|
if (transaction.categorized) {
|
||||||
|
throw new ServiceError(ERRORS.TRANSACTION_ALREADY_CATEGORIZED);
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
|
|
||||||
|
export class GetMatchedTransactionBillsTransformer extends Transformer {
|
||||||
|
/**
|
||||||
|
* Include these attributes to sale credit note object.
|
||||||
|
* @returns {Array}
|
||||||
|
*/
|
||||||
|
public includeAttributes = (): string[] => {
|
||||||
|
return [
|
||||||
|
'referenceNo',
|
||||||
|
'amount',
|
||||||
|
'amountFormatted',
|
||||||
|
'transactionNo',
|
||||||
|
'date',
|
||||||
|
'dateFormatted',
|
||||||
|
'transactionId',
|
||||||
|
'transactionNo',
|
||||||
|
'transactionType',
|
||||||
|
'transsactionTypeFormatted',
|
||||||
|
'transactionNormal',
|
||||||
|
'referenceId',
|
||||||
|
'referenceType',
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exclude all attributes.
|
||||||
|
* @returns {Array<string>}
|
||||||
|
*/
|
||||||
|
public excludeAttributes = (): string[] => {
|
||||||
|
return ['*'];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the reference number of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceNo(bill) {
|
||||||
|
return bill.referenceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the amount of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected amount(bill) {
|
||||||
|
return bill.amount;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the formatted amount of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected amountFormatted(bill) {
|
||||||
|
return this.formatNumber(bill.amount, {
|
||||||
|
currencyCode: bill.currencyCode,
|
||||||
|
money: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the date of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected date(bill) {
|
||||||
|
return bill.billDate;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the formatted date of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected dateFormatted(bill) {
|
||||||
|
return this.formatDate(bill.billDate);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transcation id of the bill.
|
||||||
|
* @param {Object} bill - The bill object.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected transactionId(bill) {
|
||||||
|
return bill.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal transaction type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionType() {
|
||||||
|
return 'Bill';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal formatted transaction type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transsactionTypeFormatted() {
|
||||||
|
return 'Bill';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the bill transaction normal (debit or credit).
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNormal() {
|
||||||
|
return 'credit';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the match transaction reference id.
|
||||||
|
* @param bill
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected referenceId(bill) {
|
||||||
|
return bill.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the match transaction referenece type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceType() {
|
||||||
|
return 'Bill';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
|
|
||||||
|
export class GetMatchedTransactionCashflowTransformer extends Transformer {
|
||||||
|
/**
|
||||||
|
* Include these attributes to sale credit note object.
|
||||||
|
* @returns {Array}
|
||||||
|
*/
|
||||||
|
public includeAttributes = (): string[] => {
|
||||||
|
return [
|
||||||
|
'referenceNo',
|
||||||
|
'amount',
|
||||||
|
'amountFormatted',
|
||||||
|
'transactionNo',
|
||||||
|
'date',
|
||||||
|
'dateFormatted',
|
||||||
|
'transactionId',
|
||||||
|
'transactionNo',
|
||||||
|
'transactionType',
|
||||||
|
'transsactionTypeFormatted',
|
||||||
|
'transactionNormal',
|
||||||
|
'referenceId',
|
||||||
|
'referenceType',
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exclude all attributes.
|
||||||
|
* @returns {Array<string>}
|
||||||
|
*/
|
||||||
|
public excludeAttributes = (): string[] => {
|
||||||
|
return ['*'];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice reference number.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceNo(invoice) {
|
||||||
|
return invoice.referenceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction amount.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected amount(transaction) {
|
||||||
|
return transaction.amount;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction formatted amount.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected amountFormatted(transaction) {
|
||||||
|
return this.formatNumber(transaction.amount, {
|
||||||
|
currencyCode: transaction.currencyCode,
|
||||||
|
money: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the date of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {Date}
|
||||||
|
*/
|
||||||
|
protected date(transaction) {
|
||||||
|
return transaction.date;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format the date of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected dateFormatted(transaction) {
|
||||||
|
return this.formatDate(transaction.date);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction ID of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected transactionId(transaction) {
|
||||||
|
return transaction.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice transaction number.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNo(transaction) {
|
||||||
|
return transaction.transactionNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice transaction type.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {String}
|
||||||
|
*/
|
||||||
|
protected transactionType(transaction) {
|
||||||
|
return transaction.transactionType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice formatted transaction type.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transsactionTypeFormatted(transaction) {
|
||||||
|
return transaction.transactionTypeFormatted;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the cashflow transaction normal (credit or debit).
|
||||||
|
* @param transaction
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNormal(transaction) {
|
||||||
|
return transaction.isCashCredit ? 'credit' : 'debit';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the cashflow transaction reference id.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected referenceId(transaction) {
|
||||||
|
return transaction.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the cashflow transaction reference type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceType() {
|
||||||
|
return 'CashflowTransaction';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
|
|
||||||
|
export class GetMatchedTransactionExpensesTransformer extends Transformer {
|
||||||
|
/**
|
||||||
|
* Include these attributes to sale credit note object.
|
||||||
|
* @returns {Array}
|
||||||
|
*/
|
||||||
|
public includeAttributes = (): string[] => {
|
||||||
|
return [
|
||||||
|
'referenceNo',
|
||||||
|
'amount',
|
||||||
|
'amountFormatted',
|
||||||
|
'transactionNo',
|
||||||
|
'date',
|
||||||
|
'dateFormatted',
|
||||||
|
'transactionId',
|
||||||
|
'transactionNo',
|
||||||
|
'transactionType',
|
||||||
|
'transsactionTypeFormatted',
|
||||||
|
'transactionNormal',
|
||||||
|
'referenceType',
|
||||||
|
'referenceId',
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exclude all attributes.
|
||||||
|
* @returns {Array<string>}
|
||||||
|
*/
|
||||||
|
public excludeAttributes = (): string[] => {
|
||||||
|
return ['*'];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the expense reference number.
|
||||||
|
* @param expense
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceNo(expense) {
|
||||||
|
return expense.referenceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the expense amount.
|
||||||
|
* @param expense
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected amount(expense) {
|
||||||
|
return expense.totalAmount;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Formats the amount of the expense.
|
||||||
|
* @param expense
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected amountFormatted(expense) {
|
||||||
|
return this.formatNumber(expense.totalAmount, {
|
||||||
|
currencyCode: expense.currencyCode,
|
||||||
|
money: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the date of the expense.
|
||||||
|
* @param expense
|
||||||
|
* @returns {Date}
|
||||||
|
*/
|
||||||
|
protected date(expense) {
|
||||||
|
return expense.paymentDate;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Formats the date of the expense.
|
||||||
|
* @param expense
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected dateFormatted(expense) {
|
||||||
|
return this.formatDate(expense.paymentDate);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the transaction ID of the expense.
|
||||||
|
* @param expense
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected transactionId(expense) {
|
||||||
|
return expense.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the expense transaction number.
|
||||||
|
* @param expense
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNo(expense) {
|
||||||
|
return expense.expenseNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the expense transaction type.
|
||||||
|
* @param expense
|
||||||
|
* @returns {String}
|
||||||
|
*/
|
||||||
|
protected transactionType() {
|
||||||
|
return 'Expense';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the formatted transaction type of the expense.
|
||||||
|
* @param expense
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transsactionTypeFormatted() {
|
||||||
|
return 'Expense';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the expense transaction normal (credit or debit).
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNormal() {
|
||||||
|
return 'credit';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction reference type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceType() {
|
||||||
|
return 'Expense';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction reference id.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected referenceId(transaction) {
|
||||||
|
return transaction.id;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
|
|
||||||
|
export class GetMatchedTransactionInvoicesTransformer extends Transformer {
|
||||||
|
/**
|
||||||
|
* Include these attributes to sale credit note object.
|
||||||
|
* @returns {Array}
|
||||||
|
*/
|
||||||
|
public includeAttributes = (): string[] => {
|
||||||
|
return [
|
||||||
|
'referenceNo',
|
||||||
|
'amount',
|
||||||
|
'amountFormatted',
|
||||||
|
'transactionNo',
|
||||||
|
'date',
|
||||||
|
'dateFormatted',
|
||||||
|
'transactionId',
|
||||||
|
'transactionNo',
|
||||||
|
'transactionType',
|
||||||
|
'transsactionTypeFormatted',
|
||||||
|
'transactionNormal',
|
||||||
|
'referenceType',
|
||||||
|
'referenceId'
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exclude all attributes.
|
||||||
|
* @returns {Array<string>}
|
||||||
|
*/
|
||||||
|
public excludeAttributes = (): string[] => {
|
||||||
|
return ['*'];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice reference number.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceNo(invoice) {
|
||||||
|
return invoice.referenceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice amount.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected amount(invoice) {
|
||||||
|
return invoice.dueAmount;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Format the amount of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected amountFormatted(invoice) {
|
||||||
|
return this.formatNumber(invoice.dueAmount, {
|
||||||
|
currencyCode: invoice.currencyCode,
|
||||||
|
money: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the date of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {Date}
|
||||||
|
*/
|
||||||
|
protected date(invoice) {
|
||||||
|
return invoice.invoiceDate;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format the date of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected dateFormatted(invoice) {
|
||||||
|
return this.formatDate(invoice.invoiceDate);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction ID of the invoice.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected transactionId(invoice) {
|
||||||
|
return invoice.id;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice transaction number.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNo(invoice) {
|
||||||
|
return invoice.invoiceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice transaction type.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {String}
|
||||||
|
*/
|
||||||
|
protected transactionType(invoice) {
|
||||||
|
return 'SaleInvoice';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the invoice formatted transaction type.
|
||||||
|
* @param invoice
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transsactionTypeFormatted(invoice) {
|
||||||
|
return 'Sale invoice';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction normal of invoice (credit or debit).
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNormal() {
|
||||||
|
return 'debit';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction reference type.
|
||||||
|
* @returns {string}
|
||||||
|
*/ protected referenceType() {
|
||||||
|
return 'SaleInvoice';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the transaction reference id.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected referenceId(transaction) {
|
||||||
|
return transaction.id;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,149 @@
|
|||||||
|
import { sumBy } from 'lodash';
|
||||||
|
import { Transformer } from '@/lib/Transformer/Transformer';
|
||||||
|
import { AccountNormal } from '@/interfaces';
|
||||||
|
|
||||||
|
export class GetMatchedTransactionManualJournalsTransformer extends Transformer {
|
||||||
|
/**
|
||||||
|
* Include these attributes to sale credit note object.
|
||||||
|
* @returns {Array}
|
||||||
|
*/
|
||||||
|
public includeAttributes = (): string[] => {
|
||||||
|
return [
|
||||||
|
'referenceNo',
|
||||||
|
'amount',
|
||||||
|
'amountFormatted',
|
||||||
|
'transactionNo',
|
||||||
|
'date',
|
||||||
|
'dateFormatted',
|
||||||
|
'transactionId',
|
||||||
|
'transactionNo',
|
||||||
|
'transactionType',
|
||||||
|
'transsactionTypeFormatted',
|
||||||
|
'transactionNormal',
|
||||||
|
'referenceType',
|
||||||
|
'referenceId',
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exclude all attributes.
|
||||||
|
* @returns {Array<string>}
|
||||||
|
*/
|
||||||
|
public excludeAttributes = (): string[] => {
|
||||||
|
return ['*'];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal reference no.
|
||||||
|
* @param manualJournal
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceNo(manualJournal) {
|
||||||
|
return manualJournal.referenceNo;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected total(manualJournal) {
|
||||||
|
const credit = sumBy(manualJournal?.entries, 'credit');
|
||||||
|
const debit = sumBy(manualJournal?.entries, 'debit');
|
||||||
|
|
||||||
|
return debit - credit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal amount.
|
||||||
|
* @param manualJournal
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected amount(manualJournal) {
|
||||||
|
return Math.abs(this.total(manualJournal));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal formatted amount.
|
||||||
|
* @param manualJournal
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected amountFormatted(manualJournal) {
|
||||||
|
return this.formatNumber(manualJournal.amount, {
|
||||||
|
currencyCode: manualJournal.currencyCode,
|
||||||
|
money: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retreives the manual journal date.
|
||||||
|
* @param manualJournal
|
||||||
|
* @returns {Date}
|
||||||
|
*/
|
||||||
|
protected date(manualJournal) {
|
||||||
|
return manualJournal.date;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal formatted date.
|
||||||
|
* @param manualJournal
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected dateFormatted(manualJournal) {
|
||||||
|
return this.formatDate(manualJournal.date);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal transaction id.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected transactionId(manualJournal) {
|
||||||
|
return manualJournal.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal transaction number.
|
||||||
|
* @param manualJournal
|
||||||
|
*/
|
||||||
|
protected transactionNo(manualJournal) {
|
||||||
|
return manualJournal.journalNumber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal transaction type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionType() {
|
||||||
|
return 'ManualJournal';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal formatted transaction type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transsactionTypeFormatted() {
|
||||||
|
return 'Manual Journal';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal transaction normal (credit or debit).
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected transactionNormal(transaction) {
|
||||||
|
const amount = this.total(transaction);
|
||||||
|
|
||||||
|
return amount >= 0 ? AccountNormal.DEBIT : AccountNormal.CREDIT;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the manual journal reference type.
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
protected referenceType() {
|
||||||
|
return 'ManualJournal';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the manual journal reference id.
|
||||||
|
* @param transaction
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
|
protected referenceId(transaction) {
|
||||||
|
return transaction.id;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import * as R from 'ramda';
|
||||||
|
import moment from 'moment';
|
||||||
|
import { PromisePool } from '@supercharge/promise-pool';
|
||||||
|
import { GetMatchedTransactionsFilter, MatchedTransactionsPOJO } from './types';
|
||||||
|
import { GetMatchedTransactionsByExpenses } from './GetMatchedTransactionsByExpenses';
|
||||||
|
import { GetMatchedTransactionsByBills } from './GetMatchedTransactionsByBills';
|
||||||
|
import { GetMatchedTransactionsByManualJournals } from './GetMatchedTransactionsByManualJournals';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { sortClosestMatchTransactions } from './_utils';
|
||||||
|
import { GetMatchedTransactionsByCashflow } from './GetMatchedTransactionsByCashflow';
|
||||||
|
import { GetMatchedTransactionsByInvoices } from './GetMatchedTransactionsByInvoices';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactions {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getMatchedInvoicesService: GetMatchedTransactionsByInvoices;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getMatchedBillsService: GetMatchedTransactionsByBills;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getMatchedManualJournalService: GetMatchedTransactionsByManualJournals;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getMatchedExpensesService: GetMatchedTransactionsByExpenses;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private getMatchedCashflowService: GetMatchedTransactionsByCashflow;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registered matched transactions types.
|
||||||
|
*/
|
||||||
|
get registered() {
|
||||||
|
return [
|
||||||
|
{ type: 'SaleInvoice', service: this.getMatchedInvoicesService },
|
||||||
|
{ type: 'Bill', service: this.getMatchedBillsService },
|
||||||
|
{ type: 'Expense', service: this.getMatchedExpensesService },
|
||||||
|
{ type: 'ManualJournal', service: this.getMatchedManualJournalService },
|
||||||
|
{ type: 'Cashflow', service: this.getMatchedCashflowService },
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter -
|
||||||
|
* @returns {Promise<MatchedTransactionsPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
): Promise<MatchedTransactionsPOJO> {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const uncategorizedTransaction =
|
||||||
|
await UncategorizedCashflowTransaction.query()
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
const filtered = filter.transactionType
|
||||||
|
? this.registered.filter((item) => item.type === filter.transactionType)
|
||||||
|
: this.registered;
|
||||||
|
|
||||||
|
const matchedTransactions = await PromisePool.withConcurrency(2)
|
||||||
|
.for(filtered)
|
||||||
|
.process(async ({ type, service }) => {
|
||||||
|
return service.getMatchedTransactions(tenantId, filter);
|
||||||
|
});
|
||||||
|
|
||||||
|
const { perfectMatches, possibleMatches } = this.groupMatchedResults(
|
||||||
|
uncategorizedTransaction,
|
||||||
|
matchedTransactions
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
perfectMatches,
|
||||||
|
possibleMatches,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Groups the given results for getting perfect and possible matches
|
||||||
|
* based on the given uncategorized transaction.
|
||||||
|
* @param uncategorizedTransaction
|
||||||
|
* @param matchedTransactions
|
||||||
|
* @returns {MatchedTransactionsPOJO}
|
||||||
|
*/
|
||||||
|
private groupMatchedResults(
|
||||||
|
uncategorizedTransaction,
|
||||||
|
matchedTransactions
|
||||||
|
): MatchedTransactionsPOJO {
|
||||||
|
const results = R.compose(R.flatten)(matchedTransactions?.results);
|
||||||
|
|
||||||
|
// Sort the results based on amount, date, and transaction type
|
||||||
|
const closestResullts = sortClosestMatchTransactions(
|
||||||
|
uncategorizedTransaction,
|
||||||
|
results
|
||||||
|
);
|
||||||
|
const perfectMatches = R.filter(
|
||||||
|
(match) =>
|
||||||
|
match.amount === uncategorizedTransaction.amount &&
|
||||||
|
moment(match.date).isSame(uncategorizedTransaction.date, 'day'),
|
||||||
|
closestResullts
|
||||||
|
);
|
||||||
|
const possibleMatches = R.difference(closestResullts, perfectMatches);
|
||||||
|
|
||||||
|
return { perfectMatches, possibleMatches };
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
import { GetMatchedTransactionBillsTransformer } from './GetMatchedTransactionBillsTransformer';
|
||||||
|
import { GetMatchedTransactionsFilter, MatchedTransactionPOJO } from './types';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactionsByBills extends GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter -
|
||||||
|
*/
|
||||||
|
public async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
) {
|
||||||
|
const { Bill, MatchedBankTransaction } = this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
// Initialize the models metadata.
|
||||||
|
await initialize(knex, [Bill, MatchedBankTransaction]);
|
||||||
|
|
||||||
|
// Retrieves the bill matches.
|
||||||
|
const bills = await Bill.query().onBuild((q) => {
|
||||||
|
q.withGraphJoined('matchedBankTransaction');
|
||||||
|
q.whereNull('matchedBankTransaction.id');
|
||||||
|
q.modify('published');
|
||||||
|
|
||||||
|
if (filter.fromDate) {
|
||||||
|
q.where('billDate', '>=', filter.fromDate);
|
||||||
|
}
|
||||||
|
if (filter.toDate) {
|
||||||
|
q.where('billDate', '<=', filter.toDate);
|
||||||
|
}
|
||||||
|
q.orderBy('billDate', 'DESC');
|
||||||
|
});
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
bills,
|
||||||
|
new GetMatchedTransactionBillsTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the given bill matched transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} transactionId
|
||||||
|
* @returns {Promise<MatchedTransactionPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
transactionId: number
|
||||||
|
): Promise<MatchedTransactionPOJO> {
|
||||||
|
const { Bill } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const bill = await Bill.query().findById(transactionId).throwIfNotFound();
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
bill,
|
||||||
|
new GetMatchedTransactionBillsTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
import { GetMatchedTransactionCashflowTransformer } from './GetMatchedTransactionCashflowTransformer';
|
||||||
|
import { GetMatchedTransactionsFilter } from './types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactionsByCashflow extends GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
private transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the matched transactions of cash flow.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: Omit<GetMatchedTransactionsFilter, 'transactionType'>
|
||||||
|
) {
|
||||||
|
const { CashflowTransaction, MatchedBankTransaction } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
// Initialize the ORM models metadata.
|
||||||
|
await initialize(knex, [CashflowTransaction, MatchedBankTransaction]);
|
||||||
|
|
||||||
|
const transactions = await CashflowTransaction.query().onBuild((q) => {
|
||||||
|
// Not matched to bank transaction.
|
||||||
|
q.withGraphJoined('matchedBankTransaction');
|
||||||
|
q.whereNull('matchedBankTransaction.id');
|
||||||
|
|
||||||
|
// Not categorized.
|
||||||
|
q.modify('notCategorized');
|
||||||
|
|
||||||
|
// Published.
|
||||||
|
q.modify('published');
|
||||||
|
|
||||||
|
if (filter.fromDate) {
|
||||||
|
q.where('date', '>=', filter.fromDate);
|
||||||
|
}
|
||||||
|
if (filter.toDate) {
|
||||||
|
q.where('date', '<=', filter.toDate);
|
||||||
|
}
|
||||||
|
q.orderBy('date', 'DESC');
|
||||||
|
});
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
transactions,
|
||||||
|
new GetMatchedTransactionCashflowTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transaction of cash flow.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} transactionId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getMatchedTransaction(tenantId: number, transactionId: number) {
|
||||||
|
const { CashflowTransaction, MatchedBankTransaction } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
// Initialize the ORM models metadata.
|
||||||
|
await initialize(knex, [CashflowTransaction, MatchedBankTransaction]);
|
||||||
|
|
||||||
|
const transactions = await CashflowTransaction.query()
|
||||||
|
.findById(transactionId)
|
||||||
|
.withGraphJoined('matchedBankTransaction')
|
||||||
|
.whereNull('matchedBankTransaction.id')
|
||||||
|
.modify('notCategorized')
|
||||||
|
.modify('published')
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
transactions,
|
||||||
|
new GetMatchedTransactionCashflowTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import { GetMatchedTransactionsFilter, MatchedTransactionPOJO } from './types';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
import { GetMatchedTransactionExpensesTransformer } from './GetMatchedTransactionExpensesTransformer';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactionsByExpenses extends GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
protected tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
protected transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions of expenses.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
) {
|
||||||
|
const { Expense, MatchedBankTransaction } = this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
// Initialize the models metadata.
|
||||||
|
await initialize(knex, [Expense, MatchedBankTransaction]);
|
||||||
|
|
||||||
|
// Retrieve the expense matches.
|
||||||
|
const expenses = await Expense.query().onBuild((query) => {
|
||||||
|
// Filter out the not matched to bank transactions.
|
||||||
|
query.withGraphJoined('matchedBankTransaction');
|
||||||
|
query.whereNull('matchedBankTransaction.id');
|
||||||
|
|
||||||
|
// Filter the published onyl
|
||||||
|
query.modify('filterByPublished');
|
||||||
|
|
||||||
|
if (filter.fromDate) {
|
||||||
|
query.where('paymentDate', '>=', filter.fromDate);
|
||||||
|
}
|
||||||
|
if (filter.toDate) {
|
||||||
|
query.where('paymentDate', '<=', filter.toDate);
|
||||||
|
}
|
||||||
|
if (filter.minAmount) {
|
||||||
|
query.where('totalAmount', '>=', filter.minAmount);
|
||||||
|
}
|
||||||
|
if (filter.maxAmount) {
|
||||||
|
query.where('totalAmount', '<=', filter.maxAmount);
|
||||||
|
}
|
||||||
|
query.orderBy('paymentDate', 'DESC');
|
||||||
|
});
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
expenses,
|
||||||
|
new GetMatchedTransactionExpensesTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the given matched expense transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} transactionId
|
||||||
|
* @returns {GetMatchedTransactionExpensesTransformer-}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
transactionId: number
|
||||||
|
): Promise<MatchedTransactionPOJO> {
|
||||||
|
const { Expense } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const expense = await Expense.query()
|
||||||
|
.findById(transactionId)
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
expense,
|
||||||
|
new GetMatchedTransactionExpensesTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
import { GetMatchedTransactionInvoicesTransformer } from './GetMatchedTransactionInvoicesTransformer';
|
||||||
|
import {
|
||||||
|
GetMatchedTransactionsFilter,
|
||||||
|
MatchedTransactionPOJO,
|
||||||
|
MatchedTransactionsPOJO,
|
||||||
|
} from './types';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactionsByInvoices extends GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
protected tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
protected transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter -
|
||||||
|
* @returns {Promise<MatchedTransactionsPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
): Promise<MatchedTransactionsPOJO> {
|
||||||
|
const { SaleInvoice, MatchedBankTransaction } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
// Initialize the models metadata.
|
||||||
|
await initialize(knex, [SaleInvoice, MatchedBankTransaction]);
|
||||||
|
|
||||||
|
// Retrieve the invoices that not matched, unpaid.
|
||||||
|
const invoices = await SaleInvoice.query().onBuild((q) => {
|
||||||
|
q.withGraphJoined('matchedBankTransaction');
|
||||||
|
q.whereNull('matchedBankTransaction.id');
|
||||||
|
q.modify('unpaid');
|
||||||
|
q.modify('published');
|
||||||
|
|
||||||
|
if (filter.fromDate) {
|
||||||
|
q.where('invoiceDate', '>=', filter.fromDate);
|
||||||
|
}
|
||||||
|
if (filter.toDate) {
|
||||||
|
q.where('invoiceDate', '<=', filter.toDate);
|
||||||
|
}
|
||||||
|
q.orderBy('invoiceDate', 'DESC');
|
||||||
|
});
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
invoices,
|
||||||
|
new GetMatchedTransactionInvoicesTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} transactionId
|
||||||
|
* @returns {Promise<MatchedTransactionPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
transactionId: number
|
||||||
|
): Promise<MatchedTransactionPOJO> {
|
||||||
|
const { SaleInvoice } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const invoice = await SaleInvoice.query().findById(transactionId);
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
invoice,
|
||||||
|
new GetMatchedTransactionInvoicesTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { initialize } from 'objection';
|
||||||
|
import { TransformerInjectable } from '@/lib/Transformer/TransformerInjectable';
|
||||||
|
import { GetMatchedTransactionManualJournalsTransformer } from './GetMatchedTransactionManualJournalsTransformer';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
import { GetMatchedTransactionsFilter } from './types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class GetMatchedTransactionsByManualJournals extends GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
private transformer: TransformerInjectable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the matched transactions of manual journals.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: Omit<GetMatchedTransactionsFilter, 'transactionType'>
|
||||||
|
) {
|
||||||
|
const { ManualJournal, ManualJournalEntry, MatchedBankTransaction } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
const knex = this.tenancy.knex(tenantId);
|
||||||
|
|
||||||
|
await initialize(knex, [
|
||||||
|
ManualJournal,
|
||||||
|
ManualJournalEntry,
|
||||||
|
MatchedBankTransaction,
|
||||||
|
]);
|
||||||
|
const accountId = 1000;
|
||||||
|
|
||||||
|
const manualJournals = await ManualJournal.query().onBuild((query) => {
|
||||||
|
query.withGraphJoined('matchedBankTransaction');
|
||||||
|
query.whereNull('matchedBankTransaction.id');
|
||||||
|
|
||||||
|
query.withGraphJoined('entries');
|
||||||
|
query.where('entries.accountId', accountId);
|
||||||
|
|
||||||
|
query.modify('filterByPublished');
|
||||||
|
|
||||||
|
if (filter.fromDate) {
|
||||||
|
query.where('date', '>=', filter.fromDate);
|
||||||
|
}
|
||||||
|
if (filter.toDate) {
|
||||||
|
query.where('date', '<=', filter.toDate);
|
||||||
|
}
|
||||||
|
if (filter.minAmount) {
|
||||||
|
query.where('amount', '>=', filter.minAmount);
|
||||||
|
}
|
||||||
|
if (filter.maxAmount) {
|
||||||
|
query.where('amount', '<=', filter.maxAmount);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
manualJournals,
|
||||||
|
new GetMatchedTransactionManualJournalsTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transaction of manual journals.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} transactionId
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
async getMatchedTransaction(tenantId: number, transactionId: number) {
|
||||||
|
const { ManualJournal } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const manualJournal = await ManualJournal.query()
|
||||||
|
.findById(transactionId)
|
||||||
|
.whereNotExists(ManualJournal.relatedQuery('matchedBankTransaction'))
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
return this.transformer.transform(
|
||||||
|
tenantId,
|
||||||
|
manualJournal,
|
||||||
|
new GetMatchedTransactionManualJournalsTransformer()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
import { Knex } from 'knex';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import {
|
||||||
|
GetMatchedTransactionsFilter,
|
||||||
|
IMatchTransactionDTO,
|
||||||
|
MatchedTransactionPOJO,
|
||||||
|
MatchedTransactionsPOJO,
|
||||||
|
} from './types';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
|
||||||
|
export abstract class GetMatchedTransactionsByType {
|
||||||
|
@Inject()
|
||||||
|
protected tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter -
|
||||||
|
* @returns {Promise<MatchedTransactionsPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
): Promise<MatchedTransactionsPOJO> {
|
||||||
|
throw new Error(
|
||||||
|
'The `getMatchedTransactions` method is not defined for the transaction type.'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transaction details.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {number} transactionId -
|
||||||
|
* @returns {Promise<MatchedTransactionPOJO>}
|
||||||
|
*/
|
||||||
|
public async getMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
transactionId: number
|
||||||
|
): Promise<MatchedTransactionPOJO> {
|
||||||
|
throw new Error(
|
||||||
|
'The `getMatchedTransaction` method is not defined for the transaction type.'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @param {IMatchTransactionDTO} matchTransactionDTO
|
||||||
|
* @param {Knex.Transaction} trx
|
||||||
|
*/
|
||||||
|
public async createMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
matchTransactionDTO: IMatchTransactionDTO,
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
) {
|
||||||
|
const { MatchedBankTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
await MatchedBankTransaction.query(trx).insert({
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
referenceType: matchTransactionDTO.referenceType,
|
||||||
|
referenceId: matchTransactionDTO.referenceId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { GetMatchedTransactions } from './GetMatchedTransactions';
|
||||||
|
import { MatchBankTransactions } from './MatchTransactions';
|
||||||
|
import { UnmatchMatchedBankTransaction } from './UnmatchMatchedTransaction';
|
||||||
|
import { GetMatchedTransactionsFilter, IMatchTransactionsDTO } from './types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class MatchBankTransactionsApplication {
|
||||||
|
@Inject()
|
||||||
|
private getMatchedTransactionsService: GetMatchedTransactions;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private matchTransactionService: MatchBankTransactions;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private unmatchMatchedTransactionService: UnmatchMatchedBankTransaction;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the matched transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {GetMatchedTransactionsFilter} filter -
|
||||||
|
* @returns
|
||||||
|
*/
|
||||||
|
public getMatchedTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
filter: GetMatchedTransactionsFilter
|
||||||
|
) {
|
||||||
|
return this.getMatchedTransactionsService.getMatchedTransactions(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
filter
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches the given uncategorized transaction with the given system transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @param {IMatchTransactionDTO} matchTransactionsDTO
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public matchTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
matchTransactionsDTO: IMatchTransactionsDTO
|
||||||
|
): Promise<void> {
|
||||||
|
return this.matchTransactionService.matchTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
matchTransactionsDTO
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unmatch the given matched transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public unmatchMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number
|
||||||
|
) {
|
||||||
|
return this.unmatchMatchedTransactionService.unmatchMatchedTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,157 @@
|
|||||||
|
import { isEmpty } from 'lodash';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PromisePool } from '@supercharge/promise-pool';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import {
|
||||||
|
ERRORS,
|
||||||
|
IBankTransactionMatchedEventPayload,
|
||||||
|
IBankTransactionMatchingEventPayload,
|
||||||
|
IMatchTransactionsDTO,
|
||||||
|
} from './types';
|
||||||
|
import { MatchTransactionsTypes } from './MatchTransactionsTypes';
|
||||||
|
import { ServiceError } from '@/exceptions';
|
||||||
|
import { sumMatchTranasctions } from './_utils';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class MatchBankTransactions {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private matchedBankTransactions: MatchTransactionsTypes;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the match bank transactions DTO.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @param {IMatchTransactionsDTO} matchTransactionsDTO
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
async validate(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
matchTransactionsDTO: IMatchTransactionsDTO
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
const { matchedTransactions } = matchTransactionsDTO;
|
||||||
|
|
||||||
|
// Validates the uncategorized transaction existance.
|
||||||
|
const uncategorizedTransaction =
|
||||||
|
await UncategorizedCashflowTransaction.query()
|
||||||
|
.findById(uncategorizedTransactionId)
|
||||||
|
.withGraphFetched('matchedBankTransactions')
|
||||||
|
.throwIfNotFound();
|
||||||
|
|
||||||
|
// Validates the uncategorized transaction is not already matched.
|
||||||
|
if (!isEmpty(uncategorizedTransaction.matchedBankTransactions)) {
|
||||||
|
throw new ServiceError(ERRORS.TRANSACTION_ALREADY_MATCHED);
|
||||||
|
}
|
||||||
|
// Validate the uncategorized transaction is not excluded.
|
||||||
|
if (uncategorizedTransaction.excluded) {
|
||||||
|
throw new ServiceError(ERRORS.CANNOT_MATCH_EXCLUDED_TRANSACTION);
|
||||||
|
}
|
||||||
|
// Validates the given matched transaction.
|
||||||
|
const validateMatchedTransaction = async (matchedTransaction) => {
|
||||||
|
const getMatchedTransactionsService =
|
||||||
|
this.matchedBankTransactions.registry.get(
|
||||||
|
matchedTransaction.referenceType
|
||||||
|
);
|
||||||
|
if (!getMatchedTransactionsService) {
|
||||||
|
throw new ServiceError(
|
||||||
|
ERRORS.RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const foundMatchedTransaction =
|
||||||
|
await getMatchedTransactionsService.getMatchedTransaction(
|
||||||
|
tenantId,
|
||||||
|
matchedTransaction.referenceId
|
||||||
|
);
|
||||||
|
if (!foundMatchedTransaction) {
|
||||||
|
throw new ServiceError(ERRORS.RESOURCE_ID_MATCHING_TRANSACTION_INVALID);
|
||||||
|
}
|
||||||
|
return foundMatchedTransaction;
|
||||||
|
};
|
||||||
|
// Matches the given transactions under promise pool concurrency controlling.
|
||||||
|
const validatationResult = await PromisePool.withConcurrency(10)
|
||||||
|
.for(matchedTransactions)
|
||||||
|
.process(validateMatchedTransaction);
|
||||||
|
|
||||||
|
if (validatationResult.errors?.length > 0) {
|
||||||
|
const error = validatationResult.errors.map((er) => er.raw)[0];
|
||||||
|
throw new ServiceError(error);
|
||||||
|
}
|
||||||
|
// Calculate the total given matching transactions.
|
||||||
|
const totalMatchedTranasctions = sumMatchTranasctions(
|
||||||
|
validatationResult.results
|
||||||
|
);
|
||||||
|
// Validates the total given matching transcations whether is not equal
|
||||||
|
// uncategorized transaction amount.
|
||||||
|
if (totalMatchedTranasctions !== uncategorizedTransaction.amount) {
|
||||||
|
throw new ServiceError(ERRORS.TOTAL_MATCHING_TRANSACTIONS_INVALID);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches the given uncategorized transaction to the given references.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async matchTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number,
|
||||||
|
matchTransactionsDTO: IMatchTransactionsDTO
|
||||||
|
): Promise<void> {
|
||||||
|
const { matchedTransactions } = matchTransactionsDTO;
|
||||||
|
|
||||||
|
// Validates the given matching transactions DTO.
|
||||||
|
await this.validate(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
matchTransactionsDTO
|
||||||
|
);
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
|
||||||
|
// Triggers the event `onBankTransactionMatching`.
|
||||||
|
await this.eventPublisher.emitAsync(events.bankMatch.onMatching, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
matchTransactionsDTO,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionMatchingEventPayload);
|
||||||
|
|
||||||
|
// Matches the given transactions under promise pool concurrency controlling.
|
||||||
|
await PromisePool.withConcurrency(10)
|
||||||
|
.for(matchedTransactions)
|
||||||
|
.process(async (matchedTransaction) => {
|
||||||
|
const getMatchedTransactionsService =
|
||||||
|
this.matchedBankTransactions.registry.get(
|
||||||
|
matchedTransaction.referenceType
|
||||||
|
);
|
||||||
|
await getMatchedTransactionsService.createMatchedTransaction(
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
matchedTransaction,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Triggers the event `onBankTransactionMatched`.
|
||||||
|
await this.eventPublisher.emitAsync(events.bankMatch.onMatched, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
matchTransactionsDTO,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionMatchedEventPayload);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
import Container, { Service } from 'typedi';
|
||||||
|
import { GetMatchedTransactionsByExpenses } from './GetMatchedTransactionsByExpenses';
|
||||||
|
import { GetMatchedTransactionsByBills } from './GetMatchedTransactionsByBills';
|
||||||
|
import { GetMatchedTransactionsByManualJournals } from './GetMatchedTransactionsByManualJournals';
|
||||||
|
import { MatchTransactionsTypesRegistry } from './MatchTransactionsTypesRegistry';
|
||||||
|
import { GetMatchedTransactionsByInvoices } from './GetMatchedTransactionsByInvoices';
|
||||||
|
import { GetMatchedTransactionCashflowTransformer } from './GetMatchedTransactionCashflowTransformer';
|
||||||
|
import { GetMatchedTransactionsByCashflow } from './GetMatchedTransactionsByCashflow';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class MatchTransactionsTypes {
|
||||||
|
private static registry: MatchTransactionsTypesRegistry;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Consttuctor method.
|
||||||
|
*/
|
||||||
|
constructor() {
|
||||||
|
this.boot();
|
||||||
|
}
|
||||||
|
|
||||||
|
get registered() {
|
||||||
|
return [
|
||||||
|
{ type: 'SaleInvoice', service: GetMatchedTransactionsByInvoices },
|
||||||
|
{ type: 'Bill', service: GetMatchedTransactionsByBills },
|
||||||
|
{ type: 'Expense', service: GetMatchedTransactionsByExpenses },
|
||||||
|
{
|
||||||
|
type: 'ManualJournal',
|
||||||
|
service: GetMatchedTransactionsByManualJournals,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'CashflowTransaction',
|
||||||
|
service: GetMatchedTransactionsByCashflow,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Importable instances.
|
||||||
|
*/
|
||||||
|
private types = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
public get registry() {
|
||||||
|
return MatchTransactionsTypes.registry;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Boots all the registered importables.
|
||||||
|
*/
|
||||||
|
public boot() {
|
||||||
|
if (!MatchTransactionsTypes.registry) {
|
||||||
|
const instance = MatchTransactionsTypesRegistry.getInstance();
|
||||||
|
|
||||||
|
this.registered.forEach((registered) => {
|
||||||
|
const serviceInstanace = Container.get(registered.service);
|
||||||
|
instance.register(registered.type, serviceInstanace);
|
||||||
|
});
|
||||||
|
MatchTransactionsTypes.registry = instance;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
import { camelCase, upperFirst } from 'lodash';
|
||||||
|
import { GetMatchedTransactionsByType } from './GetMatchedTransactionsByType';
|
||||||
|
|
||||||
|
export class MatchTransactionsTypesRegistry {
|
||||||
|
private static instance: MatchTransactionsTypesRegistry;
|
||||||
|
private importables: Record<string, GetMatchedTransactionsByType>;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this.importables = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets singleton instance of registry.
|
||||||
|
* @returns {MatchTransactionsTypesRegistry}
|
||||||
|
*/
|
||||||
|
public static getInstance(): MatchTransactionsTypesRegistry {
|
||||||
|
if (!MatchTransactionsTypesRegistry.instance) {
|
||||||
|
MatchTransactionsTypesRegistry.instance =
|
||||||
|
new MatchTransactionsTypesRegistry();
|
||||||
|
}
|
||||||
|
return MatchTransactionsTypesRegistry.instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers the given importable service.
|
||||||
|
* @param {string} resource
|
||||||
|
* @param {GetMatchedTransactionsByType} importable
|
||||||
|
*/
|
||||||
|
public register(
|
||||||
|
resource: string,
|
||||||
|
importable: GetMatchedTransactionsByType
|
||||||
|
): void {
|
||||||
|
const _resource = this.sanitizeResourceName(resource);
|
||||||
|
this.importables[_resource] = importable;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the importable service instance of the given resource name.
|
||||||
|
* @param {string} name
|
||||||
|
* @returns {GetMatchedTransactionsByType}
|
||||||
|
*/
|
||||||
|
public get(name: string): GetMatchedTransactionsByType {
|
||||||
|
const _name = this.sanitizeResourceName(name);
|
||||||
|
return this.importables[_name];
|
||||||
|
}
|
||||||
|
|
||||||
|
private sanitizeResourceName(resource: string) {
|
||||||
|
return upperFirst(camelCase(resource));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { IBankTransactionUnmatchingEventPayload } from './types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class UnmatchMatchedBankTransaction {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unmatch the matched the given uncategorized bank transaction.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {number} uncategorizedTransactionId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public unmatchMatchedTransaction(
|
||||||
|
tenantId: number,
|
||||||
|
uncategorizedTransactionId: number
|
||||||
|
): Promise<void> {
|
||||||
|
const { MatchedBankTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
return this.uow.withTransaction(tenantId, async (trx) => {
|
||||||
|
await this.eventPublisher.emitAsync(events.bankMatch.onUnmatching, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionUnmatchingEventPayload);
|
||||||
|
|
||||||
|
await MatchedBankTransaction.query(trx)
|
||||||
|
.where('uncategorizedTransactionId', uncategorizedTransactionId)
|
||||||
|
.delete();
|
||||||
|
|
||||||
|
await this.eventPublisher.emitAsync(events.bankMatch.onUnmatched, {
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
} as IBankTransactionUnmatchingEventPayload);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
import { Knex } from 'knex';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { ServiceError } from '@/exceptions';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { ERRORS } from './types';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateTransactionMatched {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validate the given transaction whether is matched with bank transactions.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {string} referenceType - Transaction reference type.
|
||||||
|
* @param {number} referenceId - Transaction reference id.
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async validateTransactionNoMatchLinking(
|
||||||
|
tenantId: number,
|
||||||
|
referenceType: string,
|
||||||
|
referenceId: number,
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
) {
|
||||||
|
const { MatchedBankTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const foundMatchedTransaction =
|
||||||
|
await MatchedBankTransaction.query(trx).findOne({
|
||||||
|
referenceType,
|
||||||
|
referenceId,
|
||||||
|
});
|
||||||
|
if (foundMatchedTransaction) {
|
||||||
|
throw new ServiceError(ERRORS.CANNOT_DELETE_TRANSACTION_MATCHED);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
31
packages/server/src/services/Banking/Matching/_utils.ts
Normal file
31
packages/server/src/services/Banking/Matching/_utils.ts
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import moment from 'moment';
|
||||||
|
import * as R from 'ramda';
|
||||||
|
import UncategorizedCashflowTransaction from '@/models/UncategorizedCashflowTransaction';
|
||||||
|
import { MatchedTransactionPOJO } from './types';
|
||||||
|
|
||||||
|
export const sortClosestMatchTransactions = (
|
||||||
|
uncategorizedTransaction: UncategorizedCashflowTransaction,
|
||||||
|
matches: MatchedTransactionPOJO[]
|
||||||
|
) => {
|
||||||
|
return R.sortWith([
|
||||||
|
// Sort by amount difference (closest to uncategorized transaction amount first)
|
||||||
|
R.ascend((match: MatchedTransactionPOJO) =>
|
||||||
|
Math.abs(match.amount - uncategorizedTransaction.amount)
|
||||||
|
),
|
||||||
|
// Sort by date difference (closest to uncategorized transaction date first)
|
||||||
|
R.ascend((match: MatchedTransactionPOJO) =>
|
||||||
|
Math.abs(
|
||||||
|
moment(match.date).diff(moment(uncategorizedTransaction.date), 'days')
|
||||||
|
)
|
||||||
|
),
|
||||||
|
])(matches);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const sumMatchTranasctions = (transactions: Array<any>) => {
|
||||||
|
return transactions.reduce(
|
||||||
|
(total, item) =>
|
||||||
|
total +
|
||||||
|
(item.transactionNormal === 'debit' ? 1 : -1) * parseFloat(item.amount),
|
||||||
|
0
|
||||||
|
);
|
||||||
|
};
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import {
|
||||||
|
IBankTransactionMatchedEventPayload,
|
||||||
|
IBankTransactionUnmatchedEventPayload,
|
||||||
|
} from '../types';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class DecrementUncategorizedTransactionOnMatching {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.bankMatch.onMatched,
|
||||||
|
this.decrementUnCategorizedTransactionsOnMatching.bind(this)
|
||||||
|
);
|
||||||
|
bus.subscribe(
|
||||||
|
events.bankMatch.onUnmatched,
|
||||||
|
this.incrementUnCategorizedTransactionsOnUnmatching.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the cashflow transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async decrementUnCategorizedTransactionsOnMatching({
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
}: IBankTransactionMatchedEventPayload) {
|
||||||
|
const { UncategorizedCashflowTransaction, Account } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query().findById(
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
await Account.query(trx)
|
||||||
|
.findById(transaction.accountId)
|
||||||
|
.decrement('uncategorizedTransactions', 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the cashflow transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async incrementUnCategorizedTransactionsOnUnmatching({
|
||||||
|
tenantId,
|
||||||
|
uncategorizedTransactionId,
|
||||||
|
trx,
|
||||||
|
}: IBankTransactionUnmatchedEventPayload) {
|
||||||
|
const { UncategorizedCashflowTransaction, Account } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const transaction = await UncategorizedCashflowTransaction.query().findById(
|
||||||
|
uncategorizedTransactionId
|
||||||
|
);
|
||||||
|
await Account.query(trx)
|
||||||
|
.findById(transaction.accountId)
|
||||||
|
.increment('uncategorizedTransactions', 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { ICommandCashflowDeletingPayload, IManualJournalDeletingPayload } from '@/interfaces';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { ValidateTransactionMatched } from '../ValidateTransactionsMatched';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateMatchingOnCashflowDelete {
|
||||||
|
@Inject()
|
||||||
|
private validateNoMatchingLinkedService: ValidateTransactionMatched;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.cashflow.onTransactionDeleting,
|
||||||
|
this.validateMatchingOnCashflowDeleting.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the cashflow transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async validateMatchingOnCashflowDeleting({
|
||||||
|
tenantId,
|
||||||
|
oldCashflowTransaction,
|
||||||
|
trx,
|
||||||
|
}: ICommandCashflowDeletingPayload) {
|
||||||
|
await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking(
|
||||||
|
tenantId,
|
||||||
|
'CashflowTransaction',
|
||||||
|
oldCashflowTransaction.id,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { IExpenseEventDeletePayload } from '@/interfaces';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { ValidateTransactionMatched } from '../ValidateTransactionsMatched';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateMatchingOnExpenseDelete {
|
||||||
|
@Inject()
|
||||||
|
private validateNoMatchingLinkedService: ValidateTransactionMatched;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.expenses.onDeleting,
|
||||||
|
this.validateMatchingOnExpenseDeleting.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the expense transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IExpenseEventDeletePayload}
|
||||||
|
*/
|
||||||
|
public async validateMatchingOnExpenseDeleting({
|
||||||
|
tenantId,
|
||||||
|
oldExpense,
|
||||||
|
trx,
|
||||||
|
}: IExpenseEventDeletePayload) {
|
||||||
|
await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking(
|
||||||
|
tenantId,
|
||||||
|
'Expense',
|
||||||
|
oldExpense.id,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { IManualJournalDeletingPayload } from '@/interfaces';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { ValidateTransactionMatched } from '../ValidateTransactionsMatched';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateMatchingOnManualJournalDelete {
|
||||||
|
@Inject()
|
||||||
|
private validateNoMatchingLinkedService: ValidateTransactionMatched;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.manualJournals.onDeleting,
|
||||||
|
this.validateMatchingOnManualJournalDeleting.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the manual journal transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IManualJournalDeletingPayload}
|
||||||
|
*/
|
||||||
|
public async validateMatchingOnManualJournalDeleting({
|
||||||
|
tenantId,
|
||||||
|
oldManualJournal,
|
||||||
|
trx,
|
||||||
|
}: IManualJournalDeletingPayload) {
|
||||||
|
await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking(
|
||||||
|
tenantId,
|
||||||
|
'ManualJournal',
|
||||||
|
oldManualJournal.id,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import {
|
||||||
|
IBillPaymentEventDeletedPayload,
|
||||||
|
IPaymentReceiveDeletedPayload,
|
||||||
|
} from '@/interfaces';
|
||||||
|
import { ValidateTransactionMatched } from '../ValidateTransactionsMatched';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateMatchingOnPaymentMadeDelete {
|
||||||
|
@Inject()
|
||||||
|
private validateNoMatchingLinkedService: ValidateTransactionMatched;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.billPayment.onDeleting,
|
||||||
|
this.validateMatchingOnPaymentMadeDeleting.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the payment made transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IPaymentReceiveDeletedPayload}
|
||||||
|
*/
|
||||||
|
public async validateMatchingOnPaymentMadeDeleting({
|
||||||
|
tenantId,
|
||||||
|
oldBillPayment,
|
||||||
|
trx,
|
||||||
|
}: IBillPaymentEventDeletedPayload) {
|
||||||
|
await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking(
|
||||||
|
tenantId,
|
||||||
|
'PaymentMade',
|
||||||
|
oldBillPayment.id,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { IPaymentReceiveDeletedPayload } from '@/interfaces';
|
||||||
|
import { ValidateTransactionMatched } from '../ValidateTransactionsMatched';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class ValidateMatchingOnPaymentReceivedDelete {
|
||||||
|
@Inject()
|
||||||
|
private validateNoMatchingLinkedService: ValidateTransactionMatched;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.paymentReceive.onDeleting,
|
||||||
|
this.validateMatchingOnPaymentReceivedDeleting.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the payment received transaction whether matched with bank transaction on deleting.
|
||||||
|
* @param {IPaymentReceiveDeletedPayload}
|
||||||
|
*/
|
||||||
|
public async validateMatchingOnPaymentReceivedDeleting({
|
||||||
|
tenantId,
|
||||||
|
oldPaymentReceive,
|
||||||
|
trx,
|
||||||
|
}: IPaymentReceiveDeletedPayload) {
|
||||||
|
await this.validateNoMatchingLinkedService.validateTransactionNoMatchLinking(
|
||||||
|
tenantId,
|
||||||
|
'PaymentReceive',
|
||||||
|
oldPaymentReceive.id,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
71
packages/server/src/services/Banking/Matching/types.ts
Normal file
71
packages/server/src/services/Banking/Matching/types.ts
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
|
export interface IBankTransactionMatchingEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
matchTransactionsDTO: IMatchTransactionsDTO;
|
||||||
|
trx?: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionMatchedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
matchTransactionsDTO: IMatchTransactionsDTO;
|
||||||
|
trx?: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionUnmatchingEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IBankTransactionUnmatchedEventPayload {
|
||||||
|
tenantId: number;
|
||||||
|
uncategorizedTransactionId: number;
|
||||||
|
trx?: Knex.Transaction;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IMatchTransactionDTO {
|
||||||
|
referenceType: string;
|
||||||
|
referenceId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IMatchTransactionsDTO {
|
||||||
|
matchedTransactions: Array<IMatchTransactionDTO>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GetMatchedTransactionsFilter {
|
||||||
|
fromDate: string;
|
||||||
|
toDate: string;
|
||||||
|
minAmount: number;
|
||||||
|
maxAmount: number;
|
||||||
|
transactionType: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MatchedTransactionPOJO {
|
||||||
|
amount: number;
|
||||||
|
amountFormatted: string;
|
||||||
|
date: string;
|
||||||
|
dateFormatted: string;
|
||||||
|
referenceNo: string;
|
||||||
|
transactionNo: string;
|
||||||
|
transactionId: number;
|
||||||
|
transactionType: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type MatchedTransactionsPOJO = {
|
||||||
|
perfectMatches: Array<MatchedTransactionPOJO>;
|
||||||
|
possibleMatches: Array<MatchedTransactionPOJO>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ERRORS = {
|
||||||
|
RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID:
|
||||||
|
'RESOURCE_TYPE_MATCHING_TRANSACTION_INVALID',
|
||||||
|
RESOURCE_ID_MATCHING_TRANSACTION_INVALID:
|
||||||
|
'RESOURCE_ID_MATCHING_TRANSACTION_INVALID',
|
||||||
|
TOTAL_MATCHING_TRANSACTIONS_INVALID: 'TOTAL_MATCHING_TRANSACTIONS_INVALID',
|
||||||
|
TRANSACTION_ALREADY_MATCHED: 'TRANSACTION_ALREADY_MATCHED',
|
||||||
|
CANNOT_MATCH_EXCLUDED_TRANSACTION: 'CANNOT_MATCH_EXCLUDED_TRANSACTION',
|
||||||
|
CANNOT_DELETE_TRANSACTION_MATCHED: 'CANNOT_DELETE_TRANSACTION_MATCHED',
|
||||||
|
};
|
||||||
@@ -3,7 +3,12 @@ import { Inject, Service } from 'typedi';
|
|||||||
import bluebird from 'bluebird';
|
import bluebird from 'bluebird';
|
||||||
import { entries, groupBy } from 'lodash';
|
import { entries, groupBy } from 'lodash';
|
||||||
import { CreateAccount } from '@/services/Accounts/CreateAccount';
|
import { CreateAccount } from '@/services/Accounts/CreateAccount';
|
||||||
import { PlaidAccount, PlaidTransaction } from '@/interfaces';
|
import {
|
||||||
|
IAccountCreateDTO,
|
||||||
|
IPlaidTransactionsSyncedEventPayload,
|
||||||
|
PlaidAccount,
|
||||||
|
PlaidTransaction,
|
||||||
|
} from '@/interfaces';
|
||||||
import {
|
import {
|
||||||
transformPlaidAccountToCreateAccount,
|
transformPlaidAccountToCreateAccount,
|
||||||
transformPlaidTrxsToCashflowCreate,
|
transformPlaidTrxsToCashflowCreate,
|
||||||
@@ -11,6 +16,10 @@ import {
|
|||||||
import { DeleteCashflowTransaction } from '@/services/Cashflow/DeleteCashflowTransactionService';
|
import { DeleteCashflowTransaction } from '@/services/Cashflow/DeleteCashflowTransactionService';
|
||||||
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
import uniqid from 'uniqid';
|
||||||
|
import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
|
||||||
const CONCURRENCY_ASYNC = 10;
|
const CONCURRENCY_ASYNC = 10;
|
||||||
|
|
||||||
@@ -28,6 +37,38 @@ export class PlaidSyncDb {
|
|||||||
@Inject()
|
@Inject()
|
||||||
private deleteCashflowTransactionService: DeleteCashflowTransaction;
|
private deleteCashflowTransactionService: DeleteCashflowTransaction;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private eventPublisher: EventPublisher;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syncs the Plaid bank account.
|
||||||
|
* @param {number} tenantId
|
||||||
|
* @param {IAccountCreateDTO} createBankAccountDTO
|
||||||
|
* @param {Knex.Transaction} trx
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
public async syncBankAccount(
|
||||||
|
tenantId: number,
|
||||||
|
createBankAccountDTO: IAccountCreateDTO,
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
) {
|
||||||
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
const plaidAccount = await Account.query().findOne(
|
||||||
|
'plaidAccountId',
|
||||||
|
createBankAccountDTO.plaidAccountId
|
||||||
|
);
|
||||||
|
// Can't continue if the Plaid account is already created.
|
||||||
|
if (plaidAccount) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await this.createAccountService.createAccount(
|
||||||
|
tenantId,
|
||||||
|
createBankAccountDTO,
|
||||||
|
trx,
|
||||||
|
{ ignoreUniqueName: true }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Syncs the plaid accounts to the system accounts.
|
* Syncs the plaid accounts to the system accounts.
|
||||||
* @param {number} tenantId Tenant ID.
|
* @param {number} tenantId Tenant ID.
|
||||||
@@ -37,7 +78,8 @@ export class PlaidSyncDb {
|
|||||||
public async syncBankAccounts(
|
public async syncBankAccounts(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidAccounts: PlaidAccount[],
|
plaidAccounts: PlaidAccount[],
|
||||||
institution: any
|
institution: any,
|
||||||
|
trx?: Knex.Transaction
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const transformToPlaidAccounts =
|
const transformToPlaidAccounts =
|
||||||
transformPlaidAccountToCreateAccount(institution);
|
transformPlaidAccountToCreateAccount(institution);
|
||||||
@@ -47,7 +89,7 @@ export class PlaidSyncDb {
|
|||||||
await bluebird.map(
|
await bluebird.map(
|
||||||
accountCreateDTOs,
|
accountCreateDTOs,
|
||||||
(createAccountDTO: any) =>
|
(createAccountDTO: any) =>
|
||||||
this.createAccountService.createAccount(tenantId, createAccountDTO),
|
this.syncBankAccount(tenantId, createAccountDTO, trx),
|
||||||
{ concurrency: CONCURRENCY_ASYNC }
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -57,26 +99,24 @@ export class PlaidSyncDb {
|
|||||||
* @param {number} tenantId - Tenant ID.
|
* @param {number} tenantId - Tenant ID.
|
||||||
* @param {number} plaidAccountId - Plaid account ID.
|
* @param {number} plaidAccountId - Plaid account ID.
|
||||||
* @param {PlaidTransaction[]} plaidTranasctions - Plaid transactions
|
* @param {PlaidTransaction[]} plaidTranasctions - Plaid transactions
|
||||||
|
* @return {Promise<void>}
|
||||||
*/
|
*/
|
||||||
public async syncAccountTranactions(
|
public async syncAccountTranactions(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidAccountId: number,
|
plaidAccountId: number,
|
||||||
plaidTranasctions: PlaidTransaction[]
|
plaidTranasctions: PlaidTransaction[],
|
||||||
|
trx?: Knex.Transaction
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const { Account } = this.tenancy.models(tenantId);
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
const cashflowAccount = await Account.query()
|
const batch = uniqid();
|
||||||
|
const cashflowAccount = await Account.query(trx)
|
||||||
.findOne({ plaidAccountId })
|
.findOne({ plaidAccountId })
|
||||||
.throwIfNotFound();
|
.throwIfNotFound();
|
||||||
|
|
||||||
const openingEquityBalance = await Account.query().findOne(
|
|
||||||
'slug',
|
|
||||||
'opening-balance-equity'
|
|
||||||
);
|
|
||||||
// Transformes the Plaid transactions to cashflow create DTOs.
|
// Transformes the Plaid transactions to cashflow create DTOs.
|
||||||
const transformTransaction = transformPlaidTrxsToCashflowCreate(
|
const transformTransaction = transformPlaidTrxsToCashflowCreate(
|
||||||
cashflowAccount.id,
|
cashflowAccount.id
|
||||||
openingEquityBalance.id
|
|
||||||
);
|
);
|
||||||
const uncategorizedTransDTOs =
|
const uncategorizedTransDTOs =
|
||||||
R.map(transformTransaction)(plaidTranasctions);
|
R.map(transformTransaction)(plaidTranasctions);
|
||||||
@@ -87,20 +127,29 @@ export class PlaidSyncDb {
|
|||||||
(uncategoriedDTO) =>
|
(uncategoriedDTO) =>
|
||||||
this.cashflowApp.createUncategorizedTransaction(
|
this.cashflowApp.createUncategorizedTransaction(
|
||||||
tenantId,
|
tenantId,
|
||||||
uncategoriedDTO
|
{ ...uncategoriedDTO, batch },
|
||||||
|
trx
|
||||||
),
|
),
|
||||||
{ concurrency: 1 }
|
{ concurrency: 1 }
|
||||||
);
|
);
|
||||||
|
// Triggers `onPlaidTransactionsSynced` event.
|
||||||
|
await this.eventPublisher.emitAsync(events.plaid.onTransactionsSynced, {
|
||||||
|
tenantId,
|
||||||
|
plaidAccountId,
|
||||||
|
batch,
|
||||||
|
} as IPlaidTransactionsSyncedEventPayload);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Syncs the accounts transactions in paraller under controlled concurrency.
|
* Syncs the accounts transactions in paraller under controlled concurrency.
|
||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
* @param {PlaidTransaction[]} plaidTransactions
|
* @param {PlaidTransaction[]} plaidTransactions
|
||||||
|
* @return {Promise<void>}
|
||||||
*/
|
*/
|
||||||
public async syncAccountsTransactions(
|
public async syncAccountsTransactions(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidAccountsTransactions: PlaidTransaction[]
|
plaidAccountsTransactions: PlaidTransaction[],
|
||||||
|
trx?: Knex.Transaction
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const groupedTrnsxByAccountId = entries(
|
const groupedTrnsxByAccountId = entries(
|
||||||
groupBy(plaidAccountsTransactions, 'account_id')
|
groupBy(plaidAccountsTransactions, 'account_id')
|
||||||
@@ -111,7 +160,8 @@ export class PlaidSyncDb {
|
|||||||
return this.syncAccountTranactions(
|
return this.syncAccountTranactions(
|
||||||
tenantId,
|
tenantId,
|
||||||
plaidAccountId,
|
plaidAccountId,
|
||||||
plaidTransactions
|
plaidTransactions,
|
||||||
|
trx
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
{ concurrency: CONCURRENCY_ASYNC }
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
@@ -124,11 +174,12 @@ export class PlaidSyncDb {
|
|||||||
*/
|
*/
|
||||||
public async syncRemoveTransactions(
|
public async syncRemoveTransactions(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidTransactionsIds: string[]
|
plaidTransactionsIds: string[],
|
||||||
|
trx?: Knex.Transaction
|
||||||
) {
|
) {
|
||||||
const { CashflowTransaction } = this.tenancy.models(tenantId);
|
const { CashflowTransaction } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
const cashflowTransactions = await CashflowTransaction.query().whereIn(
|
const cashflowTransactions = await CashflowTransaction.query(trx).whereIn(
|
||||||
'plaidTransactionId',
|
'plaidTransactionId',
|
||||||
plaidTransactionsIds
|
plaidTransactionsIds
|
||||||
);
|
);
|
||||||
@@ -140,7 +191,8 @@ export class PlaidSyncDb {
|
|||||||
(transactionId: number) =>
|
(transactionId: number) =>
|
||||||
this.deleteCashflowTransactionService.deleteCashflowTransaction(
|
this.deleteCashflowTransactionService.deleteCashflowTransaction(
|
||||||
tenantId,
|
tenantId,
|
||||||
transactionId
|
transactionId,
|
||||||
|
trx
|
||||||
),
|
),
|
||||||
{ concurrency: CONCURRENCY_ASYNC }
|
{ concurrency: CONCURRENCY_ASYNC }
|
||||||
);
|
);
|
||||||
@@ -151,31 +203,37 @@ export class PlaidSyncDb {
|
|||||||
* @param {number} tenantId - Tenant ID.
|
* @param {number} tenantId - Tenant ID.
|
||||||
* @param {string} itemId - Plaid item ID.
|
* @param {string} itemId - Plaid item ID.
|
||||||
* @param {string} lastCursor - Last transaction cursor.
|
* @param {string} lastCursor - Last transaction cursor.
|
||||||
|
* @return {Promise<void>}
|
||||||
*/
|
*/
|
||||||
public async syncTransactionsCursor(
|
public async syncTransactionsCursor(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidItemId: string,
|
plaidItemId: string,
|
||||||
lastCursor: string
|
lastCursor: string,
|
||||||
) {
|
trx?: Knex.Transaction
|
||||||
|
): Promise<void> {
|
||||||
const { PlaidItem } = this.tenancy.models(tenantId);
|
const { PlaidItem } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
await PlaidItem.query().findOne({ plaidItemId }).patch({ lastCursor });
|
await PlaidItem.query(trx).findOne({ plaidItemId }).patch({ lastCursor });
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Updates the last feeds updated at of the given Plaid accounts ids.
|
* Updates the last feeds updated at of the given Plaid accounts ids.
|
||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
* @param {string[]} plaidAccountIds
|
* @param {string[]} plaidAccountIds
|
||||||
|
* @return {Promise<void>}
|
||||||
*/
|
*/
|
||||||
public async updateLastFeedsUpdatedAt(
|
public async updateLastFeedsUpdatedAt(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidAccountIds: string[]
|
plaidAccountIds: string[],
|
||||||
) {
|
trx?: Knex.Transaction
|
||||||
|
): Promise<void> {
|
||||||
const { Account } = this.tenancy.models(tenantId);
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
await Account.query().whereIn('plaid_account_id', plaidAccountIds).patch({
|
await Account.query(trx)
|
||||||
lastFeedsUpdatedAt: new Date(),
|
.whereIn('plaid_account_id', plaidAccountIds)
|
||||||
});
|
.patch({
|
||||||
|
lastFeedsUpdatedAt: new Date(),
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -183,16 +241,20 @@ export class PlaidSyncDb {
|
|||||||
* @param {number} tenantId
|
* @param {number} tenantId
|
||||||
* @param {number[]} plaidAccountIds
|
* @param {number[]} plaidAccountIds
|
||||||
* @param {boolean} isFeedsActive
|
* @param {boolean} isFeedsActive
|
||||||
|
* @returns {Promise<void>}
|
||||||
*/
|
*/
|
||||||
public async updateAccountsFeedsActive(
|
public async updateAccountsFeedsActive(
|
||||||
tenantId: number,
|
tenantId: number,
|
||||||
plaidAccountIds: string[],
|
plaidAccountIds: string[],
|
||||||
isFeedsActive: boolean = true
|
isFeedsActive: boolean = true,
|
||||||
) {
|
trx?: Knex.Transaction
|
||||||
|
): Promise<void> {
|
||||||
const { Account } = this.tenancy.models(tenantId);
|
const { Account } = this.tenancy.models(tenantId);
|
||||||
|
|
||||||
await Account.query().whereIn('plaid_account_id', plaidAccountIds).patch({
|
await Account.query(trx)
|
||||||
isFeedsActive,
|
.whereIn('plaid_account_id', plaidAccountIds)
|
||||||
});
|
.patch({
|
||||||
|
isFeedsActive,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ import { Inject, Service } from 'typedi';
|
|||||||
import { PlaidClientWrapper } from '@/lib/Plaid/Plaid';
|
import { PlaidClientWrapper } from '@/lib/Plaid/Plaid';
|
||||||
import { PlaidSyncDb } from './PlaidSyncDB';
|
import { PlaidSyncDb } from './PlaidSyncDB';
|
||||||
import { PlaidFetchedTransactionsUpdates } from '@/interfaces';
|
import { PlaidFetchedTransactionsUpdates } from '@/interfaces';
|
||||||
|
import UnitOfWork from '@/services/UnitOfWork';
|
||||||
|
import { Knex } from 'knex';
|
||||||
|
|
||||||
@Service()
|
@Service()
|
||||||
export class PlaidUpdateTransactions {
|
export class PlaidUpdateTransactions {
|
||||||
@@ -12,12 +14,40 @@ export class PlaidUpdateTransactions {
|
|||||||
@Inject()
|
@Inject()
|
||||||
private plaidSync: PlaidSyncDb;
|
private plaidSync: PlaidSyncDb;
|
||||||
|
|
||||||
|
@Inject()
|
||||||
|
private uow: UnitOfWork;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles the fetching and storing of new, modified, or removed transactions
|
* Handles sync the Plaid item to Bigcaptial under UOW.
|
||||||
* @param {number} tenantId Tenant ID.
|
* @param {number} tenantId
|
||||||
* @param {string} plaidItemId the Plaid ID for the item.
|
* @param {number} plaidItemId
|
||||||
|
* @returns {Promise<{ addedCount: number; modifiedCount: number; removedCount: number; }>}
|
||||||
*/
|
*/
|
||||||
public async updateTransactions(tenantId: number, plaidItemId: string) {
|
public async updateTransactions(tenantId: number, plaidItemId: string) {
|
||||||
|
return this.uow.withTransaction(tenantId, (trx: Knex.Transaction) => {
|
||||||
|
return this.updateTransactionsWork(tenantId, plaidItemId, trx);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handles the fetching and storing the following:
|
||||||
|
* - New, modified, or removed transactions.
|
||||||
|
* - New bank accounts.
|
||||||
|
* - Last accounts feeds updated at.
|
||||||
|
* - Turn on the accounts feed flag.
|
||||||
|
* @param {number} tenantId - Tenant ID.
|
||||||
|
* @param {string} plaidItemId - The Plaid ID for the item.
|
||||||
|
* @returns {Promise<{ addedCount: number; modifiedCount: number; removedCount: number; }>}
|
||||||
|
*/
|
||||||
|
public async updateTransactionsWork(
|
||||||
|
tenantId: number,
|
||||||
|
plaidItemId: string,
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
): Promise<{
|
||||||
|
addedCount: number;
|
||||||
|
modifiedCount: number;
|
||||||
|
removedCount: number;
|
||||||
|
}> {
|
||||||
// Fetch new transactions from plaid api.
|
// Fetch new transactions from plaid api.
|
||||||
const { added, modified, removed, cursor, accessToken } =
|
const { added, modified, removed, cursor, accessToken } =
|
||||||
await this.fetchTransactionUpdates(tenantId, plaidItemId);
|
await this.fetchTransactionUpdates(tenantId, plaidItemId);
|
||||||
@@ -29,28 +59,42 @@ export class PlaidUpdateTransactions {
|
|||||||
} = await plaidInstance.accountsGet(request);
|
} = await plaidInstance.accountsGet(request);
|
||||||
|
|
||||||
const plaidAccountsIds = accounts.map((a) => a.account_id);
|
const plaidAccountsIds = accounts.map((a) => a.account_id);
|
||||||
|
|
||||||
const {
|
const {
|
||||||
data: { institution },
|
data: { institution },
|
||||||
} = await plaidInstance.institutionsGetById({
|
} = await plaidInstance.institutionsGetById({
|
||||||
institution_id: item.institution_id,
|
institution_id: item.institution_id,
|
||||||
country_codes: ['US', 'UK'],
|
country_codes: ['US', 'UK'],
|
||||||
});
|
});
|
||||||
// Update the DB.
|
// Sync bank accounts.
|
||||||
await this.plaidSync.syncBankAccounts(tenantId, accounts, institution);
|
await this.plaidSync.syncBankAccounts(tenantId, accounts, institution, trx);
|
||||||
|
// Sync bank account transactions.
|
||||||
await this.plaidSync.syncAccountsTransactions(
|
await this.plaidSync.syncAccountsTransactions(
|
||||||
tenantId,
|
tenantId,
|
||||||
added.concat(modified)
|
added.concat(modified),
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
// Sync removed transactions.
|
||||||
|
await this.plaidSync.syncRemoveTransactions(tenantId, removed, trx);
|
||||||
|
// Sync transactions cursor.
|
||||||
|
await this.plaidSync.syncTransactionsCursor(
|
||||||
|
tenantId,
|
||||||
|
plaidItemId,
|
||||||
|
cursor,
|
||||||
|
trx
|
||||||
);
|
);
|
||||||
await this.plaidSync.syncRemoveTransactions(tenantId, removed);
|
|
||||||
await this.plaidSync.syncTransactionsCursor(tenantId, plaidItemId, cursor);
|
|
||||||
|
|
||||||
// Update the last feeds updated at of the updated accounts.
|
// Update the last feeds updated at of the updated accounts.
|
||||||
await this.plaidSync.updateLastFeedsUpdatedAt(tenantId, plaidAccountsIds);
|
await this.plaidSync.updateLastFeedsUpdatedAt(
|
||||||
|
tenantId,
|
||||||
|
plaidAccountsIds,
|
||||||
|
trx
|
||||||
|
);
|
||||||
// Turn on the accounts feeds flag.
|
// Turn on the accounts feeds flag.
|
||||||
await this.plaidSync.updateAccountsFeedsActive(tenantId, plaidAccountsIds);
|
await this.plaidSync.updateAccountsFeedsActive(
|
||||||
|
tenantId,
|
||||||
|
plaidAccountsIds,
|
||||||
|
true,
|
||||||
|
trx
|
||||||
|
);
|
||||||
return {
|
return {
|
||||||
addedCount: added.length,
|
addedCount: added.length,
|
||||||
modifiedCount: modified.length,
|
modifiedCount: modified.length,
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { EventSubscriber } from '@/lib/EventPublisher/EventPublisher';
|
||||||
|
import {
|
||||||
|
IPlaidItemCreatedEventPayload,
|
||||||
|
IPlaidTransactionsSyncedEventPayload,
|
||||||
|
} from '@/interfaces/Plaid';
|
||||||
|
import events from '@/subscribers/events';
|
||||||
|
import { RecognizeTranasctionsService } from '../../RegonizeTranasctions/RecognizeTranasctionsService';
|
||||||
|
import { runAfterTransaction } from '@/services/UnitOfWork/TransactionsHooks';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class RecognizeSyncedBankTranasctions extends EventSubscriber {
|
||||||
|
@Inject()
|
||||||
|
private recognizeTranasctionsService: RecognizeTranasctionsService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
public attach(bus) {
|
||||||
|
bus.subscribe(
|
||||||
|
events.plaid.onTransactionsSynced,
|
||||||
|
this.handleRecognizeSyncedBankTransactions.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the Plaid item transactions
|
||||||
|
* @param {IPlaidItemCreatedEventPayload} payload - Event payload.
|
||||||
|
*/
|
||||||
|
private handleRecognizeSyncedBankTransactions = async ({
|
||||||
|
tenantId,
|
||||||
|
batch,
|
||||||
|
trx,
|
||||||
|
}: IPlaidTransactionsSyncedEventPayload) => {
|
||||||
|
runAfterTransaction(trx, async () => {
|
||||||
|
await this.recognizeTranasctionsService.recognizeTransactions(
|
||||||
|
tenantId,
|
||||||
|
batch
|
||||||
|
);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -37,7 +37,6 @@ export const transformPlaidAccountToCreateAccount = R.curry(
|
|||||||
export const transformPlaidTrxsToCashflowCreate = R.curry(
|
export const transformPlaidTrxsToCashflowCreate = R.curry(
|
||||||
(
|
(
|
||||||
cashflowAccountId: number,
|
cashflowAccountId: number,
|
||||||
creditAccountId: number,
|
|
||||||
plaidTranasction: PlaidTransaction
|
plaidTranasction: PlaidTransaction
|
||||||
): CreateUncategorizedTransactionDTO => {
|
): CreateUncategorizedTransactionDTO => {
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -0,0 +1,110 @@
|
|||||||
|
import { Knex } from 'knex';
|
||||||
|
import UncategorizedCashflowTransaction from '@/models/UncategorizedCashflowTransaction';
|
||||||
|
import HasTenancyService from '@/services/Tenancy/TenancyService';
|
||||||
|
import { transformToMapBy } from '@/utils';
|
||||||
|
import { Inject, Service } from 'typedi';
|
||||||
|
import { PromisePool } from '@supercharge/promise-pool';
|
||||||
|
import { BankRule } from '@/models/BankRule';
|
||||||
|
import { bankRulesMatchTransaction } from './_utils';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class RecognizeTranasctionsService {
|
||||||
|
@Inject()
|
||||||
|
private tenancy: HasTenancyService;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks the uncategorized transaction as recognized from the given bank rule.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {BankRule} bankRule -
|
||||||
|
* @param {UncategorizedCashflowTransaction} transaction -
|
||||||
|
* @param {Knex.Transaction} trx -
|
||||||
|
*/
|
||||||
|
private markBankRuleAsRecognized = async (
|
||||||
|
tenantId: number,
|
||||||
|
bankRule: BankRule,
|
||||||
|
transaction: UncategorizedCashflowTransaction,
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
) => {
|
||||||
|
const { RecognizedBankTransaction, UncategorizedCashflowTransaction } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const recognizedTransaction = await RecognizedBankTransaction.query(
|
||||||
|
trx
|
||||||
|
).insert({
|
||||||
|
bankRuleId: bankRule.id,
|
||||||
|
uncategorizedTransactionId: transaction.id,
|
||||||
|
assignedCategory: bankRule.assignCategory,
|
||||||
|
assignedAccountId: bankRule.assignAccountId,
|
||||||
|
assignedPayee: bankRule.assignPayee,
|
||||||
|
assignedMemo: bankRule.assignMemo,
|
||||||
|
});
|
||||||
|
await UncategorizedCashflowTransaction.query(trx)
|
||||||
|
.findById(transaction.id)
|
||||||
|
.patch({
|
||||||
|
recognizedTransactionId: recognizedTransaction.id,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Regonized the uncategorized transactions.
|
||||||
|
* @param {number} tenantId -
|
||||||
|
* @param {Knex.Transaction} trx -
|
||||||
|
*/
|
||||||
|
public async recognizeTransactions(
|
||||||
|
tenantId: number,
|
||||||
|
batch: string = '',
|
||||||
|
trx?: Knex.Transaction
|
||||||
|
) {
|
||||||
|
const { UncategorizedCashflowTransaction, BankRule } =
|
||||||
|
this.tenancy.models(tenantId);
|
||||||
|
|
||||||
|
const uncategorizedTranasctions =
|
||||||
|
await UncategorizedCashflowTransaction.query().onBuild((query) => {
|
||||||
|
query.where('recognized_transaction_id', null);
|
||||||
|
query.where('categorized', false);
|
||||||
|
|
||||||
|
if (batch) query.where('batch', batch);
|
||||||
|
});
|
||||||
|
const bankRules = await BankRule.query().withGraphFetched('conditions');
|
||||||
|
const bankRulesByAccountId = transformToMapBy(
|
||||||
|
bankRules,
|
||||||
|
'applyIfAccountId'
|
||||||
|
);
|
||||||
|
// Try to recognize the transaction.
|
||||||
|
const regonizeTransaction = async (
|
||||||
|
transaction: UncategorizedCashflowTransaction
|
||||||
|
) => {
|
||||||
|
const allAccountsBankRules = bankRulesByAccountId.get(`null`);
|
||||||
|
const accountBankRules = bankRulesByAccountId.get(
|
||||||
|
`${transaction.accountId}`
|
||||||
|
);
|
||||||
|
const recognizedBankRule = bankRulesMatchTransaction(
|
||||||
|
transaction,
|
||||||
|
accountBankRules
|
||||||
|
);
|
||||||
|
if (recognizedBankRule) {
|
||||||
|
await this.markBankRuleAsRecognized(
|
||||||
|
tenantId,
|
||||||
|
recognizedBankRule,
|
||||||
|
transaction,
|
||||||
|
trx
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const result = await PromisePool.withConcurrency(MIGRATION_CONCURRENCY)
|
||||||
|
.for(uncategorizedTranasctions)
|
||||||
|
.process((transaction: UncategorizedCashflowTransaction, index, pool) => {
|
||||||
|
return regonizeTransaction(transaction);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {number} uncategorizedTransaction
|
||||||
|
*/
|
||||||
|
public async regonizeTransaction(
|
||||||
|
uncategorizedTransaction: UncategorizedCashflowTransaction
|
||||||
|
) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
const MIGRATION_CONCURRENCY = 10;
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import Container, { Service } from 'typedi';
|
||||||
|
import { RecognizeTranasctionsService } from './RecognizeTranasctionsService';
|
||||||
|
|
||||||
|
@Service()
|
||||||
|
export class RegonizeTransactionsJob {
|
||||||
|
/**
|
||||||
|
* Constructor method.
|
||||||
|
*/
|
||||||
|
constructor(agenda) {
|
||||||
|
agenda.define(
|
||||||
|
'recognize-uncategorized-transactions-job',
|
||||||
|
{ priority: 'high', concurrency: 2 },
|
||||||
|
this.handler
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggers sending invoice mail.
|
||||||
|
*/
|
||||||
|
private handler = async (job, done: Function) => {
|
||||||
|
const { tenantId, batch } = job.attrs.data;
|
||||||
|
const regonizeTransactions = Container.get(RecognizeTranasctionsService);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await regonizeTransactions.recognizeTransactions(tenantId, batch);
|
||||||
|
done();
|
||||||
|
} catch (error) {
|
||||||
|
console.log(error);
|
||||||
|
done(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
import UncategorizedCashflowTransaction from '@/models/UncategorizedCashflowTransaction';
|
||||||
|
import {
|
||||||
|
BankRuleApplyIfTransactionType,
|
||||||
|
BankRuleConditionComparator,
|
||||||
|
BankRuleConditionType,
|
||||||
|
IBankRule,
|
||||||
|
IBankRuleCondition,
|
||||||
|
} from '../Rules/types';
|
||||||
|
import { BankRule } from '@/models/BankRule';
|
||||||
|
|
||||||
|
const conditionsMatch = (
|
||||||
|
transaction: UncategorizedCashflowTransaction,
|
||||||
|
conditions: IBankRuleCondition[],
|
||||||
|
conditionsType: BankRuleConditionType = BankRuleConditionType.And
|
||||||
|
) => {
|
||||||
|
const method =
|
||||||
|
conditionsType === BankRuleConditionType.And ? 'every' : 'some';
|
||||||
|
|
||||||
|
return conditions[method]((condition) => {
|
||||||
|
switch (determineFieldType(condition.field)) {
|
||||||
|
case 'number':
|
||||||
|
return matchNumberCondition(transaction, condition);
|
||||||
|
case 'text':
|
||||||
|
return matchTextCondition(transaction, condition);
|
||||||
|
default:
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
const matchNumberCondition = (
|
||||||
|
transaction: UncategorizedCashflowTransaction,
|
||||||
|
condition: IBankRuleCondition
|
||||||
|
) => {
|
||||||
|
switch (condition.comparator) {
|
||||||
|
case BankRuleConditionComparator.Equals:
|
||||||
|
return transaction[condition.field] === condition.value;
|
||||||
|
case BankRuleConditionComparator.Contains:
|
||||||
|
return transaction[condition.field]
|
||||||
|
?.toString()
|
||||||
|
.includes(condition.value.toString());
|
||||||
|
case BankRuleConditionComparator.NotContain:
|
||||||
|
return !transaction[condition.field]
|
||||||
|
?.toString()
|
||||||
|
.includes(condition.value.toString());
|
||||||
|
default:
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const matchTextCondition = (
|
||||||
|
transaction: UncategorizedCashflowTransaction,
|
||||||
|
condition: IBankRuleCondition
|
||||||
|
) => {
|
||||||
|
switch (condition.comparator) {
|
||||||
|
case BankRuleConditionComparator.Equals:
|
||||||
|
return transaction[condition.field] === condition.value;
|
||||||
|
case BankRuleConditionComparator.Contains:
|
||||||
|
return transaction[condition.field]?.includes(condition.value.toString());
|
||||||
|
case BankRuleConditionComparator.NotContain:
|
||||||
|
return !transaction[condition.field]?.includes(
|
||||||
|
condition.value.toString()
|
||||||
|
);
|
||||||
|
default:
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const matchTransactionType = (
|
||||||
|
bankRule: BankRule,
|
||||||
|
transaction: UncategorizedCashflowTransaction
|
||||||
|
): boolean => {
|
||||||
|
return (
|
||||||
|
(transaction.isDepositTransaction &&
|
||||||
|
bankRule.applyIfTransactionType ===
|
||||||
|
BankRuleApplyIfTransactionType.Deposit) ||
|
||||||
|
(transaction.isWithdrawalTransaction &&
|
||||||
|
bankRule.applyIfTransactionType ===
|
||||||
|
BankRuleApplyIfTransactionType.Withdrawal)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const bankRulesMatchTransaction = (
|
||||||
|
transaction: UncategorizedCashflowTransaction,
|
||||||
|
bankRules: IBankRule[]
|
||||||
|
) => {
|
||||||
|
return bankRules.find((rule) => {
|
||||||
|
return (
|
||||||
|
matchTransactionType(rule, transaction) &&
|
||||||
|
conditionsMatch(transaction, rule.conditions, rule.conditionsType)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
const determineFieldType = (field: string): string => {
|
||||||
|
switch (field) {
|
||||||
|
case 'amount':
|
||||||
|
return 'number';
|
||||||
|
case 'description':
|
||||||
|
return 'text';
|
||||||
|
default:
|
||||||
|
return 'unknown';
|
||||||
|
}
|
||||||
|
};
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user