chore(server): document methods

This commit is contained in:
Ahmed Bouhuolia
2023-08-27 00:56:14 +02:00
parent 0d57ca88bf
commit 5dec4a7df0
4 changed files with 7 additions and 9 deletions

View File

@@ -34,8 +34,8 @@ export default class APAgingSummaryReportController extends BaseFinancialReportC
...this.sheetNumberFormatValidationSchema,
query('as_date').optional().isISO8601(),
query('aging_days_before').default(30).isNumeric().toInt(),
query('aging_periods').default(3).isNumeric().toInt(),
query('aging_days_before').default(30).isInt({ max: 500 }).toInt(),
query('aging_periods').default(3).isInt({ max: 12 }).toInt(),
query('vendors_ids').optional().isArray({ min: 1 }),
query('vendors_ids.*').isInt({ min: 1 }).toInt(),

View File

@@ -121,10 +121,9 @@ export default class PayableAgingSummaryService {
}
/**
*
* Retrieves A/P aging summary in table format.
* @param {number} tenantId
* @param {IAPAgingSummaryQuery} query
* @returns
*/
async APAgingSummaryTable(tenantId: number, query: IAPAgingSummaryQuery) {
const report = await this.APAgingSummary(tenantId, query);

View File

@@ -91,7 +91,7 @@ export default class APAgingSummarySheet extends AgingSummaryReport {
return {
vendorName: vendor.displayName,
current: this.formatTotalAmount(currentTotal),
current: this.formatAmount(currentTotal),
aging: agingPeriods,
total: this.formatTotalAmount(amount),
};

View File

@@ -120,10 +120,9 @@ export default class ARAgingSummaryService {
}
/**
*
* @param tenantId
* @param query
* @returns
* Retrieves A/R aging summary in table format.
* @param {number} tenantId
* @param {IARAgingSummaryQuery} query
*/
async ARAgingSummaryTable(tenantId: number, query: IARAgingSummaryQuery) {
const report = await this.ARAgingSummary(tenantId, query);