@mbanq/core-sdk-js v0.50.0

---

@mbanq/core-sdk-js / commands / RunReport

Function: RunReport()

RunReport(data): Command<{ data: objectOutputType; }, Record<string, any>[] | { columnHeaders: object[]; data: object[]; metaData: { count: number; message: string; outputMethodDerived: string; }; }>

Defined in: src/commands/rest/report.ts:161

Executes a report with specified parameters and returns the results. Supports dynamic parameters, multiple output formats, and optional CSV export.

Parameters

data

objectOutputType

The request parameters for running the report

Returns

Command<{ data: objectOutputType; }, Record<string, any>[] | { columnHeaders: object[]; data: object[]; metaData: { count: number; message: string; outputMethodDerived: string; }; }>

A command that executes the report and returns results. Response type is RunReportGenericResponse if genericResultSet is true, otherwise RunReportResponse

Example

const command = RunReport({
  reportName: 'Client Listing',
  genericResultSet: false,
  exportCSV: true,
  outputType: 'PDF',
  R_officeId: 123,
  R_loanOfficerId: 456,
  R_start_date: '2025-12-01',
  R_end_date: 2025-12-31,
  R_saving_no: '000000016'
});
const reportResults = await client.request(command);