Reports: get bwa report
reports_get_bwaFetch a completed BWA report that was generated previously. Returns the report data, with optional files when requested.
Instructions
🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.
get bwa report
Returns a previously created BWA report ("Betriebswirtschaftliche Auswertung").
Reports are generated asynchronously, so a report is only available once its generation has been finished. Note that creating a new report of the same type replaces the previously created one.
Use to read a BWA that reports_create_bwa has finished generating. Step two of two.
Returns nothing useful until generation has finished. If the report is not ready, wait and retry rather than requesting a new one, since a new request replaces the pending one.
Endpoint: POST /reports/get/bwa
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| get_files | No | If true, the report's files will be included as base64 encoded strings. If specified, the field will be validated. | |
| report_id_by_customer | Yes | The id_by_customer of the report, as returned when the report was created |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | No | Only contained if get_files has been specified. Provides the keys 'csv' and 'pdf', each holding the base64 encoded content of the report's file, or null if the file is not available – because it has not been requested when the report was created, because it is still being created or because it is not available anymore. | |
| report | No | The report's data, containing the keys 'integrityError', 'standardChart', 'usedCostLocations', 'usedPostingaccountsNumbers', 'postingsRecordsCount', 'uncompletedPostingsCount', 'groups' and 'totals'. The groups hold their classes, which in turn hold their postingaccounts. Every group, class, postingaccount and total provides its amount as the unformatted value 'amountsSum'. | |
| message | No | blank | |
| success | Yes | Success boolean |