This page describes how to retrieve real-time reports via our reporting API service.
The API consists of a web service that accepts and processes SOAP requests from a remote location over TCP/IP. Report file data is returned real-time via the API.
SOAP Method: GenerateReport
POSThttps://demo.bambora.co.nz/interface/api/report.asmx
<rep:GenerateReport>
<rep:userName>your_api_username</rep:userName>
<rep:password>your_api_password</rep:password>
<rep:accountNumber>your_accountnumber</rep:accountNumber>
<rep:reportID>your_reportID</rep:reportID>
<rep:reportFormatID>4</rep:reportFormatID>
<rep:sDate>2017-04-01</rep:sDate>
<rep:eDate>2017-05-01</rep:eDate>
<rep:parmList></rep:parmList>
</rep:GenerateReport>
REQUEST BODY SCHEMA
The list below provides an overview of the available transaction elements that should be submitted in the XML request.
| Parameter | Format | REQUIRED OPTIONAL | Description |
|---|---|---|---|
| Username | Alpha/Num | Required | API Username |
| Password | Alpha/Num | Required | API Password |
| AccountNumber | Alpha/Num | Required | This is a special parameter that can generate a report for a specific node within the account tree hierarchy. |
| ReportID | Numeric | Required | The report #. Please login to Bambora Backoffice to find the reportID. By default the below reports are provided when you are onboarded: 1. All Transaction Detail V2 (CSV only) 2. Daily Settlement Reconcilliation Report (Adobe Acrobat only) |
| ReportFormatID | Integer | Required | This specifies the report file type. Please see valid ID below: 1 - Adobe Acrobat PDF (Default) 3 - Microsoft Excel 4 - CSV (Comma Delimited) 5- Rich Text Format 6- TIFF image 99 - Raw Data |
| sDate | Alpha/Num | Optional | Report date range start date. Format must be yyyy-mm-dd. If report does not require it leave blank. |
| eDate | Alpha/Num | Optional | Report date range end date. Format must be yyyy-mm-dd. If report does not require it leave blank. |
| ParmList | Alpha/Num | Optional | Additional parameters needed by the report in a comma-delimited list (do not include quotes). If report does not require additional parameters leave blank. |
RESPONSE
<GenerateReportResult>
<resultSummary>0</resultSummary>
<resultMessage>Report file data generated OK</resultMessage>
<b64ReportFileData>_STRING RESULT_</b64ReportFileData>
<reportFileName>AllTransactionDetail_20160928.csv</reportFileName>
</GenerateReportResult>
RESPONSE BODY SCHEMA
| Parameter | Description |
|---|---|
| resultSummary | 0 - Report file data generated OK 1 - Invalid username/password 2 - User does not have permission to generate report files 3 - Report cannot be generated based upon supplied parameters 99 - Exception encountered |
| resultMessage | Contains a textual description of the result. Including a list of any exceptions encountered. |
| b64ReportFileData | The base64 encoded report file data. Will be blank if an exception is encountered. |