Generate Account Statement

post

https://api.cloud.mbanq.com/v1/generatestatements

Use this API to generate a PDF statement for a savings account over a specified date range. Statement generation is asynchronous — the response returns a jobId that you can use to track the progress.

How It Works

Statement generation follows a three-step process:

Generate — Call this API to trigger statement generation. A jobId is returned with status ACCEPTED.
Check Status — Poll GET /v1/runreports/jobHistory/{jobId} to check when the job is complete.
Download — Once complete, use the Get Account Document Details API to retrieve the documentId, then download the PDF using the document download endpoint.

Request Body Fields

Field	Description
`reportName`	The name of the report template to use (e.g., `Report current and saving account(Pentaho)`).
`parentEntityType`	The entity type. Use `savings` for savings accounts.
`parentEntityId`	The ID of the savings account to generate the statement for.
`reportType`	Output format. Use `PDF`.
`docType`	Document type. Use `statement`.
`params.start_date`	Start date of the statement period (format: `YYYY-MM-DD`).
`params.end_date`	End date of the statement period (format: `YYYY-MM-DD`).
`params.saving_no`	The savings account number (same as `parentEntityId`).

For a full walkthrough, see: Account Statement Guide

Body Params

reportName

string

required

Defaults to Report current and saving account(Pentaho)

The Report Name which is used for generating the statement. Pattern: '^[a-zA-Z]+$' Example: 'Report current and saving account(Pentaho)'

parentEntityType

string

required

Defaults to savings

The statement is generated for a specific entity type. Allowed values are. 1. clients 2. loans 3. savings 4. client_identifiers 5. creditcards Example: clients`

parentEntityId

integer

required

Defaults to 1

The Id of the parent entity type. Pattern: '^\d+$' Example: 2

reportType

string

enum

required

Defaults to PDF

Specifies the desired format for the generated report. Default Values are in the dropdown.

Allowed:

docType

string

required

Defaults to statement

The type of the document. Example: statement

params

object

required

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:

Responses

200The account statement is generated successfully.

400The request failed validation. Common causes include missing required reporting parameters.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to generate account statements.

404The request fails if the specified account does not exist.