Automated Report Generation

The Automated Report Generation is a feature of the Reeve platform that allows users to automatically generate financial reports based on predefined templates and published transactions. This feature streamlines the reporting process, ensuring that reports are created consistently and accurately without manual intervention. The idea is that reports reflect the financial data, which is based on the transactions of an organisation. Only published transactions are considered for the report generation, ensuring that the reports are based on verified and immutable data.

How it works

The Automated Report generation can be configured via the database. It will run automatically in the background and generate reports based on the configured report types and fields.

Database configuration

The reports are defined in the database in the table organisation_report_setup. Initially Reeve has two types of reports: Balance Sheet and Income Statement. This can be extended in the future. Each report can have multiple fields (e.g. PROFIT_FOR_THE_YEAR). These fields are mapped to reports in the database table organisation_report_setup_field.

It is possible to add detailed processing information to each field. The configurations are:

• accumulated: The data of this field is accumulated over this and all previous years.
• accumulated_yearly: The data of this field is accumulated over the current year.
• accumulated_previous_year: The data of this field is accumulated over the previous year.
• negate: The data of this field is negated, meaning that the sign is flipped (e.g. from positive to negative).

Mapping Data

Report fields must be mapped to data sources. Fields can be mapped via two different ways:

• Other report fields - Database table organisation_report_setup_field_report_field_mapping
• Chart of account subtypes - Database table organisation_report_setup_field_subtype_mapping

These mappings are taken into account when calculating the value of the respective report field for the accounting period.

Calculation

When a report generation is requested, the system will:

• Calculate the start and beginning of the report period based on the report type and the organisation’s fiscal year settings.
• Retrieve all published transactions and published reports that are mapped to the report fields for the organisation within the specified period.
• Apply the mappings and calculations defined in the report setup to generate the report data.
• Return it as a structured report object, which can be accessed via the API or the Reeve UI. (The data won’t be saved, since Reeve wants the user to be able to review the report before saving it.)

API

Reeve accounting core is providing the automatic report generation via the API endpoint /api/report-generate. This endpoint can be used to trigger the report generation process for a specific organisation and report type. It will return the prefilled data object for the requested report. The request body should contain the organisation ID, the report type and the report period:

{
  "organisationId": "75f95560c1d883ee7628993da5adf725a5d97a13929fd4f477be0faf5020ca94",
  "reportType": "INCOME_STATEMENT",
  "intervalType": "YEAR",
  "year": 2023,
  "period": 3
}