Reports on request

The reports on request is an asynchronous report generation functionality, which can support larger reports, compared to the regular reports. For the reports on request, you will first post the report request, and then get the report in a separate call.

Step-by-step guide

1. Request a report via POST/api/v2/reports/request
   1. Define the report type you want to generate.
      1. Some reports may require additional parameters—some mandatory, others optional.
      2. Some reports, additional values can be included or existing ones can be excluded. Details are described in the API reference.
   2. A request-id is returned. Save this id for the following steps.
2. Check status of your request GET/api/v2/reports/{request-id}/get-status
   1. Reports typically generate within 30 seconds. Longer wait times may occur for larger reports or during high-traffic periods
   2. A reportId is returned only when a report has been successfully generated. Save this id for the following steps
      1. If the creation of the report is still in progress, we will return a retry value in seconds
3. Get list of all requested report GET/api/v2/reports/requests/requested-reports
   1. Optional. This endpoint is not required to generate a report.
4. Download your report [GET/api/v1/reports/download-report/{reportId}](ref:get_api-v1-reports-download-report-reportid)
   1. A report can be downloaded once it has a Processed status. The reportId is the only required information for this step.

📘

request-id vs. reportId

The request-id and reportId is not the same. The request-id is first used, because at the time of creation the report has not yet been assigned an Id

Account activity report

Post: api/v2/reports/requests/account-activity-report

Example:

{  
  "reportFormatType": "json",  
  "accountId": "78343563-F427-4F4F-09E1-2863145BE9AD",  
  "fromTransactionDate": "2021-11-01",  
  "toTransactionDate": "2021-11-02",  
  "includeProperties": [  
    "string"  
  ],  
  "excludeProperties": [  
    "string"  
  ],  
  "name": "My custom report name"  
}

Reconciliation report

Post: api/v2/reports/requests/reconciliation-report

Example:

{  
  "reportFormatType": "json",  
  "fromTransactionDate": "2001-11-01",  
  "toTransactionDate": "2001-11-01",  
  "includeProperties": [  
    "string"  
  ],  
  "excludeProperties": [  
    "string"  
  ],  
  "accountIds": [  
    "402AF997-14ED-26B7-6269-E50D4C865958",  
    "AB89F333-908A-DC79-4BE9-E368A0908C26"  
  ],  
  "name": "My custom report name"  
}

Account balance report

Post: api/v2/reports/requests/account-balance-report

Example:

{  
  "reportFormatType": "json",  
  "name": "My custom report name"  
}

Rejection report

Post: api/v2/reports/requests/rejection-report

Example:

{  
  "reportFormatType": "json",  
  "transactionDate": "2022-11-01",  
  "includeReceived": true,  
  "includeMissingFunds": true,  
  "name": "My custom report name"  
}

Bank statement report

Post: api/v2/reports/requests/bank-statement-report

Example:

{  
  "reportFormatType": "pdf",  
  "accountId": "78343563-F427-4F4F-09E1-2863145BE9AD",  
  "fromValueDate": "2021-11-01",  
  "toValueDate": "2021-11-02",  
  "name": "My custom report name"  
}

Company account balance report

Post: api/v2/reports/requests/company-account-balance-report

Example:

 {  
  "reportFormatType": "json",  
  "companyId": "78343563-F427-4F4F-09E1-2863145BE9AD",  
  "valueDate": "2021-11-01",  
  "accountIds": [  
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"  
  ],  
  "name": "My custom report name"  
}

Bank to customer report

Post: api/v2/reports/requests/bank-to-customer-report

Example:

 {  
  "reportFormatType": "xml",  
  "transactionDate": "2022-11-01",  
  "name": "My custom report name"  
}