QT/bigcapital
1
0
Fork 0
mirror of https://github.com/bigcapitalhq/bigcapital.git synced 2026-02-18 22:00:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(server): financial reports meta

Browse Source
This commit is contained in:
Ahmed Bouhuolia
2024-02-17 23:36:29 +02:00
parent d2e6cc0036
commit 06e78db49d
62 changed files with 726 additions and 474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
packages/server/src/interfaces/APAgingSummaryReport.ts
View File

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

8
packages/server/src/interfaces/ARAgingSummaryReport.ts
View File

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

11
packages/server/src/interfaces/AgingReport.ts
View File

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

3
packages/server/src/interfaces/BalanceSheet.ts
View File

@@ -65,8 +65,7 @@ export interface IBalanceSheetQuery extends IFinancialSheetBranchesQuery {
// Balance sheet meta.
export interface IBalanceSheetMeta extends IFinancialSheetCommonMeta {
formattedFromDate: string;
formattedToDate: string;
formattedAsDate: string;
formattedDateRange: string;
}

8
packages/server/src/interfaces/CustomerBalanceSummary.ts
View File

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

1
packages/server/src/interfaces/FinancialStatements.ts
View File

@@ -50,4 +50,5 @@ export interface IFinancialSheetCommonMeta {
dateFormat: string;
isCostComputeRunning: boolean;
sheetName: string;
}

124
packages/server/src/interfaces/GeneralLedgerSheet.ts
View File

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

13
packages/server/src/interfaces/IInventoryValuationSheet.ts
View File

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

13
packages/server/src/interfaces/InventoryDetails.ts
View File

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

9
packages/server/src/interfaces/JournalReport.ts
View File

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

12
packages/server/src/interfaces/PurchasesByItemsSheet.ts
View File

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

14
packages/server/src/interfaces/SalesByItemsSheet.ts
View File

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

8
packages/server/src/interfaces/SalesTaxLiabilitySummary.ts
View File

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

7
packages/server/src/interfaces/TransactionsByCustomers.ts
View File

@@ -1,3 +1,4 @@
import { IFinancialSheetCommonMeta } from './FinancialStatements';
import { IFinancialTable, ITableData } from './Table';
import {
ITransactionsByContactsAmount,
@@ -40,3 +41,9 @@ export interface ITransactionsByCustomersService {
filter: ITransactionsByCustomersFilter
): Promise<ITransactionsByCustomersStatement>;
}
export interface ITransactionsByCustomersMeta
extends IFinancialSheetCommonMeta {
formattedFromDate: string;
formattedToDate: string;
formattedDateRange: string;
}

11
packages/server/src/interfaces/TransactionsByVendors.ts
View File

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

13
packages/server/src/interfaces/VendorBalanceSummary.ts
View File

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

26
packages/server/src/services/FinancialStatements/AgingSummary/APAgingSummaryMeta.ts Normal file
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',
};
}
}

5
packages/server/src/services/FinancialStatements/AgingSummary/APAgingSummaryPdfInjectable.ts
View File

@@ -22,13 +22,12 @@ export class APAgingSummaryPdfInjectable {
query: IAPAgingSummaryQuery
): Promise<Buffer> {
const table = await this.APAgingSummaryTable.table(tenantId, query);
const sheetName = 'AR Aging Summary';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedAsDate
);
}
}

43
packages/server/src/services/FinancialStatements/AgingSummary/APAgingSummaryService.ts
View File

@@ -1,18 +1,19 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { isEmpty } from 'lodash';
import { IAPAgingSummaryQuery, IARAgingSummaryMeta } from '@/interfaces';
import { IAPAgingSummaryQuery, IAPAgingSummarySheet } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
import APAgingSummarySheet from './APAgingSummarySheet';
import { Tenant } from '@/system/models';
import { APAgingSummaryMeta } from './APAgingSummaryMeta';
@Service()
export class APAgingSummaryService {
@Inject()
tenancy: TenancyService;
private tenancy: TenancyService;
@Inject('logger')
logger: any;
@Inject()
private APAgingSummaryMeta: APAgingSummaryMeta;
/**
* 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.
* @param {number} tenantId -
* @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 { vendorRepository } = this.tenancy.repositories(tenantId);
@@ -111,11 +93,14 @@ export class APAgingSummaryService {
const data = APAgingSummaryReport.reportData();
const columns = APAgingSummaryReport.reportColumns();
// Retrieve the aging summary report meta.
const meta = await this.APAgingSummaryMeta.meta(tenantId, filter);
return {
data,
columns,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

26
packages/server/src/services/FinancialStatements/AgingSummary/ARAgingSummaryMeta.ts Normal file
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',
};
}
}

5
packages/server/src/services/FinancialStatements/AgingSummary/ARAgingSummaryPdfInjectable.ts
View File

@@ -22,13 +22,12 @@ export class ARAgingSummaryPdfInjectable {
query: IARAgingSummaryQuery
): Promise<Buffer> {
const table = await this.ARAgingSummaryTable.table(tenantId, query);
const sheetName = 'AR Aging Summary';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

37
packages/server/src/services/FinancialStatements/AgingSummary/ARAgingSummaryService.ts
View File

@@ -1,18 +1,19 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { isEmpty } from 'lodash';
import { IARAgingSummaryQuery, IARAgingSummaryMeta } from '@/interfaces';
import { IARAgingSummaryQuery } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
import ARAgingSummarySheet from './ARAgingSummarySheet';
import { Tenant } from '@/system/models';
import { ARAgingSummaryMeta } from './ARAgingSummaryMeta';
@Service()
export default class ARAgingSummaryService {
@Inject()
tenancy: TenancyService;
private tenancy: TenancyService;
@Inject('logger')
logger: any;
@Inject()
private ARAgingSummaryMeta: ARAgingSummaryMeta;
/**
* 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.
* @param {number} tenantId - Tenant id.
@@ -110,11 +88,14 @@ export default class ARAgingSummaryService {
const data = ARAgingSummaryReport.reportData();
const columns = ARAgingSummaryReport.reportColumns();
// Retrieve the aging summary report meta.
const meta = await this.ARAgingSummaryMeta.meta(tenantId, filter);
return {
data,
columns,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

1
packages/server/src/services/FinancialStatements/AgingSummary/ARAgingSummaryTableInjectable.ts
View File

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

30
packages/server/src/services/FinancialStatements/AgingSummary/AgingSummaryMeta.ts Normal file
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,
};
}
}

10
packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetMeta.ts
View File

@@ -18,16 +18,14 @@ export class BalanceSheetMetaInjectable {
query: IBalanceSheetQuery
): Promise<IBalanceSheetMeta> {
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}`;
const formattedAsDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedDateRange = `As ${formattedAsDate}`;
return {
...commonMeta,
sheetName: 'Balance Sheet',
formattedFromDate,
formattedToDate,
formattedDateRange
formattedAsDate,
formattedDateRange,
};
}
}

1
packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetNetIncome.ts
View File

@@ -31,6 +31,7 @@ export const BalanceSheetNetIncome = (Base: any) =>
/**
* Retrieves the closing balance of income accounts.
* @returns {number}
*
*/
private getIncomeTotal = () => {
const closeingBalance = this.repository.incomeLedger.getClosingBalance();

4
packages/server/src/services/FinancialStatements/BalanceSheet/BalanceSheetTable.ts
View File

@@ -215,13 +215,13 @@ export default class BalanceSheetTable extends R.compose(
/**
* Retrieves the total children columns.
* @returns {ITableColumn[]}
* @returns {ITableColumn[]}
*/
private totalColumnChildren = (): ITableColumn[] => {
return R.compose(
R.unless(
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.getPreviousYearColumns()),

2
packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryApplication.ts
View File

@@ -15,7 +15,7 @@ export class CustomerBalanceSummaryApplication {
@Inject()
private customerBalanceSummarySheet: CustomerBalanceSummaryService;
@Inject()
private customerBalanceSummaryPdf: CustomerBalanceSummaryPdf;

35
packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryMeta.ts Normal file
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,
};
}
}

10
packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryPdf.ts
View File

@@ -1,5 +1,6 @@
import { Inject, Service } from 'typedi';
import { IAPAgingSummaryQuery, ICustomerBalanceSummaryQuery } from '@/interfaces';
import { ICustomerBalanceSummaryQuery } from '@/interfaces';
import { TableSheetPdf } from '../TableSheetPdf';
import { CustomerBalanceSummaryTableInjectable } from './CustomerBalanceSummaryTableInjectable';
@@ -12,7 +13,7 @@ export class CustomerBalanceSummaryPdf {
private tableSheetPdf: TableSheetPdf;
/**
* Converts the given A/P aging summary sheet table to pdf.
* Converts the given customer balance summary sheet table to pdf.
* @param {number} tenantId - Tenant ID.
* @param {IAPAgingSummaryQuery} query - Balance sheet query.
* @returns {Promise<Buffer>}
@@ -22,13 +23,12 @@ export class CustomerBalanceSummaryPdf {
query: ICustomerBalanceSummaryQuery
): Promise<Buffer> {
const table = await this.customerBalanceSummaryTable.table(tenantId, query);
const sheetName = 'Customer Balance Summary';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

11
packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryService.ts
View File

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

1
packages/server/src/services/FinancialStatements/CustomerBalanceSummary/CustomerBalanceSummaryTableInjectable.ts
View File

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

33
packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerMeta.ts Normal file
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,
};
}
}

17
packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerPdf.ts
View File

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

63
packages/server/src/services/FinancialStatements/GeneralLedger/GeneralLedgerService.ts
View File

@@ -6,9 +6,9 @@ import { IGeneralLedgerSheetQuery, IGeneralLedgerMeta } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
import Journal from '@/services/Accounting/JournalPoster';
import GeneralLedgerSheet from '@/services/FinancialStatements/GeneralLedger/GeneralLedger';
import InventoryService from '@/services/Inventory/Inventory';
import { transformToMap, parseBoolean } from 'utils';
import { transformToMap } from 'utils';
import { Tenant } from '@/system/models';
import { GeneralLedgerMeta } from './GeneralLedgerMeta';
const ERRORS = {
ACCOUNTS_NOT_FOUND: 'ACCOUNTS_NOT_FOUND',
@@ -17,13 +17,10 @@ const ERRORS = {
@Service()
export class GeneralLedgerService {
@Inject()
tenancy: TenancyService;
private tenancy: TenancyService;
@Inject()
inventoryService: InventoryService;
@Inject('logger')
logger: any;
private generalLedgerMeta: GeneralLedgerMeta;
/**
* 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.
* ----------
* @param {number} tenantId
* @param {IGeneralLedgerSheetQuery} query
* @return {IGeneralLedgerStatement}
@@ -103,13 +68,10 @@ export class GeneralLedgerService {
): Promise<{
data: any;
query: IGeneralLedgerSheetQuery;
meta: IGeneralLedgerMeta
meta: IGeneralLedgerMeta;
}> {
const {
accountRepository,
transactionsRepository,
contactRepository
} = this.tenancy.repositories(tenantId);
const { accountRepository, transactionsRepository, contactRepository } =
this.tenancy.repositories(tenantId);
const i18n = this.tenancy.i18n(tenantId);
@@ -133,13 +95,13 @@ export class GeneralLedgerService {
const transactions = await transactionsRepository.journal({
fromDate: filter.fromDate,
toDate: filter.toDate,
branchesIds: filter.branchesIds
branchesIds: filter.branchesIds,
});
// Retreive opening balance credit/debit sumation.
const openingBalanceTrans = await transactionsRepository.journal({
toDate: moment(filter.fromDate).subtract(1, 'day'),
sumationCreditDebit: true,
branchesIds: filter.branchesIds
branchesIds: filter.branchesIds,
});
// Transform array transactions to journal collection.
const transactionsJournal = Journal.fromTransactions(
@@ -147,7 +109,7 @@ export class GeneralLedgerService {
tenantId,
accountsGraph
);
// Accounts opening transactions.
// Accounts opening transactions.
const openingTransJournal = Journal.fromTransactions(
openingBalanceTrans,
tenantId,
@@ -167,10 +129,13 @@ export class GeneralLedgerService {
// Retrieve general ledger report data.
const reportData = generalLedgerInstance.reportData();
// Retrieve general ledger report metadata.
const meta = await this.generalLedgerMeta.meta(tenantId, filter);
return {
data: reportData,
query: filter,
meta: this.reportMetadata(tenantId, filter),
meta,
};
}
}

33
packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsMeta.ts Normal file
View File

@@ -0,0 +1,33 @@
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}`;
return {
...commonMeta,
sheetName: 'Inventory Details',
formattedFromDate,
formattedToDay,
formattedDateRange,
};
}
}

41
packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsService.ts
View File

@@ -1,17 +1,12 @@
import moment from 'moment';
import { Service, Inject } from 'typedi';
import {
IInventoryDetailsQuery,
IInvetoryItemDetailDOO,
IInventoryItemDetailMeta,
} from '@/interfaces';
import { IInventoryDetailsQuery, IInvetoryItemDetailDOO } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
import { InventoryDetails } from './InventoryDetails';
import FinancialSheet from '../FinancialSheet';
import InventoryDetailsRepository from './InventoryDetailsRepository';
import InventoryService from '@/services/Inventory/Inventory';
import { parseBoolean } from 'utils';
import { Tenant } from '@/system/models';
import { InventoryDetailsMetaInjectable } from './InventoryDetailsMeta';
@Service()
export class InventoryDetailsService extends FinancialSheet {
@@ -22,7 +17,7 @@ export class InventoryDetailsService extends FinancialSheet {
private reportRepo: InventoryDetailsRepository;
@Inject()
private inventoryService: InventoryService;
private inventoryDetailsMeta: InventoryDetailsMetaInjectable;
/**
* 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.
* @param {number} tenantId -
@@ -115,11 +83,12 @@ export class InventoryDetailsService extends FinancialSheet {
tenant.metadata.baseCurrency,
i18n
);
const meta = await this.inventoryDetailsMeta.meta(tenantId, query);
return {
data: inventoryDetailsInstance.reportData(),
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

17
packages/server/src/services/FinancialStatements/InventoryDetails/InventoryDetailsTablePdf.ts
View File

@@ -1,8 +1,7 @@
import { Inject, Service } from "typedi";
import { InventoryDetailsTableInjectable } from "./InventoryDetailsTableInjectable";
import { TableSheetPdf } from "../TableSheetPdf";
import { IInventoryDetailsQuery } from "@/interfaces";
import { Inject, Service } from 'typedi';
import { InventoryDetailsTableInjectable } from './InventoryDetailsTableInjectable';
import { TableSheetPdf } from '../TableSheetPdf';
import { IInventoryDetailsQuery } from '@/interfaces';
@Service()
export class InventoryDetailsTablePdf {
@@ -23,14 +22,12 @@ export class InventoryDetailsTablePdf {
query: IInventoryDetailsQuery
): Promise<Buffer> {
const table = await this.inventoryDetailsTable.table(tenantId, query);
const sheetName = 'Inventory Items Details';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}
}

33
packages/server/src/services/FinancialStatements/InventoryValuationSheet/InventoryValuationSheetMeta.ts Normal file
View File

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

5
packages/server/src/services/FinancialStatements/InventoryValuationSheet/InventoryValuationSheetPdf.ts
View File

@@ -23,13 +23,12 @@ export class InventoryValuationSheetPdf {
query: IInventoryValuationReportQuery
): Promise<Buffer> {
const table = await this.inventoryValuationTable.table(tenantId, query);
const sheetName = 'Inventory Valuation Sheet';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

36
packages/server/src/services/FinancialStatements/InventoryValuationSheet/InventoryValuationSheetService.ts
View File

@@ -10,6 +10,7 @@ import TenancyService from '@/services/Tenancy/TenancyService';
import { InventoryValuationSheet } from './InventoryValuationSheet';
import InventoryService from '@/services/Inventory/Inventory';
import { Tenant } from '@/system/models';
import { InventoryValuationMetaInjectable } from './InventoryValuationSheetMeta';
@Service()
export class InventoryValuationSheetService {
@@ -22,6 +23,9 @@ export class InventoryValuationSheetService {
@Inject()
inventoryService: InventoryService;
@Inject()
private inventoryValuationMeta: InventoryValuationMetaInjectable;
/**
* Defaults balance sheet filter query.
* @return {IBalanceSheetQuery}
@@ -46,33 +50,6 @@ export class InventoryValuationSheetService {
};
}
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): IInventoryValuationSheetMeta {
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 {
organizationName,
baseCurrency,
isCostComputeRunning,
};
}
/**
* Inventory valuation sheet.
* @param {number} tenantId - Tenant id.
@@ -136,10 +113,13 @@ export class InventoryValuationSheetService {
// Retrieve the inventory valuation report data.
const inventoryValuationData = inventoryValuationInstance.reportData();
// Retrieves the inventorty valuation meta.
const meta = await this.inventoryValuationMeta.meta(tenantId, filter);
return {
data: inventoryValuationData,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

34
packages/server/src/services/FinancialStatements/JournalSheet/JournalSheetMeta.ts Normal file
View File

@@ -0,0 +1,34 @@
import { Service, Inject } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import moment from 'moment';
import { IJournalReportQuery, IJournalSheetMeta } from '@/interfaces';
@Service()
export class JournalSheetMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieves the journal sheet meta.
* @param {number} tenantId
* @param {IJournalReportQuery} query
* @returns {Promise<IJournalSheetMeta>}
*/
public async meta(
tenantId: number,
query: IJournalReportQuery
): Promise<IJournalSheetMeta> {
const common = 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 {
...common,
formattedDateRange,
formattedFromDate,
formattedToDate,
};
}
}

5
packages/server/src/services/FinancialStatements/JournalSheet/JournalSheetPdfInjectable.ts
View File

@@ -22,13 +22,12 @@ export class JournalSheetPdfInjectable {
query: IJournalReportQuery
): Promise<Buffer> {
const table = await this.journalSheetTable.table(tenantId, query);
const sheetName = 'Journal Sheet';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

45
packages/server/src/services/FinancialStatements/JournalSheet/JournalSheetService.ts
View File

@@ -1,17 +1,12 @@
import { Service, Inject } from 'typedi';
import moment from 'moment';
import {
IJournalReportQuery,
IJournalSheet,
IJournalSheetMeta,
IJournalTableData,
} from '@/interfaces';
import { IJournalReportQuery, IJournalSheet } from '@/interfaces';
import JournalSheet from './JournalSheet';
import TenancyService from '@/services/Tenancy/TenancyService';
import Journal from '@/services/Accounting/JournalPoster';
import InventoryService from '@/services/Inventory/Inventory';
import { Tenant } from '@/system/models';
import { parseBoolean, transformToMap } from 'utils';
import { transformToMap } from 'utils';
import { JournalSheetMeta } from './JournalSheetMeta';
@Service()
export class JournalSheetService {
@@ -19,7 +14,7 @@ export class JournalSheetService {
private tenancy: TenancyService;
@Inject()
private inventoryService: InventoryService;
private journalSheetMeta: JournalSheetMeta;
/**
* Default journal sheet filter queyr.
@@ -38,33 +33,6 @@ export class JournalSheetService {
};
}
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): IJournalSheetMeta {
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,
};
}
/**
* Journal sheet.
* @param {number} tenantId
@@ -130,10 +98,13 @@ export class JournalSheetService {
// Retrieve journal report columns.
const journalSheetData = journalSheetInstance.reportData();
// Retrieve the journal sheet meta.
const meta = await this.journalSheetMeta.meta(tenantId, filter);
return {
data: journalSheetData,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

36
packages/server/src/services/FinancialStatements/PurchasesByItems/PurchasesByItemsMeta.ts Normal file
View File

@@ -0,0 +1,36 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import {
IPurchasesByItemsReportQuery,
IPurchasesByItemsSheetMeta,
} from '@/interfaces/PurchasesByItemsSheet';
@Service()
export class PurchasesByItemsMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the purchases by items meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IPurchasesByItemsReportQuery
): Promise<IPurchasesByItemsSheetMeta> {
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: 'Purchases By Items',
formattedFromDate,
formattedToDate,
formattedDateRange,
};
}
}

5
packages/server/src/services/FinancialStatements/PurchasesByItems/PurchasesByItemsPdf.ts
View File

@@ -22,13 +22,12 @@ export class PurchasesByItemsPdf {
query: IPurchasesByItemsReportQuery
): Promise<Buffer> {
const table = await this.purchasesByItemsTable.table(tenantId, query);
const sheetName = 'Purchases By Items';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

35
packages/server/src/services/FinancialStatements/PurchasesByItems/PurchasesByItemsService.ts
View File

@@ -6,19 +6,22 @@ import { Tenant } from '@/system/models';
import {
IPurchasesByItemsReportQuery,
IPurchasesByItemsSheet,
IPurchasesByItemsSheetMeta,
} from '@/interfaces/PurchasesByItemsSheet';
import { PurchasesByItemsMeta } from './PurchasesByItemsMeta';
@Service()
export class PurchasesByItemsService {
@Inject()
private tenancy: TenancyService;
@Inject()
private purchasesByItemsMeta: PurchasesByItemsMeta;
/**
* Defaults purchases by items filter query.
* @return {IPurchasesByItemsReportQuery}
*/
get defaultQuery(): IPurchasesByItemsReportQuery {
private get defaultQuery(): IPurchasesByItemsReportQuery {
return {
fromDate: moment().startOf('month').format('YYYY-MM-DD'),
toDate: moment().format('YYYY-MM-DD'),
@@ -35,29 +38,6 @@ export class PurchasesByItemsService {
};
}
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): IPurchasesByItemsSheetMeta {
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 balance sheet statement.
* -------------
@@ -109,10 +89,13 @@ export class PurchasesByItemsService {
);
const purchasesByItemsData = purchasesByItemsInstance.reportData();
// Retrieve the purchases by items meta.
const meta = await this.purchasesByItemsMeta.meta(tenantId, query);
return {
data: purchasesByItemsData,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

1
packages/server/src/services/FinancialStatements/SalesByItems/SalesByItems.ts
View File

@@ -1,4 +1,5 @@
import { get, sumBy } from 'lodash';
import * as R from 'ramda';
import FinancialSheet from '../FinancialSheet';
import { allPassedConditionsPass, transformToMap } from 'utils';

1
packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsApplication.ts
View File

@@ -1,4 +1,5 @@
import { Inject, Service } from 'typedi';
import {
ISalesByItemsReportQuery,
ISalesByItemsSheet,

33
packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsMeta.ts Normal file
View File

@@ -0,0 +1,33 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import { ISalesByItemsReportQuery, ISalesByItemsSheetMeta } from '@/interfaces';
@Service()
export class SalesByItemsMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieve the sales by items meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: ISalesByItemsReportQuery
): Promise<ISalesByItemsSheetMeta> {
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: 'Purchases By Items',
formattedFromDate,
formattedToDate,
formattedDateRange,
};
}
}

5
packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsPdfInjectable.ts
View File

@@ -22,13 +22,12 @@ export class SalesByItemsPdfInjectable {
query: ISalesByItemsReportQuery
): Promise<Buffer> {
const table = await this.salesByItemsTable.table(tenantId, query);
const sheetName = 'Sales By Items';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

43
packages/server/src/services/FinancialStatements/SalesByItems/SalesByItemsService.ts
View File

@@ -1,27 +1,24 @@
import { Service, Inject } from 'typedi';
import moment from 'moment';
import {
ISalesByItemsReportQuery,
ISalesByItemsSheetMeta,
ISalesByItemsSheet,
} from '@/interfaces';
import { ISalesByItemsReportQuery, ISalesByItemsSheet } from '@/interfaces';
import TenancyService from '@/services/Tenancy/TenancyService';
import SalesByItems from './SalesByItems';
import { Tenant } from '@/system/models';
import { SalesByItemsMeta } from './SalesByItemsMeta';
@Service()
export class SalesByItemsReportService {
@Inject()
tenancy: TenancyService;
private tenancy: TenancyService;
@Inject('logger')
logger: any;
@Inject()
private salesByItemsMeta: SalesByItemsMeta;
/**
* Defaults balance sheet filter query.
* @return {IBalanceSheetQuery}
*/
get defaultQuery(): ISalesByItemsReportQuery {
private get defaultQuery(): ISalesByItemsReportQuery {
return {
fromDate: moment().startOf('month').format('YYYY-MM-DD'),
toDate: moment().format('YYYY-MM-DD'),
@@ -38,29 +35,6 @@ export class SalesByItemsReportService {
};
}
/**
* Retrieve the balance sheet meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
reportMetadata(tenantId: number): ISalesByItemsSheetMeta {
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 balance sheet statement.
* @param {number} tenantId
@@ -112,10 +86,13 @@ export class SalesByItemsReportService {
);
const salesByItemsData = sheet.reportData();
// Retrieve the sales by items meta.
const meta = await this.salesByItemsMeta.meta(tenantId, query);
return {
data: salesByItemsData,
query: filter,
meta: this.reportMetadata(tenantId),
meta,
};
}
}

1
packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryApplication.ts
View File

@@ -44,6 +44,7 @@ export class SalesTaxLiabilitySummaryApplication {
* @param {number} tenantId
* @param {SalesTaxLiabilitySummaryQuery} query
* @returns {Promise<Buffer>}
*
*/
public xlsx(
tenantId: number,

32
packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryMeta.ts Normal file
View File

@@ -0,0 +1,32 @@
import { Inject, Service } from 'typedi';
import moment from 'moment';
import { SalesTaxLiabilitySummaryQuery } from '@/interfaces/SalesTaxLiabilitySummary';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
@Service()
export class SalesTaxLiabilitySummaryMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieves the report meta.
* @param {number} tenantId
* @param {SalesTaxLiabilitySummaryQuery} filter
*/
public async meta(tenantId: number, query: SalesTaxLiabilitySummaryQuery) {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedToDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedFromDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDate}`;
const sheetName = 'Sales Tax Liability Summary';
return {
...commonMeta,
sheetName,
formattedFromDate,
formattedToDate,
formattedDateRange,
};
}
}

36
packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabilitySummaryService.ts
View File

@@ -1,11 +1,8 @@
import { Inject, Service } from 'typedi';
import { SalesTaxLiabilitySummaryRepository } from './SalesTaxLiabilitySummaryRepository';
import {
SalesTaxLiabilitySummaryMeta,
SalesTaxLiabilitySummaryQuery,
} from '@/interfaces/SalesTaxLiabilitySummary';
import { SalesTaxLiabilitySummaryQuery } from '@/interfaces/SalesTaxLiabilitySummary';
import { SalesTaxLiabilitySummary } from './SalesTaxLiabilitySummary';
import HasTenancyService from '@/services/Tenancy/TenancyService';
import { SalesTaxLiabilitySummaryMeta } from './SalesTaxLiabilitySummaryMeta';
@Service()
export class SalesTaxLiabilitySummaryService {
@@ -13,7 +10,7 @@ export class SalesTaxLiabilitySummaryService {
private repostiory: SalesTaxLiabilitySummaryRepository;
@Inject()
private tenancy: HasTenancyService;
private salesTaxLiabilityMeta: SalesTaxLiabilitySummaryMeta;
/**
* Retrieve sales tax liability summary.
@@ -39,33 +36,12 @@ export class SalesTaxLiabilitySummaryService {
payableByRateId,
salesByRateId
);
const meta = await this.salesTaxLiabilityMeta.meta(tenantId, query);
return {
data: taxLiabilitySummary.reportData(),
query,
meta: this.reportMetadata(tenantId),
};
}
/**
* Retrieve the report meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
private reportMetadata(tenantId: number): SalesTaxLiabilitySummaryMeta {
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,
meta,
};
}
}

11
packages/server/src/services/FinancialStatements/SalesTaxLiabilitySummary/SalesTaxLiabiltiySummaryPdf.ts
View File

@@ -22,14 +22,15 @@ export class SalesTaxLiabiltiySummaryPdf {
tenantId: number,
query: SalesTaxLiabilitySummaryQuery
): Promise<Buffer> {
const table = await this.salesTaxLiabiltiySummaryTable.table(tenantId, query);
const sheetName = 'Sales Tax Liability Summary';
const table = await this.salesTaxLiabiltiySummaryTable.table(
tenantId,
query
);
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedDateRange
);
}
}

24
packages/server/src/services/FinancialStatements/TableSheetPdf.ts
View File

@@ -14,34 +14,34 @@ export class TableSheetPdf {
private chromiumlyTenancy: ChromiumlyTenancy;
/**
* Converts the table to PDF.
* @param {number} tenantId -
* @param {IFinancialTable} table -
* @param {string} sheetName - Sheet name.
* @param {string} sheetDate - Sheet date.
* Converts the table data into a PDF format.
* @param {number} tenantId - The unique identifier for the tenant.
* @param {ITableData} table - The table data to be converted.
* @param {string} sheetName - The name of the sheet.
* @param {string} sheetDate - The date of the sheet.
* @returns A promise that resolves with the PDF conversion result.
*/
public async convertToPdf(
tenantId: number,
table: ITableData,
sheetName: string,
sheetDate: string
) {
): Promise<Buffer> {
// Prepare columns and rows for PDF conversion
const columns = this.tablePdfColumns(table.columns);
const rows = this.tablePdfRows(table.rows);
// Generate HTML content from the template
const htmlContent = await this.templateInjectable.render(
tenantId,
'modules/financial-sheet',
{
sheetName,
sheetDate,
table: { rows, columns },
}
{ sheetName, sheetDate, table: { rows, columns } }
);
// Convert the HTML content to PDF
return this.chromiumlyTenancy.convertHtmlContent(tenantId, htmlContent, {
margins: { top: 0, bottom: 0, left: 0, right: 0 },
});
}
/**
* Converts the table columns to pdf columns.
* @param {ITableColumn[]} columns

1
packages/server/src/services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryApplication.ts
View File

@@ -72,5 +72,6 @@ export class VendorBalanceSummaryApplication {
*/
public pdf(tenantId: number, query: IVendorBalanceSummaryQuery) {
return this.vendorBalanceSummaryPdf.pdf(tenantId, query);
}
}

32
packages/server/src/services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryMeta.ts Normal file
View File

@@ -0,0 +1,32 @@
import moment from 'moment';
import { Inject, Service } from 'typedi';
import { FinancialSheetMeta } from '../FinancialSheetMeta';
import {
IVendorBalanceSummaryMeta,
IVendorBalanceSummaryQuery,
} from '@/interfaces';
@Service()
export class VendorBalanceSummaryMeta {
@Inject()
private financialSheetMeta: FinancialSheetMeta;
/**
* Retrieves the vendor balance summary meta.
* @param {number} tenantId -
* @returns {IBalanceSheetMeta}
*/
public async meta(
tenantId: number,
query: IVendorBalanceSummaryQuery
): Promise<IVendorBalanceSummaryMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedAsDate = moment(query.asDate).format('YYYY/MM/DD');
return {
...commonMeta,
sheetName: 'Vendor Balance Summary',
formattedAsDate,
};
}
}

6
packages/server/src/services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryPdf.ts
View File

@@ -22,13 +22,13 @@ export class VendorBalanceSummaryPdf {
query: IVendorBalanceSummaryQuery
): Promise<Buffer> {
const table = await this.vendorBalanceSummaryTable.table(tenantId, query);
const sheetName = 'Sales By Items';
return this.tableSheetPdf.convertToPdf(
tenantId,
table.table,
sheetName,
table.meta.baseCurrency
table.meta.sheetName,
table.meta.formattedAsDate
);
}
}

15
packages/server/src/services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryService.ts
View File

@@ -12,15 +12,21 @@ import { VendorBalanceSummaryReport } from './VendorBalanceSummary';
import Ledger from '@/services/Accounting/Ledger';
import VendorBalanceSummaryRepository from './VendorBalanceSummaryRepository';
import { Tenant } from '@/system/models';
import { JournalSheetMeta } from '../JournalSheet/JournalSheetMeta';
import { VendorBalanceSummaryMeta } from './VendorBalanceSummaryMeta';
export class VendorBalanceSummaryService
implements IVendorBalanceSummaryService
{
@Inject()
tenancy: TenancyService;
private tenancy: TenancyService;
@Inject()
reportRepo: VendorBalanceSummaryRepository;
private reportRepo: VendorBalanceSummaryRepository;
@Inject()
private vendorBalanceSummaryMeta: VendorBalanceSummaryMeta;
/**
* Defaults balance sheet filter query.
@@ -43,6 +49,7 @@ export class VendorBalanceSummaryService
}
/**
*
* Retrieve the vendors ledger entrjes.
* @param {number} tenantId -
* @param {Date|string} date -
@@ -97,11 +104,13 @@ export class VendorBalanceSummaryService
filter,
tenant.metadata.baseCurrency
);
// Retrieve the vendor balance summary meta.
const meta = await this.vendorBalanceSummaryMeta.meta(tenantId, filter);
return {
data: reportInstance.reportData(),
query: filter,
meta: {}
meta
};
}
}

1
packages/server/src/services/FinancialStatements/VendorBalanceSummary/VendorBalanceSummaryTableInjectable.ts
View File

@@ -29,6 +29,7 @@ export class VendorBalanceSummaryTableInjectable {
const { data, meta } =
await this.vendorBalanceSummarySheet.vendorBalanceSummary(
tenantId,
query
);