Reports: create sums report
reports_create_sumsRequest a sums and balances report (Summen- und Saldenliste) for all posting accounts. Returns an ID to retrieve the report once generated.
Instructions
๐ก WRITE ยท creates data: Creates new records (receipts, transactions, postings, invoices, master data). Not idempotent: calling twice may create duplicates.
create sums report
Triggers the creation of a sums report ("Summen- und Saldenliste"). The report is always created for all of the customer's postingaccounts.
The report is generated asynchronously in the background. The response contains the id_by_customer of the created report, which may be used to retrieve it once the generation has been finished.
A new report may only be requested once the generation of a previously requested report of the same type has been finished.
Use to request a sums and balances report (Summen- und Saldenliste). Step one of two.
To read the finished report, call reports_get_sums afterwards.
Runs asynchronously and returns an id. A new report may only be requested once the previous one has finished, and it replaces the previous one.
Endpoint: POST /reports/create/sums
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | The date the postings are taken into account by. Can be either 'date' ("Buchungsdatum") or 'date_delivery_else_date' ("Buchungs- und Leistungsdatum"). If specified, the field will be validated. | |
| date_to | Yes | The last day of the period the report is created for, in format 'YYYY-MM-DD' (e.g. '2026-03-31'). | |
| file_csv | No | If true, a csv file will be created for the report additionally. If specified, the field will be validated. | |
| file_pdf | No | If true, a pdf file will be created for the report additionally. If specified, the field will be validated. | |
| date_from | Yes | The first day of the period the report is created for, in format 'YYYY-MM-DD' (e.g. '2026-01-01'). | |
| archive_export | No | If true, a zip archive containing the csv file and the postingaccount ledgers ("Kontenblätter") will be created for the report additionally. If specified, the field will be validated. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | blank | |
| success | Yes | Success boolean | |
| id_by_customer | No | The id_by_customer of the created report |