Merge branch 'develop' into big-105-convert-invoice-status-after-sending-mail-notification

This commit is contained in:
Ahmed Bouhuolia
2024-02-21 20:20:36 +02:00
committed by GitHub
368 changed files with 6512 additions and 2339 deletions

View File

@@ -58,3 +58,9 @@ GOTENBERG_DOCS_URL=http://server:3000/public/
# Gotenberg API - (development) # Gotenberg API - (development)
# GOTENBERG_URL=http://localhost:9000 # GOTENBERG_URL=http://localhost:9000
# GOTENBERG_DOCS_URL=http://host.docker.internal:3000/public/ # GOTENBERG_DOCS_URL=http://host.docker.internal:3000/public/
# Exchange Rate Service
EXCHANGE_RATE_SERVICE=open-exchange-rate
# Open Exchange Rate
OPEN_EXCHANGE_RATE_APP_ID=

View File

@@ -2,6 +2,27 @@
All notable changes to Bigcapital server-side will be in this file. All notable changes to Bigcapital server-side will be in this file.
## [0.14.0] - 30-01-2024
* feat: purchases by items exporting by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/327
* fix: expense amounts should not be rounded by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/339
* feat: get latest exchange rate from third party services by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/340
* fix(webapp): inconsistency in currency of universal search items by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/335
* hotfix: editing sales and expense transactions don't reflect GL entries by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/342
## [0.13.3] - 22-01-2024
* hotfix(server): Unhandled thrown errors of services by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/329
## [0.13.2] - 21-01-2024
* feat: show customer / vendor balance. by @asenawritescode in https://github.com/bigcapitalhq/bigcapital/pull/311
* feat: inventory valuation csv and xlsx export by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/308
* feat: sales by items export csv & xlsx by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/310
* fix(server): the invoice and payment receipt printing by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/315
* fix: get cashflow transaction broken cause transaction type by @abouolia in https://github.com/bigcapitalhq/bigcapital/pull/318
* fix: `AccountActivateAlert` import by @xprnio in https://github.com/bigcapitalhq/bigcapital/pull/322
## [0.13.1] - 15-01-2024 ## [0.13.1] - 15-01-2024
* feat(webapp): add approve/reject to action bar of estimate details dr… by @ANasouf in https://github.com/bigcapitalhq/bigcapital/pull/304 * feat(webapp): add approve/reject to action bar of estimate details dr… by @ANasouf in https://github.com/bigcapitalhq/bigcapital/pull/304

View File

@@ -0,0 +1,57 @@
@import "../base.scss";
html,
body {
font-size: 14px;
}
body{
font-weight: 400;
letter-spacing: 0;
line-height: 1.28581;
text-transform: none;
color: #000;
font-family: Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Open Sans, Helvetica Neue, Icons16, sans-serif;
}
.sheet{
padding: 20px;
}
.sheet__company-name{
margin: 0;
font-size: 1.4rem;
}
.sheet__sheet-type {
margin: 0
}
.sheet__sheet-date {
margin-top: 0.35rem;
}
.sheet__header {
text-align: center;
margin-bottom: 1rem;
}
.sheet__table {
border-top: 1px solid #000;
table-layout: fixed;
border-spacing: 0;
text-align: left;
font-size: inherit;
width: 100%;
}
.sheet__table thead th {
color: #000;
border-bottom: 1px solid #000000;
padding: 0.5rem;
}
.sheet__table tbody td {
border-bottom: 0;
padding-top: 0.28rem;
padding-bottom: 0.28rem;
padding-left: 0.5rem;
padding-right: 0.5rem;
color: #252A31;
border-bottom: 1px solid transparent;
}

View File

@@ -0,0 +1,24 @@
block head
style
include ../../css/modules/financial-sheet.css
style.
!{customCSS}
block content
.sheet
.sheet__header
.sheet__company-name=organizationName
.sheet__sheet-type=sheetName
.sheet__sheet-date=sheetDate
table.sheet__table
thead
tr
each column in table.columns
th(style=column.style class='column--' + column.key)= column.label
tbody
each row in table.rows
tr(class=row.classNames)
each cell in row.cells
td(class='cell--' + cell.key)!= cell.value

View File

@@ -66,12 +66,10 @@ module.exports = {
// sourcemaps: true, // Allow to enable/disable sourcemaps or pass object to configure it. // sourcemaps: true, // Allow to enable/disable sourcemaps or pass object to configure it.
// minify: true, // Allow to enable/disable minify the source. // minify: true, // Allow to enable/disable minify the source.
}, },
// { {
// src: './assets/sass/editor-style.scss', src: `${RESOURCES_PATH}/scss/modules/financial-sheet.scss`,
// dest: './assets/css', dest: `${RESOURCES_PATH}/css/modules`,
// sourcemaps: true, },
// minify: true,
// },
], ],
// RTL builds. // RTL builds.
rtl: [ rtl: [

View File

@@ -26,27 +26,27 @@ export default class ContactsController extends BaseController {
[...this.autocompleteQuerySchema], [...this.autocompleteQuerySchema],
this.validationResult, this.validationResult,
this.asyncMiddleware(this.autocompleteContacts.bind(this)), this.asyncMiddleware(this.autocompleteContacts.bind(this)),
this.dynamicListService.handlerErrorsToResponse this.dynamicListService.handlerErrorsToResponse,
); );
router.get( router.get(
'/:id', '/:id',
[param('id').exists().isNumeric().toInt()], [param('id').exists().isNumeric().toInt()],
this.validationResult, this.validationResult,
this.asyncMiddleware(this.getContact.bind(this)) this.asyncMiddleware(this.getContact.bind(this)),
); );
router.post( router.post(
'/:id/inactivate', '/:id/inactivate',
[param('id').exists().isNumeric().toInt()], [param('id').exists().isNumeric().toInt()],
this.validationResult, this.validationResult,
this.asyncMiddleware(this.inactivateContact.bind(this)), this.asyncMiddleware(this.inactivateContact.bind(this)),
this.handlerServiceErrors this.handlerServiceErrors,
); );
router.post( router.post(
'/:id/activate', '/:id/activate',
[param('id').exists().isNumeric().toInt()], [param('id').exists().isNumeric().toInt()],
this.validationResult, this.validationResult,
this.asyncMiddleware(this.activateContact.bind(this)), this.asyncMiddleware(this.activateContact.bind(this)),
this.handlerServiceErrors this.handlerServiceErrors,
); );
return router; return router;
} }
@@ -77,7 +77,7 @@ export default class ContactsController extends BaseController {
try { try {
const contact = await this.contactsService.getContact( const contact = await this.contactsService.getContact(
tenantId, tenantId,
contactId contactId,
); );
return res.status(200).send({ return res.status(200).send({
customer: this.transfromToResponse(contact), customer: this.transfromToResponse(contact),
@@ -105,7 +105,7 @@ export default class ContactsController extends BaseController {
try { try {
const contacts = await this.contactsService.autocompleteContacts( const contacts = await this.contactsService.autocompleteContacts(
tenantId, tenantId,
filter filter,
); );
return res.status(200).send({ contacts }); return res.status(200).send({ contacts });
} catch (error) { } catch (error) {
@@ -153,7 +153,6 @@ export default class ContactsController extends BaseController {
check('email') check('email')
.optional({ nullable: true }) .optional({ nullable: true })
.isString() .isString()
.normalizeEmail()
.isEmail() .isEmail()
.isLength({ max: DATATYPES_LENGTH.STRING }), .isLength({ max: DATATYPES_LENGTH.STRING }),
check('website') check('website')
@@ -380,7 +379,7 @@ export default class ContactsController extends BaseController {
error: Error, error: Error,
req: Request, req: Request,
res: Response, res: Response,
next: NextFunction next: NextFunction,
) { ) {
if (error instanceof ServiceError) { if (error instanceof ServiceError) {
if (error.errorType === 'contact_not_found') { if (error.errorType === 'contact_not_found') {

View File

@@ -1,19 +1,16 @@
import { Service, Inject } from 'typedi'; import { Service, Inject } from 'typedi';
import { Router, Request, Response, NextFunction } from 'express'; import { Router, Request, Response, NextFunction } from 'express';
import { check, param, query } from 'express-validator'; import { query, oneOf } from 'express-validator';
import asyncMiddleware from '@/api/middleware/asyncMiddleware'; import asyncMiddleware from '@/api/middleware/asyncMiddleware';
import BaseController from './BaseController'; import BaseController from './BaseController';
import { ServiceError } from '@/exceptions'; import { ServiceError } from '@/exceptions';
import ExchangeRatesService from '@/services/ExchangeRates/ExchangeRatesService'; import { EchangeRateErrors } from '@/lib/ExchangeRate/types';
import DynamicListingService from '@/services/DynamicListing/DynamicListService'; import { ExchangeRateApplication } from '@/services/ExchangeRates/ExchangeRateApplication';
@Service() @Service()
export default class ExchangeRatesController extends BaseController { export default class ExchangeRatesController extends BaseController {
@Inject() @Inject()
exchangeRatesService: ExchangeRatesService; private exchangeRatesApp: ExchangeRateApplication;
@Inject()
dynamicListService: DynamicListingService;
/** /**
* Constructor method. * Constructor method.
@@ -22,164 +19,40 @@ export default class ExchangeRatesController extends BaseController {
const router = Router(); const router = Router();
router.get( router.get(
'/', '/latest',
[...this.exchangeRatesListSchema], [
oneOf([
query('to_currency').exists().isString().isISO4217(),
query('from_currency').exists().isString().isISO4217(),
]),
],
this.validationResult, this.validationResult,
asyncMiddleware(this.exchangeRates.bind(this)), asyncMiddleware(this.latestExchangeRate.bind(this)),
this.dynamicListService.handlerErrorsToResponse,
this.handleServiceError,
);
router.post(
'/',
[...this.exchangeRateDTOSchema],
this.validationResult,
asyncMiddleware(this.addExchangeRate.bind(this)),
this.handleServiceError
);
router.post(
'/:id',
[...this.exchangeRateEditDTOSchema, ...this.exchangeRateIdSchema],
this.validationResult,
asyncMiddleware(this.editExchangeRate.bind(this)),
this.handleServiceError
);
router.delete(
'/:id',
[...this.exchangeRateIdSchema],
this.validationResult,
asyncMiddleware(this.deleteExchangeRate.bind(this)),
this.handleServiceError this.handleServiceError
); );
return router; return router;
} }
get exchangeRatesListSchema() {
return [
query('page').optional().isNumeric().toInt(),
query('page_size').optional().isNumeric().toInt(),
query('column_sort_by').optional(),
query('sort_order').optional().isIn(['desc', 'asc']),
];
}
get exchangeRateDTOSchema() {
return [
check('exchange_rate').exists().isNumeric().toFloat(),
check('currency_code').exists().trim().escape(),
check('date').exists().isISO8601(),
];
}
get exchangeRateEditDTOSchema() {
return [check('exchange_rate').exists().isNumeric().toFloat()];
}
get exchangeRateIdSchema() {
return [param('id').isNumeric().toInt()];
}
get exchangeRatesIdsSchema() {
return [
query('ids').isArray({ min: 2 }),
query('ids.*').isNumeric().toInt(),
];
}
/** /**
* Retrieve exchange rates. * Retrieve exchange rates.
* @param {Request} req * @param {Request} req
* @param {Response} res * @param {Response} res
* @param {NextFunction} next * @param {NextFunction} next
*/ */
async exchangeRates(req: Request, res: Response, next: NextFunction) { private async latestExchangeRate(
req: Request,
res: Response,
next: NextFunction
) {
const { tenantId } = req; const { tenantId } = req;
const filter = { const exchangeRateQuery = this.matchedQueryData(req);
page: 1,
pageSize: 12,
filterRoles: [],
columnSortBy: 'created_at',
sortOrder: 'asc',
...this.matchedQueryData(req),
};
if (filter.stringifiedFilterRoles) {
filter.filterRoles = JSON.parse(filter.stringifiedFilterRoles);
}
try {
const exchangeRates = await this.exchangeRatesService.listExchangeRates(
tenantId,
filter
);
return res.status(200).send({ exchange_rates: exchangeRates });
} catch (error) {
next(error);
}
}
/**
* Adds a new exchange rate on the given date.
* @param {Request} req
* @param {Response} res
* @param {NextFunction} next
*/
async addExchangeRate(req: Request, res: Response, next: NextFunction) {
const { tenantId } = req;
const exchangeRateDTO = this.matchedBodyData(req);
try { try {
const exchangeRate = await this.exchangeRatesService.newExchangeRate( const exchangeRate = await this.exchangeRatesApp.latest(
tenantId, tenantId,
exchangeRateDTO exchangeRateQuery
); );
return res.status(200).send({ id: exchangeRate.id }); return res.status(200).send(exchangeRate);
} catch (error) {
next(error);
}
}
/**
* Edit the given exchange rate.
* @param {Request} req
* @param {Response} res
* @param {NextFunction} next
*/
async editExchangeRate(req: Request, res: Response, next: NextFunction) {
const { tenantId } = req;
const { id: exchangeRateId } = req.params;
const exchangeRateDTO = this.matchedBodyData(req);
try {
const exchangeRate = await this.exchangeRatesService.editExchangeRate(
tenantId,
exchangeRateId,
exchangeRateDTO
);
return res.status(200).send({
id: exchangeRateId,
message: 'The exchange rate has been edited successfully.',
});
} catch (error) {
next(error);
}
}
/**
* Delete the given exchange rate from the storage.
* @param {Request} req
* @param {Response} res
* @param {NextFunction} next
*/
async deleteExchangeRate(req: Request, res: Response, next: NextFunction) {
const { tenantId } = req;
const { id: exchangeRateId } = req.params;
try {
await this.exchangeRatesService.deleteExchangeRate(
tenantId,
exchangeRateId
);
return res.status(200).send({ id: exchangeRateId });
} catch (error) { } catch (error) {
next(error); next(error);
} }
@@ -192,26 +65,56 @@ export default class ExchangeRatesController extends BaseController {
* @param {Response} res * @param {Response} res
* @param {NextFunction} next * @param {NextFunction} next
*/ */
handleServiceError( private handleServiceError(
error: Error, error: Error,
req: Request, req: Request,
res: Response, res: Response,
next: NextFunction next: NextFunction
) { ) {
if (error instanceof ServiceError) { if (error instanceof ServiceError) {
if (error.errorType === 'EXCHANGE_RATE_NOT_FOUND') { if (EchangeRateErrors.EX_RATE_INVALID_BASE_CURRENCY === error.errorType) {
return res.status(404).send({
errors: [{ type: 'EXCHANGE.RATE.NOT.FOUND', code: 200 }],
});
}
if (error.errorType === 'NOT_FOUND_EXCHANGE_RATES') {
return res.status(400).send({ return res.status(400).send({
errors: [{ type: 'EXCHANGE.RATES.IS.NOT.FOUND', code: 100 }], errors: [
{
type: EchangeRateErrors.EX_RATE_INVALID_BASE_CURRENCY,
code: 100,
message: 'The given base currency is invalid.',
},
],
}); });
} } else if (
if (error.errorType === 'EXCHANGE_RATE_PERIOD_EXISTS') { EchangeRateErrors.EX_RATE_SERVICE_NOT_ALLOWED === error.errorType
) {
return res.status(400).send({ return res.status(400).send({
errors: [{ type: 'EXCHANGE.RATE.PERIOD.EXISTS', code: 300 }], errors: [
{
type: EchangeRateErrors.EX_RATE_SERVICE_NOT_ALLOWED,
code: 200,
message: 'The service is not allowed',
},
],
});
} else if (
EchangeRateErrors.EX_RATE_SERVICE_API_KEY_REQUIRED === error.errorType
) {
return res.status(400).send({
errors: [
{
type: EchangeRateErrors.EX_RATE_SERVICE_API_KEY_REQUIRED,
code: 300,
message: 'The API key is required',
},
],
});
} else if (EchangeRateErrors.EX_RATE_LIMIT_EXCEEDED === error.errorType) {
return res.status(400).send({
errors: [
{
type: EchangeRateErrors.EX_RATE_LIMIT_EXCEEDED,
code: 400,
message: 'The API rate limit has been exceeded',
},
],
}); });
} }
} }

View File

@@ -71,6 +71,7 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) { if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
@@ -98,6 +99,15 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.APAgingSummaryApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const sheet = await this.APAgingSummaryApp.sheet(tenantId, filter); const sheet = await this.APAgingSummaryApp.sheet(tenantId, filter);

View File

@@ -11,7 +11,7 @@ import { ACCEPT_TYPE } from '@/interfaces/Http';
@Service() @Service()
export default class ARAgingSummaryReportController extends BaseFinancialReportController { export default class ARAgingSummaryReportController extends BaseFinancialReportController {
@Inject() @Inject()
ARAgingSummaryApp: ARAgingSummaryApplication; private ARAgingSummaryApp: ARAgingSummaryApplication;
/** /**
* Router constructor. * Router constructor.
@@ -69,6 +69,7 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF
]); ]);
// Retrieves the xlsx format. // Retrieves the xlsx format.
if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) { if (ACCEPT_TYPE.APPLICATION_XLSX === acceptType) {
@@ -96,6 +97,15 @@ export default class ARAgingSummaryReportController extends BaseFinancialReportC
res.setHeader('Content-Type', 'text/csv'); res.setHeader('Content-Type', 'text/csv');
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.ARAgingSummaryApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const sheet = await this.ARAgingSummaryApp.sheet(tenantId, filter); const sheet = await this.ARAgingSummaryApp.sheet(tenantId, filter);

View File

@@ -101,6 +101,7 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE == acceptType) { if (ACCEPT_TYPE.APPLICATION_JSON_TABLE == acceptType) {
@@ -128,6 +129,15 @@ export default class BalanceSheetStatementController extends BaseFinancialReport
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.balanceSheetApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
res.send(pdfContent);
} else { } else {
const sheet = await this.balanceSheetApp.sheet(tenantId, filter); const sheet = await this.balanceSheetApp.sheet(tenantId, filter);

View File

@@ -79,6 +79,7 @@ export default class CashFlowController extends BaseFinancialReportController {
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) { if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
@@ -106,6 +107,15 @@ export default class CashFlowController extends BaseFinancialReportController {
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.cashflowSheetApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const cashflow = await this.cashflowSheetApp.sheet(tenantId, filter); const cashflow = await this.cashflowSheetApp.sheet(tenantId, filter);

View File

@@ -75,6 +75,7 @@ export default class CustomerBalanceSummaryReportController extends BaseFinancia
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the xlsx format. // Retrieves the xlsx format.
@@ -109,6 +110,19 @@ export default class CustomerBalanceSummaryReportController extends BaseFinancia
filter filter
); );
return res.status(200).send(table); return res.status(200).send(table);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const buffer = await this.customerBalanceSummaryApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': buffer.length,
});
return res.send(buffer);
// Retrieves the json format.
} else { } else {
const sheet = await this.customerBalanceSummaryApp.sheet( const sheet = await this.customerBalanceSummaryApp.sheet(
tenantId, tenantId,

View File

@@ -16,7 +16,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
/** /**
* Router constructor. * Router constructor.
*/ */
router() { public router() {
const router = Router(); const router = Router();
router.get( router.get(
@@ -32,7 +32,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
/** /**
* Validation schema. * Validation schema.
*/ */
get validationSchema(): ValidationChain[] { private get validationSchema(): ValidationChain[] {
return [ return [
query('from_date').optional().isISO8601(), query('from_date').optional().isISO8601(),
query('to_date').optional().isISO8601(), query('to_date').optional().isISO8601(),
@@ -61,7 +61,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
* @param {Request} req - * @param {Request} req -
* @param {Response} res - * @param {Response} res -
*/ */
async generalLedger(req: Request, res: Response, next: NextFunction) { private async generalLedger(req: Request, res: Response, next: NextFunction) {
const { tenantId } = req; const { tenantId } = req;
const filter = this.matchedQueryData(req); const filter = this.matchedQueryData(req);
const accept = this.accepts(req); const accept = this.accepts(req);
@@ -71,6 +71,7 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the table format. // Retrieves the table format.
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) { if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
@@ -95,6 +96,17 @@ export default class GeneralLedgerReportController extends BaseFinancialReportCo
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.generalLedgerApplication.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const sheet = await this.generalLedgerApplication.sheet(tenantId, filter); const sheet = await this.generalLedgerApplication.sheet(tenantId, filter);

View File

@@ -96,6 +96,7 @@ export default class InventoryDetailsController extends BaseController {
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the csv format. // Retrieves the csv format.
if (acceptType === ACCEPT_TYPE.APPLICATION_CSV) { if (acceptType === ACCEPT_TYPE.APPLICATION_CSV) {
@@ -127,6 +128,15 @@ export default class InventoryDetailsController extends BaseController {
filter filter
); );
return res.status(200).send(table); return res.status(200).send(table);
// Retrieves the pdf format.
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
const buffer = await this.inventoryItemDetailsApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': buffer.length,
});
return res.send(buffer);
} else { } else {
const sheet = await this.inventoryItemDetailsApp.sheet( const sheet = await this.inventoryItemDetailsApp.sheet(
tenantId, tenantId,

View File

@@ -79,6 +79,7 @@ export default class InventoryValuationReportController extends BaseFinancialRep
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
@@ -104,6 +105,15 @@ export default class InventoryValuationReportController extends BaseFinancialRep
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.inventoryValuationApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.status(200).send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const { data, query, meta } = await this.inventoryValuationApp.sheet( const { data, query, meta } = await this.inventoryValuationApp.sheet(

View File

@@ -72,6 +72,7 @@ export default class JournalSheetController extends BaseFinancialReportControlle
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
@@ -97,6 +98,14 @@ export default class JournalSheetController extends BaseFinancialReportControlle
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the json format. // Retrieves the json format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.journalSheetApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
res.send(pdfContent);
} else { } else {
const sheet = await this.journalSheetApp.sheet(tenantId, filter); const sheet = await this.journalSheetApp.sheet(tenantId, filter);

View File

@@ -96,6 +96,7 @@ export default class ProfitLossSheetController extends BaseFinancialReportContro
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
try { try {
// Retrieves the csv format. // Retrieves the csv format.
@@ -125,6 +126,14 @@ export default class ProfitLossSheetController extends BaseFinancialReportContro
); );
return res.send(sheet); return res.send(sheet);
// Retrieves the json format. // Retrieves the json format.
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
const pdfContent = await this.profitLossSheetApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
} else { } else {
const sheet = await this.profitLossSheetApp.sheet(tenantId, filter); const sheet = await this.profitLossSheetApp.sheet(tenantId, filter);

View File

@@ -75,8 +75,8 @@ export default class PurchasesByItemReportController extends BaseFinancialReport
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// JSON table response format. // JSON table response format.
if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) { if (ACCEPT_TYPE.APPLICATION_JSON_TABLE === acceptType) {
const table = await this.purchasesByItemsApp.table(tenantId, filter); const table = await this.purchasesByItemsApp.table(tenantId, filter);
@@ -100,6 +100,15 @@ export default class PurchasesByItemReportController extends BaseFinancialReport
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
); );
return res.send(buffer); return res.send(buffer);
// PDF response format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.purchasesByItemsApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Json response format. // Json response format.
} else { } else {
const sheet = await this.purchasesByItemsApp.sheet(tenantId, filter); const sheet = await this.purchasesByItemsApp.sheet(tenantId, filter);

View File

@@ -11,7 +11,7 @@ import { SalesByItemsApplication } from '@/services/FinancialStatements/SalesByI
@Service() @Service()
export default class SalesByItemsReportController extends BaseFinancialReportController { export default class SalesByItemsReportController extends BaseFinancialReportController {
@Inject() @Inject()
salesByItemsApp: SalesByItemsApplication; private salesByItemsApp: SalesByItemsApplication;
/** /**
* Router constructor. * Router constructor.
@@ -71,6 +71,7 @@ export default class SalesByItemsReportController extends BaseFinancialReportCon
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the csv format. // Retrieves the csv format.
if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) { if (ACCEPT_TYPE.APPLICATION_CSV === acceptType) {
@@ -96,6 +97,14 @@ export default class SalesByItemsReportController extends BaseFinancialReportCon
); );
return res.send(buffer); return res.send(buffer);
// Retrieves the json format. // Retrieves the json format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.salesByItemsApp.pdf(tenantId, filter);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
} else { } else {
const sheet = await this.salesByItemsApp.sheet(tenantId, filter); const sheet = await this.salesByItemsApp.sheet(tenantId, filter);
return res.status(200).send(sheet); return res.status(200).send(sheet);

View File

@@ -62,6 +62,7 @@ export default class SalesTaxLiabilitySummary extends BaseFinancialReportControl
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the json table format. // Retrieves the json table format.
@@ -97,6 +98,16 @@ export default class SalesTaxLiabilitySummary extends BaseFinancialReportControl
return res.send(buffer); return res.send(buffer);
// Retrieves the json format. // Retrieves the json format.
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
const pdfContent = await this.salesTaxLiabilitySummaryApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.status(200).send(pdfContent);
} else { } else {
const sheet = await this.salesTaxLiabilitySummaryApp.sheet( const sheet = await this.salesTaxLiabilitySummaryApp.sheet(
tenantId, tenantId,

View File

@@ -70,6 +70,7 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
try { try {
// Retrieves the json table format. // Retrieves the json table format.
@@ -103,6 +104,16 @@ export default class TransactionsByCustomersReportController extends BaseFinanci
); );
return res.send(buffer); return res.send(buffer);
// Retrieve the json format. // Retrieve the json format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.transactionsByCustomersApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
} else { } else {
const sheet = await this.transactionsByCustomersApp.sheet( const sheet = await this.transactionsByCustomersApp.sheet(
tenantId, tenantId,

View File

@@ -71,6 +71,7 @@ export default class TransactionsByVendorsReportController extends BaseFinancial
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the xlsx format. // Retrieves the xlsx format.
@@ -101,6 +102,17 @@ export default class TransactionsByVendorsReportController extends BaseFinancial
filter filter
); );
return res.status(200).send(table); return res.status(200).send(table);
// Retrieves the pdf format.
} else if (ACCEPT_TYPE.APPLICATION_PDF === acceptType) {
const pdfContent = await this.transactionsByVendorsApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const sheet = await this.transactionsByVendorsApp.sheet( const sheet = await this.transactionsByVendorsApp.sheet(

View File

@@ -3,7 +3,6 @@ import { Request, Response, Router, NextFunction } from 'express';
import { query, ValidationChain } from 'express-validator'; import { query, ValidationChain } from 'express-validator';
import { castArray } from 'lodash'; import { castArray } from 'lodash';
import asyncMiddleware from '@/api/middleware/asyncMiddleware'; import asyncMiddleware from '@/api/middleware/asyncMiddleware';
import TrialBalanceSheetService from '@/services/FinancialStatements/TrialBalanceSheet/TrialBalanceSheetInjectable';
import BaseFinancialReportController from './BaseFinancialReportController'; import BaseFinancialReportController from './BaseFinancialReportController';
import { AbilitySubject, ReportsAction } from '@/interfaces'; import { AbilitySubject, ReportsAction } from '@/interfaces';
import CheckPolicies from '@/api/middleware/CheckPolicies'; import CheckPolicies from '@/api/middleware/CheckPolicies';
@@ -81,6 +80,7 @@ export default class TrialBalanceSheetController extends BaseFinancialReportCont
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves in json table format. // Retrieves in json table format.
if (acceptType === ACCEPT_TYPE.APPLICATION_JSON_TABLE) { if (acceptType === ACCEPT_TYPE.APPLICATION_JSON_TABLE) {
@@ -109,6 +109,17 @@ export default class TrialBalanceSheetController extends BaseFinancialReportCont
res.setHeader('Content-Type', 'text/csv'); res.setHeader('Content-Type', 'text/csv');
return res.send(buffer); return res.send(buffer);
// Retrieves in pdf format.
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
const pdfContent = await this.trialBalanceSheetApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
res.send(pdfContent);
// Retrieves in json format. // Retrieves in json format.
} else { } else {
const { data, query, meta } = await this.trialBalanceSheetApp.sheet( const { data, query, meta } = await this.trialBalanceSheetApp.sheet(

View File

@@ -72,6 +72,7 @@ export default class VendorBalanceSummaryReportController extends BaseFinancialR
ACCEPT_TYPE.APPLICATION_JSON_TABLE, ACCEPT_TYPE.APPLICATION_JSON_TABLE,
ACCEPT_TYPE.APPLICATION_CSV, ACCEPT_TYPE.APPLICATION_CSV,
ACCEPT_TYPE.APPLICATION_XLSX, ACCEPT_TYPE.APPLICATION_XLSX,
ACCEPT_TYPE.APPLICATION_PDF,
]); ]);
// Retrieves the csv format. // Retrieves the csv format.
@@ -100,6 +101,17 @@ export default class VendorBalanceSummaryReportController extends BaseFinancialR
filter filter
); );
return res.status(200).send(table); return res.status(200).send(table);
// Retrieves the pdf format.
} else if (acceptType === ACCEPT_TYPE.APPLICATION_PDF) {
const pdfContent = await this.vendorBalanceSummaryApp.pdf(
tenantId,
filter
);
res.set({
'Content-Type': 'application/pdf',
'Content-Length': pdfContent.length,
});
return res.send(pdfContent);
// Retrieves the json format. // Retrieves the json format.
} else { } else {
const sheet = await this.vendorBalanceSummaryApp.sheet( const sheet = await this.vendorBalanceSummaryApp.sheet(

View File

@@ -560,6 +560,16 @@ export default class BillsController extends BaseController {
errors: [{ type: 'ITEM_ENTRY_TAX_RATE_ID_NOT_FOUND', code: 1900 }], errors: [{ type: 'ITEM_ENTRY_TAX_RATE_ID_NOT_FOUND', code: 1900 }],
}); });
} }
if (error.errorType === 'BILL_AMOUNT_SMALLER_THAN_PAID_AMOUNT') {
return res.boom.badRequest(null, {
errors: [
{
type: 'BILL_AMOUNT_SMALLER_THAN_PAID_AMOUNT',
code: 2000,
},
],
});
}
} }
next(error); next(error);
} }

View File

@@ -320,20 +320,19 @@ export default class VendorCreditController extends BaseController {
res: Response, res: Response,
next: NextFunction next: NextFunction
) => { ) => {
const { id: billId } = req.params; const { id: vendorCreditId } = req.params;
const { tenantId, user } = req; const { tenantId, user } = req;
const vendorCreditEditDTO: IVendorCreditEditDTO = this.matchedBodyData(req); const vendorCreditEditDTO: IVendorCreditEditDTO = this.matchedBodyData(req);
try { try {
await this.editVendorCreditService.editVendorCredit( await this.editVendorCreditService.editVendorCredit(
tenantId, tenantId,
billId, vendorCreditId,
vendorCreditEditDTO, vendorCreditEditDTO
user
); );
return res.status(200).send({ return res.status(200).send({
id: billId, id: vendorCreditId,
message: 'The vendor credit has been edited successfully.', message: 'The vendor credit has been edited successfully.',
}); });
} catch (error) { } catch (error) {

View File

@@ -169,4 +169,14 @@ module.exports = {
* to application detarmines to upgrade. * to application detarmines to upgrade.
*/ */
databaseBatch: 4, databaseBatch: 4,
/**
* Exchange rate.
*/
exchangeRate: {
service: 'open-exchange-rate',
openExchangeRate: {
appId: process.env.OPEN_EXCHANGE_RATE_APP_ID,
}
}
}; };

View File

@@ -5,6 +5,7 @@ import {
IAgingSummaryContact, IAgingSummaryContact,
IAgingSummaryData, IAgingSummaryData,
} from './AgingReport'; } from './AgingReport';
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface IAPAgingSummaryQuery extends IAgingSummaryQuery { export interface IAPAgingSummaryQuery extends IAgingSummaryQuery {
@@ -23,17 +24,22 @@ export interface IAPAgingSummaryData extends IAgingSummaryData {
export type IAPAgingSummaryColumns = IAgingPeriod[]; export type IAPAgingSummaryColumns = IAgingPeriod[];
export interface IARAgingSummaryMeta { export interface IARAgingSummaryMeta extends IFinancialSheetCommonMeta {
baseCurrency: string; formattedAsDate: string;
organizationName: string;
} }
export interface IAPAgingSummaryMeta { export interface IAPAgingSummaryMeta extends IFinancialSheetCommonMeta {
baseCurrency: string; formattedAsDate: string;
organizationName: string;
} }
export interface IAPAgingSummaryTable extends IFinancialTable { export interface IAPAgingSummaryTable extends IFinancialTable {
query: IAPAgingSummaryQuery; query: IAPAgingSummaryQuery;
meta: IAPAgingSummaryMeta; meta: IAPAgingSummaryMeta;
} }
export interface IAPAgingSummarySheet {
data: IAPAgingSummaryData;
meta: IAPAgingSummaryMeta;
query: IAPAgingSummaryQuery;
columns: any;
}

View File

@@ -32,3 +32,11 @@ export interface IARAgingSummaryTable extends IFinancialTable {
meta: IARAgingSummaryMeta; meta: IARAgingSummaryMeta;
query: IARAgingSummaryQuery; query: IARAgingSummaryQuery;
} }
export interface IARAgingSummarySheet {
data: IARAgingSummaryData;
meta: IARAgingSummaryMeta;
query: IARAgingSummaryQuery;
columns: IARAgingSummaryColumns;
}

View File

@@ -1,5 +1,7 @@
import {
import { INumberFormatQuery } from './FinancialStatements'; IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
export interface IAgingPeriodTotal extends IAgingPeriod { export interface IAgingPeriodTotal extends IAgingPeriod {
total: IAgingAmount; total: IAgingAmount;
@@ -42,3 +44,8 @@ export interface IAgingSummaryTotal {
export interface IAgingSummaryData { export interface IAgingSummaryData {
total: IAgingSummaryTotal; total: IAgingSummaryTotal;
} }
export interface IAgingSummaryMeta extends IFinancialSheetCommonMeta {
formattedAsDate: string;
formattedDateRange: string;
}

View File

@@ -2,6 +2,7 @@ import {
INumberFormatQuery, INumberFormatQuery,
IFormatNumberSettings, IFormatNumberSettings,
IFinancialSheetBranchesQuery, IFinancialSheetBranchesQuery,
IFinancialSheetCommonMeta,
} from './FinancialStatements'; } from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
@@ -63,10 +64,9 @@ export interface IBalanceSheetQuery extends IFinancialSheetBranchesQuery {
} }
// Balance sheet meta. // Balance sheet meta.
export interface IBalanceSheetMeta { export interface IBalanceSheetMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean; formattedAsDate: string;
organizationName: string; formattedDateRange: string;
baseCurrency: string;
} }
export interface IBalanceSheetFormatNumberSettings export interface IBalanceSheetFormatNumberSettings

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IAccount } from './Account'; import { IAccount } from './Account';
import { ILedger } from './Ledger'; import { ILedger } from './Ledger';
import { IFinancialTable, ITableRow } from './Table'; import { IFinancialTable, ITableRow } from './Table';
@@ -80,7 +83,7 @@ export interface ICashFlowStatementAggregateSection
export interface ICashFlowCashBeginningNode export interface ICashFlowCashBeginningNode
extends ICashFlowStatementCommonSection { extends ICashFlowStatementCommonSection {
sectionType: ICashFlowStatementSectionType.CASH_AT_BEGINNING; sectionType: ICashFlowStatementSectionType.CASH_AT_BEGINNING;
} }
export type ICashFlowStatementSection = export type ICashFlowStatementSection =
| ICashFlowStatementAccountSection | ICashFlowStatementAccountSection
@@ -89,10 +92,10 @@ export type ICashFlowStatementSection =
| ICashFlowStatementCommonSection; | ICashFlowStatementCommonSection;
export interface ICashFlowStatementColumn {} export interface ICashFlowStatementColumn {}
export interface ICashFlowStatementMeta { export interface ICashFlowStatementMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean; formattedToDate: string;
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedDateRange: string;
} }
export interface ICashFlowStatementDOO { export interface ICashFlowStatementDOO {

View File

@@ -4,6 +4,7 @@ import {
IContactBalanceSummaryPercentage, IContactBalanceSummaryPercentage,
IContactBalanceSummaryTotal, IContactBalanceSummaryTotal,
} from './ContactBalanceSummary'; } from './ContactBalanceSummary';
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface ICustomerBalanceSummaryQuery export interface ICustomerBalanceSummaryQuery
@@ -35,9 +36,15 @@ export interface ICustomerBalanceSummaryData {
total: ICustomerBalanceSummaryTotal; total: ICustomerBalanceSummaryTotal;
} }
export interface ICustomerBalanceSummaryMeta extends IFinancialSheetCommonMeta {
formattedAsDate: string;
formattedDateRange: string;
}
export interface ICustomerBalanceSummaryStatement { export interface ICustomerBalanceSummaryStatement {
data: ICustomerBalanceSummaryData; data: ICustomerBalanceSummaryData;
query: ICustomerBalanceSummaryQuery; query: ICustomerBalanceSummaryQuery;
meta: ICustomerBalanceSummaryMeta;
} }
export interface ICustomerBalanceSummaryService { export interface ICustomerBalanceSummaryService {
@@ -49,4 +56,5 @@ export interface ICustomerBalanceSummaryService {
export interface ICustomerBalanceSummaryTable extends IFinancialTable { export interface ICustomerBalanceSummaryTable extends IFinancialTable {
query: ICustomerBalanceSummaryQuery; query: ICustomerBalanceSummaryQuery;
meta: ICustomerBalanceSummaryMeta;
} }

View File

@@ -1,36 +1,10 @@
import { IFilterRole } from './DynamicFilter'; export interface ExchangeRateLatestDTO {
toCurrency: string;
fromCurrency: string;
}
export interface IExchangeRate { export interface EchangeRateLatestPOJO {
id: number, baseCurrency: string;
currencyCode: string, toCurrency: string;
exchangeRate: number, exchangeRate: number;
date: Date, }
createdAt: Date,
updatedAt: Date,
};
export interface IExchangeRateDTO {
currencyCode: string,
exchangeRate: number,
date: Date,
};
export interface IExchangeRateEditDTO {
exchangeRate: number,
};
export interface IExchangeRateFilter {
page: number,
pageSize: number,
filterRoles?: IFilterRole[];
columnSortBy: string;
sortOrder: string;
};
export interface IExchangeRatesService {
newExchangeRate(tenantId: number, exchangeRateDTO: IExchangeRateDTO): Promise<IExchangeRate>;
editExchangeRate(tenantId: number, exchangeRateId: number, editExRateDTO: IExchangeRateEditDTO): Promise<void>;
deleteExchangeRate(tenantId: number, exchangeRateId: number): Promise<void>;
listExchangeRates(tenantId: number, exchangeRateFilter: IExchangeRateFilter): Promise<void>;
};

View File

@@ -43,3 +43,12 @@ export enum ReportsAction {
export interface IFinancialSheetBranchesQuery { export interface IFinancialSheetBranchesQuery {
branchesIds?: number[]; branchesIds?: number[];
} }
export interface IFinancialSheetCommonMeta {
organizationName: string;
baseCurrency: string;
dateFormat: string;
isCostComputeRunning: boolean;
sheetName: string;
}

View File

@@ -1,90 +1,88 @@
import { IFinancialTable } from "./Table"; import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable } from './Table';
export interface IGeneralLedgerSheetQuery { export interface IGeneralLedgerSheetQuery {
fromDate: Date | string, fromDate: Date | string;
toDate: Date | string, toDate: Date | string;
basis: string, basis: string;
numberFormat: { numberFormat: {
noCents: boolean, noCents: boolean;
divideOn1000: boolean, divideOn1000: boolean;
}, };
noneTransactions: boolean, noneTransactions: boolean;
accountsIds: number[], accountsIds: number[];
branchesIds?: number[]; branchesIds?: number[];
}; }
export interface IGeneralLedgerSheetAccountTransaction { export interface IGeneralLedgerSheetAccountTransaction {
id: number, id: number;
amount: number, amount: number;
runningBalance: number, runningBalance: number;
credit: number, credit: number;
debit: number, debit: number;
formattedAmount: string, formattedAmount: string;
formattedCredit: string, formattedCredit: string;
formattedDebit: string, formattedDebit: string;
formattedRunningBalance: string, formattedRunningBalance: string;
currencyCode: string, currencyCode: string;
note?: string, note?: string;
transactionType?: string, transactionType?: string;
transactionNumber: string, transactionNumber: string;
referenceId?: number, referenceId?: number;
referenceType?: string, referenceType?: string;
date: Date|string, date: Date | string;
dateFormatted: string; dateFormatted: string;
}; }
export interface IGeneralLedgerSheetAccountBalance { export interface IGeneralLedgerSheetAccountBalance {
date: Date|string, date: Date | string;
amount: number, amount: number;
formattedAmount: string, formattedAmount: string;
currencyCode: string, currencyCode: string;
} }
export interface IGeneralLedgerSheetAccount { export interface IGeneralLedgerSheetAccount {
id: number, id: number;
name: string, name: string;
code: string, code: string;
index: number, index: number;
parentAccountId: number, parentAccountId: number;
transactions: IGeneralLedgerSheetAccountTransaction[], transactions: IGeneralLedgerSheetAccountTransaction[];
openingBalance: IGeneralLedgerSheetAccountBalance, openingBalance: IGeneralLedgerSheetAccountBalance;
closingBalance: IGeneralLedgerSheetAccountBalance, closingBalance: IGeneralLedgerSheetAccountBalance;
} }
export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[]; export type IGeneralLedgerSheetData = IGeneralLedgerSheetAccount[];
export interface IAccountTransaction { export interface IAccountTransaction {
id: number, id: number;
index: number, index: number;
draft: boolean, draft: boolean;
note: string, note: string;
accountId: number, accountId: number;
transactionType: string, transactionType: string;
referenceType: string, referenceType: string;
referenceId: number, referenceId: number;
contactId: number, contactId: number;
contactType: string, contactType: string;
credit: number, credit: number;
debit: number, debit: number;
date: string|Date, date: string | Date;
createdAt: string|Date, createdAt: string | Date;
updatedAt: string|Date, updatedAt: string | Date;
} }
export interface IGeneralLedgerMeta { export interface IGeneralLedgerMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean, formattedFromDate: string;
organizationName: string, formattedToDate: string;
baseCurrency: string, formattedDateRange: string;
fromDate: string; }
toDate: string;
};
export interface IGeneralLedgerTableData extends IFinancialTable { export interface IGeneralLedgerTableData extends IFinancialTable {
meta: IGeneralLedgerMeta; meta: IGeneralLedgerMeta;

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface IInventoryValuationReportQuery { export interface IInventoryValuationReportQuery {
@@ -13,10 +16,10 @@ export interface IInventoryValuationReportQuery {
branchesIds?: number[]; branchesIds?: number[];
} }
export interface IInventoryValuationSheetMeta { export interface IInventoryValuationSheetMeta
organizationName: string; extends IFinancialSheetCommonMeta {
baseCurrency: string; formattedAsDate: string;
isCostComputeRunning: boolean; formattedDateRange: string;
} }
export interface IInventoryValuationItem { export interface IInventoryValuationItem {

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface IInventoryDetailsQuery { export interface IInventoryDetailsQuery {
@@ -79,10 +82,10 @@ export type IInventoryDetailsNode =
| IInventoryDetailsItemTransaction; | IInventoryDetailsItemTransaction;
export type IInventoryDetailsData = IInventoryDetailsItem[]; export type IInventoryDetailsData = IInventoryDetailsItem[];
export interface IInventoryItemDetailMeta { export interface IInventoryItemDetailMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean; formattedFromDate: string;
organizationName: string; formattedToDay: string;
baseCurrency: string; formattedDateRange: string;
} }
export interface IInvetoryItemDetailDOO { export interface IInvetoryItemDetailDOO {

View File

@@ -1,3 +1,4 @@
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IJournalEntry } from './Journal'; import { IJournalEntry } from './Journal';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
@@ -32,10 +33,10 @@ export interface IJournalReport {
entries: IJournalReportEntriesGroup[]; entries: IJournalReportEntriesGroup[];
} }
export interface IJournalSheetMeta { export interface IJournalSheetMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean; formattedDateRange: string;
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedToDate: string;
} }
export interface IJournalTable extends IFinancialTable { export interface IJournalTable extends IFinancialTable {

View File

@@ -1,5 +1,6 @@
import { import {
IFinancialSheetBranchesQuery, IFinancialSheetBranchesQuery,
IFinancialSheetCommonMeta,
INumberFormatQuery, INumberFormatQuery,
} from './FinancialStatements'; } from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
@@ -134,10 +135,10 @@ export type IProfitLossSheetNode =
| IProfitLossSheetEquationNode | IProfitLossSheetEquationNode
| IProfitLossSheetAccountNode; | IProfitLossSheetAccountNode;
export interface IProfitLossSheetMeta { export interface IProfitLossSheetMeta extends IFinancialSheetCommonMeta{
isCostComputeRunning: boolean; formattedDateRange: string;
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedToDate: string;
} }
// ------------------------------------------------ // ------------------------------------------------

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface IPurchasesByItemsReportQuery { export interface IPurchasesByItemsReportQuery {
@@ -10,9 +13,10 @@ export interface IPurchasesByItemsReportQuery {
onlyActive: boolean; onlyActive: boolean;
} }
export interface IPurchasesByItemsSheetMeta { export interface IPurchasesByItemsSheetMeta extends IFinancialSheetCommonMeta {
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedToDate: string;
formattedDateRange: string;
} }
export interface IPurchasesByItemsItem { export interface IPurchasesByItemsItem {

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface ISalesByItemsReportQuery { export interface ISalesByItemsReportQuery {
@@ -10,9 +13,10 @@ export interface ISalesByItemsReportQuery {
onlyActive: boolean; onlyActive: boolean;
} }
export interface ISalesByItemsSheetMeta { export interface ISalesByItemsSheetMeta extends IFinancialSheetCommonMeta {
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedToDate: string;
formattedDateRange: string;
} }
export interface ISalesByItemsItem { export interface ISalesByItemsItem {

View File

@@ -1,3 +1,4 @@
import { IFinancialSheetCommonMeta } from "./FinancialStatements";
import { IFinancialTable } from "./Table"; import { IFinancialTable } from "./Table";
export interface SalesTaxLiabilitySummaryQuery { export interface SalesTaxLiabilitySummaryQuery {
@@ -47,9 +48,10 @@ export type SalesTaxLiabilitySummarySalesById = Record<
{ taxRateId: number; credit: number; debit: number } { taxRateId: number; credit: number; debit: number }
>; >;
export interface SalesTaxLiabilitySummaryMeta { export interface SalesTaxLiabilitySummaryMeta extends IFinancialSheetCommonMeta {
organizationName: string; formattedFromDate: string;
baseCurrency: string; formattedToDate: string;
formattedDateRange: string;
} }
export interface ISalesTaxLiabilitySummaryTable extends IFinancialTable { export interface ISalesTaxLiabilitySummaryTable extends IFinancialTable {

View File

@@ -1,3 +1,4 @@
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable, ITableData } from './Table'; import { IFinancialTable, ITableData } from './Table';
import { import {
ITransactionsByContactsAmount, ITransactionsByContactsAmount,
@@ -28,10 +29,12 @@ export type ITransactionsByCustomersData = ITransactionsByCustomersCustomer[];
export interface ITransactionsByCustomersStatement { export interface ITransactionsByCustomersStatement {
data: ITransactionsByCustomersData; data: ITransactionsByCustomersData;
query: ITransactionsByCustomersFilter; query: ITransactionsByCustomersFilter;
meta: ITransactionsByCustomersMeta;
} }
export interface ITransactionsByCustomersTable extends IFinancialTable { export interface ITransactionsByCustomersTable extends IFinancialTable {
query: ITransactionsByCustomersFilter; query: ITransactionsByCustomersFilter;
meta: ITransactionsByCustomersMeta;
} }
export interface ITransactionsByCustomersService { export interface ITransactionsByCustomersService {
@@ -40,3 +43,9 @@ export interface ITransactionsByCustomersService {
filter: ITransactionsByCustomersFilter filter: ITransactionsByCustomersFilter
): Promise<ITransactionsByCustomersStatement>; ): Promise<ITransactionsByCustomersStatement>;
} }
export interface ITransactionsByCustomersMeta
extends IFinancialSheetCommonMeta {
formattedFromDate: string;
formattedToDate: string;
formattedDateRange: string;
}

View File

@@ -1,3 +1,4 @@
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
import { import {
ITransactionsByContactsAmount, ITransactionsByContactsAmount,
@@ -27,6 +28,8 @@ export type ITransactionsByVendorsData = ITransactionsByVendorsVendor[];
export interface ITransactionsByVendorsStatement { export interface ITransactionsByVendorsStatement {
data: ITransactionsByVendorsData; data: ITransactionsByVendorsData;
query: ITransactionsByVendorsFilter;
meta: ITransactionsByVendorMeta;
} }
export interface ITransactionsByVendorsService { export interface ITransactionsByVendorsService {
@@ -38,4 +41,10 @@ export interface ITransactionsByVendorsService {
export interface ITransactionsByVendorTable extends IFinancialTable { export interface ITransactionsByVendorTable extends IFinancialTable {
query: ITransactionsByVendorsFilter; query: ITransactionsByVendorsFilter;
meta: ITransactionsByVendorMeta;
}
export interface ITransactionsByVendorMeta extends IFinancialSheetCommonMeta {
formattedFromDate: string;
formattedToDate: string;
formattedDateRange: string;
} }

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface ITrialBalanceSheetQuery { export interface ITrialBalanceSheetQuery {
@@ -24,10 +27,10 @@ export interface ITrialBalanceTotal {
formattedBalance: string; formattedBalance: string;
} }
export interface ITrialBalanceSheetMeta { export interface ITrialBalanceSheetMeta extends IFinancialSheetCommonMeta {
isCostComputeRunning: boolean; formattedFromDate: string;
organizationName: string; formattedToDate: string;
baseCurrency: string; formattedDateRange: string;
} }
export interface ITrialBalanceAccount extends ITrialBalanceTotal { export interface ITrialBalanceAccount extends ITrialBalanceTotal {

View File

@@ -1,4 +1,7 @@
import { INumberFormatQuery } from './FinancialStatements'; import {
IFinancialSheetCommonMeta,
INumberFormatQuery,
} from './FinancialStatements';
import { IFinancialTable } from './Table'; import { IFinancialTable } from './Table';
export interface IVendorBalanceSummaryQuery { export interface IVendorBalanceSummaryQuery {
@@ -39,8 +42,9 @@ export interface IVendorBalanceSummaryData {
export interface IVendorBalanceSummaryStatement { export interface IVendorBalanceSummaryStatement {
data: IVendorBalanceSummaryData; data: IVendorBalanceSummaryData;
columns: {};
query: IVendorBalanceSummaryQuery; query: IVendorBalanceSummaryQuery;
meta: IVendorBalanceSummaryMeta;
} }
export interface IVendorBalanceSummaryService { export interface IVendorBalanceSummaryService {
@@ -52,4 +56,9 @@ export interface IVendorBalanceSummaryService {
export interface IVendorBalanceSummaryTable extends IFinancialTable { export interface IVendorBalanceSummaryTable extends IFinancialTable {
query: IVendorBalanceSummaryQuery; query: IVendorBalanceSummaryQuery;
meta: IVendorBalanceSummaryMeta;
}
export interface IVendorBalanceSummaryMeta extends IFinancialSheetCommonMeta {
formattedAsDate: string;
} }

View File

@@ -0,0 +1,45 @@
import { OpenExchangeRate } from './OpenExchangeRate';
import { ExchangeRateServiceType, IExchangeRateService } from './types';
export class ExchangeRate {
private exchangeRateService: IExchangeRateService;
private exchangeRateServiceType: ExchangeRateServiceType;
/**
* Constructor method.
* @param {ExchangeRateServiceType} service
*/
constructor(service: ExchangeRateServiceType) {
this.exchangeRateServiceType = service;
this.initService();
}
/**
* Initialize the exchange rate service based on the service type.
*/
private initService() {
if (
this.exchangeRateServiceType === ExchangeRateServiceType.OpenExchangeRate
) {
this.setExchangeRateService(new OpenExchangeRate());
}
}
/**
* Sets the exchange rate service.
* @param {IExchangeRateService} service
*/
private setExchangeRateService(service: IExchangeRateService) {
this.exchangeRateService = service;
}
/**
* Gets the latest exchange rate.
* @param {string} baseCurrency
* @param {string} toCurrency
* @returns {number}
*/
public latest(baseCurrency: string, toCurrency: string): Promise<number> {
return this.exchangeRateService.latest(baseCurrency, toCurrency);
}
}

View File

@@ -0,0 +1,81 @@
import Axios, { AxiosError } from 'axios';
import {
EchangeRateErrors,
IExchangeRateService,
OPEN_EXCHANGE_RATE_LATEST_URL,
} from './types';
import config from '@/config';
import { ServiceError } from '@/exceptions';
export class OpenExchangeRate implements IExchangeRateService {
/**
* Gets the latest exchange rate.
* @param {string} baseCurrency
* @param {string} toCurrency
* @returns {Promise<number}
*/
public async latest(
baseCurrency: string,
toCurrency: string
): Promise<number> {
// Vaclidates the Open Exchange Rate api id early.
this.validateApiIdExistance();
try {
const result = await Axios.get(OPEN_EXCHANGE_RATE_LATEST_URL, {
params: {
app_id: config.exchangeRate.openExchangeRate.appId,
base: baseCurrency,
symbols: toCurrency,
},
});
return result.data.rates[toCurrency] || (1 as number);
} catch (error) {
this.handleLatestErrors(error);
}
}
/**
* Validates the Open Exchange Rate api id.
* @throws {ServiceError}
*/
private validateApiIdExistance() {
const apiId = config.exchangeRate.openExchangeRate.appId;
if (!apiId) {
throw new ServiceError(
EchangeRateErrors.EX_RATE_SERVICE_API_KEY_REQUIRED,
'Invalid App ID provided. Please sign up at https://openexchangerates.org/signup, or contact support@openexchangerates.org.'
);
}
}
/**
* Handles the latest errors.
* @param {any} error
* @throws {ServiceError}
*/
private handleLatestErrors(error: any) {
if (error.response.data?.message === 'missing_app_id') {
throw new ServiceError(
EchangeRateErrors.EX_RATE_SERVICE_API_KEY_REQUIRED,
'Invalid App ID provided. Please sign up at https://openexchangerates.org/signup, or contact support@openexchangerates.org.'
);
} else if (error.response.data?.message === 'invalid_app_id') {
throw new ServiceError(
EchangeRateErrors.EX_RATE_SERVICE_API_KEY_REQUIRED,
'Invalid App ID provided. Please sign up at https://openexchangerates.org/signup, or contact support@openexchangerates.org.'
);
} else if (error.response.data?.message === 'not_allowed') {
throw new ServiceError(
EchangeRateErrors.EX_RATE_SERVICE_NOT_ALLOWED,
'Getting the exchange rate from the given base currency to the given currency is not allowed.'
);
} else if (error.response.data?.message === 'invalid_base') {
throw new ServiceError(
EchangeRateErrors.EX_RATE_INVALID_BASE_CURRENCY,
'The given base currency is invalid.'
);
}
}
}

View File

@@ -0,0 +1,17 @@
export interface IExchangeRateService {
latest(baseCurrency: string, toCurrency: string): Promise<number>;
}
export enum ExchangeRateServiceType {
OpenExchangeRate = 'OpenExchangeRate',
}
export enum EchangeRateErrors {
EX_RATE_SERVICE_NOT_ALLOWED = 'EX_RATE_SERVICE_NOT_ALLOWED',
EX_RATE_LIMIT_EXCEEDED = 'EX_RATE_LIMIT_EXCEEDED',
EX_RATE_SERVICE_API_KEY_REQUIRED = 'EX_RATE_SERVICE_API_KEY_REQUIRED',
EX_RATE_INVALID_BASE_CURRENCY = 'EX_RATE_INVALID_BASE_CURRENCY',
}
export const OPEN_EXCHANGE_RATE_LATEST_URL =
'https://openexchangerates.org/api/latest.json';

View File

@@ -2,6 +2,8 @@ import { Model } from 'objection';
import TenantModel from 'models/TenantModel'; import TenantModel from 'models/TenantModel';
export default class ExpenseCategory extends TenantModel { export default class ExpenseCategory extends TenantModel {
amount: number;
/** /**
* Table name * Table name
*/ */

View File

@@ -14,6 +14,7 @@ export class CreditNoteTransformer extends Transformer {
'formattedCreditNoteDate', 'formattedCreditNoteDate',
'formattedAmount', 'formattedAmount',
'formattedCreditsUsed', 'formattedCreditsUsed',
'formattedSubtotal',
'entries', 'entries',
]; ];
}; };
@@ -60,6 +61,15 @@ export class CreditNoteTransformer extends Transformer {
}); });
}; };
/**
* Retrieves the formatted subtotal.
* @param {ICreditNote} credit
* @returns {string}
*/
protected formattedSubtotal = (credit): string => {
return formatNumber(credit.amount, { money: false });
};
/** /**
* Retrieves the entries of the credit note. * Retrieves the entries of the credit note.
* @param {ICreditNote} credit * @param {ICreditNote} credit

View File

@@ -80,7 +80,7 @@ export default class EditCreditNote extends BaseCreditNotes {
} as ICreditNoteEditingPayload); } as ICreditNoteEditingPayload);
// Saves the credit note graph to the storage. // Saves the credit note graph to the storage.
const creditNote = await CreditNote.query(trx).upsertGraph({ const creditNote = await CreditNote.query(trx).upsertGraphAndFetch({
id: creditNoteId, id: creditNoteId,
...creditNoteModel, ...creditNoteModel,
}); });

View File

@@ -0,0 +1,21 @@
import { Inject } from 'typedi';
import { ExchangeRatesService } from './ExchangeRatesService';
import { EchangeRateLatestPOJO, ExchangeRateLatestDTO } from '@/interfaces';
export class ExchangeRateApplication {
@Inject()
private exchangeRateService: ExchangeRatesService;
/**
* Gets the latest exchange rate.
* @param {number} tenantId
* @param {ExchangeRateLatestDTO} exchangeRateLatestDTO
* @returns {Promise<EchangeRateLatestPOJO>}
*/
public latest(
tenantId: number,
exchangeRateLatestDTO: ExchangeRateLatestDTO
): Promise<EchangeRateLatestPOJO> {
return this.exchangeRateService.latest(tenantId, exchangeRateLatestDTO);
}
}

View File

@@ -1,193 +1,37 @@
import moment from 'moment'; import { Service } from 'typedi';
import { difference } from 'lodash'; import { ExchangeRate } from '@/lib/ExchangeRate/ExchangeRate';
import { Service, Inject } from 'typedi'; import { ExchangeRateServiceType } from '@/lib/ExchangeRate/types';
import { ServiceError } from '@/exceptions'; import { EchangeRateLatestPOJO, ExchangeRateLatestDTO } from '@/interfaces';
import DynamicListingService from '@/services/DynamicListing/DynamicListService'; import { TenantMetadata } from '@/system/models';
import {
EventDispatcher,
EventDispatcherInterface,
} from 'decorators/eventDispatcher';
import {
IExchangeRateDTO,
IExchangeRate,
IExchangeRatesService,
IExchangeRateEditDTO,
IExchangeRateFilter,
} from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
const ERRORS = {
NOT_FOUND_EXCHANGE_RATES: 'NOT_FOUND_EXCHANGE_RATES',
EXCHANGE_RATE_PERIOD_EXISTS: 'EXCHANGE_RATE_PERIOD_EXISTS',
EXCHANGE_RATE_NOT_FOUND: 'EXCHANGE_RATE_NOT_FOUND',
};
@Service() @Service()
export default class ExchangeRatesService implements IExchangeRatesService { export class ExchangeRatesService {
@Inject('logger')
logger: any;
@EventDispatcher()
eventDispatcher: EventDispatcherInterface;
@Inject()
tenancy: TenancyService;
@Inject()
dynamicListService: DynamicListingService;
/** /**
* Creates a new exchange rate. * Gets the latest exchange rate.
* @param {number} tenantId * @param {number} tenantId
* @param {IExchangeRateDTO} exchangeRateDTO * @param {number} exchangeRateLatestDTO
* @returns {Promise<IExchangeRate>} * @returns {EchangeRateLatestPOJO}
*/ */
public async newExchangeRate( public async latest(
tenantId: number, tenantId: number,
exchangeRateDTO: IExchangeRateDTO exchangeRateLatestDTO: ExchangeRateLatestDTO
): Promise<IExchangeRate> { ): Promise<EchangeRateLatestPOJO> {
const { ExchangeRate } = this.tenancy.models(tenantId); const organization = await TenantMetadata.query().findOne({ tenantId });
this.logger.info('[exchange_rates] trying to insert new exchange rate.', { // Assign the organization base currency as a default currency
tenantId, // if no currency is provided
exchangeRateDTO, const fromCurrency =
}); exchangeRateLatestDTO.fromCurrency || organization.baseCurrency;
await this.validateExchangeRatePeriodExistance(tenantId, exchangeRateDTO); const toCurrency =
exchangeRateLatestDTO.toCurrency || organization.baseCurrency;
const exchangeRate = await ExchangeRate.query().insertAndFetch({ const exchange = new ExchangeRate(ExchangeRateServiceType.OpenExchangeRate);
...exchangeRateDTO, const exchangeRate = await exchange.latest(fromCurrency, toCurrency);
date: moment(exchangeRateDTO.date).format('YYYY-MM-DD'),
});
this.logger.info('[exchange_rates] inserted successfully.', {
tenantId,
exchangeRateDTO,
});
return exchangeRate;
}
/** return {
* Edits the exchange rate details. baseCurrency: fromCurrency,
* @param {number} tenantId - Tenant id. toCurrency: exchangeRateLatestDTO.toCurrency,
* @param {number} exchangeRateId - Exchange rate id. exchangeRate,
* @param {IExchangeRateEditDTO} editExRateDTO - Edit exchange rate DTO. };
*/
public async editExchangeRate(
tenantId: number,
exchangeRateId: number,
editExRateDTO: IExchangeRateEditDTO
): Promise<void> {
const { ExchangeRate } = this.tenancy.models(tenantId);
this.logger.info('[exchange_rates] trying to edit exchange rate.', {
tenantId,
exchangeRateId,
editExRateDTO,
});
await this.validateExchangeRateExistance(tenantId, exchangeRateId);
await ExchangeRate.query()
.where('id', exchangeRateId)
.update({ ...editExRateDTO });
this.logger.info('[exchange_rates] exchange rate edited successfully.', {
tenantId,
exchangeRateId,
editExRateDTO,
});
}
/**
* Deletes the given exchange rate.
* @param {number} tenantId - Tenant id.
* @param {number} exchangeRateId - Exchange rate id.
*/
public async deleteExchangeRate(
tenantId: number,
exchangeRateId: number
): Promise<void> {
const { ExchangeRate } = this.tenancy.models(tenantId);
await this.validateExchangeRateExistance(tenantId, exchangeRateId);
await ExchangeRate.query().findById(exchangeRateId).delete();
}
/**
* Listing exchange rates details.
* @param {number} tenantId - Tenant id.
* @param {IExchangeRateFilter} exchangeRateFilter - Exchange rates list filter.
*/
public async listExchangeRates(
tenantId: number,
exchangeRateFilter: IExchangeRateFilter
): Promise<void> {
const { ExchangeRate } = this.tenancy.models(tenantId);
const dynamicFilter = await this.dynamicListService.dynamicList(
tenantId,
ExchangeRate,
exchangeRateFilter
);
// Retrieve exchange rates by the given query.
const exchangeRates = await ExchangeRate.query()
.onBuild((query) => {
dynamicFilter.buildQuery()(query);
})
.pagination(exchangeRateFilter.page - 1, exchangeRateFilter.pageSize);
return exchangeRates;
}
/**
* Validates period of the exchange rate existance.
* @param {number} tenantId - Tenant id.
* @param {IExchangeRateDTO} exchangeRateDTO - Exchange rate DTO.
* @return {Promise<void>}
*/
private async validateExchangeRatePeriodExistance(
tenantId: number,
exchangeRateDTO: IExchangeRateDTO
): Promise<void> {
const { ExchangeRate } = this.tenancy.models(tenantId);
this.logger.info('[exchange_rates] trying to validate period existance.', {
tenantId,
});
const foundExchangeRate = await ExchangeRate.query()
.where('currency_code', exchangeRateDTO.currencyCode)
.where('date', exchangeRateDTO.date);
if (foundExchangeRate.length > 0) {
this.logger.info('[exchange_rates] given exchange rate period exists.', {
tenantId,
});
throw new ServiceError(ERRORS.EXCHANGE_RATE_PERIOD_EXISTS);
}
}
/**
* Validate the given echange rate id existance.
* @param {number} tenantId - Tenant id.
* @param {number} exchangeRateId - Exchange rate id.
* @returns {Promise<void>}
*/
private async validateExchangeRateExistance(
tenantId: number,
exchangeRateId: number
) {
const { ExchangeRate } = this.tenancy.models(tenantId);
this.logger.info(
'[exchange_rates] trying to validate exchange rate id existance.',
{ tenantId, exchangeRateId }
);
const foundExchangeRate = await ExchangeRate.query().findById(
exchangeRateId
);
if (!foundExchangeRate) {
this.logger.info('[exchange_rates] exchange rate not found.', {
tenantId,
exchangeRateId,
});
throw new ServiceError(ERRORS.EXCHANGE_RATE_NOT_FOUND);
}
} }
} }

View File

@@ -136,7 +136,7 @@ export class EditExpense {
} as IExpenseEventEditingPayload); } as IExpenseEventEditingPayload);
// Upsert the expense object with expense entries. // Upsert the expense object with expense entries.
const expense: IExpense = await Expense.query(trx).upsertGraph({ const expense: IExpense = await Expense.query(trx).upsertGraphAndFetch({
id: expenseId, id: expenseId,
...expenseObj, ...expenseObj,
}); });

View File

@@ -0,0 +1,25 @@
import { Transformer } from '@/lib/Transformer/Transformer';
import { ExpenseCategory } from '@/models';
import { formatNumber } from '@/utils';
export class ExpenseCategoryTransformer extends Transformer {
/**
* Include these attributes to expense object.
* @returns {Array}
*/
public includeAttributes = (): string[] => {
return ['amountFormatted'];
};
/**
* Retrieves the formatted amount.
* @param {ExpenseCategory} category
* @returns {string}
*/
protected amountFormatted(category: ExpenseCategory) {
return formatNumber(category.amount, {
currencyCode: this.context.currencyCode,
money: false,
});
}
}

View File

@@ -1,6 +1,7 @@
import { Transformer } from '@/lib/Transformer/Transformer'; import { Transformer } from '@/lib/Transformer/Transformer';
import { formatNumber } from 'utils'; import { formatNumber } from 'utils';
import { IExpense } from '@/interfaces'; import { IExpense } from '@/interfaces';
import { ExpenseCategoryTransformer } from './ExpenseCategoryTransformer';
export class ExpenseTransfromer extends Transformer { export class ExpenseTransfromer extends Transformer {
/** /**
@@ -12,7 +13,8 @@ export class ExpenseTransfromer extends Transformer {
'formattedAmount', 'formattedAmount',
'formattedLandedCostAmount', 'formattedLandedCostAmount',
'formattedAllocatedCostAmount', 'formattedAllocatedCostAmount',
'formattedDate' 'formattedDate',
'categories',
]; ];
}; };
@@ -56,5 +58,16 @@ export class ExpenseTransfromer extends Transformer {
*/ */
protected formattedDate = (expense: IExpense): string => { protected formattedDate = (expense: IExpense): string => {
return this.formatDate(expense.paymentDate); return this.formatDate(expense.paymentDate);
} };
/**
* Retrieves the transformed expense categories.
* @param {IExpense} expense
* @returns {}
*/
protected categories = (expense: IExpense) => {
return this.item(expense.categories, new ExpenseCategoryTransformer(), {
currencyCode: expense.currencyCode,
});
};
} }

View File

@@ -1,7 +1,7 @@
import { Knex } from 'knex'; import { Knex } from 'knex';
import { Service, Inject } from 'typedi';
import LedgerStorageService from '@/services/Accounting/LedgerStorageService'; import LedgerStorageService from '@/services/Accounting/LedgerStorageService';
import HasTenancyService from '@/services/Tenancy/TenancyService'; import HasTenancyService from '@/services/Tenancy/TenancyService';
import { Service, Inject } from 'typedi';
import { ExpenseGLEntries } from './ExpenseGLEntries'; import { ExpenseGLEntries } from './ExpenseGLEntries';
@Service() @Service()

View File

@@ -70,10 +70,10 @@ export class ExpensesWriteGLSubscriber {
authorizedUser, authorizedUser,
trx, trx,
}: IExpenseEventEditPayload) => { }: IExpenseEventEditPayload) => {
// In case expense published, write journal entries. // Cannot continue if the expense is not published.
if (expense.publishedAt) return; if (!expense.publishedAt) return;
await this.expenseGLEntries.writeExpenseGLEntries( await this.expenseGLEntries.rewriteExpenseGLEntries(
tenantId, tenantId,
expense.id, expense.id,
trx trx

View File

@@ -3,6 +3,7 @@ import { APAgingSummaryExportInjectable } from './APAgingSummaryExportInjectable
import { APAgingSummaryTableInjectable } from './APAgingSummaryTableInjectable'; import { APAgingSummaryTableInjectable } from './APAgingSummaryTableInjectable';
import { IAPAgingSummaryQuery } from '@/interfaces'; import { IAPAgingSummaryQuery } from '@/interfaces';
import { APAgingSummaryService } from './APAgingSummaryService'; import { APAgingSummaryService } from './APAgingSummaryService';
import { APAgingSummaryPdfInjectable } from './APAgingSummaryPdfInjectable';
@Service() @Service()
export class APAgingSummaryApplication { export class APAgingSummaryApplication {
@@ -15,6 +16,9 @@ export class APAgingSummaryApplication {
@Inject() @Inject()
private APAgingSummarySheet: APAgingSummaryService; private APAgingSummarySheet: APAgingSummaryService;
@Inject()
private APAgingSumaryPdf: APAgingSummaryPdfInjectable;
/** /**
* Retrieve the A/P aging summary in sheet format. * Retrieve the A/P aging summary in sheet format.
* @param {number} tenantId * @param {number} tenantId
@@ -50,4 +54,14 @@ export class APAgingSummaryApplication {
public xlsx(tenantId: number, query: IAPAgingSummaryQuery) { public xlsx(tenantId: number, query: IAPAgingSummaryQuery) {
return this.APAgingSummaryExport.xlsx(tenantId, query); return this.APAgingSummaryExport.xlsx(tenantId, query);
} }
/**
* Retrieves the A/P aging summary in pdf format.
* @param {number} tenantId
* @param {IAPAgingSummaryQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(tenantId: number, query: IAPAgingSummaryQuery) {
return this.APAgingSumaryPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,26 @@
import { Inject, Service } from 'typedi';
import { IAgingSummaryMeta, IAgingSummaryQuery } from '@/interfaces';
import { AgingSummaryMeta } from './AgingSummaryMeta';
@Service()
export class APAgingSummaryMeta {
@Inject()
private agingSummaryMeta: AgingSummaryMeta;
/**
* Retrieve the aging summary meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IAgingSummaryQuery
): Promise<IAgingSummaryMeta> {
const commonMeta = await this.agingSummaryMeta.meta(tenantId, query);
return {
...commonMeta,
sheetName: 'A/P Aging Summary',
};
}
}

View File

@@ -0,0 +1,35 @@
import { Inject, Service } from 'typedi';
import { IAPAgingSummaryQuery } from '@/interfaces';
import { TableSheetPdf } from '../TableSheetPdf';
import { APAgingSummaryTableInjectable } from './APAgingSummaryTableInjectable';
import { HtmlTableCss } from './_constants';
@Service()
export class APAgingSummaryPdfInjectable {
@Inject()
private APAgingSummaryTable: APAgingSummaryTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given A/P aging summary sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IAPAgingSummaryQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: IAPAgingSummaryQuery
): Promise<Buffer> {
const table = await this.APAgingSummaryTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedAsDate,
HtmlTableCss
);
}
}

View File

@@ -1,18 +1,19 @@
import moment from 'moment'; import moment from 'moment';
import { Inject, Service } from 'typedi'; import { Inject, Service } from 'typedi';
import { isEmpty } from 'lodash'; import { isEmpty } from 'lodash';
import { IAPAgingSummaryQuery, IARAgingSummaryMeta } from '@/interfaces'; import { IAPAgingSummaryQuery, IAPAgingSummarySheet } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService'; import TenancyService from '@/services/Tenancy/TenancyService';
import APAgingSummarySheet from './APAgingSummarySheet'; import APAgingSummarySheet from './APAgingSummarySheet';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { APAgingSummaryMeta } from './APAgingSummaryMeta';
@Service() @Service()
export class APAgingSummaryService { export class APAgingSummaryService {
@Inject() @Inject()
tenancy: TenancyService; private tenancy: TenancyService;
@Inject('logger') @Inject()
logger: any; private APAgingSummaryMeta: APAgingSummaryMeta;
/** /**
* Default report query. * Default report query.
@@ -35,35 +36,16 @@ export class APAgingSummaryService {
}; };
} }
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): IARAgingSummaryMeta {
const settings = this.tenancy.settings(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
return {
organizationName,
baseCurrency,
};
}
/** /**
* Retrieve A/P aging summary report. * Retrieve A/P aging summary report.
* @param {number} tenantId - * @param {number} tenantId -
* @param {IAPAgingSummaryQuery} query - * @param {IAPAgingSummaryQuery} query -
* @returns {Promise<IAPAgingSummarySheet>}
*/ */
async APAgingSummary(tenantId: number, query: IAPAgingSummaryQuery) { public async APAgingSummary(
tenantId: number,
query: IAPAgingSummaryQuery
): Promise<IAPAgingSummarySheet> {
const { Bill } = this.tenancy.models(tenantId); const { Bill } = this.tenancy.models(tenantId);
const { vendorRepository } = this.tenancy.repositories(tenantId); const { vendorRepository } = this.tenancy.repositories(tenantId);
@@ -111,11 +93,14 @@ export class APAgingSummaryService {
const data = APAgingSummaryReport.reportData(); const data = APAgingSummaryReport.reportData();
const columns = APAgingSummaryReport.reportColumns(); const columns = APAgingSummaryReport.reportColumns();
// Retrieve the aging summary report meta.
const meta = await this.APAgingSummaryMeta.meta(tenantId, filter);
return { return {
data, data,
columns, columns,
query: filter, query: filter,
meta: this.reportMetadata(tenantId), meta,
}; };
} }
} }

View File

@@ -3,6 +3,7 @@ import { IARAgingSummaryQuery } from '@/interfaces';
import { ARAgingSummaryTableInjectable } from './ARAgingSummaryTableInjectable'; import { ARAgingSummaryTableInjectable } from './ARAgingSummaryTableInjectable';
import { ARAgingSummaryExportInjectable } from './ARAgingSummaryExportInjectable'; import { ARAgingSummaryExportInjectable } from './ARAgingSummaryExportInjectable';
import ARAgingSummaryService from './ARAgingSummaryService'; import ARAgingSummaryService from './ARAgingSummaryService';
import { ARAgingSummaryPdfInjectable } from './ARAgingSummaryPdfInjectable';
@Service() @Service()
export class ARAgingSummaryApplication { export class ARAgingSummaryApplication {
@@ -15,6 +16,9 @@ export class ARAgingSummaryApplication {
@Inject() @Inject()
private ARAgingSummarySheet: ARAgingSummaryService; private ARAgingSummarySheet: ARAgingSummaryService;
@Inject()
private ARAgingSummaryPdf: ARAgingSummaryPdfInjectable;
/** /**
* Retrieve the A/R aging summary sheet. * Retrieve the A/R aging summary sheet.
* @param {number} tenantId * @param {number} tenantId
@@ -50,4 +54,14 @@ export class ARAgingSummaryApplication {
public csv(tenantId: number, query: IARAgingSummaryQuery) { public csv(tenantId: number, query: IARAgingSummaryQuery) {
return this.ARAgingSummaryExport.csv(tenantId, query); return this.ARAgingSummaryExport.csv(tenantId, query);
} }
/**
* Retrieves the A/R aging summary in pdf format.
* @param {number} tenantId
* @param {IARAgingSummaryQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(tenantId: number, query: IARAgingSummaryQuery) {
return this.ARAgingSummaryPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,26 @@
import { Inject, Service } from 'typedi';
import { IAgingSummaryMeta, IAgingSummaryQuery } from '@/interfaces';
import { AgingSummaryMeta } from './AgingSummaryMeta';
@Service()
export class ARAgingSummaryMeta {
@Inject()
private agingSummaryMeta: AgingSummaryMeta;
/**
* Retrieve the aging summary meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IAgingSummaryQuery
): Promise<IAgingSummaryMeta> {
const commonMeta = await this.agingSummaryMeta.meta(tenantId, query);
return {
...commonMeta,
sheetName: 'A/R Aging Summary',
};
}
}

View File

@@ -0,0 +1,35 @@
import { Inject, Service } from 'typedi';
import { IARAgingSummaryQuery } from '@/interfaces';
import { TableSheetPdf } from '../TableSheetPdf';
import { ARAgingSummaryTableInjectable } from './ARAgingSummaryTableInjectable';
import { HtmlTableCss } from './_constants';
@Service()
export class ARAgingSummaryPdfInjectable {
@Inject()
private ARAgingSummaryTable: ARAgingSummaryTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given balance sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IBalanceSheetQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: IARAgingSummaryQuery
): Promise<Buffer> {
const table = await this.ARAgingSummaryTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedDateRange,
HtmlTableCss
);
}
}

View File

@@ -1,18 +1,19 @@
import moment from 'moment'; import moment from 'moment';
import { Inject, Service } from 'typedi'; import { Inject, Service } from 'typedi';
import { isEmpty } from 'lodash'; import { isEmpty } from 'lodash';
import { IARAgingSummaryQuery, IARAgingSummaryMeta } from '@/interfaces'; import { IARAgingSummaryQuery } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService'; import TenancyService from '@/services/Tenancy/TenancyService';
import ARAgingSummarySheet from './ARAgingSummarySheet'; import ARAgingSummarySheet from './ARAgingSummarySheet';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { ARAgingSummaryMeta } from './ARAgingSummaryMeta';
@Service() @Service()
export default class ARAgingSummaryService { export default class ARAgingSummaryService {
@Inject() @Inject()
tenancy: TenancyService; private tenancy: TenancyService;
@Inject('logger') @Inject()
logger: any; private ARAgingSummaryMeta: ARAgingSummaryMeta;
/** /**
* Default report query. * Default report query.
@@ -35,29 +36,6 @@ export default class ARAgingSummaryService {
}; };
} }
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): IARAgingSummaryMeta {
const settings = this.tenancy.settings(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
return {
organizationName,
baseCurrency,
};
}
/** /**
* Retrieve A/R aging summary report. * Retrieve A/R aging summary report.
* @param {number} tenantId - Tenant id. * @param {number} tenantId - Tenant id.
@@ -110,11 +88,14 @@ export default class ARAgingSummaryService {
const data = ARAgingSummaryReport.reportData(); const data = ARAgingSummaryReport.reportData();
const columns = ARAgingSummaryReport.reportColumns(); const columns = ARAgingSummaryReport.reportColumns();
// Retrieve the aging summary report meta.
const meta = await this.ARAgingSummaryMeta.meta(tenantId, filter);
return { return {
data, data,
columns, columns,
query: filter, query: filter,
meta: this.reportMetadata(tenantId), meta,
}; };
} }
} }

View File

@@ -19,6 +19,7 @@ export class ARAgingSummaryTableInjectable {
query: IARAgingSummaryQuery query: IARAgingSummaryQuery
): Promise<IARAgingSummaryTable> { ): Promise<IARAgingSummaryTable> {
const report = await this.ARAgingSummarySheet.ARAgingSummary( const report = await this.ARAgingSummarySheet.ARAgingSummary(
tenantId, tenantId,
query query
); );

View File

@@ -0,0 +1,30 @@
import { Inject } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import { IAgingSummaryMeta, IAgingSummaryQuery } from '@/interfaces';
import moment from 'moment';
export class AgingSummaryMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the aging summary meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IAgingSummaryQuery
): Promise<IAgingSummaryMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedAsDate = moment(query.asDate).format('YYYY/MM/DD');
const formattedDateRange = `As ${formattedAsDate}`;
return {
...commonMeta,
sheetName: 'A/P Aging Summary',
formattedAsDate,
formattedDateRange,
};
}
}

View File

@@ -2,3 +2,11 @@ export enum AgingSummaryRowType {
Contact = 'contact', Contact = 'contact',
Total = 'total', Total = 'total',
} }
export const HtmlTableCss = `
table tr.row-type--total td{
font-weight: 500;
border-top: 1px solid #bbb;
border-bottom: 3px double #333;
}
`;

View File

@@ -54,4 +54,14 @@ export class BalanceSheetApplication {
public csv(tenantId: number, query: IBalanceSheetQuery): Promise<string> { public csv(tenantId: number, query: IBalanceSheetQuery): Promise<string> {
return this.balanceSheetExport.csv(tenantId, query); return this.balanceSheetExport.csv(tenantId, query);
} }
/**
* Retrieves the balance sheet in pdf format.
* @param {number} tenantId
* @param {IBalanceSheetQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(tenantId: number, query: IBalanceSheetQuery) {
return this.balanceSheetExport.pdf(tenantId, query);
}
} }

View File

@@ -2,12 +2,16 @@ import { Inject, Service } from 'typedi';
import { BalanceSheetTableInjectable } from './BalanceSheetTableInjectable'; import { BalanceSheetTableInjectable } from './BalanceSheetTableInjectable';
import { TableSheet } from '@/lib/Xlsx/TableSheet'; import { TableSheet } from '@/lib/Xlsx/TableSheet';
import { IBalanceSheetQuery } from '@/interfaces'; import { IBalanceSheetQuery } from '@/interfaces';
import { BalanceSheetPdfInjectable } from './BalanceSheetPdfInjectable';
@Service() @Service()
export class BalanceSheetExportInjectable { export class BalanceSheetExportInjectable {
@Inject() @Inject()
private balanceSheetTable: BalanceSheetTableInjectable; private balanceSheetTable: BalanceSheetTableInjectable;
@Inject()
private balanceSheetPdf: BalanceSheetPdfInjectable;
/** /**
* Retrieves the trial balance sheet in XLSX format. * Retrieves the trial balance sheet in XLSX format.
* @param {number} tenantId * @param {number} tenantId
@@ -40,4 +44,17 @@ export class BalanceSheetExportInjectable {
return tableCsv; return tableCsv;
} }
/**
* Retrieves the balance sheet in pdf format.
* @param {number} tenantId
* @param {IBalanceSheetQuery} query
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: IBalanceSheetQuery
): Promise<Buffer> {
return this.balanceSheetPdf.pdf(tenantId, query);
}
} }

View File

@@ -4,15 +4,12 @@ import {
IBalanceSheetStatementService, IBalanceSheetStatementService,
IBalanceSheetQuery, IBalanceSheetQuery,
IBalanceSheetStatement, IBalanceSheetStatement,
IBalanceSheetMeta,
} from '@/interfaces'; } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService'; import TenancyService from '@/services/Tenancy/TenancyService';
import Journal from '@/services/Accounting/JournalPoster';
import BalanceSheetStatement from './BalanceSheet'; import BalanceSheetStatement from './BalanceSheet';
import InventoryService from '@/services/Inventory/Inventory';
import { parseBoolean } from 'utils';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import BalanceSheetRepository from './BalanceSheetRepository'; import BalanceSheetRepository from './BalanceSheetRepository';
import { BalanceSheetMetaInjectable } from './BalanceSheetMeta';
@Service() @Service()
export default class BalanceSheetStatementService export default class BalanceSheetStatementService
@@ -22,7 +19,7 @@ export default class BalanceSheetStatementService
private tenancy: TenancyService; private tenancy: TenancyService;
@Inject() @Inject()
private inventoryService: InventoryService; private balanceSheetMeta: BalanceSheetMetaInjectable;
/** /**
* Defaults balance sheet filter query. * Defaults balance sheet filter query.
@@ -62,33 +59,6 @@ export default class BalanceSheetStatementService
}; };
} }
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
private reportMetadata(tenantId: number): IBalanceSheetMeta {
const settings = this.tenancy.settings(tenantId);
const isCostComputeRunning =
this.inventoryService.isItemsCostComputeRunning(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
return {
isCostComputeRunning: parseBoolean(isCostComputeRunning, false),
organizationName,
baseCurrency,
};
}
/** /**
* Retrieve balance sheet statement. * Retrieve balance sheet statement.
* @param {number} tenantId * @param {number} tenantId
@@ -112,6 +82,7 @@ export default class BalanceSheetStatementService
const models = this.tenancy.models(tenantId); const models = this.tenancy.models(tenantId);
const balanceSheetRepo = new BalanceSheetRepository(models, filter); const balanceSheetRepo = new BalanceSheetRepository(models, filter);
// Loads all resources.
await balanceSheetRepo.asyncInitialize(); await balanceSheetRepo.asyncInitialize();
// Balance sheet report instance. // Balance sheet report instance.
@@ -122,12 +93,15 @@ export default class BalanceSheetStatementService
i18n i18n
); );
// Balance sheet data. // Balance sheet data.
const balanceSheetData = balanceSheetInstanace.reportData(); const data = balanceSheetInstanace.reportData();
// Balance sheet meta.
const meta = await this.balanceSheetMeta.meta(tenantId, filter);
return { return {
data: balanceSheetData,
query: filter, query: filter,
meta: this.reportMetadata(tenantId), data,
meta,
}; };
} }
} }

View File

@@ -0,0 +1,32 @@
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import { IBalanceSheetMeta, IBalanceSheetQuery } from '@/interfaces';
import moment from 'moment';
@Service()
export class BalanceSheetMetaInjectable {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IBalanceSheetQuery
): Promise<IBalanceSheetMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedAsDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedDateRange = `As ${formattedAsDate}`;
const sheetName = 'Balance Sheet Statement';
return {
...commonMeta,
sheetName,
formattedAsDate,
formattedDateRange,
};
}
}

View File

@@ -0,0 +1,35 @@
import { Inject, Service } from 'typedi';
import { IBalanceSheetQuery } from '@/interfaces';
import { BalanceSheetTableInjectable } from './BalanceSheetTableInjectable';
import { TableSheetPdf } from '../TableSheetPdf';
import { HtmlTableCustomCss } from './constants';
@Service()
export class BalanceSheetPdfInjectable {
@Inject()
private balanceSheetTable: BalanceSheetTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given balance sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IBalanceSheetQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: IBalanceSheetQuery
): Promise<Buffer> {
const table = await this.balanceSheetTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedDateRange,
HtmlTableCustomCss
);
}
}

View File

@@ -41,15 +41,16 @@ export default class BalanceSheetTable extends R.compose(
BalanceSheetBase BalanceSheetBase
)(FinancialSheet) { )(FinancialSheet) {
/** /**
* @param {} * Balance sheet data.
* @param {IBalanceSheetStatementData}
*/ */
reportData: IBalanceSheetStatementData; private reportData: IBalanceSheetStatementData;
/** /**
* Balance sheet query. * Balance sheet query.
* @parma {} * @parma {BalanceSheetQuery}
*/ */
query: BalanceSheetQuery; private query: BalanceSheetQuery;
/** /**
* Constructor method. * Constructor method.
@@ -221,7 +222,7 @@ export default class BalanceSheetTable extends R.compose(
return R.compose( return R.compose(
R.unless( R.unless(
R.isEmpty, R.isEmpty,
R.concat([{ key: 'total', Label: this.i18n.__('balance_sheet.total') }]) R.concat([{ key: 'total', label: this.i18n.__('balance_sheet.total') }])
), ),
R.concat(this.percentageColumns()), R.concat(this.percentageColumns()),
R.concat(this.getPreviousYearColumns()), R.concat(this.getPreviousYearColumns()),

View File

@@ -12,3 +12,53 @@ export enum IROW_TYPE {
NET_INCOME = 'NET_INCOME', NET_INCOME = 'NET_INCOME',
TOTAL = 'TOTAL', TOTAL = 'TOTAL',
} }
export const HtmlTableCustomCss = `
table tr.row-type--total td {
font-weight: 600;
border-top: 1px solid #bbb;
color: #000;
}
table tr.row-type--total.row-id--assets td,
table tr.row-type--total.row-id--liability-equity td {
border-bottom: 3px double #000;
}
table .column--name,
table .cell--name {
width: 400px;
}
table .column--total {
width: 25%;
}
table td.cell--total,
table td.cell--previous_year,
table td.cell--previous_year_change,
table td.cell--previous_year_percentage,
table td.cell--previous_period,
table td.cell--previous_period_change,
table td.cell--previous_period_percentage,
table td.cell--percentage_of_row,
table td.cell--percentage_of_column,
table td[class*="cell--date-range"] {
text-align: right;
}
table .column--total,
table .column--previous_year,
table .column--previous_year_change,
table .column--previous_year_percentage,
table .column--previous_period,
table .column--previous_period_change,
table .column--previous_period_percentage,
table .column--percentage_of_row,
table .column--percentage_of_column,
table [class*="column--date-range"] {
text-align: right;
}
`;

View File

@@ -8,7 +8,7 @@ import {
ICashFlowStatementQuery, ICashFlowStatementQuery,
ICashFlowStatementDOO, ICashFlowStatementDOO,
IAccountTransaction, IAccountTransaction,
ICashFlowStatementMeta ICashFlowStatementMeta,
} from '@/interfaces'; } from '@/interfaces';
import CashFlowStatement from './CashFlow'; import CashFlowStatement from './CashFlow';
import Ledger from '@/services/Accounting/Ledger'; import Ledger from '@/services/Accounting/Ledger';
@@ -16,6 +16,7 @@ import CashFlowRepository from './CashFlowRepository';
import InventoryService from '@/services/Inventory/Inventory'; import InventoryService from '@/services/Inventory/Inventory';
import { parseBoolean } from 'utils'; import { parseBoolean } from 'utils';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { CashflowSheetMeta } from './CashflowSheetMeta';
@Service() @Service()
export default class CashFlowStatementService export default class CashFlowStatementService
@@ -31,6 +32,9 @@ export default class CashFlowStatementService
@Inject() @Inject()
inventoryService: InventoryService; inventoryService: InventoryService;
@Inject()
private cashflowSheetMeta: CashflowSheetMeta;
/** /**
* Defaults balance sheet filter query. * Defaults balance sheet filter query.
* @return {IBalanceSheetQuery} * @return {IBalanceSheetQuery}
@@ -138,38 +142,13 @@ export default class CashFlowStatementService
tenant.metadata.baseCurrency, tenant.metadata.baseCurrency,
i18n i18n
); );
// Retrieve the cashflow sheet meta.
const meta = await this.cashflowSheetMeta.meta(tenantId, filter);
return { return {
data: cashFlowInstance.reportData(), data: cashFlowInstance.reportData(),
query: filter, query: filter,
meta: this.reportMetadata(tenantId), meta,
};
}
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {ICashFlowStatementMeta}
*/
private reportMetadata(tenantId: number): ICashFlowStatementMeta {
const settings = this.tenancy.settings(tenantId);
const isCostComputeRunning = this.inventoryService
.isItemsCostComputeRunning(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
return {
isCostComputeRunning: parseBoolean(isCostComputeRunning, false),
organizationName,
baseCurrency
}; };
} }
} }

View File

@@ -76,7 +76,7 @@ export default class CashFlowTable implements ICashFlowTable {
*/ */
private commonColumns = () => { private commonColumns = () => {
return R.compose( return R.compose(
R.concat([{ key: 'label', accessor: 'label' }]), R.concat([{ key: 'name', accessor: 'label' }]),
R.when( R.when(
R.always(this.isDisplayColumnsBy(DISPLAY_COLUMNS_BY.DATE_PERIODS)), R.always(this.isDisplayColumnsBy(DISPLAY_COLUMNS_BY.DATE_PERIODS)),
R.concat(this.datePeriodsColumnsAccessors()) R.concat(this.datePeriodsColumnsAccessors())

View File

@@ -3,6 +3,7 @@ import { CashflowExportInjectable } from './CashflowExportInjectable';
import { ICashFlowStatementQuery } from '@/interfaces'; import { ICashFlowStatementQuery } from '@/interfaces';
import CashFlowStatementService from './CashFlowService'; import CashFlowStatementService from './CashFlowService';
import { CashflowTableInjectable } from './CashflowTableInjectable'; import { CashflowTableInjectable } from './CashflowTableInjectable';
import { CashflowTablePdfInjectable } from './CashflowTablePdfInjectable';
@Service() @Service()
export class CashflowSheetApplication { export class CashflowSheetApplication {
@@ -15,6 +16,9 @@ export class CashflowSheetApplication {
@Inject() @Inject()
private cashflowTable: CashflowTableInjectable; private cashflowTable: CashflowTableInjectable;
@Inject()
private cashflowPdf: CashflowTablePdfInjectable;
/** /**
* Retrieves the cashflow sheet * Retrieves the cashflow sheet
* @param {number} tenantId * @param {number} tenantId
@@ -55,4 +59,17 @@ export class CashflowSheetApplication {
): Promise<string> { ): Promise<string> {
return this.cashflowExport.csv(tenantId, query); return this.cashflowExport.csv(tenantId, query);
} }
/**
* Retrieves the cashflow sheet in pdf format.
* @param {number} tenantId
* @param {ICashFlowStatementQuery} query
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: ICashFlowStatementQuery
): Promise<Buffer> {
return this.cashflowPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,36 @@
import { Inject, Service } from 'typedi';
import moment from 'moment';
import { ICashFlowStatementMeta, ICashFlowStatementQuery } from '@/interfaces';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
@Service()
export class CashflowSheetMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* CAshflow sheet meta.
* @param {number} tenantId
* @param {ICashFlowStatementQuery} query
* @returns {Promise<ICashFlowStatementMeta>}
*/
public async meta(
tenantId: number,
query: ICashFlowStatementQuery
): Promise<ICashFlowStatementMeta> {
const meta = await this.financialSheetMeta.meta(tenantId);
const formattedToDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedFromDate = moment(query.fromDate).format('YYYY/MM/DD');
const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDate}`;
const sheetName = 'Statement of Cash Flow';
return {
...meta,
sheetName,
formattedToDate,
formattedFromDate,
formattedDateRange,
};
}
}

View File

@@ -0,0 +1,34 @@
import { Inject } from 'typedi';
import { CashflowTableInjectable } from './CashflowTableInjectable';
import { TableSheetPdf } from '../TableSheetPdf';
import { ICashFlowStatementQuery } from '@/interfaces';
import { HtmlTableCustomCss } from './constants';
export class CashflowTablePdfInjectable {
@Inject()
private cashflowTable: CashflowTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given cashflow sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IBalanceSheetQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: ICashFlowStatementQuery
): Promise<Buffer> {
const table = await this.cashflowTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedDateRange,
HtmlTableCustomCss
);
}
}

View File

@@ -1,8 +1,33 @@
export const DISPLAY_COLUMNS_BY = { export const DISPLAY_COLUMNS_BY = {
DATE_PERIODS: 'date_periods', DATE_PERIODS: 'date_periods',
TOTAL: 'total', TOTAL: 'total',
}; };
export const MAP_CONFIG = { childrenPath: 'children', pathFormat: 'array' }; export const MAP_CONFIG = { childrenPath: 'children', pathFormat: 'array' };
export const HtmlTableCustomCss = `
table tr.row-type--accounts td {
border-top: 1px solid #bbb;
}
table tr.row-id--cash-end-period td {
border-bottom: 3px double #333;
}
table tr.row-type--total {
font-weight: 600;
}
table tr.row-type--total td {
color: #000;
}
table tr.row-type--total:not(:first-child) td {
border-top: 1px solid #bbb;
}
table .column--name,
table .cell--name {
width: 400px;
}
table .column--total,
table .cell--total,
table [class*="column--date-range"],
table [class*="cell--date-range"] {
text-align: right;
}
`;

View File

@@ -3,6 +3,7 @@ import { CustomerBalanceSummaryExportInjectable } from './CustomerBalanceSummary
import { CustomerBalanceSummaryTableInjectable } from './CustomerBalanceSummaryTableInjectable'; import { CustomerBalanceSummaryTableInjectable } from './CustomerBalanceSummaryTableInjectable';
import { ICustomerBalanceSummaryQuery } from '@/interfaces'; import { ICustomerBalanceSummaryQuery } from '@/interfaces';
import { CustomerBalanceSummaryService } from './CustomerBalanceSummaryService'; import { CustomerBalanceSummaryService } from './CustomerBalanceSummaryService';
import { CustomerBalanceSummaryPdf } from './CustomerBalanceSummaryPdf';
@Service() @Service()
export class CustomerBalanceSummaryApplication { export class CustomerBalanceSummaryApplication {
@@ -15,6 +16,9 @@ export class CustomerBalanceSummaryApplication {
@Inject() @Inject()
private customerBalanceSummarySheet: CustomerBalanceSummaryService; private customerBalanceSummarySheet: CustomerBalanceSummaryService;
@Inject()
private customerBalanceSummaryPdf: CustomerBalanceSummaryPdf;
/** /**
* Retrieves the customer balance sheet in json format. * Retrieves the customer balance sheet in json format.
* @param {number} tenantId * @param {number} tenantId
@@ -57,4 +61,14 @@ export class CustomerBalanceSummaryApplication {
public csv(tenantId: number, query: ICustomerBalanceSummaryQuery) { public csv(tenantId: number, query: ICustomerBalanceSummaryQuery) {
return this.customerBalanceSummaryExport.csv(tenantId, query); return this.customerBalanceSummaryExport.csv(tenantId, query);
} }
/**
* Retrieves the customer balance sheet in PDF format.
* @param {number} tenantId
* @param {ICustomerBalanceSummaryQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(tenantId: number, query: ICustomerBalanceSummaryQuery) {
return this.customerBalanceSummaryPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,35 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import {
ICustomerBalanceSummaryMeta,
ICustomerBalanceSummaryQuery,
} from '@/interfaces';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
@Service()
export class CustomerBalanceSummaryMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieves the customer balance summary meta.
* @param {number} tenantId
* @param {ICustomerBalanceSummaryQuery} query
* @returns {Promise<ICustomerBalanceSummaryMeta>}
*/
async meta(
tenantId: number,
query: ICustomerBalanceSummaryQuery
): Promise<ICustomerBalanceSummaryMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedAsDate = moment(query.asDate).format('YYYY/MM/DD');
const formattedDateRange = `As ${formattedAsDate}`;
return {
...commonMeta,
sheetName: 'Customer Balance Summary',
formattedAsDate,
formattedDateRange,
};
}
}

View File

@@ -0,0 +1,36 @@
import { Inject, Service } from 'typedi';
import { ICustomerBalanceSummaryQuery } from '@/interfaces';
import { TableSheetPdf } from '../TableSheetPdf';
import { CustomerBalanceSummaryTableInjectable } from './CustomerBalanceSummaryTableInjectable';
import { HtmlTableCustomCss } from './constants';
@Service()
export class CustomerBalanceSummaryPdf {
@Inject()
private customerBalanceSummaryTable: CustomerBalanceSummaryTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given customer balance summary sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IAPAgingSummaryQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: ICustomerBalanceSummaryQuery
): Promise<Buffer> {
const table = await this.customerBalanceSummaryTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedDateRange,
HtmlTableCustomCss
);
}
}

View File

@@ -1,4 +1,4 @@
import { Inject } from 'typedi'; import { Inject, Service } from 'typedi';
import moment from 'moment'; import moment from 'moment';
import * as R from 'ramda'; import * as R from 'ramda';
import { import {
@@ -12,13 +12,18 @@ import { CustomerBalanceSummaryReport } from './CustomerBalanceSummary';
import Ledger from '@/services/Accounting/Ledger'; import Ledger from '@/services/Accounting/Ledger';
import CustomerBalanceSummaryRepository from './CustomerBalanceSummaryRepository'; import CustomerBalanceSummaryRepository from './CustomerBalanceSummaryRepository';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { CustomerBalanceSummaryMeta } from './CustomerBalanceSummaryMeta';
@Service()
export class CustomerBalanceSummaryService export class CustomerBalanceSummaryService
implements ICustomerBalanceSummaryService implements ICustomerBalanceSummaryService
{ {
@Inject() @Inject()
private reportRepository: CustomerBalanceSummaryRepository; private reportRepository: CustomerBalanceSummaryRepository;
@Inject()
private customerBalanceSummaryMeta: CustomerBalanceSummaryMeta;
/** /**
* Defaults balance sheet filter query. * Defaults balance sheet filter query.
* @return {ICustomerBalanceSummaryQuery} * @return {ICustomerBalanceSummaryQuery}
@@ -96,10 +101,13 @@ export class CustomerBalanceSummaryService
filter, filter,
tenant.metadata.baseCurrency tenant.metadata.baseCurrency
); );
// Retrieve the customer balance summary meta.
const meta = await this.customerBalanceSummaryMeta.meta(tenantId, filter);
return { return {
data: report.reportData(), data: report.reportData(),
query: filter, query: filter,
meta,
}; };
} }
} }

View File

@@ -25,8 +25,9 @@ export class CustomerBalanceSummaryTableInjectable {
tenantId: number, tenantId: number,
filter: ICustomerBalanceSummaryQuery filter: ICustomerBalanceSummaryQuery
): Promise<ICustomerBalanceSummaryTable> { ): Promise<ICustomerBalanceSummaryTable> {
const i18n = this.tenancy.i18n(tenantId); const i18n = this.tenancy.i18n(tenantId);
const { data, query } = const { data, query, meta } =
await this.customerBalanceSummaryService.customerBalanceSummary( await this.customerBalanceSummaryService.customerBalanceSummary(
tenantId, tenantId,
filter filter
@@ -39,6 +40,7 @@ export class CustomerBalanceSummaryTableInjectable {
rows: tableRows.tableRows(), rows: tableRows.tableRows(),
}, },
query, query,
meta,
}; };
} }
} }

View File

@@ -0,0 +1,6 @@
export const HtmlTableCustomCss = `
table tr.row-type--total td {
font-weight: 600;
border-top: 1px solid #bbb;
border-bottom: 3px double #333;
}`;

View File

@@ -0,0 +1,34 @@
import { TenantMetadata } from '@/system/models';
import { Inject, Service } from 'typedi';
import InventoryService from '../Inventory/Inventory';
import { IFinancialSheetCommonMeta } from '@/interfaces';
@Service()
export class FinancialSheetMeta {
@Inject()
private inventoryService: InventoryService;
/**
* Retrieves the common meta data of the financial sheet.
* @param {number} tenantId
* @returns {Promise<IFinancialSheetCommonMeta>}
*/
async meta(tenantId: number): Promise<IFinancialSheetCommonMeta> {
const tenantMetadata = await TenantMetadata.query().findOne({ tenantId });
const organizationName = tenantMetadata.name;
const baseCurrency = tenantMetadata.baseCurrency;
const dateFormat = tenantMetadata.dateFormat;
const isCostComputeRunning =
this.inventoryService.isItemsCostComputeRunning(tenantId);
return {
organizationName,
baseCurrency,
dateFormat,
isCostComputeRunning,
sheetName: '',
};
}
}

View File

@@ -61,14 +61,14 @@ export const FinancialSheetStructure = (Base: Class) =>
}); });
}; };
findNodeDeep = (nodes, callback) => { public findNodeDeep = (nodes, callback) => {
return findValueDeep(nodes, callback, { return findValueDeep(nodes, callback, {
childrenPath: 'children', childrenPath: 'children',
pathFormat: 'array', pathFormat: 'array',
}); });
}; };
mapAccNodesDeep = (nodes, callback) => { public mapAccNodesDeep = (nodes, callback) => {
return reduceDeep( return reduceDeep(
nodes, nodes,
(acc, value, key, parentValue, context) => { (acc, value, key, parentValue, context) => {
@@ -97,11 +97,11 @@ export const FinancialSheetStructure = (Base: Class) =>
}); });
}; };
getTotalOfChildrenNodes = (node) => { public getTotalOfChildrenNodes = (node) => {
return this.getTotalOfNodes(node.children); return this.getTotalOfNodes(node.children);
}; };
getTotalOfNodes = (nodes) => { public getTotalOfNodes = (nodes) => {
return sumBy(nodes, 'total.amount'); return sumBy(nodes, 'total.amount');
}; };
}; };

View File

@@ -6,6 +6,7 @@ import {
import { GeneralLedgerTableInjectable } from './GeneralLedgerTableInjectable'; import { GeneralLedgerTableInjectable } from './GeneralLedgerTableInjectable';
import { GeneralLedgerExportInjectable } from './GeneralLedgerExport'; import { GeneralLedgerExportInjectable } from './GeneralLedgerExport';
import { GeneralLedgerService } from './GeneralLedgerService'; import { GeneralLedgerService } from './GeneralLedgerService';
import { GeneralLedgerPdf } from './GeneralLedgerPdf';
export class GeneralLedgerApplication { export class GeneralLedgerApplication {
@Inject() @Inject()
@@ -17,6 +18,9 @@ export class GeneralLedgerApplication {
@Inject() @Inject()
private GLSheet: GeneralLedgerService; private GLSheet: GeneralLedgerService;
@Inject()
private GLPdf: GeneralLedgerPdf;
/** /**
* Retrieves the G/L sheet in json format. * Retrieves the G/L sheet in json format.
* @param {number} tenantId * @param {number} tenantId
@@ -63,4 +67,17 @@ export class GeneralLedgerApplication {
): Promise<string> { ): Promise<string> {
return this.GLExport.csv(tenantId, query); return this.GLExport.csv(tenantId, query);
} }
/**
* Retrieves the G/L sheet in pdf format.
* @param {number} tenantId
* @param {IGeneralLedgerSheetQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(
tenantId: number,
query: IGeneralLedgerSheetQuery
): Promise<Buffer> {
return this.GLPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,33 @@
import { IGeneralLedgerMeta, IGeneralLedgerSheetQuery } from '@/interfaces';
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
@Service()
export class GeneralLedgerMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IGeneralLedgerSheetQuery
): Promise<IGeneralLedgerMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedToDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedFromDate = moment(query.fromDate).format('YYYY/MM/DD');
const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDate}`;
return {
...commonMeta,
sheetName: 'Balance Sheet',
formattedFromDate,
formattedToDate,
formattedDateRange,
};
}
}

View File

@@ -0,0 +1,35 @@
import { Inject, Service } from 'typedi';
import { TableSheetPdf } from '../TableSheetPdf';
import { GeneralLedgerTableInjectable } from './GeneralLedgerTableInjectable';
import { IGeneralLedgerSheetQuery } from '@/interfaces';
import { HtmlTableCustomCss } from './constants';
@Service()
export class GeneralLedgerPdf {
@Inject()
private generalLedgerTable: GeneralLedgerTableInjectable;
@Inject()
private tableSheetPdf: TableSheetPdf;
/**
* Converts the general ledger sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IGeneralLedgerSheetQuery} query -
* @returns {Promise<Buffer>}
*/
public async pdf(
tenantId: number,
query: IGeneralLedgerSheetQuery
): Promise<Buffer> {
const table = await this.generalLedgerTable.table(tenantId, query);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
table.meta.sheetName,
table.meta.formattedDateRange,
HtmlTableCustomCss
);
}
}

View File

@@ -6,9 +6,9 @@ import { IGeneralLedgerSheetQuery, IGeneralLedgerMeta } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService'; import TenancyService from '@/services/Tenancy/TenancyService';
import Journal from '@/services/Accounting/JournalPoster'; import Journal from '@/services/Accounting/JournalPoster';
import GeneralLedgerSheet from '@/services/FinancialStatements/GeneralLedger/GeneralLedger'; import GeneralLedgerSheet from '@/services/FinancialStatements/GeneralLedger/GeneralLedger';
import InventoryService from '@/services/Inventory/Inventory'; import { transformToMap } from 'utils';
import { transformToMap, parseBoolean } from 'utils';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { GeneralLedgerMeta } from './GeneralLedgerMeta';
const ERRORS = { const ERRORS = {
ACCOUNTS_NOT_FOUND: 'ACCOUNTS_NOT_FOUND', ACCOUNTS_NOT_FOUND: 'ACCOUNTS_NOT_FOUND',
@@ -17,13 +17,10 @@ const ERRORS = {
@Service() @Service()
export class GeneralLedgerService { export class GeneralLedgerService {
@Inject() @Inject()
tenancy: TenancyService; private tenancy: TenancyService;
@Inject() @Inject()
inventoryService: InventoryService; private generalLedgerMeta: GeneralLedgerMeta;
@Inject('logger')
logger: any;
/** /**
* Defaults general ledger report filter query. * Defaults general ledger report filter query.
@@ -59,40 +56,8 @@ export class GeneralLedgerService {
} }
} }
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IGeneralLedgerMeta}
*/
reportMetadata(tenantId: number, filter): IGeneralLedgerMeta {
const settings = this.tenancy.settings(tenantId);
const isCostComputeRunning = this.inventoryService
.isItemsCostComputeRunning(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
const fromDate = moment(filter.fromDate).format('YYYY MMM DD');
const toDate = moment(filter.toDate).format('YYYY MMM DD');
return {
isCostComputeRunning: parseBoolean(isCostComputeRunning, false),
organizationName,
baseCurrency,
fromDate,
toDate
};
}
/** /**
* Retrieve general ledger report statement. * Retrieve general ledger report statement.
* ----------
* @param {number} tenantId * @param {number} tenantId
* @param {IGeneralLedgerSheetQuery} query * @param {IGeneralLedgerSheetQuery} query
* @return {IGeneralLedgerStatement} * @return {IGeneralLedgerStatement}
@@ -103,13 +68,10 @@ export class GeneralLedgerService {
): Promise<{ ): Promise<{
data: any; data: any;
query: IGeneralLedgerSheetQuery; query: IGeneralLedgerSheetQuery;
meta: IGeneralLedgerMeta meta: IGeneralLedgerMeta;
}> { }> {
const { const { accountRepository, transactionsRepository, contactRepository } =
accountRepository, this.tenancy.repositories(tenantId);
transactionsRepository,
contactRepository
} = this.tenancy.repositories(tenantId);
const i18n = this.tenancy.i18n(tenantId); const i18n = this.tenancy.i18n(tenantId);
@@ -133,13 +95,13 @@ export class GeneralLedgerService {
const transactions = await transactionsRepository.journal({ const transactions = await transactionsRepository.journal({
fromDate: filter.fromDate, fromDate: filter.fromDate,
toDate: filter.toDate, toDate: filter.toDate,
branchesIds: filter.branchesIds branchesIds: filter.branchesIds,
}); });
// Retreive opening balance credit/debit sumation. // Retreive opening balance credit/debit sumation.
const openingBalanceTrans = await transactionsRepository.journal({ const openingBalanceTrans = await transactionsRepository.journal({
toDate: moment(filter.fromDate).subtract(1, 'day'), toDate: moment(filter.fromDate).subtract(1, 'day'),
sumationCreditDebit: true, sumationCreditDebit: true,
branchesIds: filter.branchesIds branchesIds: filter.branchesIds,
}); });
// Transform array transactions to journal collection. // Transform array transactions to journal collection.
const transactionsJournal = Journal.fromTransactions( const transactionsJournal = Journal.fromTransactions(
@@ -167,10 +129,13 @@ export class GeneralLedgerService {
// Retrieve general ledger report data. // Retrieve general ledger report data.
const reportData = generalLedgerInstance.reportData(); const reportData = generalLedgerInstance.reportData();
// Retrieve general ledger report metadata.
const meta = await this.generalLedgerMeta.meta(tenantId, filter);
return { return {
data: reportData, data: reportData,
query: filter, query: filter,
meta: this.reportMetadata(tenantId, filter), meta,
}; };
} }
} }

View File

@@ -0,0 +1,13 @@
export const HtmlTableCustomCss = `
table tr:last-child td {
border-bottom: 1px solid #ececec;
}
table tr.row-type--account td,
table tr.row-type--opening-balance td,
table tr.row-type--closing-balance td{
font-weight: 600;
}
table tr.row-type--closing-balance td {
border-bottom: 1px solid #ececec;
}
`;

View File

@@ -6,6 +6,7 @@ import { Inject, Service } from 'typedi';
import { InventoryDetailsExportInjectable } from './InventoryDetailsExportInjectable'; import { InventoryDetailsExportInjectable } from './InventoryDetailsExportInjectable';
import { InventoryDetailsTableInjectable } from './InventoryDetailsTableInjectable'; import { InventoryDetailsTableInjectable } from './InventoryDetailsTableInjectable';
import { InventoryDetailsService } from './InventoryDetailsService'; import { InventoryDetailsService } from './InventoryDetailsService';
import { InventoryDetailsTablePdf } from './InventoryDetailsTablePdf';
@Service() @Service()
export class InventortyDetailsApplication { export class InventortyDetailsApplication {
@@ -18,6 +19,9 @@ export class InventortyDetailsApplication {
@Inject() @Inject()
private inventoryDetails: InventoryDetailsService; private inventoryDetails: InventoryDetailsService;
@Inject()
private inventoryDetailsPdf: InventoryDetailsTablePdf;
/** /**
* Retrieves the inventory details report in sheet format. * Retrieves the inventory details report in sheet format.
* @param {number} tenantId * @param {number} tenantId
@@ -63,4 +67,14 @@ export class InventortyDetailsApplication {
public csv(tenantId: number, query: IInventoryDetailsQuery): Promise<string> { public csv(tenantId: number, query: IInventoryDetailsQuery): Promise<string> {
return this.inventoryDetailsExport.csv(tenantId, query); return this.inventoryDetailsExport.csv(tenantId, query);
} }
/**
* Retrieves the inventory details report in PDF format.
* @param {number} tenantId
* @param {IInventoryDetailsQuery} query
* @returns {Promise<Buffer>}
*/
public pdf(tenantId: number, query: IInventoryDetailsQuery) {
return this.inventoryDetailsPdf.pdf(tenantId, query);
}
} }

View File

@@ -0,0 +1,35 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import { IInventoryDetailsQuery, IInventoryItemDetailMeta } from '@/interfaces';
@Service()
export class InventoryDetailsMetaInjectable {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the inventoy details meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IInventoryDetailsQuery
): Promise<IInventoryItemDetailMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedFromDate = moment(query.fromDate).format('YYYY/MM/DD');
const formattedToDay = moment(query.toDate).format('YYYY/MM/DD');
const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDay}`;
const sheetName = 'Inventory Item Details';
return {
...commonMeta,
sheetName,
formattedFromDate,
formattedToDay,
formattedDateRange,
};
}
}

View File

@@ -1,17 +1,12 @@
import moment from 'moment'; import moment from 'moment';
import { Service, Inject } from 'typedi'; import { Service, Inject } from 'typedi';
import { import { IInventoryDetailsQuery, IInvetoryItemDetailDOO } from '@/interfaces';
IInventoryDetailsQuery,
IInvetoryItemDetailDOO,
IInventoryItemDetailMeta,
} from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService'; import TenancyService from '@/services/Tenancy/TenancyService';
import { InventoryDetails } from './InventoryDetails'; import { InventoryDetails } from './InventoryDetails';
import FinancialSheet from '../FinancialSheet'; import FinancialSheet from '../FinancialSheet';
import InventoryDetailsRepository from './InventoryDetailsRepository'; import InventoryDetailsRepository from './InventoryDetailsRepository';
import InventoryService from '@/services/Inventory/Inventory';
import { parseBoolean } from 'utils';
import { Tenant } from '@/system/models'; import { Tenant } from '@/system/models';
import { InventoryDetailsMetaInjectable } from './InventoryDetailsMeta';
@Service() @Service()
export class InventoryDetailsService extends FinancialSheet { export class InventoryDetailsService extends FinancialSheet {
@@ -22,7 +17,7 @@ export class InventoryDetailsService extends FinancialSheet {
private reportRepo: InventoryDetailsRepository; private reportRepo: InventoryDetailsRepository;
@Inject() @Inject()
private inventoryService: InventoryService; private inventoryDetailsMeta: InventoryDetailsMetaInjectable;
/** /**
* Defaults balance sheet filter query. * Defaults balance sheet filter query.
@@ -46,33 +41,6 @@ export class InventoryDetailsService extends FinancialSheet {
}; };
} }
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IInventoryItemDetailMeta}
*/
private reportMetadata(tenantId: number): IInventoryItemDetailMeta {
const settings = this.tenancy.settings(tenantId);
const isCostComputeRunning =
this.inventoryService.isItemsCostComputeRunning(tenantId);
const organizationName = settings.get({
group: 'organization',
key: 'name',
});
const baseCurrency = settings.get({
group: 'organization',
key: 'base_currency',
});
return {
isCostComputeRunning: parseBoolean(isCostComputeRunning, false),
organizationName,
baseCurrency,
};
}
/** /**
* Retrieve the inventory details report data. * Retrieve the inventory details report data.
* @param {number} tenantId - * @param {number} tenantId -
@@ -115,11 +83,12 @@ export class InventoryDetailsService extends FinancialSheet {
tenant.metadata.baseCurrency, tenant.metadata.baseCurrency,
i18n i18n
); );
const meta = await this.inventoryDetailsMeta.meta(tenantId, query);
return { return {
data: inventoryDetailsInstance.reportData(), data: inventoryDetailsInstance.reportData(),
query: filter, query: filter,
meta: this.reportMetadata(tenantId), meta,
}; };
} }
} }

Some files were not shown because too many files have changed in this diff Show More