Run Reports

get

https://api.cloud.mbanq.com/v1/runreports/{reportName}

To understand the reports API please refer to Introduction to Reports.

Purpose - Use the Run Reports endpoint to run and receive specific reporting data from the database by passing the report name as a path parameter. Reports are pre-configured in the system according to bank requirements.

Behaviour - The default output is a JSON-formatted key value pairs which includes both column headings and data of the database query associated with the report. To export this result to CSV format, simply append "&exportCSV=true" to the end of your URL.

If the configuration for flexible report generation is enabled, the output method will be determined based on the preferred output type and the record count in the report. The output method can be one of the following: Email, Download, or Display.

Additionally, if Pentaho reports have been pre-defined, they can be executed through this endpoint. Pentaho reports can be returned in HTML, PDF, or CSV formats. To understand Pentaho integration refer to Pentaho Official Website

Example Requests:

runreports/Client%20Listing?R_officeId=1
runreports/Client%20Listing?R_officeId=1&exportCSV=true

Path Params

reportName

string

required

Defaults to Client Listing

Report Name Example: Client Listing

Query Params

R_officeId

string

Defaults to 1

Office ID parameter for the report. This is a commonly used parameter for filtering reports by office.

R_loanOfficerId

string

Defaults to -1

Loan Officer ID parameter for the report. Use -1 to include all loan officers.

R_{parameterName}

object

Additional dynamic report parameters. Use this pattern to pass any other parameters required for the report. The parameter names are case-sensitive and must be prefixed with "R_". You can pass multiple additional dynamic parameters with different names and values beyond the default R_officeId and R_loanOfficerId. Examples: - R_startDate=2024-01-01 - R_endDate=2024-12-31 - R_status=ACTIVE - R_currencyId=USD

genericResultSet

string

Use this field to specify the output format of the report. The default output is a JSON-formatted "Generic Resultset," which includes both column headings and data. Example: true

exportCSV

string

Use this field to export the result to CSV format instead of JSON format. This field is not applicable for Pentaho reports. Example: true

output-type

string

Use this field to specify the output type of the report. This field is only applicable for Pentaho reports. Example: HTML, PDF, CSV

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200The report data is retrieved successfully.