Repository navigation
User Documentation [EN]
The Main Page serves as the central hub of the application. It is available at:
<base-url>/ or <base-url>/main
To open the page, select Main View in the navigation drawer or navigate to the application root.
The page displays hub cards that provide direct access and quick descriptions for all major sections:
- Manage Shareholders: Navigate to shareholder master data management.
- Manage Bookings: Record and edit financial bookings and transaction summaries.
- Account Statements: View, adjust, reorder, and export annual shareholder account statements.
- Interest Calculation: Calculate monthly and annual interest on shareholder balances.
- Export: Generate batch exports for shareholders across multiple views in PDF and Excel formats.
- Backup: Create and download database backups.
Clicking on any card navigates directly to the corresponding page.
The Shareholders page provides an overview of the shareholders managed by the application. It is available at:
<base-url>/shareholders
To open the page, select the Shareholders item in the navigation.
The page contains a table showing the current shareholders.
A new shareholder can be created by clicking the Add Shareholder button. This displays entry fields for:
- An optional ID, which is displayed in PDF and XLSX exports
- The shareholder’s first name
- The shareholder’s last name
After entering the shareholder’s data, click Save to create the shareholder. To discard the entered data, click Cancel next to the entry fields.
Each shareholder row contains a list of available actions. These actions allow you to edit or delete the corresponding shareholder.
Clicking Edit makes the shareholder’s ID, first name, and last name editable. Click Save to persist the changes. Clicking Cancel discards the changes and restores the previous values.
Clicking Delete opens a confirmation dialog asking whether the shareholder, including all associated data, should be deleted. Click Delete in the dialog to confirm the deletion. Clicking Cancel closes the dialog without deleting the shareholder.
The Delete button may be disabled depending on the configured deletion mode. When the deletion mode is set to RESTRICT, a shareholder cannot be deleted if other data is still associated with that shareholder. In this case the associated data must be deleted before the shareholder can be deleted. This is intended to prevent accidental deletion of shareholders.
By default the mode is set to CASCADE, which will delete the shareholder and their associated data.
The Bookings page is used to manage all financial bookings for a selected shareholder and year, configure opening balances, and maintain reusable comment templates. It is available at:
<base-url>/bookings
To open the page, select the Bookings item in the navigation.
The page is split into two tabs:
- Bookings: Displays the bookings table, opening balance, and action bar for the chosen shareholder and year.
- Comment Templates: Manages reusable text templates suggested when adding or editing bookings.
Before bookings can be displayed or edited, select:
- A Shareholder (searchable by name or ID)
- A Year
Use the shareholder and year selectors in the header of the page. Once selected, URL query parameters (?shareholder=<id>&year=<year>) are updated automatically to preserve your selection across views and refreshes.
The Opening Balance input field allows setting the starting balance for the selected year. Entering a valid opening balance value immediately saves it as a user-defined balance. An invalid or non-numeric amount visually marks the field as invalid and does not save the invalid value.
The Update this shareholder's opening balance for next year automatically checkbox controls whether the final computed balance of the selected year automatically transfers to the subsequent year as its opening balance.
- When enabled, any balance recalculation in the current year automatically updates or creates the system-generated opening balance for the following year.
- If a user already manually entered an opening balance for the next year, enabling this setting triggers a warning dialog asking for confirmation before overwriting the existing value.
- If the subsequent year is locked, this toggle is disabled.
Click the Add Booking button in the header action bar to open the Add Booking dialog.
The dialog contains the following fields:
- Shareholder: Select the shareholder for the booking.
- Date: Select the booking date. If the chosen year is locked for this shareholder, validation prevents saving.
- Type: Select the booking type (e.g. Withdrawals, Tax Prev. Years, Tax Credit, Interest, Compensation).
- Comment: Enter a comment or select from suggested templates. You can also type custom text.
- Amount: Enter the transaction amount. The amount must be non-zero and formatted according to your locale currency settings.
- Add another: When checked, saving the booking keeps the dialog open and resets fields for consecutive entry while retaining the shareholder and date.
Click Save to persist the booking or Cancel to discard. If an identical booking (matching shareholder, type, date, and comment) already exists, a duplicate warning dialog is displayed to prevent accidental duplicate entries.
Each row in the bookings table contains action buttons:
- Edit: Opens the Edit Booking dialog to modify booking details. Note: If an interest booking was automatically generated by the system, clicking edit directs you directly to the Interest Calculation page instead to edit the value there.
- Delete: Opens a confirmation dialog detailing the booking type, date, and amount. Confirming removes the booking and recalculates all row totals and running balances.
The bookings table breaks down all records throughout the year and includes:
- Booking ID: Sequential booking identifier.
- Date: Transaction date.
- Comment: Booking description text.
- Total: Total row transaction amount.
- Booking Type Columns: Separate columns categorized by type (Withdrawals, Tax Prev. Years, Tax Credit, Interest, Compensation).
- Balance: The running balance after applying the row transaction.
- Monthly & Cumulative Summaries: Distinct summary rows showing monthly totals and cumulative running totals across the year.
The lock button in the header bar allows you to lock the selected year for the shareholder:
- When locked, the opening balance field becomes read-only, the Add Booking button is disabled, existing bookings cannot be edited or deleted, and automatic balance updates cannot modify the year.
- Clicking the lock button opens a confirmation dialog.
- Clicking unlock allows reopening a locked year after confirming the dialog.
Click the print/PDF icon in the header bar to immediately download a formatted PDF report of the current year's bookings for the selected shareholder.
Switching to the Comment Templates tab allows creating and managing reusable booking comment descriptions.
- Add Template: Click Add Template to open a dialog where you can enter description text and select which booking types the template applies to (or leave blank to make it available for all booking types).
- Edit: Click the edit button on any template row to adjust its text or associated booking types.
- Delete: Click the delete button and confirm the dialog to remove a template.
Templates configured here appear automatically in the comment dropdown when adding or editing bookings of matching types.
The Account Statements page presents the annual account statement overview for a selected shareholder and year, showing opening balances, automatically grouped booking totals, and manual statement adjustments. It is available at:
<base-url>/account-statements
To open the page, select the Account Statements item in the navigation.
Use the shareholder and year pickers in the header bar to select the desired record.
The main table presents an overview of all statement entries for the year:
- Booking: Reference identifier.
- Date: Date of the transaction.
- Type: A descriptive comment the user entered.
- Debit: Outgoing amounts.
- Credit: Incoming amounts.
- Balance: Cumulative balance after the row entry.
- Actions: Contextual action buttons for each row.
Below the main statement table, the Closing Statement table displays the final closing balance as of December 31st of the selected year.
Entries in the statement table can be reordered via drag-and-drop:
- Click and drag the grip icon (
≡) at the far left of any non-opening-balance row. - Drop the row between any existing rows to adjust display order.
- The application automatically saves the custom order for that shareholder and year.
- Drag-and-drop reordering is disabled when the year is locked.
You can exclude specific booking rows from appearing in the final account statement:
- Click the Exclude (slashed eye) icon on an entry row to hide it from the active statement.
- To view excluded entries, check the Show excluded entries checkbox in the top action bar.
- Once visible, click the Include (open eye) icon on an excluded entry to restore it to the active statement calculation.
In addition to automatically aggregated bookings, you can add custom manual entries to the statement:
- Click the Add entry button in the header action bar to open the Add entry dialog.
- Enter a custom Type / Label and the monetary Amount.
- Click Save to persist the entry.
- Manual entries appear with an Edit button (to change the label or amount) and a Delete (trash) button to permanently remove the manual extra row.
If there is a mismatch between the sum of active bookings and the calculated total of non-opening statement entries (for example, if entries were excluded, amounts overridden, or manual entries added without matching bookings), a highlighted warning banner appears below the header bar:
- The banner informs you of the exact discrepancy amount and compares the statement total against the bookings total.
- The banner disappears automatically as soon as the amounts are balanced.
- Lock / Unlock: Uses the same unified locking control as the Bookings page. Locking prevents reordering, adding manual entries, editing amounts, or toggling exclusions.
- PDF Export: Click the print/PDF icon in the header to download the official Account Statement PDF for the selected shareholder and year.
The Interest Calculation page automatically calculates interest for a selected shareholder and year. It is available at:
<base-url>/interest-calculation
To open the page, select Interest Calculation in the navigation.
The page displays the interest calculation based on the selected shareholder’s bookings for the selected year.
Before a calculation can be displayed, select:
- A shareholder
- A year
Use the shareholder and year selectors in the header of the page.
Once both values have been selected, the page loads the applicable bookings and displays the interest calculation. If either value is missing, the calculation table remains empty and the page actions are unavailable.
The Interest Rate field defines the percentage used for the calculation.
When the interest rate is changed, the calculation is recalculated automatically.
Only valid percentage values can be entered. If an invalid value is entered, the field is marked as invalid and an error notification is displayed.
The Update Interest Automatically checkbox controls whether the calculated interest is recorded as a booking in the Bookings View.
When enabled:
- Any existing system-generated interest booking for the selected shareholder and year is updated with the newly calculated amount.
- If no such booking exists, a new interest booking is created.
- The generated booking is dated at the end of December of the selected year.
When disabled, the interest calculation is displayed but the corresponding interest booking is not automatically created or updated.
The calculation table displays the result broken down by month.
The table includes the following information:
| Column | Description |
|---|---|
| Month | The month covered by the row |
| Transactions | The total value of transactions for the month |
| Transaction type | The type of the transaction total (Debit / Credit) |
| Balance | The balance at the end of the month |
| Balance type | The type of the balance transaction (Debit / Credit) |
| Days | The number of days used for the interest calculation |
| Interest amount | The interest calculated for the month (Interest number) |
If no interest-related bookings exist for the selected shareholder and year, the table remains empty.
The selected shareholder and year can be locked using the lock control in the page header. Clicking on it will open a dialog asking for confirmation before locking this year for the shareholder.
When the calculation is locked:
- The interest rate field becomes read-only.
- The Update Interest Automatically checkbox is disabled.
- The calculation cannot be changed through the page controls.
Unlock the shareholder for this year to edit the interest rate or change the automatic update setting.
The calculation can be exported as PDF using the export action in the page header.
The Export page provides exports for comprehensive reports for multiple shareholders and views across customizable date ranges in Excel (XLSX) and PDF formats. It is available at:
<base-url>/export
To open the page, select the Export item in the navigation.
The export form contains the following configuration controls:
-
Shareholders Selection:
- Shareholders Dropdown: A multi-select dropdown listing all registered shareholders with their names and IDs.
- Select All Checkbox: Quickly selects or deselects all shareholders in the system.
-
Views Selection:
- Choose one or more views to include in the export:
- Bookings
- Interest Calculation
- Account Statements
- Choose one or more views to include in the export:
-
Date Range:
- From (Start Date): Defaults to January 1st of the current year.
- Until (End Date): Defaults to December 31st of the current year.
- Validation ensures the end date is not earlier than the start date.
-
Formats:
- Excel (XLSX): Generates structured spreadsheet files.
- PDF: Generates printable, formatted document files.
- One or both formats can be selected simultaneously.
- The Run Export button is only enabled when at least one shareholder, at least one view, at least one format, and valid dates are selected.
- Clicking Run Export triggers the generation process and downloads the files directly in your browser.
- A notification indicates when the export encountered an unexpected error.
The Backup page allows users to create and download complete database and system data backups. It is available at:
<base-url>/backup
To open the page, select the Backup item in the navigation.
The page displays the timestamp of the last successful backup which shows the formatted date and time of the last backup, or never if no previous backup has been recorded.
- Click the Create Full Backup button to initiate the backup process. This process may take a while.
- Once preparation is complete, a
.ziparchive containing the database snapshot and backup files begins downloading automatically. - A success notification confirms the backup, and the Last backup timestamp updates to the current date and time.
The Settings page enables users to customize application-wide preferences and appearance. It is available at:
<base-url>/settings
To open the page, select the Settings item in the navigation.
The settings table provides the following configuration options:
- A theme toggle button allows instantly switching themes. The selected setting is saved and preserved across sessions.
- A language selection dropdown allowing you to pick your preferred language. All labels, notifications, tables, and dialogs adapt immediately to the selected locale.
- Note: Some or all of these settings may be hidden if configured by a system administrators.