Reports: get sums report
reports_get_sumsFetches a completed sums and balances report from the accounting system. Use this after the report has finished generating to retrieve the final data.
Instructions
🟢 READ-ONLY: Fetches data. Makes no changes to the accounting records.
get sums report
Returns a previously created sums report ("Summen- und Saldenliste").
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 sums and balances report that reports_create_sums has finished generating. Step two of two.
For the individual bookings behind one posting account, use reports_get_sums_ledger.
Endpoint: POST /reports/get/sums
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', 'pdf' and 'csv_archive', 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', 'countPostingsWithDateVatEffectiveNotConsideredInReport' and 'sums'. The sums are keyed by postingaccount number, and every entry provides the 'postingaccount' itself as well as the unformatted values 'balanceBeforeDebit', 'balanceBeforeCredit', 'balanceBeforeAbsolute', 'balanceBeforeSide', 'sumPeriodDebit', 'sumPeriodCredit', 'balanceAfterDebit', 'balanceAfterCredit', 'balanceAfterAbsolute' and 'balanceAfterSide'. | |
| message | No | blank | |
| success | Yes | Success boolean |