You can generate balance platform reports automatically according to a specific schedule, or manually on-demand.
Requirements
| Requirement | Description |
|---|---|
| API credential roles | To Download reports make sure that you have the following role:
|
| Customer Area roles | Make sure that you have the following roles:
|
| Webhooks | Subscribe to the following webhook(s): |
Generate reports
Get updates when a report is available
To get updates when a balance platform report is generated and available for download, listen to the balancePlatform.report.created webhook. The webhook contains the URL at which you can download the report.
Download reports
All reports are generated in CSV format. You can also generate the Accounting report in TSV format. We recommend that you create a script to load the reports and reconcile into your systems. Alternatively, you can use any spreadsheet software to open the file and reconcile manually.
You can download reports manually from your Balance Platform Customer Area, or programmatically by making an HTTP GET request.