Fortuna

Signing in

Mon, 01 Jan 0001 00:00:00 +0000

This page covers how you get into Fortuna and out again. Online, identity belongs to Heimdall, and the interface reaches it through Fortuna’s own /api/auth/* routes; see Signing in through Heimdall. The rules behind session handling are in Concepts. The desktop local account used in offline mode is on the Offline mode page.

Two things to know first. The interface never keeps a password: a credential is sent once and cleared from the form, and a failed attempt is retyped, not replayed. And a rejection is shown in the API’s own words, the same for an unknown account and a wrong password, so the screen cannot be used to find out who is registered.

API explorer

Mon, 01 Jan 0001 00:00:00 +0000

Every endpoint the API exposes, rendered from docs/openapi/fortuna.json on fortuna-api’s main branch — read live, so this page always shows the released document. If the explorer below stays empty, open the raw document directly.

This explorer does not call anything

There is no server behind this page, so Try it out and Authorize are removed. To call the endpoints, run the API (see Installation) and use its own Swagger UI. For what each endpoint means and who may call it, see the API reference.

Settings, two-factor and instance health

Mon, 01 Jan 0001 00:00:00 +0000

This page covers three screens that are about the account and the instance rather than about money: Settings, which both roles use; two-factor management, which is written but not reachable; and Instance health, which only the instance administrator can open.

Screen	Address	Who
Settings	`/settings`	Both roles
Two-factor authentication	none	No route opens it
Instance health	`/admin`	Instance administrator only

UC-13: Choose Theme, Locale and Display Currency

Screen: Settings, /settings. There is a sign-out button in its top bar.

Accounts, cards and investments

Mon, 01 Jan 0001 00:00:00 +0000

A holding is anything that has value and a history: a financial account, a credit card or an investment. This page covers the screens for creating and reading them. The rules behind them, including that a holding has one currency fixed for life and that a balance is always derived, never stored, are in Concepts.

Every figure on these screens comes from the API. The interface never works out a balance, a used limit or a position itself (UI-BR-02), and when the API refuses something, the screen shows the API’s reason. Each screen below is for an account owner. Creating and editing happen in a small dialog on the same screen.

Transactions and transfers

Mon, 01 Jan 0001 00:00:00 +0000

A transaction is an expense or an earning on one of your accounts or cards, and it is the most frequent thing you do in Fortuna. A transfer moves money between two of your own accounts and counts as neither. The rules, including that an amount is always positive and its direction carries the sign, are in Concepts.

In every form on this page the amount is read as an exact decimal in the locale you chose in Settings, so 1.234,50 and 1,234.50 are stored identically, and an action is only reported as done once the API has accepted it (UI-BR-04). When the API refuses, you see its reason and the form keeps what you entered.

Installments and recurring commitments

Mon, 01 Jan 0001 00:00:00 +0000

Two kinds of money movement are spread over time. An installment purchase is one purchase split into several charges on a credit card. A recurring commitment is a rule that creates transactions on a schedule. The rules for both, including how an installment total is split and what a recurring rule is, are in Concepts: Installments and Concepts: Recurring commitments.

Screen	Address
Record an installment purchase	`/installments/new`
Recurring commitments	none: not built

UC-22: Record an Installment Purchase

Screen: Record an installment purchase, /installments/new. In this version a plan is charged to a credit card, not to an account.

Spreadsheet

Mon, 01 Jan 0001 00:00:00 +0000

The spreadsheet is the interface’s table view. It shows your transactions as a grid you can filter, sort and page through, and it is where most of your records are found and opened. Nothing on it changes anything: it only reads.

The grid does not hold your records and filter them itself. Every filter, every sort and every page is a request to the API, which answers with just that page (UI-BR-02, UI-BR-03).

Categories, tags, budgets and goals

Mon, 01 Jan 0001 00:00:00 +0000

These screens are how you give your records meaning. A category says what kind of spending or earning a transaction is, and categories form a tree. Tags are free labels and counterparties are the shops, employers and people on the other side. A budget is a ceiling for some categories over a period, and a goal is a savings target with a date. The rules are in Concepts.

Spent, remaining and progress figures are the API’s. The interface never works them out, and shows the ceiling or target on its own, with the reason, when it cannot read them.

Imports and connections

Mon, 01 Jan 0001 00:00:00 +0000

Fortuna brings transactions in from outside in two ways: by connecting an institution through an aggregator, and by importing a file. Either one starts a job on the instance, and you follow the job and review what it did. How the pipeline works, with its duplicate check and its per-row outcomes, is on the Architecture page, and the rules are in Concepts.

Three things to know. The interface uploads a file whole and untouched: it does not parse, transform, filter or repair it (UI-BR-28). A raw imported record can never be edited, because it is the evidence the import is reconciled against, so you correct the transaction it produced instead. And file imports are not available in desktop offline mode; connections are not offered there either.

Charts

Mon, 01 Jan 0001 00:00:00 +0000

The Insight screen draws your spending and earning as a chart, grouped the way you choose. Every element can be opened, and the one behind it opened again, until you reach the individual transactions. That path is the interface’s answer to the question “where did the money go?”.

The chart is not computed in the interface. Each aggregation and each level of the drill-down is requested from the API (UI-BR-02, UI-BR-14), and a chart element’s value is read from the data behind it, never from where it was drawn. The sequence is drawn on the Architecture page. Charts are not available in desktop offline mode.

Projections

Mon, 01 Jan 0001 00:00:00 +0000

The Projections screen answers two questions: where do I stand now, and where will I be in the coming months? It shows your net position, a projected balance over a period you choose, and the obligations you have already committed to.

Nothing on it is stored. The API builds each figure on request, and the interface marks every forecast as a forecast in words and in shape, not by color alone. The concepts, including what committed obligations are, are in Concepts. This screen is not the home screen: the home address / is a placeholder (see the guide’s start). The net position, projections and obligations are not available in desktop offline mode.

Exports

Mon, 01 Jan 0001 00:00:00 +0000

An export takes the data in a view out of Fortuna as a file. In this version the one view you can export is the transactions spreadsheet. The API builds the file, and the interface only asks for it and saves it, so what you save is exactly what the instance holds (UI-BR-29). The rules for exports, including what an export leaves out, are in Concepts.

This is not the same as taking all of your data. The complete personal-data archive, the portability right, is on the Privacy and data rights page.

Deleted records and the audit trail

Mon, 01 Jan 0001 00:00:00 +0000

Deleting a record in Fortuna is the first of two steps. A deleted record leaves every balance, chart, projection and export, but it can still be found and restored. Only a record that has been deleted can then be removed permanently. The audit trail is the append-only record of significant actions on your records. The rules are in Concepts.

Erasing your whole account is a different and irreversible operation, on the Privacy and data rights page.

Privacy and data rights

Mon, 01 Jan 0001 00:00:00 +0000

Fortuna is built to satisfy the GDPR and the LGPD. All of the controls for that live on one screen, Privacy, reachable by both roles. The rules (what counts as consent, what the personal-data archive contains, what erasure removes) are in Concepts.

The interface follows three rules here: consent comes before anything is sent to a third party, your data can be exported and erased without contacting anyone, and erasure is irreversible and is not the two-step deletion a single record goes through (UI-BR-40, UI-BR-41 and UI-BR-42).

Offline mode

Mon, 01 Jan 0001 00:00:00 +0000

Desktop offline mode runs the Fortuna core inside the application, on your own machine, with no network and no server. Your data stays in a file on that computer. It is available only on Windows and Linux, and only when the core library loads. How it is built is on the Architecture page, and how to build and start it is in Installation. You get into it in one of two ways: a build made for it starts there directly, and the setup screen offers Use this device only wherever the core loads (see Signing in).