feat(server): financial reports meta

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

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

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

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

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

View File

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

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,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 {
@@ -51,4 +55,4 @@ export interface ISalesByItemsSheet {
export interface ISalesByItemsTable extends IFinancialTable { export interface ISalesByItemsTable extends IFinancialTable {
query: ISalesByItemsReportQuery; query: ISalesByItemsReportQuery;
meta: ISalesByItemsSheetMeta; meta: ISalesByItemsSheetMeta;
} }

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,
@@ -40,3 +41,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 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,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

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

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

@@ -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

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

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

@@ -18,16 +18,14 @@ export class BalanceSheetMetaInjectable {
query: IBalanceSheetQuery query: IBalanceSheetQuery
): Promise<IBalanceSheetMeta> { ): Promise<IBalanceSheetMeta> {
const commonMeta = await this.financialSheetMeta.meta(tenantId); const commonMeta = await this.financialSheetMeta.meta(tenantId);
const formattedToDate = moment(query.toDate).format('YYYY/MM/DD'); const formattedAsDate = moment(query.toDate).format('YYYY/MM/DD');
const formattedFromDate = moment(query.fromDate).format('YYYY/MM/DD'); const formattedDateRange = `As ${formattedAsDate}`;
const formattedDateRange = `From ${formattedFromDate} | To ${formattedToDate}`;
return { return {
...commonMeta, ...commonMeta,
sheetName: 'Balance Sheet', sheetName: 'Balance Sheet',
formattedFromDate, formattedAsDate,
formattedToDate, formattedDateRange,
formattedDateRange
}; };
} }
} }

View File

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

View File

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

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

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

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

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,11 +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: {} meta,
}; };
} }
} }

View File

@@ -25,6 +25,7 @@ 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, meta } = const { data, query, meta } =
await this.customerBalanceSummaryService.customerBalanceSummary( await this.customerBalanceSummaryService.customerBalanceSummary(

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

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

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(
@@ -147,7 +109,7 @@ export class GeneralLedgerService {
tenantId, tenantId,
accountsGraph accountsGraph
); );
// Accounts opening transactions. // Accounts opening transactions.
const openingTransJournal = Journal.fromTransactions( const openingTransJournal = Journal.fromTransactions(
openingBalanceTrans, openingBalanceTrans,
tenantId, tenantId,
@@ -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,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,
};
}
}

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,
}; };
} }
} }

View File

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

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,
};
}
}

View File

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

View File

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

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,
};
}
}

View File

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

View File

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

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,
};
}
}

View File

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

View File

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

View File

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

View File

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

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,
};
}
}

View File

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

View File

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

View File

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

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,
};
}
}

View File

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

View File

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

View File

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

View File

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

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,
};
}
}

View File

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

View File

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

View File

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