Remove steps no longer necessary.

🤖 Automatically merge the PR into the main branch.

.ci/all.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+#
+# all.sh
+# Copyright (c) 2024 james@firefly-iii.org
+#
+# This file is part of Firefly III (https://github.com/firefly-iii).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+echo "Running PHP CS Fixer"
+$SCRIPT_DIR/phpcs.sh
+echo "Running PHPStan"
+$SCRIPT_DIR/phpstan.sh
+echo "Running PHPMD"
+$SCRIPT_DIR/phpmd.sh

.ci/php-cs-fixer/.php-cs-fixer.php

@@ -24,21 +24,61 @@ $current = __DIR__;
 $paths = [
     $current . '/../../app',
     $current . '/../../config',
-    $current . '/../../database',
     $current . '/../../routes',
     $current . '/../../tests',
-    $current . '/../../resources/lang',
 ];
 
 $finder = PhpCsFixer\Finder::create()
                            ->in($paths);
 
 
-$config = new PhpCsFixer\Config();
-return $config->setRules([
-                             '@PSR12'               => true,
-                             'declare_strict_types' => true,
-                             'strict_param'         => true,
-                             'array_syntax'         => ['syntax' => 'short'],
-                         ])
+$config = (new PhpCsFixer\Config())
+        // ->setUnsupportedPhpVersionAllowed(true) // use this when PHP 8.5 comes out.
+        ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+        ;
+return $config->setRules(
+
+    [
+        // rule sets
+        '@PHP83Migration'               => true,
+        '@PhpCsFixer'                   => true,
+        '@PhpCsFixer:risky'             => true,
+        '@PSR12'                        => true,
+        '@PSR12:risky'                  => true,
+        'declare_strict_types'          => true,
+        'strict_param'                  => true,
+        'no_unused_imports'             => true,
+        'single_space_around_construct' => true,
+        'statement_indentation'         => true,
+        'void_return'                   => true,
+
+        // disabled rules
+        'native_function_invocation'    => false, // annoying
+        'php_unit_data_provider_name'   => false, // bloody annoying long test names
+        'static_lambda'                 => false, // breaks the Response macro for API's.
+        'phpdoc_summary'                => false, // annoying.
+        'comment_to_phpdoc'             => false, // breaks phpstan lines in combination with PHPStorm.
+        'type_declaration_spaces'       => false,
+        'cast_spaces'                   => false,
+
+        // enabled rules
+        'global_namespace_import' => true, // matches with rector.
+
+        // complex rules
+        'phpdoc_to_comment' => ['ignored_tags' => ['var']],
+        'php_unit_test_case_static_method_calls' => [
+            'call_type' => 'this',
+        ],
+        'array_syntax'                  => ['syntax' => 'short'],
+        'binary_operator_spaces'        => [
+            'default'   => 'at_least_single_space',
+            'operators' => [
+                '=>'  => 'align_single_space_by_scope',
+                '='   => 'align_single_space_minimal_by_scope',
+                '??=' => 'align_single_space_minimal_by_scope',
+            ],
+        ],
+    ]
+
+)
               ->setFinder($finder);

.ci/php-cs-fixer/composer.json

@@ -1,5 +1,5 @@
 {
-  "require": {
-    "friendsofphp/php-cs-fixer": "^3.12"
-  }
+    "require": {
+        "friendsofphp/php-cs-fixer": "^3.12"
+    }
 }

.ci/phpcs.sh

@@ -20,19 +20,22 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-# Install composer packages
-#composer install --no-scripts --no-ansi
-
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 
-# enable test .env file.
-# cp .ci/.env.ci .env
-
 # clean up php code
 cd $SCRIPT_DIR/php-cs-fixer
 composer update --quiet
 rm -f .php-cs-fixer.cache
-PHP_CS_FIXER_IGNORE_ENV=true ./vendor/bin/php-cs-fixer fix --config $SCRIPT_DIR/php-cs-fixer/.php-cs-fixer.php --allow-risky=yes
+./vendor/bin/php-cs-fixer fix \
+    --config $SCRIPT_DIR/php-cs-fixer/.php-cs-fixer.php \
+    --format=txt \
+    -v \
+    --allow-risky=yes
+
+EXIT_CODE=$?
+
+echo "Exit code for CS fixer is $EXIT_CODE."
+
 cd $SCRIPT_DIR/..
 
-exit 0
+exit $EXIT_CODE

.ci/phpmd.sh

@@ -22,16 +22,29 @@
 
 
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+OUTPUT_FORMAT=text
+
+if [[ $GITHUB_ACTIONS = "true" ]]
+then
+    OUTPUT_FORMAT=github
+fi
+
 
 cd $SCRIPT_DIR/phpmd
 composer update --quiet
 ./vendor/bin/phpmd \
-  $SCRIPT_DIR/../app text phpmd.xml \
+  $SCRIPT_DIR/../app,$SCRIPT_DIR/../database,$SCRIPT_DIR/../routes,$SCRIPT_DIR/../config \
+   $OUTPUT_FORMAT phpmd.xml \
   --exclude $SCRIPT_DIR/../app/resources/** \
   --exclude $SCRIPT_DIR/../app/frontend/** \
   --exclude $SCRIPT_DIR/../app/public/** \
-  --exclude $SCRIPT_DIR/../app/vendor/** \
+  --exclude $SCRIPT_DIR/../app/vendor/**
+
+EXIT_CODE=$?
 
 cd $SCRIPT_DIR/..
 
-exit 0
+echo "Exit code is $EXIT_CODE."
+
+# for the time being, exit 0
+exit $EXIT_CODE

.ci/phpmd/composer.lock

@@ -9,16 +9,16 @@
     "packages-dev": [
         {
             "name": "composer/pcre",
-            "version": "3.1.0",
+            "version": "3.1.3",
             "source": {
                 "type": "git",
                 "url": "https://github.com/composer/pcre.git",
-                "reference": "4bff79ddd77851fe3cdd11616ed3f92841ba5bd2"
+                "reference": "5b16e25a5355f1f3afdfc2f954a0a80aec4826a8"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/composer/pcre/zipball/4bff79ddd77851fe3cdd11616ed3f92841ba5bd2",
-                "reference": "4bff79ddd77851fe3cdd11616ed3f92841ba5bd2",
+                "url": "https://api.github.com/repos/composer/pcre/zipball/5b16e25a5355f1f3afdfc2f954a0a80aec4826a8",
+                "reference": "5b16e25a5355f1f3afdfc2f954a0a80aec4826a8",
                 "shasum": ""
             },
             "require": {
@@ -60,7 +60,7 @@
             ],
             "support": {
                 "issues": "https://github.com/composer/pcre/issues",
-                "source": "https://github.com/composer/pcre/tree/3.1.0"
+                "source": "https://github.com/composer/pcre/tree/3.1.3"
             },
             "funding": [
                 {
@@ -76,20 +76,20 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-11-17T09:50:14+00:00"
+            "time": "2024-03-19T10:26:25+00:00"
         },
         {
             "name": "composer/xdebug-handler",
-            "version": "3.0.3",
+            "version": "3.0.4",
             "source": {
                 "type": "git",
                 "url": "https://github.com/composer/xdebug-handler.git",
-                "reference": "ced299686f41dce890debac69273b47ffe98a40c"
+                "reference": "4f988f8fdf580d53bdb2d1278fe93d1ed5462255"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/composer/xdebug-handler/zipball/ced299686f41dce890debac69273b47ffe98a40c",
-                "reference": "ced299686f41dce890debac69273b47ffe98a40c",
+                "url": "https://api.github.com/repos/composer/xdebug-handler/zipball/4f988f8fdf580d53bdb2d1278fe93d1ed5462255",
+                "reference": "4f988f8fdf580d53bdb2d1278fe93d1ed5462255",
                 "shasum": ""
             },
             "require": {
@@ -100,7 +100,7 @@
             "require-dev": {
                 "phpstan/phpstan": "^1.0",
                 "phpstan/phpstan-strict-rules": "^1.1",
-                "symfony/phpunit-bridge": "^6.0"
+                "phpunit/phpunit": "^8.5 || ^9.6 || ^10.5"
             },
             "type": "library",
             "autoload": {
@@ -124,9 +124,9 @@
                 "performance"
             ],
             "support": {
-                "irc": "irc://irc.freenode.org/composer",
+                "irc": "ircs://irc.libera.chat:6697/composer",
                 "issues": "https://github.com/composer/xdebug-handler/issues",
-                "source": "https://github.com/composer/xdebug-handler/tree/3.0.3"
+                "source": "https://github.com/composer/xdebug-handler/tree/3.0.4"
             },
             "funding": [
                 {
@@ -142,32 +142,32 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-02-25T21:32:43+00:00"
+            "time": "2024-03-26T18:29:49+00:00"
         },
         {
             "name": "pdepend/pdepend",
-            "version": "2.14.0",
+            "version": "2.16.2",
             "source": {
                 "type": "git",
                 "url": "https://github.com/pdepend/pdepend.git",
-                "reference": "1121d4b04af06e33e9659bac3a6741b91cab1de1"
+                "reference": "f942b208dc2a0868454d01b29f0c75bbcfc6ed58"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/pdepend/pdepend/zipball/1121d4b04af06e33e9659bac3a6741b91cab1de1",
-                "reference": "1121d4b04af06e33e9659bac3a6741b91cab1de1",
+                "url": "https://api.github.com/repos/pdepend/pdepend/zipball/f942b208dc2a0868454d01b29f0c75bbcfc6ed58",
+                "reference": "f942b208dc2a0868454d01b29f0c75bbcfc6ed58",
                 "shasum": ""
             },
             "require": {
                 "php": ">=5.3.7",
-                "symfony/config": "^2.3.0|^3|^4|^5|^6.0",
-                "symfony/dependency-injection": "^2.3.0|^3|^4|^5|^6.0",
-                "symfony/filesystem": "^2.3.0|^3|^4|^5|^6.0"
+                "symfony/config": "^2.3.0|^3|^4|^5|^6.0|^7.0",
+                "symfony/dependency-injection": "^2.3.0|^3|^4|^5|^6.0|^7.0",
+                "symfony/filesystem": "^2.3.0|^3|^4|^5|^6.0|^7.0",
+                "symfony/polyfill-mbstring": "^1.19"
             },
             "require-dev": {
                 "easy-doc/easy-doc": "0.0.0|^1.2.3",
                 "gregwar/rst": "^1.0",
-                "phpunit/phpunit": "^4.8.36|^5.7.27",
                 "squizlabs/php_codesniffer": "^2.0.0"
             },
             "bin": [
@@ -197,7 +197,7 @@
             ],
             "support": {
                 "issues": "https://github.com/pdepend/pdepend/issues",
-                "source": "https://github.com/pdepend/pdepend/tree/2.14.0"
+                "source": "https://github.com/pdepend/pdepend/tree/2.16.2"
             },
             "funding": [
                 {
@@ -205,26 +205,26 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-05-26T13:15:18+00:00"
+            "time": "2023-12-17T18:09:59+00:00"
         },
         {
             "name": "phpmd/phpmd",
-            "version": "2.13.0",
+            "version": "2.15.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/phpmd/phpmd.git",
-                "reference": "dad0228156856b3ad959992f9748514fa943f3e3"
+                "reference": "74a1f56e33afad4128b886e334093e98e1b5e7c0"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/phpmd/phpmd/zipball/dad0228156856b3ad959992f9748514fa943f3e3",
-                "reference": "dad0228156856b3ad959992f9748514fa943f3e3",
+                "url": "https://api.github.com/repos/phpmd/phpmd/zipball/74a1f56e33afad4128b886e334093e98e1b5e7c0",
+                "reference": "74a1f56e33afad4128b886e334093e98e1b5e7c0",
                 "shasum": ""
             },
             "require": {
                 "composer/xdebug-handler": "^1.0 || ^2.0 || ^3.0",
                 "ext-xml": "*",
-                "pdepend/pdepend": "^2.12.1",
+                "pdepend/pdepend": "^2.16.1",
                 "php": ">=5.3.9"
             },
             "require-dev": {
@@ -233,8 +233,7 @@
                 "ext-simplexml": "*",
                 "gregwar/rst": "^1.0",
                 "mikey179/vfsstream": "^1.6.8",
-                "phpunit/phpunit": "^4.8.36 || ^5.7.27",
-                "squizlabs/php_codesniffer": "^2.0"
+                "squizlabs/php_codesniffer": "^2.9.2 || ^3.7.2"
             },
             "bin": [
                 "src/bin/phpmd"
@@ -271,6 +270,7 @@
             "description": "PHPMD is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD.",
             "homepage": "https://phpmd.org/",
             "keywords": [
+                "dev",
                 "mess detection",
                 "mess detector",
                 "pdepend",
@@ -280,7 +280,7 @@
             "support": {
                 "irc": "irc://irc.freenode.org/phpmd",
                 "issues": "https://github.com/phpmd/phpmd/issues",
-                "source": "https://github.com/phpmd/phpmd/tree/2.13.0"
+                "source": "https://github.com/phpmd/phpmd/tree/2.15.0"
             },
             "funding": [
                 {
@@ -288,7 +288,7 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-09-10T08:44:15+00:00"
+            "time": "2023-12-11T08:22:20+00:00"
         },
         {
             "name": "psr/container",
@@ -395,34 +395,34 @@
         },
         {
             "name": "symfony/config",
-            "version": "v6.3.0",
+            "version": "v7.0.4",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/config.git",
-                "reference": "a5e00dec161b08c946a2c16eed02adbeedf827ae"
+                "reference": "44deeba7233f08f383185ffa37dace3b3bc87364"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/config/zipball/a5e00dec161b08c946a2c16eed02adbeedf827ae",
-                "reference": "a5e00dec161b08c946a2c16eed02adbeedf827ae",
+                "url": "https://api.github.com/repos/symfony/config/zipball/44deeba7233f08f383185ffa37dace3b3bc87364",
+                "reference": "44deeba7233f08f383185ffa37dace3b3bc87364",
                 "shasum": ""
             },
             "require": {
-                "php": ">=8.1",
+                "php": ">=8.2",
                 "symfony/deprecation-contracts": "^2.5|^3",
-                "symfony/filesystem": "^5.4|^6.0",
+                "symfony/filesystem": "^6.4|^7.0",
                 "symfony/polyfill-ctype": "~1.8"
             },
             "conflict": {
-                "symfony/finder": "<5.4",
+                "symfony/finder": "<6.4",
                 "symfony/service-contracts": "<2.5"
             },
             "require-dev": {
-                "symfony/event-dispatcher": "^5.4|^6.0",
-                "symfony/finder": "^5.4|^6.0",
-                "symfony/messenger": "^5.4|^6.0",
+                "symfony/event-dispatcher": "^6.4|^7.0",
+                "symfony/finder": "^6.4|^7.0",
+                "symfony/messenger": "^6.4|^7.0",
                 "symfony/service-contracts": "^2.5|^3",
-                "symfony/yaml": "^5.4|^6.0"
+                "symfony/yaml": "^6.4|^7.0"
             },
             "type": "library",
             "autoload": {
@@ -450,7 +450,7 @@
             "description": "Helps you find, load, combine, autofill and validate configuration values of any kind",
             "homepage": "https://symfony.com",
             "support": {
-                "source": "https://github.com/symfony/config/tree/v6.3.0"
+                "source": "https://github.com/symfony/config/tree/v7.0.4"
             },
             "funding": [
                 {
@@ -466,44 +466,43 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-04-25T10:46:17+00:00"
+            "time": "2024-02-26T07:52:39+00:00"
         },
         {
             "name": "symfony/dependency-injection",
-            "version": "v6.3.1",
+            "version": "v7.0.4",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/dependency-injection.git",
-                "reference": "7abf242af21f196b65f20ab00ff251fdf3889b8d"
+                "reference": "47f37af245df8457ea63409fc242b3cc825ce5eb"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/7abf242af21f196b65f20ab00ff251fdf3889b8d",
-                "reference": "7abf242af21f196b65f20ab00ff251fdf3889b8d",
+                "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/47f37af245df8457ea63409fc242b3cc825ce5eb",
+                "reference": "47f37af245df8457ea63409fc242b3cc825ce5eb",
                 "shasum": ""
             },
             "require": {
-                "php": ">=8.1",
+                "php": ">=8.2",
                 "psr/container": "^1.1|^2.0",
                 "symfony/deprecation-contracts": "^2.5|^3",
-                "symfony/service-contracts": "^2.5|^3.0",
-                "symfony/var-exporter": "^6.2.10"
+                "symfony/service-contracts": "^3.3",
+                "symfony/var-exporter": "^6.4|^7.0"
             },
             "conflict": {
                 "ext-psr": "<1.1|>=2",
-                "symfony/config": "<6.1",
-                "symfony/finder": "<5.4",
-                "symfony/proxy-manager-bridge": "<6.3",
-                "symfony/yaml": "<5.4"
+                "symfony/config": "<6.4",
+                "symfony/finder": "<6.4",
+                "symfony/yaml": "<6.4"
             },
             "provide": {
                 "psr/container-implementation": "1.1|2.0",
                 "symfony/service-implementation": "1.1|2.0|3.0"
             },
             "require-dev": {
-                "symfony/config": "^6.1",
-                "symfony/expression-language": "^5.4|^6.0",
-                "symfony/yaml": "^5.4|^6.0"
+                "symfony/config": "^6.4|^7.0",
+                "symfony/expression-language": "^6.4|^7.0",
+                "symfony/yaml": "^6.4|^7.0"
             },
             "type": "library",
             "autoload": {
@@ -531,7 +530,7 @@
             "description": "Allows you to standardize and centralize the way objects are constructed in your application",
             "homepage": "https://symfony.com",
             "support": {
-                "source": "https://github.com/symfony/dependency-injection/tree/v6.3.1"
+                "source": "https://github.com/symfony/dependency-injection/tree/v7.0.4"
             },
             "funding": [
                 {
@@ -547,11 +546,11 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-06-24T11:51:27+00:00"
+            "time": "2024-02-22T20:27:20+00:00"
         },
         {
             "name": "symfony/deprecation-contracts",
-            "version": "v3.3.0",
+            "version": "v3.4.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/deprecation-contracts.git",
@@ -598,7 +597,7 @@
             "description": "A generic function and convention to trigger deprecation notices",
             "homepage": "https://symfony.com",
             "support": {
-                "source": "https://github.com/symfony/deprecation-contracts/tree/v3.3.0"
+                "source": "https://github.com/symfony/deprecation-contracts/tree/v3.4.0"
             },
             "funding": [
                 {
@@ -618,20 +617,20 @@
         },
         {
             "name": "symfony/filesystem",
-            "version": "v6.3.1",
+            "version": "v7.0.3",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/filesystem.git",
-                "reference": "edd36776956f2a6fcf577edb5b05eb0e3bdc52ae"
+                "reference": "2890e3a825bc0c0558526c04499c13f83e1b6b12"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/filesystem/zipball/edd36776956f2a6fcf577edb5b05eb0e3bdc52ae",
-                "reference": "edd36776956f2a6fcf577edb5b05eb0e3bdc52ae",
+                "url": "https://api.github.com/repos/symfony/filesystem/zipball/2890e3a825bc0c0558526c04499c13f83e1b6b12",
+                "reference": "2890e3a825bc0c0558526c04499c13f83e1b6b12",
                 "shasum": ""
             },
             "require": {
-                "php": ">=8.1",
+                "php": ">=8.2",
                 "symfony/polyfill-ctype": "~1.8",
                 "symfony/polyfill-mbstring": "~1.8"
             },
@@ -661,7 +660,7 @@
             "description": "Provides basic utilities for the filesystem",
             "homepage": "https://symfony.com",
             "support": {
-                "source": "https://github.com/symfony/filesystem/tree/v6.3.1"
+                "source": "https://github.com/symfony/filesystem/tree/v7.0.3"
             },
             "funding": [
                 {
@@ -677,20 +676,20 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-06-01T08:30:39+00:00"
+            "time": "2024-01-23T15:02:46+00:00"
         },
         {
             "name": "symfony/polyfill-ctype",
-            "version": "v1.27.0",
+            "version": "v1.29.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/polyfill-ctype.git",
-                "reference": "5bbc823adecdae860bb64756d639ecfec17b050a"
+                "reference": "ef4d7e442ca910c4764bce785146269b30cb5fc4"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/5bbc823adecdae860bb64756d639ecfec17b050a",
-                "reference": "5bbc823adecdae860bb64756d639ecfec17b050a",
+                "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/ef4d7e442ca910c4764bce785146269b30cb5fc4",
+                "reference": "ef4d7e442ca910c4764bce785146269b30cb5fc4",
                 "shasum": ""
             },
             "require": {
@@ -704,9 +703,6 @@
             },
             "type": "library",
             "extra": {
-                "branch-alias": {
-                    "dev-main": "1.27-dev"
-                },
                 "thanks": {
                     "name": "symfony/polyfill",
                     "url": "https://github.com/symfony/polyfill"
@@ -743,7 +739,7 @@
                 "portable"
             ],
             "support": {
-                "source": "https://github.com/symfony/polyfill-ctype/tree/v1.27.0"
+                "source": "https://github.com/symfony/polyfill-ctype/tree/v1.29.0"
             },
             "funding": [
                 {
@@ -759,20 +755,20 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-11-03T14:55:06+00:00"
+            "time": "2024-01-29T20:11:03+00:00"
         },
         {
             "name": "symfony/polyfill-mbstring",
-            "version": "v1.27.0",
+            "version": "v1.29.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/polyfill-mbstring.git",
-                "reference": "8ad114f6b39e2c98a8b0e3bd907732c207c2b534"
+                "reference": "9773676c8a1bb1f8d4340a62efe641cf76eda7ec"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/8ad114f6b39e2c98a8b0e3bd907732c207c2b534",
-                "reference": "8ad114f6b39e2c98a8b0e3bd907732c207c2b534",
+                "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/9773676c8a1bb1f8d4340a62efe641cf76eda7ec",
+                "reference": "9773676c8a1bb1f8d4340a62efe641cf76eda7ec",
                 "shasum": ""
             },
             "require": {
@@ -786,9 +782,6 @@
             },
             "type": "library",
             "extra": {
-                "branch-alias": {
-                    "dev-main": "1.27-dev"
-                },
                 "thanks": {
                     "name": "symfony/polyfill",
                     "url": "https://github.com/symfony/polyfill"
@@ -826,7 +819,7 @@
                 "shim"
             ],
             "support": {
-                "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.27.0"
+                "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.29.0"
             },
             "funding": [
                 {
@@ -842,25 +835,25 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-11-03T14:55:06+00:00"
+            "time": "2024-01-29T20:11:03+00:00"
         },
         {
             "name": "symfony/service-contracts",
-            "version": "v3.3.0",
+            "version": "v3.4.1",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/service-contracts.git",
-                "reference": "40da9cc13ec349d9e4966ce18b5fbcd724ab10a4"
+                "reference": "fe07cbc8d837f60caf7018068e350cc5163681a0"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/service-contracts/zipball/40da9cc13ec349d9e4966ce18b5fbcd724ab10a4",
-                "reference": "40da9cc13ec349d9e4966ce18b5fbcd724ab10a4",
+                "url": "https://api.github.com/repos/symfony/service-contracts/zipball/fe07cbc8d837f60caf7018068e350cc5163681a0",
+                "reference": "fe07cbc8d837f60caf7018068e350cc5163681a0",
                 "shasum": ""
             },
             "require": {
                 "php": ">=8.1",
-                "psr/container": "^2.0"
+                "psr/container": "^1.1|^2.0"
             },
             "conflict": {
                 "ext-psr": "<1.1|>=2"
@@ -908,7 +901,7 @@
                 "standards"
             ],
             "support": {
-                "source": "https://github.com/symfony/service-contracts/tree/v3.3.0"
+                "source": "https://github.com/symfony/service-contracts/tree/v3.4.1"
             },
             "funding": [
                 {
@@ -924,27 +917,27 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-05-23T14:45:45+00:00"
+            "time": "2023-12-26T14:02:43+00:00"
         },
         {
             "name": "symfony/var-exporter",
-            "version": "v6.3.0",
+            "version": "v7.0.4",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/var-exporter.git",
-                "reference": "db5416d04269f2827d8c54331ba4cfa42620d350"
+                "reference": "dfb0acb6803eb714f05d97dd4c5abe6d5fa9fe41"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/var-exporter/zipball/db5416d04269f2827d8c54331ba4cfa42620d350",
-                "reference": "db5416d04269f2827d8c54331ba4cfa42620d350",
+                "url": "https://api.github.com/repos/symfony/var-exporter/zipball/dfb0acb6803eb714f05d97dd4c5abe6d5fa9fe41",
+                "reference": "dfb0acb6803eb714f05d97dd4c5abe6d5fa9fe41",
                 "shasum": ""
             },
             "require": {
-                "php": ">=8.1"
+                "php": ">=8.2"
             },
             "require-dev": {
-                "symfony/var-dumper": "^5.4|^6.0"
+                "symfony/var-dumper": "^6.4|^7.0"
             },
             "type": "library",
             "autoload": {
@@ -982,7 +975,7 @@
                 "serialize"
             ],
             "support": {
-                "source": "https://github.com/symfony/var-exporter/tree/v6.3.0"
+                "source": "https://github.com/symfony/var-exporter/tree/v7.0.4"
             },
             "funding": [
                 {
@@ -998,7 +991,7 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2023-04-21T08:48:44+00:00"
+            "time": "2024-02-26T10:35:24+00:00"
         }
     ],
     "aliases": [],
@@ -1008,5 +1001,5 @@
     "prefer-lowest": false,
     "platform": [],
     "platform-dev": [],
-    "plugin-api-version": "2.3.0"
+    "plugin-api-version": "2.6.0"
 }

.ci/phpmd/phpmd.xml

@@ -19,54 +19,76 @@
   ~ along with this program.  If not, see <https://www.gnu.org/licenses/>.
   -->
 
-<ruleset name="pcsg-generated-ruleset"
-    xmlns="http://pmd.sf.net/ruleset/1.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
-    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
-	<description>Bla bla</description>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         name="pcsg-generated-ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>Firefly III ruleset.</description>
+    <!-- Import the entire controversial code rule set -->
+    <rule ref="rulesets/controversial.xml">
+        <exclude name="CamelCasePropertyName"/>
+    </rule>
 
-	<!--
-Commando vanuit firefly directory:
-phpmd database,app,tests html /gdrive-all/development/phpmd/phpmd.xml > public/report.html
-	-->
+    <!-- clean code -->
+    <!-- <rule ref="rulesets/codesize.xml" /> -->
+    <rule ref="rulesets/unusedcode.xml"/>
 
-	<!-- Import the entire controversial code rule set -->
-	<rule ref="rulesets/controversial.xml">
-		<exclude name="CamelCasePropertyName" />
-	</rule>
 
-	<!-- clean code -->
-	<rule ref="rulesets/codesize.xml" />
-	<rule ref="rulesets/design.xml" />
-	<rule ref="rulesets/naming.xml" />
-	<rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/design.xml/NumberOfChildren">
+        <properties>
+            <!-- This is now at 32, which excludes the controllers but should prevent more monoliths. -->
+            <property name="minimum" value="32"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/design.xml/CouplingBetweenObjects">
+        <properties>
+            <!-- Leaving this at 28 excuses most current code but it can't get worse than that. -->
+            <property name="maximum" value="28"/>
+        </properties>
+    </rule>
 
-	<rule ref="rulesets/codesize.xml/CyclomaticComplexity">
-		<properties>
-			<property name="reportLevel" value="5"/>
-		</properties>
-	</rule>
-	<rule ref="rulesets/codesize.xml/NPathComplexity">
-		<properties>
-			<property name="minimum" value="128"/>
-		</properties>
-	</rule>
-	<rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
-		<properties>
-			<property name="minimum" value="40"/>
-		</properties>
-	</rule>
-	<rule ref="rulesets/codesize.xml/ExcessiveParameterList">
-		<properties>
-			<property name="minimum" value="5"/>
-		</properties>
-	</rule>
 
-	<!-- include clean code manually -->
-	<rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" />
-	<rule ref="rulesets/cleancode.xml/ElseExpression" />
+    <rule ref="rulesets/naming.xml/ShortMethodName">
+        <properties>
+            <property name="minimum" value="3"/>
+        </properties>
+    </rule>
 
-	<!-- no this one -->
-	<!--<rule ref="rulesets/cleancode.xml/StaticAccess" />-->
+    <!-- code size -->
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
+        <properties>
+            <!-- Leave at 20. This means methods will be pretty complex before the system starts complaining. -->
+            <property name="reportLevel" value="20"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/NPathComplexity">
+        <properties>
+            <!-- 2000 results in some pretty complex methods, but it's OK. -->
+            <!-- They should not be much more complex than that though -->
+            <property name="minimum" value="2000"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
+        <properties>
+            <!-- 75 seems like a nice number. Shorter isn't always feasible and there are a few exceptions already -->
+            <property name="minimum" value="75"/>
+            <property name="ignore-whitespace" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
+        <properties>
+            <!-- 5 is fine. 6 is excessive, but I have just one of those. At the end of the day, I still need all params. -->
+            <property name="minimum" value="5"/>
+        </properties>
+    </rule>
+
+    <!-- include clean code manually -->
+    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
+    <rule ref="rulesets/cleancode.xml/ElseExpression"/>
+    <rule ref="rulesets/cleancode.xml/MissingImport"/>
+    <rule ref="rulesets/cleancode.xml/UndefinedVariable"/>
+    <rule ref="rulesets/cleancode.xml/IfStatementAssignment"/>
+    <rule ref="rulesets/cleancode.xml/DuplicatedArrayKey"/>
+    <rule ref="rulesets/cleancode.xml/ErrorControlOperator"/>
 </ruleset>

.ci/phpstan.neon

@@ -1,70 +1,38 @@
-includes:
-  - ../vendor/nunomaduro/larastan/extension.neon
-  - ../vendor/ergebnis/phpstan-rules/rules.neon
-  - ../vendor/phpstan/phpstan-deprecation-rules/rules.neon
-  - ../vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
-
 parameters:
-  ignoreErrors:
-    - '#is not allowed to extend#'
-    - '#is neither abstract nor final#'
-    - '#has a nullable return type declaration#'
-    - '#with a nullable type declaration#'
-    - '#with null as default value#'
-    - '#is not covariant with PHPDoc type array#'
-    -
-        message: '#but containers should not be injected#'
-        paths:
-            - ../app/Support/Authentication/RemoteUserGuard.php
-    -
-        message: '#Control structures using switch should not be used.#'
-        paths:
-            - ../app/Api/V1/Controllers/Data/DestroyController.php
-            - ../app/Console/Commands/Correction/FixAccountTypes.php
-            - ../app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php
-            - ../app/Exceptions/GracefulNotFoundHandler.php
-            - ../app/Generator/Webhook/StandardMessageGenerator.php
-            - ../app/Support/Amount.php
-            - ../app/Support/Navigation.php
-            - ../app/Support/ParseDateString.php
-            - ../app/Support/Search/AccountSearch.php
-            - ../app/Support/Search/OperatorQuerySearch.php
-            - ../app/Support/Twig/General.php
-            - ../app/Transformers/RecurrenceTransformer.php
-            - ../app/Validation/AccountValidator.php
-            - ../app/Validation/RecurrenceValidation.php
-            - ../app/Validation/TransactionValidation.php
-
-    -
-        message: '#Function compact\(\) should not be used#'
-        paths:
-            - ../app/Generator/Report/Account/MonthReportGenerator.php
-            - ../app/Generator/Report/Audit/MonthReportGenerator.php
-            - ../app/Generator/Report/Budget/MonthReportGenerator.php
-            - ../app/Generator/Report/Category/MonthReportGenerator.php
-            - ../app/Generator/Report/Standard/MonthReportGenerator.php
-            - ../app/Generator/Report/Standard/MultiYearReportGenerator.php
-            - ../app/Generator/Report/Standard/YearReportGenerator.php
-            - ../app/Generator/Report/Tag/MonthReportGenerator.php
-            - ../app/Http/Controllers/Account/*.php
-            - ../app/Http/Controllers/Admin/*.php
-            - ../app/Http/Controllers/*.php
-            - ../app/Support/ExpandedForm.php
-            - ../app/Support/Form/AccountForm.php
-            - ../app/Support/Form/CurrencyForm.php
-            - ../app/Support/Form/FormSupport.php
-    -
-        message: '#Either catch a more specific exception#'
-        paths:
-            - ../app/Support/Form/FormSupport.php
-
+  scanFiles:
+    - ../_ide_helper
   paths:
     - ../app
     - ../database
     - ../routes
     - ../config
     - ../bootstrap/app.php
+  universalObjectCratesClasses:
+    - Illuminate\Database\Eloquent\Model
+  # TODO: slowly remove these parameters and fix the issues found.
+  reportUnmatchedIgnoredErrors: true
+  ignoreErrors:
+  # TODO: slowly remove these exceptions and fix the issues found.
+    - '#Dynamic call to static method#' # all the Laravel ORM things depend on this.
+    - identifier: varTag.nativeType
+    - identifier: varTag.type
+    -
+        identifier: larastan.noEnvCallsOutsideOfConfig
+        path: ../app/Console/Commands/System/CreatesDatabase.php
+    - identifier: missingType.iterableValue # not interesting enough to fix.
+    - identifier: missingType.generics # not interesting enough to fix.
+    - "#Parameter \\#[1-2] \\$num[1-2] of function bc[a-z]+ expects numeric-string, [a-z\\-|&]+ given#"
+    - '#expects view-string, string given#'
+    - '#expects view-string\|null, string given#'
+
+    # phpstan can't handle this so we ignore them.
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::before#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::after#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::withTrashed#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::accountTypeIn#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\BelongsTo::withTrashed#'
 
   # The level 8 is the highest level. original was 5
-  level: 4
+  # 7 is more than enough, higher just leaves NULL things.
+  level: 7
 

.ci/phpstan.sh

@@ -29,7 +29,20 @@ SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 # cp .ci/.env.ci .env
 
 # Do static code analysis.
-# ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --no-progress
-./vendor/bin/phpstan analyse -c .ci/phpstan.neon --xdebug --error-format=table > phpstan-report.txt
+if [[ $GITHUB_ACTIONS = "" ]]
+then
+    ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --error-format=table > phpstan-report.txt
+    EXIT_CODE=$?
+    echo "The PHPstan report can be found in phpstan-report.txt. Exit code is $EXIT_CODE."
+fi
 
-echo 'The PHPstan report can be found in phpstan-report.txt'
+if [[ $GITHUB_ACTIONS = "true" ]]
+then
+    ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --no-progress --error-format=github
+    EXIT_CODE=$?
+
+    # temporary exit code 0
+    # EXIT_CODE=0
+fi
+
+exit $EXIT_CODE

.ci/phpunit.sh

@@ -1,63 +0,0 @@
-#!/usr/bin/env bash
-
-#
-# phpunit.sh
-# Copyright (c) 2021 james@firefly-iii.org
-#
-# This file is part of Firefly III (https://github.com/firefly-iii).
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-#
-SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
-# enable test .env file.
-cp $SCRIPT_DIR/../.env $SCRIPT_DIR/../.env.backup
-cp $SCRIPT_DIR/.env.ci $SCRIPT_DIR/../.env
-
-COVERAGE=false
-RESET=false
-FILE=storage/database/database.sqlite
-
-while getopts "cr" o; do
-    case "${o}" in
-        c) COVERAGE=true;;
-        r) RESET=true;;
-    esac
-done
-
-# reset if necessary.
-if [ $RESET = "true" ] ; then
-    rm -f $FILE
-fi
-
-# download test database
-if [ -f "$FILE" ]; then
-  echo 'DB exists, will use it'
-else
-  echo 'Download new DB'
-  wget --quiet https://github.com/firefly-iii/test-fixtures/raw/main/test-database.sqlite -O $FILE
-fi
-
-# run phpunit
-if [ $COVERAGE = "true" ] ; then
-  echo 'Run with coverage'
-  XDEBUG_MODE=coverage ./vendor/bin/phpunit --configuration phpunit.xml --coverage-html $SCRIPT_DIR/coverage
-else
-  echo 'Run without coverage'
-  ./vendor/bin/phpunit --configuration phpunit.xml
-fi
-
-# restore .env file
-mv $SCRIPT_DIR/../.env.backup $SCRIPT_DIR/../.env
-
-cd $SCRIPT_DIR/..

.ci/rector.php

@@ -0,0 +1,82 @@
+<?php
+
+
+/*
+ * rector.php
+ * Copyright (c) 2025 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\EarlyReturn\Rector\If_\ChangeOrIfContinueToMultiContinueRector;
+use Rector\Php80\Rector\ClassMethod\AddParamBasedOnParentClassMethodRector;
+use Rector\Transform\Rector\String_\StringToClassConstantRector;
+use RectorLaravel\Set\LaravelLevelSetList;
+
+
+return RectorConfig::configure()
+    ->withSkip([
+        ChangeOrIfContinueToMultiContinueRector::class,
+        AddParamBasedOnParentClassMethodRector::class,
+        StringToClassConstantRector::class => [
+            __DIR__ . '/../app/Http/Controllers/Auth/LoginController.php',
+        ],
+        __DIR__.'/../bootstrap/cache/*'
+    ])
+    ->withPaths([
+        __DIR__ . '/../app',
+        __DIR__ . '/../bootstrap',
+        __DIR__ . '/../config',
+        __DIR__ . '/../public',
+        __DIR__ . '/../resources/lang/en_US',
+        __DIR__ . '/../routes',
+        __DIR__ . '/../tests',
+    ])
+    ->withSets([
+        LaravelLevelSetList::UP_TO_LARAVEL_120,
+    ])
+//    ->withConfiguredRule(ReplaceServiceContainerCallArgRector::class, [
+//        new ReplaceServiceContainerCallArg('log', new ClassConstFetch(new Name('Illuminate\Support\Facades\Log'), 'class')),
+//    ])
+    // uncomment to reach your current PHP version
+    ->withPhpSets()
+    ->withPreparedSets(
+        codingStyle: false, // leave false
+        privatization: false, // leave false.
+        naming: false, // leave false
+        instanceOf: true,
+        earlyReturn: true,
+        strictBooleans: true,
+        carbon: true,
+        rectorPreset: true,
+        phpunitCodeQuality: true,
+        doctrineCodeQuality: true,
+        symfonyCodeQuality: true,
+        symfonyConfigs: true
+
+    )
+    ->withComposerBased(
+        twig: true,
+        doctrine: true,
+        phpunit: true,
+        symfony: true)
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0)
+    ->withImportNames(removeUnusedImports: true);// import statements instead of full classes.

.ci/rector.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+#
+# phpstan.sh
+# Copyright (c) 2021 james@firefly-iii.org
+#
+# This file is part of Firefly III (https://github.com/firefly-iii).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+# Install composer packages
+#composer install --no-scripts --no-ansi
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+echo $1
+
+if [ "$1" == "--dry-run" ]; then
+    echo "Running rector in dry run."
+    $SCRIPT_DIR/../vendor/bin/rector --config $SCRIPT_DIR/rector.php --dry-run
+    exit $?
+fi
+
+$SCRIPT_DIR/../vendor/bin/rector --config $SCRIPT_DIR/rector.php

.env.example

@@ -1,6 +1,6 @@
 # You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
 # Never set it to "testing".
-APP_ENV=local
+APP_ENV=production
 
 # Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
@@ -19,7 +19,7 @@ SITE_OWNER=mail@example.com
 APP_KEY=SomeRandomStringOf32CharsExactly
 
 # Firefly III will launch using this language (for new users and unauthenticated visitors)
-# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
+# For a list of available languages: https://github.com/firefly-iii/firefly-iii/blob/main/config/firefly.php#L123
 #
 # If text is still in English, remember that not everything may have been translated.
 DEFAULT_LANGUAGE=en_US
@@ -78,7 +78,7 @@ PAPERTRAIL_HOST=
 PAPERTRAIL_PORT=
 
 # Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
-# For other database types, please see the FAQ: https://docs.firefly-iii.org/firefly-iii/faq/self-hosted/#i-want-to-use-sqlite
+# For other database types, please see the FAQ: https://docs.firefly-iii.org/references/faq/install/#i-want-to-use-sqlite
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 # Use "pgsql" for PostgreSQL
 # Use "mysql" for MySQL and MariaDB.
@@ -111,7 +111,10 @@ PGSQL_SSL_CERT=null
 PGSQL_SSL_KEY=null
 PGSQL_SSL_CRL_FILE=null
 
-# more PostgreSQL settings
+# For postgresql 15 and up, setting this to public will no longer work as expected, becasuse the
+# 'public' schema is without grants. This can be worked around by having a super user grant those
+# necessary privileges, but in security conscious setups that's not viable.
+# You will need to set this to the schema you want to use.
 PGSQL_SCHEMA=public
 
 # If you're looking for performance improvements, you could install memcached or redis
@@ -122,7 +125,7 @@ SESSION_DRIVER=file
 # If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
 # REDIS_PORT_FILE to set the value from a file instead of from an environment variable
 
-# can be tcp, unix or http
+# can be tcp or unix. http is not supported
 REDIS_SCHEME=tcp
 
 # use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
@@ -150,7 +153,7 @@ COOKIE_SECURE=false
 COOKIE_SAMESITE=lax
 
 # If you want Firefly III to email you, update these settings
-# For instructions, see: https://docs.firefly-iii.org/firefly-iii/advanced-installation/email/#email
+# For instructions, see: https://docs.firefly-iii.org/how-to/firefly-iii/advanced/notifications/#email
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MAIL_MAILER=log
 MAIL_HOST=null
@@ -161,6 +164,13 @@ MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 MAIL_SENDMAIL_COMMAND=
 
+#
+# If you use self-signed certificates for your STMP server, you can use the following settings.
+#
+MAIL_ALLOW_SELF_SIGNED=false
+MAIL_VERIFY_PEER=true
+MAIL_VERIFY_PEER_NAME=true
+
 # Other mail drivers:
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MAILGUN_DOMAIN=
@@ -173,6 +183,7 @@ MAILGUN_ENDPOINT=api.mailgun.net
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MANDRILL_SECRET=
 SPARKPOST_SECRET=
+MAILERSEND_API_KEY=
 
 # Firefly III can send you the following messages.
 SEND_ERROR_MESSAGE=true
@@ -184,6 +195,11 @@ SEND_REPORT_JOURNALS=true
 # Since this involves an external service, it's optional and disabled by default.
 ENABLE_EXTERNAL_MAP=false
 
+#
+# Enable or disable exchange rate conversion.
+#
+ENABLE_EXCHANGE_RATES=false
+
 # Set this value to true if you want Firefly III to download currency exchange rates
 # from the internet. These rates are hosted by the creator of Firefly III inside
 # an Azure Storage Container.
@@ -214,7 +230,7 @@ VALID_URL_PROTOCOLS=
 # - 'web' (default, uses built in DB)
 # - 'remote_user_guard' for Authelia etc
 # Read more about these settings in the documentation.
-# https://docs.firefly-iii.org/firefly-iii/advanced-installation/authentication
+# https://docs.firefly-iii.org/how-to/firefly-iii/advanced/authentication/
 #
 # LDAP is no longer supported :(
 #
@@ -269,49 +285,21 @@ ALLOW_WEBHOOKS=false
 # 1. Set this token to any 32-character value (this is important!).
 # 2. Use this token in the cron URL instead of a user's command line token that you can find in /profile
 #
-# For more info: https://docs.firefly-iii.org/firefly-iii/advanced-installation/cron/
+# For more info: https://docs.firefly-iii.org/how-to/firefly-iii/advanced/cron/
 #
 # You can set this variable from a file by appending it with _FILE
 #
-STATIC_CRON_TOKEN=
+STATIC_CRON_TOKEN=PLEASE_REPLACE_WITH_32_CHAR_CODE
 
 # You can fine tune the start-up of a Docker container by editing these environment variables.
 # Use this at your own risk. Disabling certain checks and features may result in lots of inconsistent data.
 # However if you know what you're doing you can significantly speed up container start times.
 # Set each value to true to enable, or false to disable.
 
-# Set this to true to build all locales supported by Firefly III.
-# This may take quite some time (several minutes) and is generally not recommended.
-# If you wish to change or alter the list of locales, start your Docker container with
-# `docker run -v locale.gen:/etc/locale.gen -e DKR_BUILD_LOCALE=true`
-# and make sure your preferred locales are in your own locale.gen.
-DKR_BUILD_LOCALE=false
-
 # Check if the SQLite database exists. Can be skipped if you're not using SQLite.
 # Won't significantly speed up things.
 DKR_CHECK_SQLITE=true
 
-# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
-# and is up to date.
-DKR_RUN_MIGRATION=true
-
-# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
-# with the latest fixes (outside of migrations!)
-DKR_RUN_UPGRADE=true
-
-# Verify database integrity. Includes all data checks and verifications.
-# Disabling this makes Firefly III assume your DB is intact.
-DKR_RUN_VERIFY=true
-
-# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
-# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
-DKR_RUN_REPORT=true
-
-# Generate OAuth2 keys.
-# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
-# you had previously generated keys already and they're stored in your database for restoration.
-DKR_RUN_PASSPORT_INSTALL=true
-
 # Leave the following configuration vars as is.
 # Unless you like to tinker and know what you're doing.
 APP_NAME=FireflyIII
@@ -324,18 +312,27 @@ PUSHER_SECRET=
 PUSHER_ID=
 DEMO_USERNAME=
 DEMO_PASSWORD=
+
+#
+# Disable or enable the running balance column data
+# Please disable this. It's a very experimental feature.
+#
+USE_RUNNING_BALANCE=false
+
+#
+# The v2 layout is very experimental. If it breaks you get to keep both parts.
+# Be wary of data loss.
+#
 FIREFLY_III_LAYOUT=v1
 
 #
-# If you have trouble configuring your Firefly III installation, DON'T BOTHER setting this variable.
-# It won't work. It doesn't do ANYTHING. Don't believe the lies you read online. I'm not joking.
-# This configuration value WILL NOT HELP.
+# Which Query Parser implementation to use for the search engine and rules
+# 'new' is experimental, 'legacy' is the classic one
 #
-# Notable exception to this rule is Synology, which, according to some users, will use APP_URL to rewrite stuff.
+QUERY_PARSER_IMPLEMENTATION=new
+
 #
-# This variable is ONLY used in some of the emails Firefly III sends around. Nowhere else.
-# So when configuring anything WEB related this variable doesn't do anything. Nothing
-#
-# If you're stuck I understand you get desperate but look SOMEWHERE ELSE.
+# Please make sure this URL matches the external URL of your Firefly III installation.
+# It is used to validate specific requests and to generate URLs in emails.
 #
 APP_URL=http://localhost

.env.testing

@@ -0,0 +1,26 @@
+APP_ENV=testing
+APP_DEBUG=true
+SITE_OWNER=mail@example.com
+APP_KEY=TestTestTestTestTestTestTestTest
+DEFAULT_LANGUAGE=en_US
+DEFAULT_LOCALE=equal
+TZ=Europe/Amsterdam
+LOG_CHANNEL=stdout
+APP_LOG_LEVEL=debug
+AUDIT_LOG_LEVEL=info
+AUDIT_LOG_CHANNEL=audit_stdout
+DB_CONNECTION=sqlite
+CACHE_DRIVER=array
+SESSION_DRIVER=array
+MAIL_MAILER=log
+SEND_ERROR_MESSAGE=true
+ENABLE_EXTERNAL_MAP=false
+ENABLE_EXTERNAL_RATES=true
+AUTHENTICATION_GUARD=web
+ALLOW_WEBHOOKS=true
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+CACHE_PREFIX=firefly
+FIREFLY_III_LAYOUT=v1
+APP_URL=http://localhost

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# code owners for this Firefly III related repository
+* @JC5 @SDx3

.github/ISSUE_TEMPLATE/bug.yml

@@ -1,4 +1,4 @@
-name: Bug Report
+name: Bug report
 description: Report a bug in Firefly III (or associated tools)
 body:
   - type: checkboxes
@@ -12,7 +12,7 @@ body:
   - type: checkboxes
     attributes:
       label: I've found a bug and checked that ...
-      description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
+      description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, please explain why.
       options:
         - label: ... [the documentation](https://docs.firefly-iii.org/) does not mention anything about my problem
         - label: ... there are no open or closed issues that are related to my problem
@@ -33,13 +33,6 @@ body:
     validations:
       required: true
 
-  - type: textarea
-    attributes:
-      label: Expected behaviour
-      description: Please describe precisely what you'd expect to happen. Be specific.
-    validations:
-      required: false
-
   - type: textarea
     attributes:
       label: Steps to reproduce
@@ -54,4 +47,4 @@ body:
   - type: textarea
     attributes:
       label: Additional info
-      description: Please provide any additional information that seem useful.
+      description: Please provide any additional information that seems useful.

.github/ISSUE_TEMPLATE/config.yml

@@ -3,3 +3,6 @@ contact_links:
   - name: Ask a question
     url: https://github.com/firefly-iii/firefly-iii/discussions
     about: Please ask and answer questions here.
+  - name: I need support! 
+    url: https://github.com/firefly-iii/firefly-iii/discussions
+    about: I think I broke something...

.github/ISSUE_TEMPLATE/fr.yml

@@ -1,4 +1,4 @@
-name: Feature Request
+name: Feature request
 description: Request a feature or enhancement in Firefly III (or associated tools)
 body:
   - type: checkboxes
@@ -8,7 +8,7 @@ body:
       options:
         - label: I've read the [support guidelines](https://github.com/firefly-iii/firefly-iii/blob/main/.github/support.md)
           required: true
-        - label: My request is not listed as [a very good idea, but unfortunately...](https://docs.firefly-iii.org/firefly-iii/more-information/what-its-not/)
+        - label: My request is not listed as [a very good idea, but unfortunately...](https://docs.firefly-iii.org/explanation/more-information/what-its-not/)
           required: true
         - label: I've used [the search](https://github.com/firefly-iii/firefly-iii/issues?q=is%3Aissue) and this has not been requested before.
           required: true
@@ -31,11 +31,6 @@ body:
     validations:
       required: true
 
-  - type: textarea
-    attributes:
-      label: What are alternatives?
-      description: Please describe what alternatives currently exist.
-
   - type: textarea
     attributes:
       label: Additional context

.github/contributing.md

@@ -1,3 +1,3 @@
-# [Contributing guidelines](https://docs.firefly-iii.org/firefly-iii/support/#contributing-code)
+# [Contributing guidelines](https://docs.firefly-iii.org/explanation/support/#contributing-code)
 
-[Contributing guidelines](https://docs.firefly-iii.org/firefly-iii/support/#contributing-code)
+[Contributing guidelines](https://docs.firefly-iii.org/explanation/support/#contributing-code)

.github/dependabot.yml

@@ -1,11 +1,18 @@
 version: 2
 updates:
 
+  # Check for updates to GitHub Actions every week
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    labels: []
+    schedule:
+      interval: "weekly"
+
   # composer updates
   - package-ecosystem: "composer"
     directory: "/" # Location of package manifests
     target-branch: develop
-    labels: [ "bug" ]
+    labels: []
     versioning-strategy: increase
     schedule:
       interval: "weekly"
@@ -13,16 +20,8 @@ updates:
   # yarn / JS updates
   - package-ecosystem: "npm"
     directory: "/"
+    labels: []
     target-branch: develop
-    labels: [ "bug" ]
-    versioning-strategy: increase
-    schedule:
-      interval: "weekly"
-
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    target-branch: develop
-    labels: [ "bug" ]
     versioning-strategy: increase
     schedule:
       interval: "weekly"

.github/funding.yml

@@ -1,4 +1,6 @@
-# These are supported funding model platforms
+# Firefly III sponsor options
 
 github: jc5
 patreon: JC5
+ko_fi: jamesc5
+liberapay: JC5

.github/label-actions.yml

@@ -1,37 +1,126 @@
 # Configuration for Label Actions - https://github.com/dessant/label-actions
 
 # The `feature` label is added to issues
-feature:
+fixed:
   issues:
     # Post a comment, `{issue-author}` is an optional placeholder
     comment: |
-      Hi there! This is an automatic reply. `Share and enjoy`
+      Hi there!
 
-      This issue has been marked as a feature request. The requested (new) feature will become a part of Firefly III or the data importer in due course.
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as fixed. Thanks for reporting! A new version will be released in due time. Unfortunately, [I cannot give an estimate](https://docs.firefly-iii.org/references/faq/firefly-iii/general/#when-will-you-release-version-the-next-version), but [the roadmap](https://roadmap.firefly-iii.org/) is available for your reading pleasure.
+
+      There is no need to close the issue. It will be closed automatically.
+
+      Thank you for your contributions.
+feature:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    unlabel: feature
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as a feature request.
 
       If you come across this issue, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted. You can subscribe to this issue to get updates.
 
       Thank you for your contributions.
 
+epic:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as an epic. In epics, large amounts of works are collected that will be part of a major new feature. If you have more ideas that could be a part of this epic, feel free to reply.
+
+      *However*, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted.
+
+      If you are merely interested in this epic's progress, you can subscribe to this issue to get updates.
+
+      Thank you for your contributions.
+
 enhancement:
+  unlabel: enhancement
   issues:
     # Post a comment, `{issue-author}` is an optional placeholder
     comment: |
-      Hi there! This is an automatic reply. `Share and enjoy`
+      Hi there!
 
-      This issue has been marked as an enhancement. The requested enhancement to an existing feature will become a part of Firefly III or the data importer in due course.
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as an enhancement.
 
       If you come across this issue, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted. You can subscribe to this issue to get updates.
 
       Thank you for your contributions.
 
-# The `solved` label is added to discussions
 triage:
   issues:
     # Post a comment, `{issue-author}` is an optional placeholder
     comment: |
-      Hi there! This is an automatic reply. `Share and enjoy`
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
 
       This issue has been marked as being in triage. The root cause is not known yet, or the issue needs more investigation. You can help by sharing debug information (from `/debug`) if you also have this issue or when you haven't already done so.
 
       Thank you for your contributions.
+
+needs-moar-debug:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      To learn more about this issue, please make sure you share at least:
+
+      1. The table you can find on the `/debug` page
+      2. Firefly III version
+      2. Docker, self-hosted, or hosted by a third party?
+      3. Operating system and browser
+
+      Thank you for your contributions.
+    unlabel: needs-moar-debug
+
+
+needs-moar-logs:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      To learn more about this issue, please share the relevant log files from your Firefly III or data importer installation.
+
+      The relevant instructions can be found in the documentation: [How to debug Firefly III?](https://docs.firefly-iii.org/how-to/general/debug/) Once debug mode is activated per these instructions, you can repeat your action and find the logs, depending on your method of installation. All is explained on the page.
+
+      Please share the relevant log lines in your issue, either inline or as an attachment. If you feel the logs contain sensitive information, you may also send them to [james@firefly-iii.org](mailto:james@firefly-iii.org). Without these logs, it may not be possible to properly investigate this issue.
+
+      Thank you for your contributions.
+    unlabel: needs-moar-logs
+
+v2-layout-issue:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      It seems your issue is about the new v2-layout that is currently in development for Firefly III.
+
+      These issues are collected in [a GitHub discussion](https://github.com/firefly-iii/firefly-iii/issues/8361).
+
+      Please note that the v2 layout is still very much in development.
+
+      Thank you for your contributions.
+    close: true
+    close-reason: completed
+    lock: false
+    unlabel: v2-layout-issue

.github/mergify.yml

@@ -1,5 +1,11 @@
----
 pull_request_rules:
+  - name: Make sure PR are up to date before merging
+    description: This automatically updates PRs when they are out-of-date with the
+      base branch to avoid semantic conflicts (next step is using a merge
+      queue).
+    conditions: []
+    actions:
+      update:
   - name: Close all on main
     conditions:
       - base=main
@@ -8,56 +14,3 @@ pull_request_rules:
       close:
         message: Please do not open PR's on the `main` branch, but on the `develop`
           branch only. Thank you!
-  - name: No translations
-    conditions:
-      - -author~=^dependabot(|-preview)\[bot\]$
-      - base=develop
-      - or:
-          - files~=^resources/lang/bg_BG
-          - files~=^resources/lang/ca_ES
-          - files~=^resources/lang/cs_CZ
-          - files~=^resources/lang/da_DK
-          - files~=^resources/lang/de_DE
-          - files~=^resources/lang/el_GR
-          - files~=^resources/lang/en_GB
-          - files~=^resources/lang/es_ES
-          - files~=^resources/lang/et_EE
-          - files~=^resources/lang/fa_IR
-          - files~=^resources/lang/fi_FI
-          - files~=^resources/lang/fr_FR
-          - files~=^resources/lang/he_IL
-          - files~=^resources/lang/hu_HU
-          - files~=^resources/lang/id_ID
-          - files~=^resources/lang/is_IS
-          - files~=^resources/lang/it_IT
-          - files~=^resources/lang/ja_JP
-          - files~=^resources/lang/ko_KR
-          - files~=^resources/lang/lt_LT
-          - files~=^resources/lang/nb_NO
-          - files~=^resources/lang/nl_NL
-          - files~=^resources/lang/pl_PL
-          - files~=^resources/lang/pt_BR
-          - files~=^resources/lang/pt_PT
-          - files~=^resources/lang/ro_RO
-          - files~=^resources/lang/ru_RU
-          - files~=^resources/lang/si_LK
-          - files~=^resources/lang/sk_SK
-          - files~=^resources/lang/sl_SI
-          - files~=^resources/lang/sr_CS
-          - files~=^resources/lang/sv_SE
-          - files~=^resources/lang/th_TH
-          - files~=^resources/lang/tlh_AA
-          - files~=^resources/lang/tr_TR
-          - files~=^resources/lang/uk_UA
-          - files~=^resources/lang/vi_VN
-          - files~=^resources/lang/zh_CN
-          - files~=^resources/lang/zh_TW
-    actions:
-      comment:
-        message: >
-          Please do not submit translated strings in your PR. If you need new
-          sentences to be translated, add them to the `en_US` language strings.
-          New or changed translations for other languages can be submitted at
-          https://crowdin.com/project/firefly-iii
-
-          Thank you!

.github/pull_request_template.md

@@ -1,18 +1,23 @@
 <!--
-Before you create a new PR, please consider:
+Thank you for submitting new code to Firefly III, or any of the related projects. Please read the following rules carefully.
 
-1) Pull requests for the MAIN branch will be closed.
-2) DO NOT include translations in your PR. Only English US sentences.
+- Please do not submit solutions for problems that are not already reported in an issue.
+- Unfortunately, Firefly III can't be your learning experience. If you're new to all of this, please open an issue first.
+- Please do not open PRs to "discuss" possible solutions or to "get feedback" on your code. I simply don't have time for that.
+- Pull requests for the MAIN branch will be closed.
+- DO NOT include translated strings in your PR.
+- PRs (or parts thereof) that only fix issues inside code comments will not be accepted.
+
+If it feels necessary to open an issue first, please do so, before you open a PR.
+
+See also: https://docs.firefly-iii.org/explanation/support/#contributing-code
 
-Thanks.
 -->
-
-Fixes issue # (if relevant)
+    
+This PR fixes issue # (if relevant).
 
 Changes in this pull request:
 
 -
 -
 -
-
-@JC5

.github/stale.yml

@@ -1,58 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 14
-
-# Number of days of inactivity before a stale Issue or Pull Request is closed.
-# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
-daysUntilClose: 14
-
-# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
-# - "[Status] Maybe Later"
-exemptLabels:
-  - enhancement
-  - feature
-  - bug
-  - announcement
-  - "layout-v3"
-
-# Set to true to ignore issues in a project (defaults to false)
-exemptProjects: false
-
-# Set to true to ignore issues in a milestone (defaults to false)
-exemptMilestones: false
-
-# Label to use when marking as stale
-staleLabel: stale
-
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when removing the stale label.
-# unmarkComment: >
-#   Your comment here.
-
-# Comment to post when closing a stale Issue or Pull Request.
-# closeComment: >
-#   Your comment here.
-
-# Limit the number of actions per hour, from 1-30. Default is 30
-limitPerRun: 30
-
-# Limit to only `issues` or `pulls`
-# only: issues
-
-# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
-# pulls:
-#   daysUntilStale: 30
-#   markComment: >
-#     This pull request has been automatically marked as stale because it has not had
-#     recent activity. It will be closed if no further activity occurs. Thank you
-#     for your contributions.
-
-# issues:
-#   exemptLabels:
-#     - confirmed

.github/support.md

@@ -27,7 +27,7 @@ Only then [create a new issue](https://github.com/firefly-iii/firefly-iii/issues
 
 - Issues can be converted into discussions if it's not a bug or feature request.
 - Features that won't be implemented will be labelled "
-  wontfix". [This isn't personal](https://docs.firefly-iii.org/firefly-iii/about-firefly-iii/what-its-not/).
+  wontfix". [This isn't personal](https://docs.firefly-iii.org/explanation/more-information/what-its-not/).
 - Issues can be closed if they're duplicates of other issues.
 - Issues can be closed if the answer is in the FAQ.
 - Issues will be closed automatically after 14 days.

.github/workflows/cleanup.yml

@@ -1,10 +1,13 @@
 # This workflow prunes old workflow runs for an entire repository.
 
-name: "Chore - prune old builds"
+name: "Chore - Prune old builds"
+
+permissions:
+  actions: write
 
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '0 1 * * *'
   workflow_dispatch:
 jobs:
   prune:
@@ -12,9 +15,9 @@ jobs:
     timeout-minutes: 10
     steps:
       - name: Prune cancelled/skipped runs
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.GH_ACTIONS_PERSONAL_ACCESS_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const cancelled = await github.rest.actions.listWorkflowRunsForRepo({
               owner: context.repo.owner,
@@ -42,9 +45,9 @@ jobs:
             }
 
       - name: Prune runs older than 3 days
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.GH_ACTIONS_PERSONAL_ACCESS_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const days_to_expiration = 3;
             const ms_in_day = 86400000;
@@ -56,12 +59,13 @@ jobs:
 
             const workflows = [
               'cleanup.yml',
+              'close-duplicates.yml',
               'closed-issues.yml',
-              'depsreview.yaml',
-              'laravel.yml',
+              'debug-info-actions.yml',
+              'depsreview.yml',
+              'label-actions.yml',
               'lock.yml',
-              'qodana.yml',
-              'sonarcloud.yml',
+              'release.yml',
               'stale.yml'
             ]
 

.github/workflows/close-duplicates.yml

@@ -0,0 +1,39 @@
+name: "Issues - Command to close duplicate issues"
+
+# the workflow to execute on is comments that are newly created
+on:
+  issue_comment:
+    types: [ created ]
+
+permissions:
+  issues: write
+  checks: read
+
+jobs:
+  close_duplicates:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: github/command@v2.0.2
+        id: command
+        with:
+          allowed_contexts: "issue"
+          command: ".duplicate"
+      - name: reply
+        if: ${{ steps.command.outputs.continue == 'true' }}
+        run: |
+
+          ISSUE_TITLE=$(gh issue view ${{ steps.command.outputs.params }} --json title --jq '.title')
+
+          gh issue comment "$NUMBER" --body "Hi there!
+
+          This is an automatic reply. \`Share and enjoy\`.
+
+          Your issue is probably a duplicate of issue <span>#</span>${{ steps.command.outputs.params }}: [$ISSUE_TITLE](https://github.com/firefly-iii/firefly-iii/issues/${{ steps.command.outputs.params }}). Please refer to issue #${{ steps.command.outputs.params }} for support.
+
+          You can close this issue now. If you believe this is not in fact a duplicate, please reply and let us know. Otherwise, this issue will be automatically closed in a few days time.
+
+          Thank you for your contributions."
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.issue.number }}

.github/workflows/closed-issues.yml

@@ -1,13 +1,14 @@
-name: "Issues - reply to closed issue"
+---
+name: Issues - Reply to closed issue
 on:
   issues:
     types:
       - closed
 jobs:
-  auto_comment:
+  command_and_close:
     runs-on: ubuntu-latest
     steps:
-      - uses: aws-actions/closed-issue-message@v1
+      - uses: aws-actions/closed-issue-message@v2
         with:
           message: |
             Hi there! This is an automatic reply. `Share and enjoy`
@@ -21,4 +22,4 @@ jobs:
             If there is more to discuss, please open [a new issue](https://github.com/firefly-iii/firefly-iii/issues/new/choose) or [discussion](https://github.com/firefly-iii/firefly-iii/discussions/).
 
             Thank you for your contributions.
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/debug-info-actions.yml

@@ -0,0 +1,32 @@
+name: 'Issues - Respond to hidden commands'
+
+# the workflow to execute on is comments that are newly created
+on:
+  issues:
+    types: [ opened, edited ]
+  issue_comment:
+    types: [ created ]
+
+# permissions needed for reacting to IssueOps commands on issues and PRs
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+  checks: read
+
+jobs:
+  respond:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          ISSUE_BODY=$(gh issue view $NUMBER --json body)
+          if [[ $ISSUE_BODY == *".eOxNZAmyGz6CXMyf"* ]]; then
+            gh issue comment "$NUMBER" --body "$V2_ISSUE_REPLY_BODY"
+            gh issue close "$NUMBER" --reason completed
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.issue.number }}
+          V2_ISSUE_REPLY_BODY: ${{ secrets.V2_ISSUE_REPLY_BODY }}
+          LABELS: v2-layout-issue

.github/workflows/depsreview.yaml

@@ -1,14 +0,0 @@
-name: 'Code - dependency review'
-on: [ pull_request ]
-
-permissions:
-  contents: read
-
-jobs:
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3

.github/workflows/depsreview.yml

@@ -0,0 +1,16 @@
+name: 'Code - Dependency review'
+on: [ pull_request ]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: 'Dependency review'
+        uses: actions/dependency-review-action@v4

.github/workflows/label-actions.yml

@@ -1,12 +1,12 @@
-name: 'Issues - reply to specific labels'
+name: 'Issues - Reply to specific labels'
 
 on:
   issues:
-    types: [labeled, unlabeled]
+    types: [ labeled, unlabeled ]
   pull_request_target:
-    types: [labeled, unlabeled]
+    types: [ labeled, unlabeled ]
   discussion:
-    types: [labeled, unlabeled]
+    types: [ labeled, unlabeled ]
 
 permissions:
   contents: read
@@ -18,4 +18,4 @@ jobs:
   action:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/label-actions@v3
+      - uses: dessant/label-actions@v4

.github/workflows/lock.yml

@@ -3,17 +3,27 @@ name: 'Issues - Lock old issues'
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '0 2 * * *'
+
+concurrency:
+  group: lock-threads
+
+permissions:
+  issues: write
+  pull-requests: write
+  discussions: write
 
 jobs:
   lock:
     permissions:
       issues: write
       pull-requests: write
+      discussions: write
     runs-on: ubuntu-latest
     steps:
-      - uses: JC5/lock-threads@main
+      - uses: dessant/lock-threads@v5
         with:
-          github-token: ${{ github.token }}
-          issue-inactive-days: 90
-          pr-inactive-days: 90
+          issue-inactive-days: 21
+          pr-inactive-days: 21
+          discussion-inactive-days: 21
+          log-output: true

.github/workflows/release.yml

@@ -0,0 +1,414 @@
+name: 'Code - Create new release'
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release "v1.2.3" or "develop" or "branch-abc"'
+        required: true
+        default: 'develop'
+      phpversion:
+        description: 'PHP version'
+        required: true
+        default: '8.4'
+  schedule:
+    - cron: '0 3 * * MON'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.PASSPHRASE }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ github.event.inputs.phpversion }}
+          extensions: mbstring, intl, zip, bcmath
+      - name: Switch and pull
+        run: |
+          #
+          # Always check out origin/develop, unless its a branch release.
+          #
+          BRANCH_TO_PULL=origin/develop
+          if [[ "$version" == branch* ]]; then
+            BRANCH_TO_PULL=origin/$version
+          fi
+
+          echo "Version is '$version', check out '$BRANCH_TO_PULL'-branch"
+
+          git checkout --track $BRANCH_TO_PULL
+          git pull
+          echo "Current branch is $(git branch --show-current)"
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Configure Git
+        run: |
+          # do some configuration
+          sudo timedatectl set-timezone Europe/Amsterdam
+          git config user.name JC5
+          git config user.email release@firefly-iii.org
+          git config advice.addIgnoredFile false
+          git config push.autoSetupRemote true
+      - name: Lint PHP
+        run: |
+          php_lint_file()
+          {
+              local php_file="$1"
+              php -l "$php_file" &> /dev/null
+              if [ "$?" -ne 0 ]
+              then
+                  echo -e "[FAIL] $php_file"
+                  return 1
+              fi
+          }
+
+          export -f php_lint_file
+
+          find . -path ./vendor -prune -o -name '*.php' | parallel -j 4 php_lint_file {}
+
+          if [ "$?" -ne 0 ]
+          then
+              exit 1
+          fi
+      - name: Crowdin action
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: true
+          download_translations: true
+          push_translations: false
+          push_sources: false
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          CROWDIN_PROJECT_NR: ${{ secrets.CROWDIN_PROJECT_NR }}
+          CROWDIN_TOKEN: ${{ secrets.CROWDIN_TOKEN }}
+      - name: Cleanup changelog
+        id: cleanup-changelog
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:changelog'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ${{ secrets.CHANGELOG_TOKEN }}
+      - name: "Create THANKS.md"
+        id: thank-you
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:thank-you'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Replace version
+        id: replace-version
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:version'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ""
+          FF_III_VERSION: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Generate JSON v1
+        id: json-v1
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:json-translations v1'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Generate JSON v2
+        id: json-v2
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:json-translations v2'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Code cleanup
+        id: code-cleanup
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:code'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Build JS
+        run: |
+          npm install
+          npm run prod  --workspace=v1
+          npm run build --workspace=v2
+          npm update
+      - name: Run CI
+        run: |
+          rm -rf vendor composer.lock
+          composer update --no-dev --no-scripts --no-plugins -q
+          sudo chown -R runner:docker resources/lang
+          .ci/phpcs.sh || true
+      - name: Calculate variables
+        run: |
+
+          # set some variables
+          releaseName=$version
+          originalName=$version
+          zipName=FireflyIII-$version.zip
+          tarName=FireflyIII-$version.tar.gz
+
+          # if this is a develop build, slightly different variable names.
+          if [[ "develop" == "$version" ]]; then
+            #[[ -z $(git status --untracked-files=normal --porcelain) ]] && echo "this branch is clean, no need to push..." && exit 0;
+            releaseName=$version-$(date +'%Y%m%d')
+            originalName=$releaseName
+            zipName=FireflyIII-develop.zip
+            tarName=FireflyIII-develop.tar.gz
+          fi
+
+          # if this is a branch build, also slightly different variable names.
+          if [[ "$version" == branch* ]]; then
+            #[[ -z $(git status --untracked-files=normal --porcelain) ]] && echo "this branch is clean, no need to push..." && exit 0;
+            # branch builds overrule develop
+            releaseName=$version-$(date +'%Y%m%d')
+            originalName=$releaseName
+            zipName=FireflyIII-$version.zip
+            tarName=FireflyIII-$version.tar.gz
+          fi
+
+          # in both cases, if the release or tag already exists, add ".1" until it no longer exists.
+          tagFound=true
+          tagCount=1
+          while [ "$tagFound" = true ]
+          do
+            if [ $(git tag -l "$releaseName") ]; then
+              echo "Tag $releaseName exists already."
+              releaseName="$originalName"."$tagCount"
+              echo "Tag for release is now $releaseName"
+              tagCount=$((tagCount+1))
+            else
+             echo "Tag $releaseName does not exist, can continue"
+             tagFound=false
+            fi
+          done
+
+          # set some variables
+          echo "Release name is $releaseName."
+          echo "Original name is $originalName."
+          echo "Zip name is $zipName."
+          echo "Tar name is $tarName."
+
+          # create a new branch to store the difference in.
+          BRANCH_NAME=release-$(date +'%s')
+          git checkout -b $BRANCH_NAME
+
+          echo "Temporary branch name is '$BRANCH_NAME'."
+
+          # share variables with next step.
+          echo "releaseName=$releaseName" >> "$GITHUB_ENV"
+          echo "originalName=$originalName" >> "$GITHUB_ENV"
+          echo "zipName=$zipName" >> "$GITHUB_ENV"
+          echo "tarName=$tarName" >> "$GITHUB_ENV"
+          echo "BRANCH_NAME=$BRANCH_NAME" >> "$GITHUB_ENV"
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Commit all changes
+        run: |
+          # add all content, except output.txt (this contains the changelog and/or the download instructions)
+          echo 'Add all'
+          git add -A
+          # push to a new branch.
+          echo "Auto commit on branch '$(git branch --show-current)'."
+          git commit -m "🤖 Auto commit for release '$version' on $(date +'%Y-%m-%d')" || true
+          git push
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Generate release description
+        id: release-description
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: "ff3:generate-release-notes firefly-iii ${{ github.event.inputs.version }}"
+          output: 'output'
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ""
+      - name: Merge all into working branch
+        run: |
+          MERGE_INTO=develop
+            if [[ "$version" == branch* ]]; then
+                MERGE_INTO=$version
+            fi
+
+          echo "Merge all changes from $BRANCH_NAME back into '$MERGE_INTO' using a PR"
+          PR_URL=$(gh pr create -B $MERGE_INTO -H $BRANCH_NAME --title "🤖 Automatic PR to merge all changes into the '$MERGE_INTO' branch." --body '🤖 Created by GitHub action')
+          echo "PR URL is '$PR_URL'"
+          IFS='/' read -ra parts <<< "$PR_URL"
+          PR_NR=$(printf %s\\n "${parts[@]:(-1)}")
+          echo "PR number is '$PR_NR'"
+          gh pr merge $PR_NR -b "🤖 Automatically merge the PR into the $MERGE_INTO branch." -d --merge
+
+          # pull the changes from the $MERGE_INTO branch.
+          git checkout $MERGE_INTO
+          git merge origin/$MERGE_INTO
+          git pull
+          git status
+          echo "Current branch '$(git branch --show-current)'."
+
+          if [[ "develop" != "$version" ]] && [[ "$version" != branch* ]]; then
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+
+            echo "Also merge everything into main since this is a release."
+            echo 'create PR'
+            PR_URL=$(gh pr create -B main -H develop --title "🤖 Automatic PR to merge all changes into the main branch." --body "🤖 Created by GitHub action")
+            echo "PR URL is '$PR_URL'"
+
+            IFS='/' read -ra parts <<< "$PR_URL"
+            PR_NR=$(printf %s\\n "${parts[@]:(-1)}")
+            echo "PR number is '$PR_NR'"
+
+            echo 'Merge PR'
+            gh pr merge $PR_NR -b "🤖 Automatically merge the PR into the main branch." --merge
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+            echo "Current branch '$(git branch --show-current)'."
+
+          fi
+          echo "DONE!"
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Create archives
+        run: |
+          echo "Create zip file $zipName"
+          zip -rq $zipName . -x "*.git*" "*.ci*" "*.github*" "*node_modules*" "*output.txt*" "*Procfile*" "*crowdin.yml*" "*sonar-project.properties*"
+          touch $tarName
+
+          echo "Create tar file $tarName"
+          tar --exclude=$tarName --exclude=$zipName --exclude='./.git' --exclude='./.ci' --exclude='./.github' --exclude='./node_modules' --exclude='./output.txt' --exclude='./Procfile' --exclude='../crowdin.yml' --exclude='./sonar-project.properties' -czf $tarName .
+          # add sha256 sum
+          echo 'Sha sum ...'
+          sha256sum -b $zipName > $zipName.sha256
+          sha256sum -b $tarName > $tarName.sha256
+
+          # add signatures:
+          gpg --armor --detach-sign $zipName
+          gpg --armor --detach-sign $tarName
+      - name: Create release
+        run: |
+
+          # create a development release:
+          if [[ "develop" == "$version" ]]; then
+            # pull the changes from the develop branch.
+            git checkout develop
+            git merge origin/develop
+            git pull
+
+            # create the release:
+            echo "Create develop release under tag '$releaseName'."
+            git tag -a $releaseName -m "🤖 Development release '$version' on $(date +'%Y-%m-%d')"
+            git push origin $releaseName
+
+            gh release create $releaseName -p --verify-tag \
+              -t "Development release for $(date +'%Y-%m-%d')" \
+              --latest=false \
+              -F output.txt
+
+          fi
+
+          # create a branch release:
+          if [[ "$version" == branch* ]]; then
+
+            # pull the changes from the branch-* branch.
+            git checkout $version
+            git merge origin/$version
+            git pull
+
+            # create the release:
+            echo "Create branch release."
+            git tag -a $releaseName -m "Branch release '$version' on $(date +'%Y-%m-%d')"
+            git push origin $releaseName
+
+            gh release create $releaseName -p --verify-tag \
+              -t "Branch release for $(date +'%Y-%m-%d')" \
+              --latest=false \
+              -F output.txt
+
+          fi
+
+          # Create a production release.
+          if [[ "develop" != "$version" ]] && [[ "$version" != branch* ]]; then
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+
+            echo "Create prod release."
+            git tag -a $releaseName -m "Release $version"
+            git push origin $releaseName
+
+            # do not tag as latest when alpha or beta.
+            if [[ "$version" == *alpha* ]] || [[ "$version" == *beta* ]]; then
+              echo 'Mark alpha or beta as NOT the latest.'
+              gh release create $releaseName -F output.txt -t "$releaseName" --verify-tag --latest=false
+            fi
+
+            # tag as latest when NOT alpha or beta.
+            if [[ "$version" != *alpha* ]] && [[ "$version" != *beta* ]]; then
+              echo 'Mark prod as the latest.'
+              gh release create $releaseName -F output.txt -t "$releaseName" --verify-tag --latest=true
+            fi
+          fi
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Upload artifacts
+        run: |
+          # add zip file to release.
+          echo "Upload $zipName to $releaseName"
+          gh release upload $releaseName $zipName
+          echo "Upload $tarName to $releaseName"
+          gh release upload $releaseName $tarName
+
+          # add sha256 sum to release
+          echo "Upload $zipName.sha256 to $releaseName"
+          gh release upload $releaseName $zipName.sha256
+          echo "Upload $tarName.sha256 to $releaseName"
+          gh release upload $releaseName $tarName.sha256
+
+          # add signatures to release
+          echo "Upload $zipName.asc to $releaseName"
+          gh release upload $releaseName $zipName.asc
+          echo "Upload $tarName.asc to $releaseName"
+          gh release upload $releaseName $tarName.asc
+
+          # get current HEAD and add as file to the release
+          HEAD=$(git rev-parse HEAD)
+          echo $HEAD > HEAD.txt
+          echo "Upload HEAD.txt to $releaseName"
+          gh release upload $releaseName HEAD.txt
+
+          # remove all temporary files
+          rm -f output.txt
+          rm -f HEAD.txt
+          rm -f $zipName
+          rm -f $zipName.sha256
+          rm -f $tarName
+          rm -f $tarName.sha256
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}

.github/workflows/sonarcloud.yml

@@ -1,103 +0,0 @@
-name: 'Code - Run Sonarcloud'
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-      - develop
-env:
-  DB_CONNECTION: mysql
-  DB_HOST: "127.0.0.1"
-  DB_DATABASE: firefly
-  DB_USER: firefly
-  DB_PASSWORD: secret_firefly_password
-
-jobs:
-  sonarcloud:
-    name: SonarCloud
-    runs-on: ubuntu-latest
-    services:
-      mariadb:
-        image: mariadb:latest
-        ports:
-          - 3306:3306
-        env:
-          MYSQL_ROOT_PASSWORD: yes
-          MYSQL_USER: ${{ env.DB_USER }}
-          MYSQL_PASSWORD: ${{ env.DB_PASSWORD }}
-          MYSQL_DATABASE: ${{ env.DB_DATABASE }}
-        options: >-
-          --health-cmd="healthcheck.sh --connect --innodb_initialized"
-          --health-interval=10s
-          --health-timeout=5s
-          --health-retries=3
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
-      - name: Setup PHP with Xdebug
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '8.2'
-          coverage: xdebug
-          extensions: >-
-            bcmath
-            curl
-            fileinfo
-            iconv
-            intl
-            json
-            mbstring
-            openssl
-            pdo
-            session
-            simplexml
-            sodium
-            tokenizer
-            xml
-            xmlwriter
-
-      - name: Install Composer dependencies
-        run: composer install --prefer-dist --no-interaction --no-progress --no-scripts
-
-      - name: Verify Database connection
-        env:
-          PORT: ${{ job.services.mariadb.ports[3306] }}
-        run: |
-          while ! mysqladmin ping -h"${{env.DB_HOST}}" -P"${PORT}" --silent; do
-            sleep 1
-          done
-
-      - name: Copy environment file
-        run: sed 's@DB_HOST=.*@DB_HOST=${{env.DB_HOST}}@g' .env.example > .env
-
-      - name: Generate app key
-        run: php artisan key:generate
-
-      - name: "Create the database"
-        run: php artisan firefly-iii:create-database
-
-      - name: "Upgrades the database to the latest version"
-        run: php artisan firefly-iii:upgrade-database
-
-      - name: "Integrity Database Report"
-        run: php artisan firefly-iii:report-integrity
-
-      - name: "Run tests with coverage"
-        run: composer coverage
-
-      - name: Fix code coverage paths
-        run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.xml
-
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_ACTIONS_PERSONAL_ACCESS_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/stale.yml

@@ -1,7 +1,7 @@
-name: "Issues - close stale issues"
+name: "Issues - Mark and close stale issues"
 on:
   schedule:
-    - cron: "30 1 * * *"
+    - cron: "0 4 * * *"
   workflow_dispatch:
 
 permissions:
@@ -12,23 +12,29 @@ jobs:
     permissions:
       issues: write  # for actions/stale to close stale issues
       pull-requests: write  # for actions/stale to close stale PRs
+      actions: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v9
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: >
-            Hi there! This is an automatic reply. `Share and enjoy`
+          stale-issue-message: |
+            Hi there!
+
+            This is an automatic reply. `Share and enjoy`
 
             This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
 
             Thank you for your contributions.
-          stale-pr-message: >
-            Hi there! This is an automatic reply. `Share and enjoy`
+          stale-pr-message: |
+            Hi there!
+
+            This is an automatic reply. `Share and enjoy`
 
             This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
 
             Thank you for your contributions.
           days-before-stale: 14
           days-before-close: 7
-          exempt-issue-labels: 'enhancement,feature,bug,announcement,epic'
+          exempt-all-milestones: true
+          exempt-issue-labels: 'triage'

.gitignore

@@ -1,8 +1,30 @@
 /node_modules
 /storage/*.key
 /vendor
+public/hot
 npm-debug.log
 yarn-error.log
 .env
 /.ci/php-cs-fixer/vendor
 coverage.xml
+output.txt
+
+# ignore generated files.
+public/build
+
+# ignore v1 build files
+resources/assets/v1/node_modules
+resources/assets/v1/build
+public/v1/js/app.js*
+public/v1/js/app_vue.js*
+public/v1/js/create*
+public/v1/js/edit*
+public/v1/js/profile*
+public/v1/js/administrations
+public/v1/js/exchange-rates
+public/v1/js/webhooks
+
+# ignore v2 build files
+resources/assets/v2/node_modules
+resources/assets/v2/build
+public/v2/i18n

THANKS.md

@@ -0,0 +1,209 @@
+# Thank you! :tada: :heart: :tada:
+
+Over time, many people have contributed to Firefly III. Their efforts are not always visible, but always remembered and appreciated.
+Please find below all the people who contributed to the Firefly III code. Their names are mentioned in the year of their first contribution.
+
+## 2025
+- Denis Iskandarov
+- =
+- Lompi
+- Jose Diaz-Gonzalez
+- SoftBrix
+
+## 2024
+- Sobuno
+- TasneemTantawy
+- Antônio Franco
+- yparitcher
+- Jhon Pedroza
+- mzhubail
+- tasnim
+- withbest
+- Steve Wasiura
+- imlonghao
+- Rahman Yusuf
+- Michael Thomas
+- WardenJakx
+- kuilin
+- Stevie Robinson
+- luzpaz
+- Lemuel Roberto Bonifácio
+- maureenferreira
+
+## 2023
+- tieu1991
+- Maxco10
+- zqye
+- Mateus Pereira
+- josephbadow
+- Christian Desktop
+- Edgars
+- Hannah K
+- noxonad
+- Kaijia Feng
+- Marc Ordinas i Llopis
+- Kuba Turek
+- Julien Stébenne
+
+## 2022
+- Johannes Zellner
+- Janne Heß
+- charlesteets
+- Nathan PERIER
+- Jan Willhaus
+- canoine
+- Rick Cuddy
+- James
+- Hugo Meyronneinc
+- naveen
+- neilnaveen
+- naveensrinivasan
+- Federico Micelli
+- George Hahn
+
+## 2021
+- StillLoading
+- Igor Rzegocki
+- Lorenzo Breda
+- Hosh
+- Flightkick
+- alex6480
+- VREEdom
+- Hamza FADIL
+- Kasper Læssø Sørensen
+- Alex
+- Jeroen De Meerleer
+- Ruben van Erk
+- Fabian Zimmermann
+- Mirko Berger
+- KaihatsuOnline
+- MihataBG
+
+## 2020
+- Hannes Körber
+- Julien Cassagne
+- bu4ak
+- Viktor Yakovlev
+- Oliver Kaufmann
+- Arvind Chembarpu
+- GrayStrider
+- psychowood
+- Hosh Sadiq
+- emansih
+- Aniruddha Maru
+- johnny
+- sephrat
+- bpatath
+- Florian Dupret
+- Maxim Kurbatov
+- Lucas Guima
+- Sandro
+- Ruben Verhoef
+- Daniel Idzerda
+- Calum Smith
+- Agraphie
+- Tomer Shvueli
+- Tomer S
+
+## 2019
+- Pascal Jungblut
+- Justyn Shull
+- Timendum
+- Nicolas Lœuillet
+- Dominic Guhl
+- Melroy van den Berg
+- Henning Stein
+- Jan Klepek
+- Jonathan
+- Geoffrey “Frogeye” Preud'homme
+- Michael Fix
+- Juraj Mlich
+- Eddybrando Vásquez
+- hulloanson
+- Will Rouesnel
+- lastlink
+- Mr. Funk
+- Simon Taddiken
+- Joris
+- Bastiaan Nijkamp
+
+## 2018
+- a1ex4
+- Daniel Quah
+- Marco Lourenço
+- Dennis Enderink
+- Luca Bognolo
+- Mike Conway
+- Ben
+- Mathieu Post
+- George Hertz
+- HamuZ HamuZ
+- David Meiseles
+- Erik Gelderblom
+- Luca Vallerini
+- Clemens Wijnekus
+- Jacob Weisz
+- Mateusz Gozdek
+- anmol26s
+- Kevin Hellemun
+- Shashank M Chakravarthy
+- Nico Schreiner
+- Paul Sohier
+- Brenden Conte
+- Ben Yanke
+- Andrew Prokhorenkov
+- devlearner
+- Kelvin
+- J'informatique
+
+## 2017
+- Victor Mosin
+- Justin
+- Hugo van Duijn
+- Lukas Winkler
+- Marcin Szymanski
+- Jens Kat
+- koziolek
+- jleeong
+- Simon Hanna
+- richard & xeli.eu
+- Sergey Besedin
+- Welbert Serra
+- Joris de Vries
+- Patrick Kostjens
+- Enrico Lamperti
+- Christian Musa
+- Enno Lohmeier
+
+## 2016
+- Sander
+- Toon Schoenmakers
+- Telyn
+- Sander Kleykens
+- Tom van der Werf
+- Matthew Peck
+- Sander Mulders
+- Bonno Nachtegaal-Karels
+- Niek Haarman
+- Edwin
+- Thijs Alkemade
+- zjean
+- Graham Miller
+- Robert Horlings
+- leander091
+
+## 2015
+- Antonio Spinelli
+- Colin O'Dell
+- RonaldvanMeer
+- Richard Ebbers
+- Balazs Varkonyi
+- Niek van der Kooy
+- Ilya Kil
+
+## 2014
+- Stewart Malik
+- Graham Campbell
+
+
+Thank you for all your support!

app/Api/V1/Controllers/Autocomplete/AccountController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -25,14 +26,17 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Enums\AccountTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\Debug\Timer;
+use FireflyIII\Support\Facades\Amount;
+use FireflyIII\Support\Facades\Steam;
 use FireflyIII\Support\Http\Api\AccountFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use JsonException;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class AccountController
@@ -41,6 +45,10 @@ class AccountController extends Controller
 {
     use AccountFilter;
 
+    // this array only exists to test if the constructor will use it properly.
+    protected array $accepts = ['application/json', 'application/vnd.api+json'];
+
+    /** @var array<int, string> */
     private array                      $balanceTypes;
     private AccountRepositoryInterface $repository;
 
@@ -60,72 +68,78 @@ class AccountController extends Controller
                 return $next($request);
             }
         );
-        $this->balanceTypes = [AccountType::ASSET, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE,];
+        $this->balanceTypes = [AccountTypeEnum::ASSET->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::DEBT->value, AccountTypeEnum::MORTGAGE->value];
     }
 
     /**
      * Documentation for this endpoint:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getAccountsAC
      *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
-     * @throws JsonException
      * @throws FireflyException
      * @throws FireflyException
      */
     public function accounts(AutocompleteRequest $request): JsonResponse
     {
-        $data  = $request->getData();
-        $types = $data['types'];
-        $query = $data['query'];
-        $date  = $data['date'] ?? today(config('app.timezone'));
+        $data        = $request->getData();
+        $types       = $data['types'];
+        $query       = $data['query'];
+        $date        = $data['date'] ?? today(config('app.timezone'));
+        $return      = [];
+        $timer       = Timer::getInstance();
+        $timer->start(sprintf('AC accounts "%s"', $query));
+        $result      = $this->repository->searchAccount((string) $query, $types, $this->parameters->get('limit'));
 
-        $return = [];
+        // set date to subday + end-of-day for account balance. so it is at $date 23:59:59
+        $date->endOfDay();
 
-        $result = $this->repository->searchAccount((string)$query, $types, $this->parameters->get('limit'));
-        // TODO this code is duplicated in the V2 Autocomplete controller, which means this code is due to be deprecated.
-        $defaultCurrency = app('amount')->getDefaultCurrency();
+        $allBalances = Steam::accountsBalancesOptimized($result, $date, $this->primaryCurrency, $this->convertToPrimary);
 
         /** @var Account $account */
         foreach ($result as $account) {
             $nameWithBalance = $account->name;
-            $currency        = $this->repository->getAccountCurrency($account) ?? $defaultCurrency;
-
+            $currency        = $this->repository->getAccountCurrency($account) ?? $this->primaryCurrency;
+            $useCurrency     = $currency;
             if (in_array($account->accountType->type, $this->balanceTypes, true)) {
-                $balance         = app('steam')->balance($account, $date);
-                $nameWithBalance = sprintf(
-                    '%s (%s)',
-                    $account->name,
-                    app('amount')->formatAnything($currency, $balance, false)
-                );
+                // this one is correct.
+                Log::debug(sprintf('accounts: Call finalAccountBalance with date/time "%s"', $date->toIso8601String()));
+                $balance         = $allBalances[$account->id] ?? [];
+                $key             = $this->convertToPrimary && $currency->id !== $this->primaryCurrency->id ? 'pc_balance' : 'balance';
+                $useCurrency     = $this->convertToPrimary && $currency->id !== $this->primaryCurrency->id ? $this->primaryCurrency : $currency;
+                $amount          = $balance[$key] ?? '0';
+                $nameWithBalance = sprintf('%s (%s)', $account->name, Amount::formatAnything($useCurrency, $amount, false));
             }
 
-            $return[] = [
-                'id'                      => (string)$account->id,
-                'name'                    => $account->name,
-                'name_with_balance'       => $nameWithBalance,
-                'type'                    => $account->accountType->type,
-                'currency_id'             => (string)$currency->id,
-                'currency_name'           => $currency->name,
-                'currency_code'           => $currency->code,
-                'currency_symbol'         => $currency->symbol,
-                'currency_decimal_places' => $currency->decimal_places,
+            $return[]        = [
+                'id'                              => (string) $account->id,
+                'name'                            => $account->name,
+                'name_with_balance'               => $nameWithBalance,
+                'type'                            => $account->accountType->type,
+                'currency_id'                     => (string) $useCurrency->id,
+                'currency_name'                   => $useCurrency->name,
+                'currency_code'                   => $useCurrency->code,
+                'currency_symbol'                 => $useCurrency->symbol,
+                'currency_decimal_places'         => $useCurrency->decimal_places,
+                'account_currency_id'             => (string) $currency->id,
+                'account_currency_name'           => $currency->name,
+                'account_currency_code'           => $currency->code,
+                'account_currency_symbol'         => $currency->symbol,
+                'account_currency_decimal_places' => $currency->decimal_places,
             ];
         }
 
         // custom order.
         usort(
             $return,
-            function ($a, $b) {
-                $order = [AccountType::ASSET, AccountType::REVENUE, AccountType::EXPENSE];
-                $posA  = array_search($a['type'], $order, true);
-                $posB  = array_search($b['type'], $order, true);
+            static function (array $left, array $right) {
+                $order = [AccountTypeEnum::ASSET->value, AccountTypeEnum::REVENUE->value, AccountTypeEnum::EXPENSE->value];
+                $posA  = (int) array_search($left['type'], $order, true);
+                $posB  = (int) array_search($right['type'], $order, true);
 
                 return $posA - $posB;
             }
         );
+        $timer->stop(sprintf('AC accounts "%s"', $query));
 
-        return response()->json($return);
+        return response()->api($return);
     }
 }

app/Api/V1/Controllers/Autocomplete/BillController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BillController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -58,25 +59,19 @@ class BillController extends Controller
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getBillsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function bills(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
         $result   = $this->repository->searchBill($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Bill $item) {
-                return [
-                    'id'     => (string)$item->id,
-                    'name'   => $item->name,
-                    'active' => $item->active,
-                ];
-            }
+            static fn (Bill $item) => [
+                'id'     => (string) $item->id,
+                'name'   => $item->name,
+                'active' => $item->active,
+            ]
         );
 
-        return response()->json($filtered->toArray());
+        return response()->api($filtered->toArray());
     }
 }

app/Api/V1/Controllers/Autocomplete/BudgetController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BudgetController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -58,24 +59,18 @@ class BudgetController extends Controller
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getBudgetsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function budgets(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
         $result   = $this->repository->searchBudget($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Budget $item) {
-                return [
-                    'id'   => (string)$item->id,
-                    'name' => $item->name,
-                ];
-            }
+            static fn (Budget $item) => [
+                'id'   => (string) $item->id,
+                'name' => $item->name,
+            ]
         );
 
-        return response()->json($filtered);
+        return response()->api($filtered->toArray());
     }
 }

app/Api/V1/Controllers/Autocomplete/CategoryController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CategoryController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -58,24 +59,18 @@ class CategoryController extends Controller
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCategoriesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function categories(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
         $result   = $this->repository->searchCategory($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Category $item) {
-                return [
-                    'id'   => (string)$item->id,
-                    'name' => $item->name,
-                ];
-            }
+            static fn (Category $item) => [
+                'id'   => (string) $item->id,
+                'name' => $item->name,
+            ]
         );
 
-        return response()->json($filtered);
+        return response()->api($filtered->toArray());
     }
 }

app/Api/V1/Controllers/Autocomplete/CurrencyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CurrencyController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -23,10 +24,11 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
+use Deprecated;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
 use FireflyIII\Models\TransactionCurrency;
-use FireflyIII\Repositories\UserGroups\Currency\CurrencyRepositoryInterface;
+use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
@@ -58,10 +60,6 @@ class CurrencyController extends Controller
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCurrenciesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function currencies(AutocompleteRequest $request): JsonResponse
     {
@@ -72,7 +70,7 @@ class CurrencyController extends Controller
         /** @var TransactionCurrency $currency */
         foreach ($collection as $currency) {
             $result[] = [
-                'id'             => (string)$currency->id,
+                'id'             => (string) $currency->id,
                 'name'           => $currency->name,
                 'code'           => $currency->code,
                 'symbol'         => $currency->symbol,
@@ -80,18 +78,14 @@ class CurrencyController extends Controller
             ];
         }
 
-        return response()->json($result);
+        return response()->api($result);
     }
 
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCurrenciesCodeAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
-     * @deprecated
      */
+    #[Deprecated]
     public function currenciesWithCode(AutocompleteRequest $request): JsonResponse
     {
         $data       = $request->getData();
@@ -101,7 +95,7 @@ class CurrencyController extends Controller
         /** @var TransactionCurrency $currency */
         foreach ($collection as $currency) {
             $result[] = [
-                'id'             => (string)$currency->id,
+                'id'             => (string) $currency->id,
                 'name'           => sprintf('%s (%s)', $currency->name, $currency->code),
                 'code'           => $currency->code,
                 'symbol'         => $currency->symbol,
@@ -109,6 +103,6 @@ class CurrencyController extends Controller
             ];
         }
 
-        return response()->json($result);
+        return response()->api($result);
     }
 }

app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * ObjectGroupController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -58,10 +59,6 @@ class ObjectGroupController extends Controller
     /**
      * Documentation for this endpoint is at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getObjectGroupsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function objectGroups(AutocompleteRequest $request): JsonResponse
     {
@@ -72,12 +69,12 @@ class ObjectGroupController extends Controller
         /** @var ObjectGroup $objectGroup */
         foreach ($result as $objectGroup) {
             $return[] = [
-                'id'    => (string)$objectGroup->id,
+                'id'    => (string) $objectGroup->id,
                 'name'  => $objectGroup->title,
                 'title' => $objectGroup->title,
             ];
         }
 
-        return response()->json($return);
+        return response()->api($return);
     }
 }

app/Api/V1/Controllers/Autocomplete/PiggyBankController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * PiggyBankController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -62,76 +63,67 @@ class PiggyBankController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getPiggiesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function piggyBanks(AutocompleteRequest $request): JsonResponse
     {
-        $data            = $request->getData();
-        $piggies         = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
-        $defaultCurrency = app('amount')->getDefaultCurrency();
-        $response        = [];
+        $data     = $request->getData();
+        $piggies  = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
+        $response = [];
 
         /** @var PiggyBank $piggy */
         foreach ($piggies as $piggy) {
-            $currency    = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
+            $currency    = $piggy->transactionCurrency;
             $objectGroup = $piggy->objectGroups()->first();
             $response[]  = [
-                'id'                      => (string)$piggy->id,
+                'id'                      => (string) $piggy->id,
                 'name'                    => $piggy->name,
-                'currency_id'             => (string)$currency->id,
+                'currency_id'             => (string) $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
                 'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
-                'object_group_id'         => null === $objectGroup ? null : (string)$objectGroup->id,
+                'object_group_id'         => null === $objectGroup ? null : (string) $objectGroup->id,
                 'object_group_title'      => $objectGroup?->title,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getPiggiesBalanceAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function piggyBanksWithBalance(AutocompleteRequest $request): JsonResponse
     {
-        $data            = $request->getData();
-        $piggies         = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
-        $defaultCurrency = app('amount')->getDefaultCurrency();
-        $response        = [];
+        $data     = $request->getData();
+        $piggies  = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
+        $response = [];
+
         /** @var PiggyBank $piggy */
         foreach ($piggies as $piggy) {
-            $currency      = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
-            $currentAmount = $this->piggyRepository->getRepetition($piggy)->currentamount ?? '0';
+            $currency      = $piggy->transactionCurrency;
+            $currentAmount = $this->piggyRepository->getCurrentAmount($piggy);
             $objectGroup   = $piggy->objectGroups()->first();
             $response[]    = [
-                'id'                      => (string)$piggy->id,
+                'id'                      => (string) $piggy->id,
                 'name'                    => $piggy->name,
                 'name_with_balance'       => sprintf(
                     '%s (%s / %s)',
                     $piggy->name,
                     app('amount')->formatAnything($currency, $currentAmount, false),
-                    app('amount')->formatAnything($currency, $piggy->targetamount, false),
+                    app('amount')->formatAnything($currency, $piggy->target_amount, false),
                 ),
-                'currency_id'             => (string)$currency->id,
+                'currency_id'             => (string) $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
                 'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
-                'object_group_id'         => null === $objectGroup ? null : (string)$objectGroup->id,
+                'object_group_id'         => null === $objectGroup ? null : (string) $objectGroup->id,
                 'object_group_title'      => $objectGroup?->title,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 }

app/Api/V1/Controllers/Autocomplete/RecurrenceController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RecurrenceController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -56,10 +57,6 @@ class RecurrenceController extends Controller
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRecurringAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function recurring(AutocompleteRequest $request): JsonResponse
     {
@@ -70,12 +67,12 @@ class RecurrenceController extends Controller
         /** @var Recurrence $recurrence */
         foreach ($recurrences as $recurrence) {
             $response[] = [
-                'id'          => (string)$recurrence->id,
+                'id'          => (string) $recurrence->id,
                 'name'        => $recurrence->title,
                 'description' => $recurrence->description,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 }

app/Api/V1/Controllers/Autocomplete/RuleController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RuleController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -55,10 +56,6 @@ class RuleController extends Controller
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRulesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function rules(AutocompleteRequest $request): JsonResponse
     {
@@ -69,12 +66,12 @@ class RuleController extends Controller
         /** @var Rule $rule */
         foreach ($rules as $rule) {
             $response[] = [
-                'id'          => (string)$rule->id,
+                'id'          => (string) $rule->id,
                 'name'        => $rule->title,
                 'description' => $rule->description,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 }

app/Api/V1/Controllers/Autocomplete/RuleGroupController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RuleGroupController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -55,10 +56,6 @@ class RuleGroupController extends Controller
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRuleGroupsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function ruleGroups(AutocompleteRequest $request): JsonResponse
     {
@@ -69,12 +66,12 @@ class RuleGroupController extends Controller
         /** @var RuleGroup $group */
         foreach ($groups as $group) {
             $response[] = [
-                'id'          => (string)$group->id,
+                'id'          => (string) $group->id,
                 'name'        => $group->title,
                 'description' => $group->description,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 }

app/Api/V1/Controllers/Autocomplete/TagController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TagController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -58,26 +59,22 @@ class TagController extends Controller
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTagAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function tags(AutocompleteRequest $request): JsonResponse
     {
-        $data = $request->getData();
-
+        $data   = $request->getData();
         $result = $this->repository->searchTags($data['query'], $this->parameters->get('limit'));
         $array  = [];
+
         /** @var Tag $tag */
         foreach ($result as $tag) {
             $array[] = [
-                'id'   => (string)$tag->id,
+                'id'   => (string) $tag->id,
                 'name' => $tag->tag,
                 'tag'  => $tag->tag,
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Autocomplete/TransactionController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TransactionController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -23,8 +24,10 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
+use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Enums\UserRoleEnum;
 use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
 use FireflyIII\Repositories\TransactionGroup\TransactionGroupRepositoryInterface;
@@ -37,6 +40,7 @@ use Illuminate\Support\Collection;
  */
 class TransactionController extends Controller
 {
+    protected array $acceptedRoles = [UserRoleEnum::READ_ONLY];
     private TransactionGroupRepositoryInterface $groupRepository;
     private JournalRepositoryInterface          $repository;
 
@@ -50,10 +54,12 @@ class TransactionController extends Controller
             function ($request, $next) {
                 /** @var User $user */
                 $user                  = auth()->user();
+                $userGroup             = $this->validateUserGroup($request);
                 $this->repository      = app(JournalRepositoryInterface::class);
                 $this->groupRepository = app(TransactionGroupRepositoryInterface::class);
                 $this->repository->setUser($user);
                 $this->groupRepository->setUser($user);
+                $this->groupRepository->setUserGroup($userGroup);
 
                 return $next($request);
             }
@@ -63,15 +69,11 @@ class TransactionController extends Controller
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function transactions(AutocompleteRequest $request): JsonResponse
     {
-        $data   = $request->getData();
-        $result = $this->repository->searchJournalDescriptions($data['query'], $this->parameters->get('limit'));
+        $data     = $request->getData();
+        $result   = $this->repository->searchJournalDescriptions($data['query'], $this->parameters->get('limit'));
 
         // limit and unique
         $filtered = $result->unique('description');
@@ -80,23 +82,19 @@ class TransactionController extends Controller
         /** @var TransactionJournal $journal */
         foreach ($filtered as $journal) {
             $array[] = [
-                'id'                   => (string)$journal->id,
-                'transaction_group_id' => (string)$journal->transaction_group_id,
+                'id'                   => (string) $journal->id,
+                'transaction_group_id' => (string) $journal->transaction_group_id,
                 'name'                 => $journal->description,
                 'description'          => $journal->description,
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 
     /**
      * This endpoint is documented at:
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionsIDAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function transactionsWithID(AutocompleteRequest $request): JsonResponse
     {
@@ -104,8 +102,8 @@ class TransactionController extends Controller
         $result = new Collection();
         if (is_numeric($data['query'])) {
             // search for group, not journal.
-            $firstResult = $this->groupRepository->find((int)$data['query']);
-            if (null !== $firstResult) {
+            $firstResult = $this->groupRepository->find((int) $data['query']);
+            if ($firstResult instanceof TransactionGroup) {
                 // group may contain multiple journals, each a result:
                 foreach ($firstResult->transactionJournals as $journal) {
                     $result->push($journal);
@@ -117,18 +115,18 @@ class TransactionController extends Controller
         }
 
         // limit and unique
-        $array = [];
+        $array  = [];
 
         /** @var TransactionJournal $journal */
         foreach ($result as $journal) {
             $array[] = [
-                'id'                   => (string)$journal->id,
-                'transaction_group_id' => (string)$journal->transaction_group_id,
+                'id'                   => (string) $journal->id,
+                'transaction_group_id' => (string) $journal->transaction_group_id,
                 'name'                 => sprintf('#%d: %s', $journal->transaction_group_id, $journal->description),
                 'description'          => sprintf('#%d: %s', $journal->transaction_group_id, $journal->description),
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TransactionTypeController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -54,10 +55,6 @@ class TransactionTypeController extends Controller
     /**
      * This endpoint is documented at
      * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionTypesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
      */
     public function transactionTypes(AutocompleteRequest $request): JsonResponse
     {
@@ -69,12 +66,12 @@ class TransactionTypeController extends Controller
         foreach ($types as $type) {
             // different key for consistency.
             $array[] = [
-                'id'   => (string)$type->id,
+                'id'   => (string) $type->id,
                 'name' => $type->type,
                 'type' => $type->type,
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Chart/AccountController.php

@@ -26,17 +26,23 @@ namespace FireflyIII\Api\V1\Controllers\Chart;
 
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Chart\ChartRequest;
 use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Enums\AccountTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Exceptions\ValidationException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
+use FireflyIII\Models\Preference;
+use FireflyIII\Models\TransactionCurrency;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\Chart\ChartData;
+use FireflyIII\Support\Facades\Preferences;
+use FireflyIII\Support\Facades\Steam;
 use FireflyIII\Support\Http\Api\ApiSupport;
+use FireflyIII\Support\Http\Api\CollectsAccountsFromFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use JsonException;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class AccountController
@@ -44,13 +50,13 @@ use Psr\Container\NotFoundExceptionInterface;
 class AccountController extends Controller
 {
     use ApiSupport;
+    use CollectsAccountsFromFilter;
 
+    private ChartData                  $chartData;
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -59,6 +65,7 @@ class AccountController extends Controller
             function ($request, $next) {
                 /** @var User $user */
                 $user             = auth()->user();
+                $this->chartData  = new ChartData();
                 $this->repository = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -67,48 +74,129 @@ class AccountController extends Controller
         );
     }
 
+    /**
+     * TODO fix documentation
+     *
+     * @throws FireflyException
+     */
+    public function dashboard(ChartRequest $request): JsonResponse
+    {
+        $queryParameters = $request->getParameters();
+        $accounts        = $this->getAccountList($queryParameters);
+
+        // move date to end of day
+        $queryParameters['start']->startOfDay();
+        $queryParameters['end']->endOfDay();
+        Log::debug(sprintf('dashboard(), convert to primary: %s', var_export($this->convertToPrimary, true)));
+
+        // loop each account, and collect info:
+        /** @var Account $account */
+        foreach ($accounts as $account) {
+            Log::debug(sprintf('Account #%d ("%s")', $account->id, $account->name));
+            $this->renderAccountData($queryParameters, $account);
+        }
+
+        return response()->json($this->chartData->render());
+    }
+
+    /**
+     * @throws FireflyException
+     */
+    private function renderAccountData(array $params, Account $account): void
+    {
+        Log::debug(sprintf('Now in %s(array, #%d)', __METHOD__, $account->id));
+        $currency     = $this->repository->getAccountCurrency($account);
+        $currentStart = clone $params['start'];
+        $range        = Steam::finalAccountBalanceInRange($account, $params['start'], clone $params['end'], $this->convertToPrimary);
+
+
+        $previous     = array_values($range)[0]['balance'];
+        $pcPrevious   = null;
+        if (!$currency instanceof TransactionCurrency) {
+            $currency = $this->default;
+        }
+        $currentSet   = [
+            'label'                   => $account->name,
+
+            // the currency that belongs to the account.
+            'currency_id'             => (string)$currency->id,
+            'currency_code'           => $currency->code,
+            'currency_symbol'         => $currency->symbol,
+            'currency_decimal_places' => $currency->decimal_places,
+
+            // the default currency of the user (could be the same!)
+            'date'                    => $params['start']->toAtomString(),
+            'start'                   => $params['start']->toAtomString(),
+            'end'                     => $params['end']->toAtomString(),
+            'period'                  => '1D',
+            'entries'                 => [],
+        ];
+        if ($this->convertToPrimary) {
+            $currentSet['pc_entries']                      = [];
+            $currentSet['primary_currency_id']             = (string)$this->primaryCurrency->id;
+            $currentSet['primary_currency_code']           = $this->primaryCurrency->code;
+            $currentSet['primary_currency_symbol']         = $this->primaryCurrency->symbol;
+            $currentSet['primary_currency_decimal_places'] = $this->primaryCurrency->decimal_places;
+            $pcPrevious                                    = array_values($range)[0]['pc_balance'];
+        }
+
+
+        while ($currentStart <= $params['end']) {
+            $format                        = $currentStart->format('Y-m-d');
+            $label                         = $currentStart->toAtomString();
+            $balance                       = array_key_exists($format, $range) ? $range[$format]['balance'] : $previous;
+            $previous                      = $balance;
+            $currentSet['entries'][$label] = $balance;
+
+
+            // do the same for the primary currency balance, if relevant:
+            $pcBalance                     = null;
+            if ($this->convertToPrimary) {
+                $pcBalance                        = array_key_exists($format, $range) ? $range[$format]['pc_balance'] : $pcPrevious;
+                $pcPrevious                       = $pcBalance;
+                $currentSet['pc_entries'][$label] = $pcBalance;
+            }
+
+            $currentStart->addDay();
+        }
+        $this->chartData->add($currentSet);
+    }
+
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/charts/getChartAccountOverview
      *
-     * @param DateRequest $request
-     *
-     * @return JsonResponse
-     * @throws FireflyException
-     * @throws JsonException
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
+     * @throws ValidationException
      */
     public function overview(DateRequest $request): JsonResponse
     {
         // parameters for chart:
-        $dates = $request->getAll();
+        $dates        = $request->getAll();
+
+
         /** @var Carbon $start */
-        $start = $dates['start'];
+        $start        = $dates['start'];
+
         /** @var Carbon $end */
-        $end = $dates['end'];
+        $end          = $dates['end'];
 
-        // user's preferences
-        $defaultSet = $this->repository->getAccountsByType([AccountType::ASSET])->pluck('id')->toArray();
-        $frontPage  = app('preferences')->get('frontPageAccounts', $defaultSet);
-        $default    = app('amount')->getDefaultCurrency();
+        // set dates to end of day + start of day:
+        $start->startOfDay();
+        $end->endOfDay();
 
-        if (!(is_array($frontPage->data) && count($frontPage->data) > 0)) {
-            $frontPage->data = $defaultSet;
-            $frontPage->save();
-        }
+        $frontPageIds = $this->getFrontPageAccountIds();
+        $accounts     = $this->repository->getAccountsById($frontPageIds);
+        $chartData    = [];
 
-
-        // get accounts:
-        $accounts  = $this->repository->getAccountsById($frontPage->data);
-        $chartData = [];
         /** @var Account $account */
         foreach ($accounts as $account) {
-            $currency = $this->repository->getAccountCurrency($account);
-            if (null === $currency) {
-                $currency = $default;
-            }
-            $currentSet = [
+            Log::debug(sprintf('Rendering chart data for account %s (%d)', $account->name, $account->id));
+            $currency     = $this->repository->getAccountCurrency($account) ?? $this->primaryCurrency;
+            $currentStart = clone $start;
+            $range        = Steam::finalAccountBalanceInRange($account, $start, clone $end, $this->convertToPrimary);
+            $previous     = array_values($range)[0]['balance'];
+            $pcPrevious   = null;
+            $currentSet   = [
                 'label'                   => $account->name,
                 'currency_id'             => (string)$currency->id,
                 'currency_code'           => $currency->code,
@@ -120,22 +208,57 @@ class AccountController extends Controller
                 'yAxisID'                 => 0, // 0, 1, 2
                 'entries'                 => [],
             ];
-            // TODO this code is also present in the V2 chart account controller so this method is due to be deprecated.
-            $currentStart = clone $start;
-            $range        = app('steam')->balanceInRange($account, $start, clone $end);
-            // 2022-10-11 this method no longer converts to float.
-            $previous = array_values($range)[0];
-            while ($currentStart <= $end) {
-                $format   = $currentStart->format('Y-m-d');
-                $label    = $currentStart->toAtomString();
-                $balance  = array_key_exists($format, $range) ? $range[$format] : $previous;
-                $previous = $balance;
-                $currentStart->addDay();
-                $currentSet['entries'][$label] = $balance;
+
+            // add "pc_entries" if convertToPrimary is true:
+            if ($this->convertToPrimary) {
+                $currentSet['pc_entries']                      = [];
+                $currentSet['primary_currency_id']             = (string)$this->primaryCurrency->id;
+                $currentSet['primary_currency_code']           = $this->primaryCurrency->code;
+                $currentSet['primary_currency_symbol']         = $this->primaryCurrency->symbol;
+                $currentSet['primary_currency_decimal_places'] = $this->primaryCurrency->decimal_places;
+                $pcPrevious                                    = array_values($range)[0]['pc_balance'];
+
             }
-            $chartData[] = $currentSet;
+
+            // also get the primary balance if convertToPrimary is true:
+            while ($currentStart <= $end) {
+                $format                        = $currentStart->format('Y-m-d');
+                $label                         = $currentStart->toAtomString();
+
+                // balance is based on "balance" from the $range variable.
+                $balance                       = array_key_exists($format, $range) ? $range[$format]['balance'] : $previous;
+                $previous                      = $balance;
+                $currentSet['entries'][$label] = $balance;
+
+                // do the same for the primary balance, if relevant:
+                $pcBalance                     = null;
+                if ($this->convertToPrimary) {
+                    $pcBalance                        = array_key_exists($format, $range) ? $range[$format]['pc_balance'] : $pcPrevious;
+                    $pcPrevious                       = $pcBalance;
+                    $currentSet['pc_entries'][$label] = $pcBalance;
+                }
+
+                $currentStart->addDay();
+
+            }
+            $chartData[]  = $currentSet;
         }
 
         return response()->json($chartData);
     }
+
+    private function getFrontPageAccountIds(): array
+    {
+        $defaultSet = $this->repository->getAccountsByType([AccountTypeEnum::ASSET->value])->pluck('id')->toArray();
+
+        /** @var Preference $frontpage */
+        $frontpage  = Preferences::get('frontpageAccounts', $defaultSet);
+
+        if (!(is_array($frontpage->data) && count($frontpage->data) > 0)) {
+            $frontpage->data = $defaultSet;
+            $frontpage->save();
+        }
+
+        return $frontpage->data ?? $defaultSet;
+    }
 }

app/Api/V1/Controllers/Chart/BalanceController.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Chart;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Chart\ChartRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\Chart\ChartData;
+use FireflyIII\Support\Facades\Amount;
+use FireflyIII\Support\Http\Api\AccountBalanceGrouped;
+use FireflyIII\Support\Http\Api\CleansChartData;
+use FireflyIII\Support\Http\Api\CollectsAccountsFromFilter;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class BalanceController
+ */
+class BalanceController extends Controller
+{
+    use CleansChartData;
+    use CollectsAccountsFromFilter;
+
+    private ChartData                  $chartData;
+    private GroupCollectorInterface    $collector;
+    private AccountRepositoryInterface $repository;
+
+    // private TransactionCurrency        $default;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(AccountRepositoryInterface::class);
+                $this->collector  = app(GroupCollectorInterface::class);
+                $userGroup        = $this->validateUserGroup($request);
+                $this->repository->setUserGroup($userGroup);
+                $this->collector->setUserGroup($userGroup);
+                $this->chartData  = new ChartData();
+                // $this->default    = app('amount')->getPrimaryCurrency();
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * The code is practically a duplicate of ReportController::operations.
+     *
+     * Currency is up to the account/transactions in question, but conversion to the default
+     * currency is possible.
+     *
+     * If the transaction being processed is already in native currency OR if the
+     * foreign amount is in the native currency, the amount will not be converted.
+     *
+     * @throws FireflyException
+     */
+    public function balance(ChartRequest $request): JsonResponse
+    {
+        $queryParameters = $request->getParameters();
+        $accounts        = $this->getAccountList($queryParameters);
+
+        // prepare for currency conversion and data collection:
+        /** @var TransactionCurrency $primary */
+        $primary         = Amount::getPrimaryCurrency();
+
+        // get journals for entire period:
+
+        $this->collector->setRange($queryParameters['start'], $queryParameters['end'])
+            ->withAccountInformation()
+            ->setXorAccounts($accounts)
+            ->setTypes([TransactionTypeEnum::WITHDRAWAL->value, TransactionTypeEnum::DEPOSIT->value, TransactionTypeEnum::RECONCILIATION->value, TransactionTypeEnum::TRANSFER->value])
+        ;
+        $journals        = $this->collector->getExtractedJournals();
+
+        $object          = new AccountBalanceGrouped();
+        $object->setPreferredRange($queryParameters['period']);
+        $object->setPrimary($primary);
+        $object->setAccounts($accounts);
+        $object->setJournals($journals);
+        $object->setStart($queryParameters['start']);
+        $object->setEnd($queryParameters['end']);
+        $object->groupByCurrencyAndPeriod();
+        $data            = $object->convertToChartData();
+        foreach ($data as $entry) {
+            $this->chartData->add($entry);
+        }
+
+        return response()->json($this->chartData->render());
+    }
+}

app/Api/V1/Controllers/Chart/BudgetController.php

@@ -1,6 +1,5 @@
 <?php
 
-
 /*
  * BudgetController.php
  * Copyright (c) 2023 james@firefly-iii.org
@@ -23,23 +22,25 @@
 
 declare(strict_types=1);
 
-namespace FireflyIII\Api\V2\Controllers\Chart;
+namespace FireflyIII\Api\V1\Controllers\Chart;
 
 use Carbon\Carbon;
-use FireflyIII\Api\V2\Controllers\Controller;
-use FireflyIII\Api\V2\Request\Generic\DateRequest;
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Enums\UserRoleEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
 use FireflyIII\Models\TransactionCurrency;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
-use FireflyIII\Repositories\UserGroups\Budget\BudgetRepositoryInterface;
-use FireflyIII\Repositories\UserGroups\Budget\OperationsRepositoryInterface;
+use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Repositories\Budget\OperationsRepositoryInterface;
 use FireflyIII\Support\Http\Api\CleansChartData;
 use FireflyIII\Support\Http\Api\ExchangeRateConverter;
 use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class BudgetController
@@ -49,6 +50,8 @@ class BudgetController extends Controller
     use CleansChartData;
     use ValidatesUserGroupTrait;
 
+    protected array $acceptedRoles                      = [UserRoleEnum::READ_ONLY];
+
     protected OperationsRepositoryInterface $opsRepository;
     private BudgetLimitRepositoryInterface  $blRepository;
     private array                           $currencies = [];
@@ -63,13 +66,10 @@ class BudgetController extends Controller
                 $this->repository    = app(BudgetRepositoryInterface::class);
                 $this->blRepository  = app(BudgetLimitRepositoryInterface::class);
                 $this->opsRepository = app(OperationsRepositoryInterface::class);
-                $this->currency      = app('amount')->getDefaultCurrency();
-
-                $userGroup = $this->validateUserGroup($request);
-                if (null !== $userGroup) {
-                    $this->repository->setUserGroup($userGroup);
-                    $this->opsRepository->setUserGroup($userGroup);
-                }
+                $userGroup           = $this->validateUserGroup($request);
+                $this->repository->setUserGroup($userGroup);
+                $this->opsRepository->setUserGroup($userGroup);
+                $this->blRepository->setUserGroup($userGroup);
 
                 return $next($request);
             }
@@ -77,56 +77,70 @@ class BudgetController extends Controller
     }
 
     /**
-     * @param DateRequest $request
-     *
      * TODO see autocomplete/accountcontroller
      *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function dashboard(DateRequest $request): JsonResponse
     {
-        $params = $request->getAll();
+        $params  = $request->getAll();
+
         /** @var Carbon $start */
-        $start = $params['start'];
+        $start   = $params['start'];
+
         /** @var Carbon $end */
-        $end = $params['end'];
+        $end     = $params['end'];
 
         // code from FrontpageChartGenerator, but not in separate class
         $budgets = $this->repository->getActiveBudgets();
         $data    = [];
+
         /** @var Budget $budget */
         foreach ($budgets as $budget) {
             // could return multiple arrays, so merge.
             $data = array_merge($data, $this->processBudget($budget, $start, $end));
         }
+
         return response()->json($this->clean($data));
     }
 
     /**
-     * @param Budget $budget
-     * @param Carbon $start
-     * @param Carbon $end
-     *
-     * @return array
      * @throws FireflyException
      */
     private function processBudget(Budget $budget, Carbon $start, Carbon $end): array
     {
         // get all limits:
-        $limits = $this->blRepository->getBudgetLimits($budget, $start, $end);
-        $rows   = [];
+        $limits   = $this->blRepository->getBudgetLimits($budget, $start, $end);
+        $rows     = [];
+        $spent    = $this->opsRepository->listExpenses($start, $end, null, new Collection([$budget]));
+        $expenses = $this->processExpenses($budget->id, $spent, $start, $end);
+
+        /**
+         * @var int   $currencyId
+         * @var array $row
+         */
+        foreach ($expenses as $currencyId => $row) {
+            // budgeted, left and overspent are now 0.
+            $limit  = $this->filterLimit($currencyId, $limits);
+            if (null !== $limit) {
+                $row['budgeted']  = $limit->amount;
+                $row['left']      = bcsub($row['budgeted'], bcmul($row['spent'], '-1'));
+                $row['overspent'] = bcmul($row['left'], '-1');
+                $row['left']      = 1 === bccomp($row['left'], '0') ? $row['left'] : '0';
+                $row['overspent'] = 1 === bccomp($row['overspent'], '0') ? $row['overspent'] : '0';
+            }
+            $rows[] = $row;
+        }
+
 
         // if no limits
-        if (0 === $limits->count()) {
-            // return as a single item in an array
-            $rows = $this->noBudgetLimits($budget, $start, $end);
-        }
-        if ($limits->count() > 0) {
-            $rows = $this->budgetLimits($budget, $limits);
-        }
+        //        if (0 === $limits->count()) {
+        //             return as a single item in an array
+        //            $rows = $this->noBudgetLimits($budget, $start, $end);
+        //        }
+
         // is always an array
-        $return = [];
+        $return   = [];
         foreach ($rows as $row) {
             $current  = [
                 'label'                   => $budget->name,
@@ -134,26 +148,19 @@ class BudgetController extends Controller
                 'currency_code'           => $row['currency_code'],
                 'currency_name'           => $row['currency_name'],
                 'currency_decimal_places' => $row['currency_decimal_places'],
-                'native_id'               => (string)$row['native_id'],
-                'native_code'             => $row['native_code'],
-                'native_name'             => $row['native_name'],
-                'native_decimal_places'   => $row['native_decimal_places'],
                 'period'                  => null,
                 'start'                   => $row['start'],
                 'end'                     => $row['end'],
                 'entries'                 => [
+                    'budgeted'  => $row['budgeted'],
                     'spent'     => $row['spent'],
                     'left'      => $row['left'],
                     'overspent' => $row['overspent'],
                 ],
-                'native_entries'          => [
-                    'spent'     => $row['native_spent'],
-                    'left'      => $row['native_left'],
-                    'overspent' => $row['native_overspent'],
-                ],
             ];
             $return[] = $current;
         }
+
         return $return;
     }
 
@@ -161,35 +168,24 @@ class BudgetController extends Controller
      * When no budget limits are present, the expenses of the whole period are collected and grouped.
      * This is grouped per currency. Because there is no limit set, "left to spend" and "overspent" are empty.
      *
-     * @param Budget $budget
-     * @param Carbon $start
-     * @param Carbon $end
-     *
-     * @return array
      * @throws FireflyException
      */
     private function noBudgetLimits(Budget $budget, Carbon $start, Carbon $end): array
     {
-        $budgetId = (int)$budget->id;
-        $spent    = $this->opsRepository->listExpenses($start, $end, null, new Collection([$budget]));
-        return $this->processExpenses($budgetId, $spent, $start, $end);
+        $spent = $this->opsRepository->listExpenses($start, $end, null, new Collection([$budget]));
+
+        return $this->processExpenses($budget->id, $spent, $start, $end);
     }
 
     /**
-     * Shared between the "noBudgetLimits" function and "processLimit".
+     * Shared between the "noBudgetLimits" function and "processLimit". Will take a single set of expenses and return
+     * its info.
      *
-     * Will take a single set of expenses and return its info.
-     *
-     * @param int   $budgetId
-     * @param array $array
-     *
-     * @return array
      * @throws FireflyException
      */
-    private function processExpenses(int $budgetId, array $array, Carbon $start, Carbon $end): array
+    private function processExpenses(int $budgetId, array $spent, Carbon $start, Carbon $end): array
     {
-        $converter = new ExchangeRateConverter();
-        $return    = [];
+        $return = [];
 
         /**
          * This array contains the expenses in this budget. Grouped per currency.
@@ -198,45 +194,30 @@ class BudgetController extends Controller
          * @var int   $currencyId
          * @var array $block
          */
-        foreach ($array as $currencyId => $block) {
-            $this->currencies[$currencyId] = $this->currencies[$currencyId] ?? TransactionCurrency::find($currencyId);
-            $return[$currencyId]           = $return[$currencyId] ?? [
+        foreach ($spent as $currencyId => $block) {
+            $this->currencies[$currencyId] ??= TransactionCurrency::find($currencyId);
+            $return[$currencyId]           ??= [
                 'currency_id'             => (string)$currencyId,
                 'currency_code'           => $block['currency_code'],
                 'currency_name'           => $block['currency_name'],
                 'currency_symbol'         => $block['currency_symbol'],
                 'currency_decimal_places' => (int)$block['currency_decimal_places'],
-                'native_id'               => (string)$this->currency->id,
-                'native_code'             => $this->currency->code,
-                'native_name'             => $this->currency->name,
-                'native_symbol'           => $this->currency->symbol,
-                'native_decimal_places'   => (int)$this->currency->decimal_places,
                 'start'                   => $start->toAtomString(),
                 'end'                     => $end->toAtomString(),
+                'budgeted'                => '0',
                 'spent'                   => '0',
-                'native_spent'            => '0',
                 'left'                    => '0',
-                'native_left'             => '0',
                 'overspent'               => '0',
-                'native_overspent'        => '0',
-
             ];
-            $currentBudgetArray            = $block['budgets'][$budgetId];
-            //var_dump($return);
+            $currentBudgetArray = $block['budgets'][$budgetId];
+
+            // var_dump($return);
             /** @var array $journal */
             foreach ($currentBudgetArray['transaction_journals'] as $journal) {
-
-                // convert the amount to the native currency.
-                $rate            = $converter->getCurrencyRate($this->currencies[$currencyId], $this->currency, $journal['date']);
-                $convertedAmount = bcmul($journal['amount'], $rate);
-                if ($journal['foreign_currency_id'] === $this->currency->id) {
-                    $convertedAmount = $journal['foreign_amount'];
-                }
-
-                $return[$currencyId]['spent']        = bcadd($return[$currencyId]['spent'], $journal['amount']);
-                $return[$currencyId]['native_spent'] = bcadd($return[$currencyId]['native_spent'], $convertedAmount);
+                $return[$currencyId]['spent'] = bcadd($return[$currencyId]['spent'], (string)$journal['amount']);
             }
         }
+
         return $return;
     }
 
@@ -248,16 +229,13 @@ class BudgetController extends Controller
      *
      * If you have a budget limit in EUR, and a transaction in GBP, it will not be considered for the EUR budget limit.
      *
-     * @param Budget     $budget
-     * @param Collection $limits
-     *
-     * @return array
      * @throws FireflyException
      */
     private function budgetLimits(Budget $budget, Collection $limits): array
     {
-        app('log')->debug(sprintf('Now in budgetLimits(#%d)', $budget->id));
+        Log::debug(sprintf('Now in budgetLimits(#%d)', $budget->id));
         $data = [];
+
         /** @var BudgetLimit $limit */
         foreach ($limits as $limit) {
             $data = array_merge($data, $this->processLimit($budget, $limit));
@@ -267,49 +245,68 @@ class BudgetController extends Controller
     }
 
     /**
-     * @param Budget      $budget
-     * @param BudgetLimit $limit
-     *
-     * @return array
      * @throws FireflyException
      */
     private function processLimit(Budget $budget, BudgetLimit $limit): array
     {
-        $budgetId = (int)$budget->id;
-        $end      = clone $limit->end_date;
+        Log::debug(sprintf('Created new ExchangeRateConverter in %s', __METHOD__));
+        $end             = clone $limit->end_date;
         $end->endOfDay();
-        $spent                = $this->opsRepository->listExpenses($limit->start_date, $end, null, new Collection([$budget]));
-        $limitCurrencyId      = (int)$limit->transaction_currency_id;
-        $limitCurrency        = $limit->transactionCurrency;
-        $converter            = new ExchangeRateConverter();
-        $filtered             = [];
-        $rate                 = $converter->getCurrencyRate($limitCurrency, $this->currency, $limit->start_date);
-        $convertedLimitAmount = bcmul($limit->amount, $rate);
-
+        $spent           = $this->opsRepository->listExpenses($limit->start_date, $end, null, new Collection([$budget]));
+        $limitCurrencyId = $limit->transaction_currency_id;
 
         /** @var array $entry */
-        foreach ($spent as $currencyId => $entry) {
-            // only spent the entry where the entry's currency matches the budget limit's currency
-            // so $filtered will only have 1 or 0 entries
-            if ($entry['currency_id'] === $limitCurrencyId) {
-                $filtered[$currencyId] = $entry;
-            }
-        }
-        $result = $this->processExpenses($budgetId, $filtered, $limit->start_date, $end);
+        // only spent the entry where the entry's currency matches the budget limit's currency
+        // so $filtered will only have 1 or 0 entries
+        $filtered        = array_filter($spent, fn ($entry) => $entry['currency_id'] === $limitCurrencyId);
+        $result          = $this->processExpenses($budget->id, $filtered, $limit->start_date, $end);
         if (1 === count($result)) {
-            $compare = bccomp((string)$limit->amount, app('steam')->positive($result[$limitCurrencyId]['spent']));
+            $compare                              = bccomp($limit->amount, (string)app('steam')->positive($result[$limitCurrencyId]['spent']));
+            $result[$limitCurrencyId]['budgeted'] = $limit->amount;
             if (1 === $compare) {
-                // convert this amount into the native currency:
-                $result[$limitCurrencyId]['left']        = bcadd($limit->amount, $result[$limitCurrencyId]['spent']);
-                $result[$limitCurrencyId]['native_left'] = bcadd($convertedLimitAmount, $result[$limitCurrencyId]['native_spent']);
+                // convert this amount into the primary currency:
+                $result[$limitCurrencyId]['left'] = bcadd($limit->amount, (string)$result[$limitCurrencyId]['spent']);
             }
             if ($compare <= 0) {
-                $result[$limitCurrencyId]['overspent']        = app('steam')->positive(bcadd($limit->amount, $result[$limitCurrencyId]['spent']));
-                $result[$limitCurrencyId]['native_overspent'] = app('steam')->positive(bcadd($convertedLimitAmount, $result[$limitCurrencyId]['native_spent']));
+                $result[$limitCurrencyId]['overspent'] = app('steam')->positive(bcadd($limit->amount, (string)$result[$limitCurrencyId]['spent']));
             }
         }
+
         return $result;
     }
 
+    private function filterLimit(int $currencyId, Collection $limits): ?BudgetLimit
+    {
+        $amount    = '0';
+        $limit     = null;
+        $converter = new ExchangeRateConverter();
 
+        /** @var BudgetLimit $current */
+        foreach ($limits as $current) {
+            if (true === $this->convertToPrimary) {
+                if ($current->transaction_currency_id === $this->primaryCurrency->id) {
+                    // simply add it.
+                    $amount = bcadd($amount, (string)$current->amount);
+                    Log::debug(sprintf('Set amount in limit to %s', $amount));
+                }
+                if ($current->transaction_currency_id !== $this->primaryCurrency->id) {
+                    // convert and then add it.
+                    $converted = $converter->convert($current->transactionCurrency, $this->primaryCurrency, $current->start_date, $current->amount);
+                    $amount    = bcadd($amount, $converted);
+                    Log::debug(sprintf('Budgeted in limit #%d: %s %s, converted to %s %s', $current->id, $current->transactionCurrency->code, $current->amount, $this->primaryCurrency->code, $converted));
+                    Log::debug(sprintf('Set amount in limit to %s', $amount));
+                }
+            }
+            if ($current->transaction_currency_id === $currencyId) {
+                $limit = $current;
+            }
+        }
+        if (null !== $limit && true === $this->convertToPrimary) {
+            // convert and add all amounts.
+            $limit->amount = app('steam')->positive($amount);
+            Log::debug(sprintf('Final amount in limit with converted amount %s', $limit->amount));
+        }
+
+        return $limit;
+    }
 }

app/Api/V1/Controllers/Chart/CategoryController.php

@@ -0,0 +1,152 @@
+<?php
+
+/*
+ * CategoryController.php
+ * Copyright (c) 2023 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Chart;
+
+use Carbon\Carbon;
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Enums\AccountTypeEnum;
+use FireflyIII\Enums\TransactionTypeEnum;
+use FireflyIII\Enums\UserRoleEnum;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
+use FireflyIII\Support\Http\Api\CleansChartData;
+use FireflyIII\Support\Http\Api\ExchangeRateConverter;
+use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
+
+/**
+ * Class BudgetController
+ */
+class CategoryController extends Controller
+{
+    use CleansChartData;
+    use ValidatesUserGroupTrait;
+
+    protected array $acceptedRoles = [UserRoleEnum::READ_ONLY];
+
+    private AccountRepositoryInterface  $accountRepos;
+    private CurrencyRepositoryInterface $currencyRepos;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->accountRepos  = app(AccountRepositoryInterface::class);
+                $this->currencyRepos = app(CurrencyRepositoryInterface::class);
+                $userGroup           = $this->validateUserGroup($request);
+                $this->accountRepos->setUserGroup($userGroup);
+                $this->currencyRepos->setUserGroup($userGroup);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * TODO may be worth to move to a handler but the data is simple enough.
+     * TODO see autoComplete/account controller
+     *
+     * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
+     */
+    public function dashboard(DateRequest $request): JsonResponse
+    {
+        /** @var Carbon $start */
+        $start      = $this->parameters->get('start');
+
+        /** @var Carbon $end */
+        $end        = $this->parameters->get('end');
+        $accounts   = $this->accountRepos->getAccountsByType([AccountTypeEnum::DEBT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::ASSET->value]);
+        $currencies = [];
+        $return     = [];
+        $converter  = new ExchangeRateConverter();
+
+        // get journals for entire period:
+        /** @var GroupCollectorInterface $collector */
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setRange($start, $end)->withAccountInformation();
+        $collector->setXorAccounts($accounts)->withCategoryInformation();
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value, TransactionTypeEnum::RECONCILIATION->value]);
+        $journals   = $collector->getExtractedJournals();
+
+        /** @var array $journal */
+        foreach ($journals as $journal) {
+            // find journal:
+            $journalCurrencyId              = (int)$journal['currency_id'];
+            $currency                       = $currencies[$journalCurrencyId] ?? $this->currencyRepos->find($journalCurrencyId);
+            $currencies[$journalCurrencyId] = $currency;
+            $currencyId                     = (int)$currency->id;
+            $currencyName                   = (string)$currency->name;
+            $currencyCode                   = (string)$currency->code;
+            $currencySymbol                 = (string)$currency->symbol;
+            $currencyDecimalPlaces          = (int)$currency->decimal_places;
+            $amount                         = app('steam')->positive($journal['amount']);
+
+            // overrule if necessary:
+            if ($this->convertToPrimary && $journalCurrencyId !== $this->primaryCurrency->id) {
+                $currencyId            = (int)$this->primaryCurrency->id;
+                $currencyName          = (string)$this->primaryCurrency->name;
+                $currencyCode          = (string)$this->primaryCurrency->code;
+                $currencySymbol        = (string)$this->primaryCurrency->symbol;
+                $currencyDecimalPlaces = (int)$this->primaryCurrency->decimal_places;
+                $convertedAmount       = $converter->convert($currency, $this->primaryCurrency, $journal['date'], $amount);
+                Log::debug(sprintf('Converted %s %s to %s %s', $journal['currency_code'], $amount, $this->primaryCurrency->code, $convertedAmount));
+                $amount                = $convertedAmount;
+            }
+
+
+            $categoryName                   = $journal['category_name'] ?? (string)trans('firefly.no_category');
+            $key                            = sprintf('%s-%s', $categoryName, $currencyCode);
+            // create arrays
+            $return[$key] ??= [
+                'label'                   => $categoryName,
+                'currency_id'             => (string)$currencyId,
+                'currency_code'           => $currencyCode,
+                'currency_name'           => $currencyName,
+                'currency_symbol'         => $currencySymbol,
+                'currency_decimal_places' => $currencyDecimalPlaces,
+                'period'                  => null,
+                'start'                   => $start->toAtomString(),
+                'end'                     => $end->toAtomString(),
+                'amount'                  => '0',
+            ];
+
+            // add monies
+            $return[$key]['amount']         = bcadd($return[$key]['amount'], (string)$amount);
+        }
+        $return     = array_values($return);
+
+        // order by amount
+        usort($return, static fn (array $a, array $b) => (float)$a['amount'] < (float)$b['amount'] ? 1 : -1);
+
+        return response()->json($this->clean($return));
+    }
+}

app/Api/V1/Controllers/Controller.php

@@ -25,34 +25,52 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers;
 
 use Carbon\Carbon;
-use Carbon\Exceptions\InvalidDateException;
 use Carbon\Exceptions\InvalidFormatException;
+use FireflyIII\Exceptions\BadHttpHeaderException;
+use FireflyIII\Models\Preference;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Support\Facades\Amount;
+use FireflyIII\Support\Facades\Steam;
+use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
+use FireflyIII\Transformers\AbstractTransformer;
+use FireflyIII\User;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Routing\Controller as BaseController;
 use Illuminate\Support\Facades\Log;
 use League\Fractal\Manager;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\Resource\Item;
 use League\Fractal\Serializer\JsonApiSerializer;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
 use Symfony\Component\HttpFoundation\Exception\BadRequestException;
 use Symfony\Component\HttpFoundation\ParameterBag;
 
 /**
  * Class Controller.
  *
-
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
+ * @SuppressWarnings("PHPMD.NumberOfChildren")
  */
 abstract class Controller extends BaseController
 {
     use AuthorizesRequests;
     use DispatchesJobs;
     use ValidatesRequests;
+    use ValidatesUserGroupTrait;
 
-    protected const CONTENT_TYPE = 'application/vnd.api+json';
-    protected array        $allowedSort;
-    protected ParameterBag $parameters;
+    protected const string CONTENT_TYPE             = 'application/vnd.api+json';
+    protected const string JSON_CONTENT_TYPE        = 'application/json';
+    protected array               $accepts          = ['application/json', 'application/vnd.api+json'];
+
+    /** @var array<int, string> */
+    protected array               $allowedSort;
+    protected bool                $convertToPrimary = false;
+    protected TransactionCurrency $primaryCurrency;
+    protected ParameterBag        $parameters;
 
     /**
      * Controller constructor.
@@ -65,10 +83,19 @@ abstract class Controller extends BaseController
             function ($request, $next) {
                 $this->parameters = $this->getParameters();
                 if (auth()->check()) {
-                    $language = app('steam')->getLanguage();
+                    $language               = Steam::getLanguage();
+                    $this->convertToPrimary = Amount::convertToPrimary();
+                    $this->primaryCurrency  = Amount::getPrimaryCurrency();
                     app()->setLocale($language);
                 }
 
+
+                // filter down what this endpoint accepts.
+                if (!$request->accepts($this->accepts)) {
+                    throw new BadHttpHeaderException(sprintf('Sorry, Accept header "%s" is not something this endpoint can provide.', $request->header('Accept')));
+                }
+
+
                 return $next($request);
             }
         );
@@ -76,45 +103,41 @@ abstract class Controller extends BaseController
 
     /**
      * Method to grab all parameters from the URL.
-     *
-     * @return ParameterBag
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     private function getParameters(): ParameterBag
     {
-        $bag  = new ParameterBag();
-        $page = (int)request()->get('page');
+        $bag      = new ParameterBag();
+        $page     = (int) request()->get('page');
         if ($page < 1) {
             $page = 1;
         }
-        if ($page > pow(2, 16)) {
-            $page = pow(2, 16);
+        if ($page > 2 ** 16) {
+            $page = 2 ** 16;
         }
         $bag->set('page', $page);
 
         // some date fields:
-        $dates = ['start', 'end', 'date'];
+        $dates    = ['start', 'end', 'date'];
         foreach ($dates as $field) {
             $date = null;
+
             try {
                 $date = request()->query->get($field);
             } catch (BadRequestException $e) {
                 Log::error(sprintf('Request field "%s" contains a non-scalar value. Value set to NULL.', $field));
                 Log::error($e->getMessage());
                 Log::error($e->getTraceAsString());
-                $value = null;
             }
-            $obj = null;
+            $obj  = null;
             if (null !== $date) {
                 try {
-                    $obj = Carbon::parse($date);
-                } catch (InvalidDateException | InvalidFormatException $e) {
+                    $obj = Carbon::parse((string) $date);
+                } catch (InvalidFormatException $e) {
                     // don't care
-                    app('log')->warning(
+                    Log::warning(
                         sprintf(
                             'Ignored invalid date "%s" in API controller parameter check: %s',
-                            substr($date, 0, 20),
+                            substr((string) $date, 0, 20),
                             $e->getMessage()
                         )
                     );
@@ -135,11 +158,25 @@ abstract class Controller extends BaseController
                 $value = null;
             }
             if (null !== $value) {
-                $bag->set($integer, (int)$value);
+                $value = (int) $value;
+                if ($value < 1) {
+                    $value = 1;
+                }
+                if ($value > 2 ** 16) {
+                    $value = 2 ** 16;
+                }
+
+                $bag->set($integer, $value);
             }
-            if (null === $value && 'limit' === $integer && auth()->check()) {
+            if (null === $value
+                && 'limit' === $integer // @phpstan-ignore-line
+                && auth()->check()) {
                 // set default for user:
-                $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+                /** @var User $user */
+                $user     = auth()->user();
+
+                /** @var Preference $pageSize */
+                $pageSize = (int) app('preferences')->getForUser($user, 'listPageSize', 50)->data;
                 $bag->set($integer, $pageSize);
             }
         }
@@ -148,16 +185,12 @@ abstract class Controller extends BaseController
         return $this->getSortParameters($bag);
     }
 
-    /**
-     * @param ParameterBag $bag
-     *
-     * @return ParameterBag
-     */
     private function getSortParameters(ParameterBag $bag): ParameterBag
     {
         $sortParameters = [];
+
         try {
-            $param = (string)request()->query->get('sort');
+            $param = (string) request()->query->get('sort');
         } catch (BadRequestException $e) {
             Log::error('Request field "sort" contains a non-scalar value. Value set to NULL.');
             Log::error($e->getMessage());
@@ -167,7 +200,7 @@ abstract class Controller extends BaseController
         if ('' === $param) {
             return $bag;
         }
-        $parts = explode(',', $param);
+        $parts          = explode(',', $param);
         foreach ($parts as $part) {
             $part      = trim($part);
             $direction = 'asc';
@@ -186,8 +219,6 @@ abstract class Controller extends BaseController
 
     /**
      * Method to help build URL's.
-     *
-     * @return string
      */
     final protected function buildParams(): string
     {
@@ -199,24 +230,63 @@ abstract class Controller extends BaseController
             }
             if ($value instanceof Carbon) {
                 $params[$key] = $value->format('Y-m-d');
+
                 continue;
             }
             $params[$key] = $value;
         }
 
-        return $return . http_build_query($params);
+        return $return.http_build_query($params);
     }
 
-    /**
-     * @return Manager
-     */
     final protected function getManager(): Manager
     {
         // create some objects:
         $manager = new Manager();
-        $baseUrl = request()->getSchemeAndHttpHost() . '/api/v1';
+        $baseUrl = request()->getSchemeAndHttpHost().'/api/v1';
         $manager->setSerializer(new JsonApiSerializer($baseUrl));
 
         return $manager;
     }
+
+    final protected function jsonApiList(string $key, LengthAwarePaginator $paginator, AbstractTransformer $transformer): array
+    {
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1/', request()->getSchemeAndHttpHost());
+
+        // TODO add stuff to path?
+
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        $objects  = $paginator->getCollection();
+
+        // the transformer, at this point, needs to collect information that ALL items in the collection
+        // require, like meta-data and stuff like that, and save it for later.
+        // $objects  = $transformer->collectMetaData($objects);
+        $paginator->setCollection($objects);
+
+        $resource = new FractalCollection($objects, $transformer, $key);
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return $manager->createData($resource)->toArray();
+    }
+
+    /**
+     * Returns a JSON API object and returns it.
+     *
+     * @param array<int, mixed>|Model $object
+     */
+    final protected function jsonApiObject(string $key, array|Model $object, AbstractTransformer $transformer): array
+    {
+        // create some objects:
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1', request()->getSchemeAndHttpHost());
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        // $transformer->collectMetaData(new Collection([$object]));
+
+        $resource = new Item($object, $transformer, $key);
+
+        return $manager->createData($resource)->toArray();
+    }
 }

app/Api/V1/Controllers/Data/Bulk/TransactionController.php

@@ -44,9 +44,6 @@ class TransactionController extends Controller
 {
     private AccountRepositoryInterface $repository;
 
-    /**
-     *
-     */
     public function __construct()
     {
         parent::__construct();
@@ -63,10 +60,6 @@ class TransactionController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/bulkUpdateTransactions
-     *
-     * @param TransactionRequest $request
-     *
-     * @return JsonResponse
      */
     public function update(TransactionRequest $request): JsonResponse
     {
@@ -76,12 +69,12 @@ class TransactionController extends Controller
         // this deserves better code, but for now a loop of basic if-statements
         // to respond to what is in the $query.
         // this is OK because only one thing can be in the query at the moment.
-        if ($this->updatesTransactionAccount($params)) {
-            $original    = $this->repository->find((int)$params['where']['account_id']);
-            $destination = $this->repository->find((int)$params['update']['account_id']);
+        if ($this->isUpdateTransactionAccount($params)) {
+            $original    = $this->repository->find((int) $params['where']['account_id']);
+            $destination = $this->repository->find((int) $params['update']['account_id']);
 
             /** @var AccountDestroyService $service */
-            $service = app(AccountDestroyService::class);
+            $service     = app(AccountDestroyService::class);
             $service->moveTransactions($original, $destination);
         }
 
@@ -89,11 +82,9 @@ class TransactionController extends Controller
     }
 
     /**
-     * @param array $params
-     *
-     * @return bool
+     * @param array<string, array<string, string>> $params
      */
-    private function updatesTransactionAccount(array $params): bool
+    private function isUpdateTransactionAccount(array $params): bool
     {
         return array_key_exists('account_id', $params['where']) && array_key_exists('account_id', $params['update']);
     }

app/Api/V1/Controllers/Data/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,11 +26,11 @@ namespace FireflyIII\Api\V1\Controllers\Data;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\DestroyRequest;
+use FireflyIII\Enums\AccountTypeEnum;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
 use FireflyIII\Models\TransactionJournal;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
@@ -58,160 +59,53 @@ class DestroyController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/destroyData
      *
-     * @param DestroyRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function destroy(DestroyRequest $request): JsonResponse
     {
-        $objects      = $request->getObjects();
-        $this->unused = $request->boolean('unused', false);
-        switch ($objects) {
-            default:
-                throw new FireflyException(sprintf('200033: This endpoint can\'t handle object "%s"', $objects));
-            case 'budgets':
-                $this->destroyBudgets();
-                break;
-            case 'bills':
-                $this->destroyBills();
-                break;
-            case 'piggy_banks':
-                $this->destroyPiggyBanks();
-                break;
-            case 'rules':
-                $this->destroyRules();
-                break;
-            case 'recurring':
-                $this->destroyRecurringTransactions();
-                break;
-            case 'categories':
-                $this->destroyCategories();
-                break;
-            case 'tags':
-                $this->destroyTags();
-                break;
-            case 'object_groups':
-                $this->destroyObjectGroups();
-                break;
-            case 'not_assets_liabilities':
-                $this->destroyAccounts(
-                    [
-                        AccountType::BENEFICIARY,
-                        AccountType::CASH,
-                        AccountType::CREDITCARD,
-                        AccountType::DEFAULT,
-                        AccountType::EXPENSE,
-                        AccountType::IMPORT,
-                        AccountType::INITIAL_BALANCE,
-                        AccountType::LIABILITY_CREDIT,
-                        AccountType::RECONCILIATION,
-                        AccountType::REVENUE,
-                    ]
-                );
-                break;
-            case 'accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::ASSET,
-                        AccountType::BENEFICIARY,
-                        AccountType::CASH,
-                        AccountType::CREDITCARD,
-                        AccountType::DEBT,
-                        AccountType::DEFAULT,
-                        AccountType::EXPENSE,
-                        AccountType::IMPORT,
-                        AccountType::INITIAL_BALANCE,
-                        AccountType::LIABILITY_CREDIT,
-                        AccountType::LOAN,
-                        AccountType::MORTGAGE,
-                        AccountType::RECONCILIATION,
-                        AccountType::REVENUE,
-                    ]
-                );
-                break;
-            case 'asset_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::ASSET,
-                        AccountType::DEFAULT,
-                    ]
-                );
-                break;
-            case 'expense_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::BENEFICIARY,
-                        AccountType::EXPENSE,
-                    ]
-                );
-                break;
-            case 'revenue_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::REVENUE,
-                    ]
-                );
-                break;
-            case 'liabilities':
-                $this->destroyAccounts(
-                    [
-                        AccountType::DEBT,
-                        AccountType::LOAN,
-                        AccountType::MORTGAGE,
-                        AccountType::CREDITCARD,
-                    ]
-                );
-                break;
-            case 'transactions':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::WITHDRAWAL,
-                        TransactionType::DEPOSIT,
-                        TransactionType::TRANSFER,
-                        TransactionType::RECONCILIATION,
-                        TransactionType::OPENING_BALANCE,
-                    ]
-                );
-                break;
-            case 'withdrawals':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::WITHDRAWAL,
-                    ]
-                );
-                break;
-            case 'deposits':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::DEPOSIT,
-                    ]
-                );
-                break;
-            case 'transfers':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::TRANSFER,
-                    ]
-                );
-                break;
-        }
+        $objects         = $request->getObjects();
+        $this->unused    = $request->boolean('unused');
+
+        $allExceptAssets = [AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::CASH->value, AccountTypeEnum::CREDITCARD->value, AccountTypeEnum::DEFAULT->value, AccountTypeEnum::EXPENSE->value, AccountTypeEnum::IMPORT->value, AccountTypeEnum::INITIAL_BALANCE->value, AccountTypeEnum::LIABILITY_CREDIT->value, AccountTypeEnum::RECONCILIATION->value, AccountTypeEnum::REVENUE->value];
+        $all             = [AccountTypeEnum::ASSET->value, AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::CASH->value, AccountTypeEnum::CREDITCARD->value, AccountTypeEnum::DEBT->value, AccountTypeEnum::DEFAULT->value, AccountTypeEnum::EXPENSE->value, AccountTypeEnum::IMPORT->value, AccountTypeEnum::INITIAL_BALANCE->value, AccountTypeEnum::LIABILITY_CREDIT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::RECONCILIATION->value];
+        $liabilities     = [AccountTypeEnum::DEBT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::CREDITCARD->value];
+        $transactions    = [TransactionTypeEnum::WITHDRAWAL->value, TransactionTypeEnum::DEPOSIT->value, TransactionTypeEnum::TRANSFER->value, TransactionTypeEnum::RECONCILIATION->value];
+
+        match ($objects) {
+            'budgets'                => $this->destroyBudgets(),
+            'bills'                  => $this->destroyBills(),
+            'piggy_banks'            => $this->destroyPiggyBanks(),
+            'rules'                  => $this->destroyRules(),
+            'recurring'              => $this->destroyRecurringTransactions(),
+            'categories'             => $this->destroyCategories(),
+            'tags'                   => $this->destroyTags(),
+            'object_groups'          => $this->destroyObjectGroups(),
+            'not_assets_liabilities' => $this->destroyAccounts($allExceptAssets),
+            'accounts'               => $this->destroyAccounts($all),
+            'asset_accounts'         => $this->destroyAccounts([AccountTypeEnum::ASSET->value, AccountTypeEnum::DEFAULT->value]),
+            'expense_accounts'       => $this->destroyAccounts([AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::EXPENSE->value]),
+            'revenue_accounts'       => $this->destroyAccounts([AccountTypeEnum::REVENUE->value]),
+            'liabilities'            => $this->destroyAccounts($liabilities),
+            'transactions'           => $this->destroyTransactions($transactions),
+            'withdrawals'            => $this->destroyTransactions([TransactionTypeEnum::WITHDRAWAL->value]),
+            'deposits'               => $this->destroyTransactions([TransactionTypeEnum::DEPOSIT->value]),
+            'transfers'              => $this->destroyTransactions([TransactionTypeEnum::TRANSFER->value]),
+            default                  => throw new FireflyException(sprintf('200033: This endpoint can\'t handle object "%s"', $objects)),
+        };
+
         app('preferences')->mark();
 
         return response()->json([], 204);
     }
 
-    /**
-     *
-     */
     private function destroyBudgets(): void
     {
         /** @var AvailableBudgetRepositoryInterface $abRepository */
-        $abRepository = app(AvailableBudgetRepositoryInterface::class);
+        $abRepository     = app(AvailableBudgetRepositoryInterface::class);
         $abRepository->destroyAll();
 
         /** @var BudgetLimitRepositoryInterface $blRepository */
-        $blRepository = app(BudgetLimitRepositoryInterface::class);
+        $blRepository     = app(BudgetLimitRepositoryInterface::class);
         $blRepository->destroyAll();
 
         /** @var BudgetRepositoryInterface $budgetRepository */
@@ -219,9 +113,6 @@ class DestroyController extends Controller
         $budgetRepository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyBills(): void
     {
         /** @var BillRepositoryInterface $repository */
@@ -229,9 +120,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyPiggyBanks(): void
     {
         /** @var PiggyBankRepositoryInterface $repository */
@@ -239,9 +127,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyRules(): void
     {
         /** @var RuleGroupRepositoryInterface $repository */
@@ -249,9 +134,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyRecurringTransactions(): void
     {
         /** @var RecurringRepositoryInterface $repository */
@@ -259,9 +141,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyCategories(): void
     {
         /** @var CategoryRepositoryInterface $categoryRepos */
@@ -269,9 +148,6 @@ class DestroyController extends Controller
         $categoryRepos->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyTags(): void
     {
         /** @var TagRepositoryInterface $tagRepository */
@@ -279,9 +155,6 @@ class DestroyController extends Controller
         $tagRepository->destroyAll();
     }
 
-    /**
-     * @return void
-     */
     private function destroyObjectGroups(): void
     {
         /** @var ObjectGroupRepositoryInterface $repository */
@@ -290,7 +163,7 @@ class DestroyController extends Controller
     }
 
     /**
-     * @param array $types
+     * @param array<int, string> $types
      */
     private function destroyAccounts(array $types): void
     {
@@ -304,18 +177,21 @@ class DestroyController extends Controller
             $count = $account->transactions()->count();
             if (true === $this->unused && 0 === $count) {
                 Log::info(sprintf('Deleted unused account #%d "%s"', $account->id, $account->name));
+                Log::channel('audit')->info(sprintf('Deleted unused account #%d "%s"', $account->id, $account->name));
                 $service->destroy($account, null);
+
                 continue;
             }
             if (false === $this->unused) {
                 Log::info(sprintf('Deleting account #%d "%s"', $account->id, $account->name));
+                Log::channel('audit')->warning(sprintf('Deleted account #%d "%s"', $account->id, $account->name));
                 $service->destroy($account, null);
             }
         }
     }
 
     /**
-     * @param array $types
+     * @param array<int, string> $types
      */
     private function destroyTransactions(array $types): void
     {
@@ -323,6 +199,7 @@ class DestroyController extends Controller
         $repository = app(JournalRepositoryInterface::class);
         $journals   = $repository->findByType($types);
         $service    = app(JournalDestroyService::class);
+
         /** @var TransactionJournal $journal */
         foreach ($journals as $journal) {
             $service->destroy($journal);

app/Api/V1/Controllers/Data/Export/ExportController.php

@@ -29,8 +29,9 @@ use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Support\Export\ExportDataGenerator;
 use Illuminate\Http\Response as LaravelResponse;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
+use Safe\Exceptions\DatetimeException;
+
+use function Safe\date;
 
 /**
  * Class ExportController
@@ -59,10 +60,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportAccounts
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function accounts(ExportRequest $request): LaravelResponse
     {
@@ -72,12 +72,8 @@ class ExportController extends Controller
     }
 
     /**
-     * @param string $key
-     *
-     * @return LaravelResponse
      * @throws FireflyException
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
+     * @throws DatetimeException
      */
     private function returnExport(string $key): LaravelResponse
     {
@@ -90,13 +86,14 @@ class ExportController extends Controller
         $response
             ->header('Content-Description', 'File Transfer')
             ->header('Content-Type', 'application/octet-stream')
-            ->header('Content-Disposition', 'attachment; filename=' . $fileName)
+            ->header('Content-Disposition', 'attachment; filename='.$fileName)
             ->header('Content-Transfer-Encoding', 'binary')
             ->header('Connection', 'Keep-Alive')
             ->header('Expires', '0')
             ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
             ->header('Pragma', 'public')
-            ->header('Content-Length', (string)strlen($data[$key]));
+            ->header('Content-Length', (string) strlen((string) $data[$key]))
+        ;
 
         return $response;
     }
@@ -105,10 +102,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportBills
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function bills(ExportRequest $request): LaravelResponse
     {
@@ -121,10 +117,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportBudgets
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function budgets(ExportRequest $request): LaravelResponse
     {
@@ -137,10 +132,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportCategories
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function categories(ExportRequest $request): LaravelResponse
     {
@@ -153,10 +147,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportPiggies
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function piggyBanks(ExportRequest $request): LaravelResponse
     {
@@ -169,10 +162,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportRecurring
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function recurring(ExportRequest $request): LaravelResponse
     {
@@ -185,10 +177,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportRules
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function rules(ExportRequest $request): LaravelResponse
     {
@@ -201,10 +192,9 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportTags
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function tags(ExportRequest $request): LaravelResponse
     {
@@ -217,9 +207,6 @@ class ExportController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportTransactions
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
      */
     public function transactions(ExportRequest $request): LaravelResponse

app/Api/V1/Controllers/Data/PurgeController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PurgeController.php
  * Copyright (c) 2022 james@firefly-iii.org
@@ -28,13 +29,14 @@ use FireflyIII\Models\Account;
 use FireflyIII\Models\Bill;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\Category;
-use FireflyIII\Models\PiggyBank;
 use FireflyIII\Models\Recurrence;
 use FireflyIII\Models\Rule;
 use FireflyIII\Models\RuleGroup;
 use FireflyIII\Models\Tag;
 use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -46,12 +48,11 @@ class PurgeController extends Controller
      * TODO cleanup and use repositories.
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/purgeData
-     *
-     * @return JsonResponse
      */
     public function purge(): JsonResponse
     {
-        $user = auth()->user();
+        /** @var User $user */
+        $user       = auth()->user();
 
         // some manual code, too lazy to call all repositories.
 
@@ -62,12 +63,17 @@ class PurgeController extends Controller
         Bill::whereUserId($user->id)->onlyTrashed()->forceDelete();
 
         // piggies
-        $set = PiggyBank::leftJoin('accounts', 'accounts.id', 'piggy_banks.account_id')
-                        ->where('accounts.user_id', $user->id)->onlyTrashed()->get(['piggy_banks.*']);
-        /** @var PiggyBank $piggy */
-        foreach ($set as $piggy) {
-            $piggy->forceDelete();
-        }
+        $repository = app(PiggyBankRepositoryInterface::class);
+        $repository->setUser($user);
+        $repository->purgeAll();
+        //        $set  = PiggyBank::leftJoin('accounts', 'accounts.id', 'piggy_banks.account_id')
+        //            ->where('accounts.user_id', $user->id)->onlyTrashed()->get(['piggy_banks.*'])
+        //        ;
+        //
+        //        /** @var PiggyBank $piggy */
+        //        foreach ($set as $piggy) {
+        //            $piggy->forceDelete();
+        //        }
 
         // rule group
         RuleGroup::whereUserId($user->id)->onlyTrashed()->forceDelete();
@@ -84,7 +90,6 @@ class PurgeController extends Controller
         // tags
         Tag::whereUserId($user->id)->onlyTrashed()->forceDelete();
 
-
         // accounts
         Account::whereUserId($user->id)->onlyTrashed()->forceDelete();
 

app/Api/V1/Controllers/Insight/Expense/AccountController.php

@@ -32,7 +32,6 @@ use FireflyIII\Support\Http\Api\ApiSupport;
 use Illuminate\Http\JsonResponse;
 
 /**
- *
  * Class AccountController
  *
  * Shows expense information grouped or limited by date.
@@ -47,16 +46,14 @@ class AccountController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
         parent::__construct();
         $this->middleware(
             function ($request, $next) {
-                $user             = auth()->user();
-                $this->repository = app(AccountRepositoryInterface::class);
+                $user                = auth()->user();
+                $this->repository    = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
                 $this->opsRepository = app(OperationsRepositoryInterface::class);
@@ -70,10 +67,6 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseAsset
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function asset(GenericRequest $request): JsonResponse
     {
@@ -86,11 +79,11 @@ class AccountController extends Controller
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
-                'id'               => (string)$expense['id'],
+                'id'               => (string) $expense['id'],
                 'name'             => $expense['name'],
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'], // intentional float
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'], // intentional float
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }
@@ -101,10 +94,6 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseExpense
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function expense(GenericRequest $request): JsonResponse
     {
@@ -118,11 +107,11 @@ class AccountController extends Controller
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
-                'id'               => (string)$expense['id'],
+                'id'               => (string) $expense['id'],
                 'name'             => $expense['name'],
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'], // intentional float
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'], // intentional float
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Expense/BillController.php

@@ -26,10 +26,12 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class BillController
@@ -60,18 +62,16 @@ class BillController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseBill
      *
      * Expenses per bill, possibly filtered by bill and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function bill(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $bills    = $request->getBills();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $bills            = $request->getBills();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
+        $response         = [];
 
         // get all bills:
         if (0 === $bills->count()) {
@@ -79,39 +79,42 @@ class BillController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->setBills($bills);
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet       = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $billId            = (int)$journal['bill_id'];
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
-            $key               = sprintf('%d-%d', $billId, $currencyId);
-            $foreignKey        = sprintf('%d-%d', $billId, $foreignCurrencyId);
+            $billId       = (int) $journal['bill_id'];
+            $currencyId   = (int) $journal['currency_id'];
+            $currencyCode = $journal['currency_code'];
+            $field        = 'amount';
+
+            // use the primary amount if the user wants to convert to primary currency
+            if ($convertToPrimary && $currencyId !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
+                $field        = 'pc_amount';
+            }
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
+            }
+            Log::debug(sprintf('Journal #%d in bill #%d will use %s (%s %s)', $journal['transaction_group_id'], $billId, $field, $currencyCode, $journal[$field] ?? '0'));
+
+            $key          = sprintf('%d-%d', $billId, $currencyId);
 
             if (0 !== $currencyId) {
-                $response[$key]                     = $response[$key] ?? [
-                    'id'               => (string)$billId,
+                $response[$key] ??= [
+                    'id'               => (string) $billId,
                     'name'             => $journal['bill_name'],
                     'difference'       => '0',
                     'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
+                    'currency_id'      => (string) $currencyId,
+                    'currency_code'    => $currencyCode,
                 ];
-                $response[$key]['difference']       = bcadd($response[$key]['difference'], $journal['amount']);
-                $response[$key]['difference_float'] = (float)$response[$key]['difference']; // intentional float
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignKey]                     = $response[$foreignKey] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignKey]['difference']       = bcadd($response[$foreignKey]['difference'], $journal['foreign_amount']);
-                $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference']; // intentional float
+                $response[$key]['difference']       = bcadd($response[$key]['difference'], (string) ($journal[$field] ?? '0'));
+                $response[$key]['difference_float'] = (float) $response[$key]['difference']; // intentional float
             }
         }
 
@@ -123,48 +126,49 @@ class BillController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoBill
      *
      * Expenses for no bill filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noBill(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
+        $response         = [];
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->withoutBill();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet       = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            $currencyId   = (int) $journal['currency_id'];
+            $currencyCode = $journal['currency_code'];
+            $field        = 'amount';
+
+            // use the primary amount if the user wants to convert to primary currency
+            if ($convertToPrimary && $currencyId !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
+                $field        = 'pc_amount';
+            }
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
+            }
+            Log::debug(sprintf('Journal #%d will use %s (%s %s)', $journal['transaction_group_id'], $field, $currencyCode, $journal[$field] ?? '0'));
 
             if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
+                $response[$currencyId] ??= [
                     'difference'       => '0',
                     'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
+                    'currency_id'      => (string) $currencyId,
+                    'currency_code'    => $currencyCode,
                 ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference']; // intentional float
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference']; // intentional float
+                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) ($journal[$field] ?? '0'));
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // intentional float
             }
         }
 

app/Api/V1/Controllers/Insight/Expense/BudgetController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * BudgetController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -43,8 +44,6 @@ class BudgetController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -67,10 +66,6 @@ class BudgetController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseBudget
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function budget(GenericRequest $request): JsonResponse
     {
@@ -82,17 +77,19 @@ class BudgetController extends Controller
         if (0 === $budgets->count()) {
             $budgets = $this->repository->getActiveBudgets();
         }
+
         /** @var Budget $budget */
         foreach ($budgets as $budget) {
             $expenses = $this->opsRepository->sumExpenses($start, $end, $assetAccounts, new Collection([$budget]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
-                    'id'               => (string)$budget->id,
+                    'id'               => (string) $budget->id,
                     'name'             => $budget->name,
                     'difference'       => $expense['sum'],
-                    'difference_float' => (float)$expense['sum'], // intentional float
-                    'currency_id'      => (string)$expense['currency_id'],
+                    'difference_float' => (float) $expense['sum'], // intentional float
+                    'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
             }
@@ -104,10 +101,6 @@ class BudgetController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoBudget
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noBudget(GenericRequest $request): JsonResponse
     {
@@ -116,12 +109,13 @@ class BudgetController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumExpenses($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'], // intentional float
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'], // intentional float
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Expense/CategoryController.php

@@ -44,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -68,10 +66,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -83,17 +77,19 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumExpenses($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
-                    'id'               => (string)$category->id,
+                    'id'               => (string) $category->id,
                     'name'             => $category->name,
                     'difference'       => $expense['sum'],
-                    'difference_float' => (float)$expense['sum'], // intentional float
-                    'currency_id'      => (string)$expense['currency_id'],
+                    'difference_float' => (float) $expense['sum'], // intentional float
+                    'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
             }
@@ -105,10 +101,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -117,12 +109,13 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumExpenses($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'], // intentional float
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'], // intentional float
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Expense/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,9 +26,11 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class PeriodController
@@ -37,46 +40,52 @@ class PeriodController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
+        $genericSet       = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // same code as many other sumExpense methods. I think this needs some kind of generic method.
+            $amount                                    = '0';
+            $currencyId                                = (int) $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            if ($convertToPrimary) {
+                $amount = Amount::getAmountFromJournal($journal);
+                if ($primary->id !== (int) $journal['currency_id'] && $primary->id !== (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $primary->id;
+                    $currencyCode = $primary->code;
+                }
+                if ($primary->id !== (int) $journal['currency_id'] && $primary->id === (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $journal['foreign_currency_id'];
+                    $currencyCode = $journal['foreign_currency_code'];
+                }
+                Log::debug(sprintf('[a] Add amount %s %s', $currencyCode, $amount));
+            }
+            if (!$convertToPrimary) {
+                // ignore the amount in foreign currency.
+                Log::debug(sprintf('[b] Add amount %s %s', $currencyCode, $journal['amount']));
+                $amount = $journal['amount'];
+            }
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference']; // intentional float
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference']; // intentional float
-            }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $amount);
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // intentional float
         }
 
         return response()->json(array_values($response));

app/Api/V1/Controllers/Insight/Expense/TagController.php

@@ -26,10 +26,12 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class TagController
@@ -59,49 +61,54 @@ class TagController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoTag
      *
      * Expenses for no tag filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet       = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // same code as many other sumExpense methods. I think this needs some kind of generic method.
+            $amount                                    = '0';
+            $currencyId                                = (int) $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            if ($convertToPrimary) {
+                $amount = Amount::getAmountFromJournal($journal);
+                if ($primary->id !== (int) $journal['currency_id'] && $primary->id !== (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $primary->id;
+                    $currencyCode = $primary->code;
+                }
+                if ($primary->id !== (int) $journal['currency_id'] && $primary->id === (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $journal['foreign_currency_id'];
+                    $currencyCode = $journal['foreign_currency_code'];
+                }
+                Log::debug(sprintf('[a] Add amount %s %s', $currencyCode, $amount));
+            }
+            if (!$convertToPrimary) {
+                // ignore the amount in foreign currency.
+                Log::debug(sprintf('[b] Add amount %s %s', $currencyCode, $journal['amount']));
+                $amount = $journal['amount'];
+            }
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference']; // float but on purpose.
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference']; // float but on purpose.
-            }
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $amount);
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // float but on purpose.
         }
 
         return response()->json(array_values($response));
@@ -112,18 +119,14 @@ class TagController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseTag
      *
      * Expenses per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -131,14 +134,15 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            $currencyId        = (int) $journal['currency_id'];
+            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
 
             /** @var array $tag */
             foreach ($journal['tags'] as $tag) {
@@ -148,16 +152,16 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                        'id'               => (string)$tagId,
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
                         'name'             => $tag['name'],
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        'currency_id'      => (string) $currencyId,
                         'currency_code'    => $journal['currency_code'],
                     ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], $journal['amount']);
-                    $response[$key]['difference_float'] = (float)$response[$key]['difference']; // float but on purpose.
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) $journal['amount']);
+                    $response[$key]['difference_float'] = (float) $response[$key]['difference']; // float but on purpose.
                 }
 
                 // on foreign ID
@@ -165,11 +169,11 @@ class TagController extends Controller
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        'currency_id'      => (string) $foreignCurrencyId,
                         'currency_code'    => $journal['foreign_currency_code'],
                     ];
-                    $response[$foreignKey]['difference']       = bcadd($response[$foreignKey]['difference'], $journal['foreign_amount']);
-                    $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference']; // float but on purpose.
+                    $response[$foreignKey]['difference']       = bcadd((string) $response[$foreignKey]['difference'], (string) $journal['foreign_amount']);
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference']; // float but on purpose.
                 }
             }
         }

app/Api/V1/Controllers/Insight/Income/AccountController.php

@@ -32,7 +32,6 @@ use FireflyIII\Support\Http\Api\ApiSupport;
 use Illuminate\Http\JsonResponse;
 
 /**
- *
  * Class AccountController
  *
  * Shows income information grouped or limited by date.
@@ -47,16 +46,14 @@ class AccountController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
         parent::__construct();
         $this->middleware(
             function ($request, $next) {
-                $user             = auth()->user();
-                $this->repository = app(AccountRepositoryInterface::class);
+                $user                = auth()->user();
+                $this->repository    = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
                 $this->opsRepository = app(OperationsRepositoryInterface::class);
@@ -70,26 +67,24 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeAsset
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function asset(GenericRequest $request): JsonResponse
     {
         $start         = $request->getStart();
         $end           = $request->getEnd();
         $assetAccounts = $request->getAssetAccounts();
+
         $income        = $this->opsRepository->sumIncomeByDestination($start, $end, $assetAccounts);
         $result        = [];
+
         /** @var array $entry */
         foreach ($income as $entry) {
             $result[] = [
-                'id'               => (string)$entry['id'],
+                'id'               => (string) $entry['id'],
                 'name'             => $entry['name'],
                 'difference'       => $entry['sum'],
-                'difference_float' => (float)$entry['sum'], // float but on purpose.
-                'currency_id'      => (string)$entry['currency_id'],
+                'difference_float' => (float) $entry['sum'], // float but on purpose.
+                'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
         }
@@ -100,10 +95,6 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeRevenue
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function revenue(GenericRequest $request): JsonResponse
     {
@@ -117,11 +108,11 @@ class AccountController extends Controller
         /** @var array $entry */
         foreach ($income as $entry) {
             $result[] = [
-                'id'               => (string)$entry['id'],
+                'id'               => (string) $entry['id'],
                 'name'             => $entry['name'],
                 'difference'       => $entry['sum'],
-                'difference_float' => (float)$entry['sum'], // float but on purpose.
-                'currency_id'      => (string)$entry['currency_id'],
+                'difference_float' => (float) $entry['sum'], // float but on purpose.
+                'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Income/CategoryController.php

@@ -44,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -68,10 +66,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -83,17 +77,19 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumIncome($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
-                    'id'               => (string)$category->id,
+                    'id'               => (string) $category->id,
                     'name'             => $category->name,
                     'difference'       => $expense['sum'],
-                    'difference_float' => (float)$expense['sum'], // float but on purpose.
-                    'currency_id'      => (string)$expense['currency_id'],
+                    'difference_float' => (float) $expense['sum'], // float but on purpose.
+                    'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
             }
@@ -105,10 +101,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -117,12 +109,13 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumIncome($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'], // float but on purpose.
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'], // float but on purpose.
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Income/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,8 +26,9 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Income;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -37,49 +39,44 @@ class PeriodController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $genericSet       = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToPrimary && $currencyId !== $primary->id ? 'pc_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference']; // float but on purpose.
+            // perhaps use default currency instead?
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'],
-                    app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference']; // float but on purpose.
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // float but on purpose.
         }
 
         return response()->json(array_values($response));

app/Api/V1/Controllers/Insight/Income/TagController.php

@@ -26,9 +26,10 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Income;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -60,52 +61,48 @@ class TagController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeTag
      *
      * Expenses for no tag filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet       = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToPrimary && $currencyId !== $primary->id ? 'pc_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'],
-                    app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));
@@ -116,18 +113,14 @@ class TagController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeNoTag
      *
      * Expenses per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -135,14 +128,15 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            $currencyId        = (int) $journal['currency_id'];
+            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
 
             /** @var array $tag */
             foreach ($journal['tags'] as $tag) {
@@ -152,16 +146,16 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                        'id'               => (string)$tagId,
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
                         'name'             => $tag['name'],
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        'currency_id'      => (string) $currencyId,
                         'currency_code'    => $journal['currency_code'],
                     ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], app('steam')->positive($journal['amount']));
-                    $response[$key]['difference_float'] = (float)$response[$key]['difference'];
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) app('steam')->positive($journal['amount']));
+                    $response[$key]['difference_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
@@ -169,14 +163,14 @@ class TagController extends Controller
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        'currency_id'      => (string) $foreignCurrencyId,
                         'currency_code'    => $journal['foreign_currency_code'],
                     ];
                     $response[$foreignKey]['difference']       = bcadd(
-                        $response[$foreignKey]['difference'],
-                        app('steam')->positive($journal['foreign_amount'])
+                        (string) $response[$foreignKey]['difference'],
+                        (string) app('steam')->positive($journal['foreign_amount'])
                     );
-                    $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference'];
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
                 }
             }
         }

app/Api/V1/Controllers/Insight/Transfer/AccountController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * AccountController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -40,8 +41,6 @@ class AccountController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -60,10 +59,6 @@ class AccountController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransfers
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function asset(GenericRequest $request): JsonResponse
     {

app/Api/V1/Controllers/Insight/Transfer/CategoryController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * CategoryController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -43,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -67,10 +66,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -82,17 +77,19 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumTransfers($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
-                    'id'               => (string)$category->id,
+                    'id'               => (string) $category->id,
                     'name'             => $category->name,
                     'difference'       => $expense['sum'],
-                    'difference_float' => (float)$expense['sum'],
-                    'currency_id'      => (string)$expense['currency_id'],
+                    'difference_float' => (float) $expense['sum'],
+                    'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
             }
@@ -104,10 +101,6 @@ class CategoryController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -116,12 +109,13 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumTransfers($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
                 'difference'       => $expense['sum'],
-                'difference_float' => (float)$expense['sum'],
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'],
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }

app/Api/V1/Controllers/Insight/Transfer/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,8 +26,9 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Transfer;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -37,49 +39,45 @@ class PeriodController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $genericSet       = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToPrimary && $currencyId !== $primary->id ? 'pc_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'],
-                    app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));

app/Api/V1/Controllers/Insight/Transfer/TagController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * TagController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,9 +26,10 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Transfer;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -57,52 +59,49 @@ class TagController extends Controller
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoTag
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts         = $request->getAssetAccounts();
+        $start            = $request->getStart();
+        $end              = $request->getEnd();
+        $response         = [];
+        $convertToPrimary = Amount::convertToPrimary();
+        $primary          = Amount::getPrimaryCurrency();
+
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector        = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet       = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToPrimary && $currencyId !== $primary->id ? 'pc_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$currencyId,
-                    'currency_code'    => $journal['currency_code'],
-                ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float)$response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id) {
+                $currencyId   = $primary->id;
+                $currencyCode = $primary->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                    'difference'       => '0',
-                    'difference_float' => 0,
-                    'currency_id'      => (string)$foreignCurrencyId,
-                    'currency_code'    => $journal['foreign_currency_code'],
-                ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'],
-                    app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float)$response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToPrimary && $journal['currency_id'] !== $primary->id && $primary->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));
@@ -113,18 +112,14 @@ class TagController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferTag
      *
      * Transfers per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -132,14 +127,15 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            $currencyId        = (int) $journal['currency_id'];
+            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
 
             /** @var array $tag */
             foreach ($journal['tags'] as $tag) {
@@ -149,16 +145,16 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                        'id'               => (string)$tagId,
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
                         'name'             => $tag['name'],
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        'currency_id'      => (string) $currencyId,
                         'currency_code'    => $journal['currency_code'],
                     ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], app('steam')->positive($journal['amount']));
-                    $response[$key]['difference_float'] = (float)$response[$key]['difference'];
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) app('steam')->positive($journal['amount']));
+                    $response[$key]['difference_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
@@ -166,14 +162,14 @@ class TagController extends Controller
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        'currency_id'      => (string) $foreignCurrencyId,
                         'currency_code'    => $journal['foreign_currency_code'],
                     ];
                     $response[$foreignKey]['difference']       = bcadd(
-                        $response[$foreignKey]['difference'],
-                        app('steam')->positive($journal['foreign_amount'])
+                        (string) $response[$foreignKey]['difference'],
+                        (string) app('steam')->positive($journal['foreign_amount'])
                     );
-                    $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference']; // intentional float
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference']; // intentional float
                 }
             }
         }

app/Api/V1/Controllers/Models/Account/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -33,14 +34,12 @@ use Illuminate\Http\JsonResponse;
  */
 class DestroyController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -60,10 +59,6 @@ class DestroyController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/deleteAccount
      *
      * Remove the specified resource from storage.
-     *
-     * @param Account $account
-     *
-     * @return JsonResponse
      */
     public function destroy(Account $account): JsonResponse
     {

app/Api/V1/Controllers/Models/Account/ListController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -29,6 +30,8 @@ use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\PiggyBankEnrichment;
+use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\Transformers\PiggyBankTransformer;
 use FireflyIII\Transformers\TransactionGroupTransformer;
@@ -47,14 +50,12 @@ class ListController extends Controller
 {
     use TransactionFilter;
 
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -73,29 +74,26 @@ class ListController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listAttachmentByAccount
      *
-     * @param Account $account
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function attachments(Account $account): JsonResponse
     {
-        $manager    = $this->getManager();
-        $pageSize   = $this->parameters->get('limit');
-        $collection = $this->repository->getAttachments($account);
+        $manager     = $this->getManager();
+        $pageSize    = $this->parameters->get('limit');
+        $collection  = $this->repository->getAttachments($account);
 
         $count       = $collection->count();
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.attachments', [$account->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.attachments', [$account->id]).$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -105,33 +103,37 @@ class ListController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listPiggyBankByAccount
      *
-     * @param Account $account
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function piggyBanks(Account $account): JsonResponse
     {
         // create some objects:
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = $this->parameters->get('limit');
+        $pageSize    = $this->parameters->get('limit');
 
-        // get list of budgets. Count it and split it.
-        $collection = $this->repository->getPiggyBanks($account);
-        $count      = $collection->count();
-        $piggyBanks = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        // get list of piggy banks. Count it and split it.
+        $collection  = $this->repository->getPiggyBanks($account);
+        $count       = $collection->count();
+        $piggyBanks  = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new PiggyBankEnrichment();
+        $enrichment->setUser($admin);
+        $piggyBanks  = $enrichment->enrich($piggyBanks);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($piggyBanks, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.piggy-banks', [$account->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($piggyBanks, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.piggy-banks', [$account->id]).$this->buildParams());
 
         /** @var PiggyBankTransformer $transformer */
         $transformer = app(PiggyBankTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($piggyBanks, $transformer, 'piggy_banks');
+        $resource    = new FractalCollection($piggyBanks, $transformer, 'piggy-banks');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -143,28 +145,25 @@ class ListController extends Controller
      *
      * Show all transaction groups related to the account.
      *
-     *
-     * @param Request $request
-     * @param Account $account
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function transactions(Request $request, Account $account): JsonResponse
     {
-        $pageSize = $this->parameters->get('limit');
-        $type     = $request->get('type') ?? 'default';
+        $pageSize     = $this->parameters->get('limit');
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
+
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector->setUser($admin)->setAccounts(new Collection([$account]))
-                  ->withAPIInformation()->setLimit($pageSize)->setPage($this->parameters->get('page'))->setTypes($types);
+            ->withAPIInformation()->setLimit($pageSize)->setPage($this->parameters->get('page'))->setTypes($types)
+        ;
 
         if (null !== $this->parameters->get('start')) {
             $collector->setStart($this->parameters->get('start'));
@@ -173,15 +172,19 @@ class ListController extends Controller
             $collector->setEnd($this->parameters->get('end'));
         }
 
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.accounts.transactions', [$account->id]) . $this->buildParams());
-        $groups = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.accounts.transactions', [$account->id]).$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($groups, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);

app/Api/V1/Controllers/Models/Account/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -28,7 +29,9 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Pagination\LengthAwarePaginator;
@@ -43,14 +46,12 @@ class ShowController extends Controller
 {
     use AccountFilter;
 
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -71,40 +72,43 @@ class ShowController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @param Request $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function index(Request $request): JsonResponse
     {
-        $manager = $this->getManager();
-        $type    = $request->get('type') ?? 'all';
+        $manager     = $this->getManager();
+        $type        = $request->get('type') ?? 'all';
         $this->parameters->set('type', $type);
 
         // types to get, page size:
-        $types    = $this->mapAccountTypes($this->parameters->get('type'));
-        $pageSize = $this->parameters->get('limit');
+        $types       = $this->mapAccountTypes($this->parameters->get('type'));
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of accounts. Count it and split it.
         $this->repository->resetAccountOrder();
-        $collection = $this->repository->getAccountsByType($types, $this->parameters->get('sort') ?? []);
-        $count      = $collection->count();
+        $collection  = $this->repository->getAccountsByType($types, $this->parameters->get('sort') ?? []);
+        $count       = $collection->count();
 
         // continue sort:
+        $accounts    = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
-
-        $accounts = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setDate($this->parameters->get('date'));
+        $enrichment->setUser($admin);
+        $accounts    = $enrichment->enrich($accounts);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.index') . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.index').$this->buildParams());
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($accounts, $transformer, self::RESOURCE_KEY);
+        $resource    = new FractalCollection($accounts, $transformer, self::RESOURCE_KEY);
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -115,22 +119,27 @@ class ShowController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/getAccount
      *
      * Show single instance.
-     *
-     * @param Account $account
-     *
-     * @return JsonResponse
      */
     public function show(Account $account): JsonResponse
     {
         // get list of accounts. Count it and split it.
         $this->repository->resetAccountOrder();
         $account->refresh();
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setDate($this->parameters->get('date'));
+        $enrichment->setUser($admin);
+        $account     = $enrichment->enrichSingle($account);
+
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource    = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Account/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -26,7 +27,9 @@ namespace FireflyIII\Api\V1\Controllers\Models\Account;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Account\StoreRequest;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -35,14 +38,12 @@ use League\Fractal\Resource\Item;
  */
 class StoreController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -62,23 +63,27 @@ class StoreController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/storeAccount
      *
      * Store a new instance.
-     *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $data = $request->getAllAccountData();
+        $data        = $request->getAllAccountData();
         $this->repository->resetAccountOrder();
-        $account = $this->repository->store($data);
-        $manager = $this->getManager();
+        $account     = $this->repository->store($data);
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setDate(null);
+        $enrichment->setUser($admin);
+        $account     = $enrichment->enrichSingle($account);
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource    = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Account/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -27,25 +28,24 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Account\UpdateRequest;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
-use Preferences;
 
 /**
  * Class UpdateController
  */
 class UpdateController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -65,26 +65,29 @@ class UpdateController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/updateAccount
      *
      * Update account.
-     *
-     * @param UpdateRequest $request
-     * @param Account       $account
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Account $account): JsonResponse
     {
         Log::debug(sprintf('Now in %s', __METHOD__));
         $data         = $request->getUpdateData();
-        $data['type'] = config('firefly.shortNamesByFullName.' . $account->accountType->type);
+        $data['type'] = config('firefly.shortNamesByFullName.'.$account->accountType->type);
         $account      = $this->repository->update($account, $data);
         $manager      = $this->getManager();
         $account->refresh();
-        Preferences::mark();
+        app('preferences')->mark();
+
+        // enrich
+        /** @var User $admin */
+        $admin        = auth()->user();
+        $enrichment   = new AccountEnrichment();
+        $enrichment->setDate(null);
+        $enrichment->setUser($admin);
+        $account      = $enrichment->enrichSingle($account);
 
         /** @var AccountTransformer $transformer */
-        $transformer = app(AccountTransformer::class);
+        $transformer  = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource     = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Attachment/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -29,6 +30,8 @@ use FireflyIII\Models\Attachment;
 use FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class DestroyController
@@ -39,8 +42,6 @@ class DestroyController extends Controller
 
     /**
      * DestroyController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -63,14 +64,15 @@ class DestroyController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/deleteAttachment
      *
      * Remove the specified resource from storage.
-     *
-     *
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function destroy(Attachment $attachment): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
         $this->repository->destroy($attachment);
         app('preferences')->mark();
 

app/Api/V1/Controllers/Models/Attachment/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -33,9 +34,11 @@ use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Response as LaravelResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
 use League\Fractal\Resource\Item;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class ShowController
@@ -46,8 +49,6 @@ class ShowController extends Controller
 
     /**
      * ShowController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -71,13 +72,15 @@ class ShowController extends Controller
      *
      * Download an attachment.
      *
-     * @param Attachment $attachment
-     *
-     * @return LaravelResponse
-     * @throws   FireflyException
+     * @throws FireflyException
      */
     public function download(Attachment $attachment): LaravelResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
         if (false === $attachment->uploaded) {
             throw new FireflyException('200000: File has not been uploaded (yet).');
         }
@@ -85,27 +88,29 @@ class ShowController extends Controller
             throw new FireflyException('200000: File has not been uploaded (yet).');
         }
         if ($this->repository->exists($attachment)) {
-            $content = $this->repository->getContent($attachment);
+            $content  = $this->repository->getContent($attachment);
             if ('' === $content) {
                 throw new FireflyException('200002: File is empty (zero bytes).');
             }
-            $quoted = sprintf('"%s"', addcslashes(basename($attachment->filename), '"\\'));
+            $quoted   = sprintf('"%s"', addcslashes(basename($attachment->filename), '"\\'));
 
             /** @var LaravelResponse $response */
             $response = response($content);
             $response
                 ->header('Content-Description', 'File Transfer')
                 ->header('Content-Type', 'application/octet-stream')
-                ->header('Content-Disposition', 'attachment; filename=' . $quoted)
+                ->header('Content-Disposition', 'attachment; filename='.$quoted)
                 ->header('Content-Transfer-Encoding', 'binary')
                 ->header('Connection', 'Keep-Alive')
                 ->header('Expires', '0')
                 ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
                 ->header('Pragma', 'public')
-                ->header('Content-Length', (string)strlen($content));
+                ->header('Content-Length', (string) strlen($content))
+            ;
 
             return $response;
         }
+
         throw new FireflyException('200003: File does not exist.');
     }
 
@@ -115,15 +120,20 @@ class ShowController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function index(): JsonResponse
     {
-        $manager = $this->getManager();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = $this->parameters->get('limit');
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of attachments. Count it and split it.
         $collection  = $this->repository->get();
@@ -131,14 +141,14 @@ class ShowController extends Controller
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.attachments.index') . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.attachments.index').$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -149,19 +159,21 @@ class ShowController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/getAttachment
      *
      * Display the specified resource.
-     *
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function show(Attachment $attachment): JsonResponse
     {
-        $manager = $this->getManager();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+        $manager     = $this->getManager();
+
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Attachment/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * StoreController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -36,6 +37,7 @@ use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class StoreController
@@ -46,8 +48,6 @@ class StoreController extends Controller
 
     /**
      * StoreController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -71,38 +71,40 @@ class StoreController extends Controller
      *
      * Store a newly created resource in storage.
      *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function store(StoreRequest $request): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
         Log::debug(sprintf('Now in %s', __METHOD__));
-        $data       = $request->getAll();
-        $attachment = $this->repository->store($data);
-        $manager    = $this->getManager();
+        $data        = $request->getAll();
+        $attachment  = $this->repository->store($data);
+        $manager     = $this->getManager();
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
     /**
      * Upload an attachment.
-     *
-     *
-     * @param Request    $request
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function upload(Request $request, Attachment $attachment): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
         /** @var AttachmentHelperInterface $helper */
         $helper = app(AttachmentHelperInterface::class);
         $body   = $request->getContent();
@@ -111,7 +113,12 @@ class StoreController extends Controller
 
             return response()->json([], 422);
         }
-        $helper->saveAttachmentFromApi($attachment, $body);
+        $result = $helper->saveAttachmentFromApi($attachment, $body);
+        if (false === $result) {
+            Log::error('Could not save attachment from API.');
+
+            return response()->json([], 422);
+        }
 
         return response()->json([], 204);
     }

app/Api/V1/Controllers/Models/Attachment/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * UpdateController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -31,7 +32,9 @@ use FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class UpdateController
@@ -42,8 +45,6 @@ class UpdateController extends Controller
 
     /**
      * UpdateController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -66,23 +67,23 @@ class UpdateController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/updateAttachment
      *
      * Update the specified resource in storage.
-     *
-     * @param UpdateRequest $request
-     * @param Attachment    $attachment
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Attachment $attachment): JsonResponse
     {
-        $data = $request->getAll();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+        $data        = $request->getAll();
         $this->repository->update($attachment, $data);
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,6 +28,7 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\AvailableBudget;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\AvailableBudgetEnrichment;
 use FireflyIII\Transformers\AvailableBudgetTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
@@ -44,8 +46,6 @@ class ShowController extends Controller
 
     /**
      * AvailableBudgetController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -68,33 +68,38 @@ class ShowController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function index(): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager          = $this->getManager();
 
         // types to get, page size:
-        $pageSize = $this->parameters->get('limit');
-
-        $start = $this->parameters->get('start');
-        $end   = $this->parameters->get('end');
+        $pageSize         = $this->parameters->get('limit');
+        $start            = $this->parameters->get('start');
+        $end              = $this->parameters->get('end');
 
         // get list of available budgets. Count it and split it.
         $collection       = $this->abRepository->getAvailableBudgetsByDate($start, $end);
         $count            = $collection->count();
         $availableBudgets = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
+        // enrich
+        /** @var User $admin */
+        $admin            = auth()->user();
+        $enrichment       = new AvailableBudgetEnrichment();
+        $enrichment->setUser($admin);
+        $availableBudgets = $enrichment->enrich($availableBudgets);
+
         // make paginator:
-        $paginator = new LengthAwarePaginator($availableBudgets, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.available-budgets.index') . $this->buildParams());
+        $paginator        = new LengthAwarePaginator($availableBudgets, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.available-budgets.index').$this->buildParams());
 
         /** @var AvailableBudgetTransformer $transformer */
-        $transformer = app(AvailableBudgetTransformer::class);
+        $transformer      = app(AvailableBudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($availableBudgets, $transformer, 'available_budgets');
+        $resource         = new FractalCollection($availableBudgets, $transformer, 'available_budgets');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -105,20 +110,28 @@ class ShowController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/available_budgets/getAvailableBudget
      *
      * Display the specified resource.
-     *
-     * @param AvailableBudget $availableBudget
-     *
-     * @return JsonResponse
      */
     public function show(AvailableBudget $availableBudget): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager         = $this->getManager();
+        $start           = $this->parameters->get('start');
+        $end             = $this->parameters->get('end');
 
         /** @var AvailableBudgetTransformer $transformer */
-        $transformer = app(AvailableBudgetTransformer::class);
+        $transformer     = app(AvailableBudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($availableBudget, $transformer, 'available_budgets');
+        // enrich
+        /** @var User $admin */
+        $admin           = auth()->user();
+        $enrichment      = new AvailableBudgetEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($start);
+        $enrichment->setEnd($end);
+        $availableBudget = $enrichment->enrichSingle($availableBudget);
+
+
+        $resource        = new Item($availableBudget, $transformer, 'available_budgets');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Bill/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -37,8 +38,6 @@ class DestroyController extends Controller
 
     /**
      * BillController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -58,10 +57,6 @@ class DestroyController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/bills/deleteBill
      *
      * Remove the specified resource from storage.
-     *
-     * @param Bill $bill
-     *
-     * @return JsonResponse
      */
     public function destroy(Bill $bill): JsonResponse
     {

app/Api/V1/Controllers/Models/Bill/ListController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ListController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -29,6 +30,7 @@ use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\Transformers\RuleTransformer;
 use FireflyIII\Transformers\TransactionGroupTransformer;
@@ -50,8 +52,6 @@ class ListController extends Controller
 
     /**
      * BillController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -72,29 +72,26 @@ class ListController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @param Bill $bill
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function attachments(Bill $bill): JsonResponse
     {
-        $manager    = $this->getManager();
-        $pageSize   = $this->parameters->get('limit');
-        $collection = $this->repository->getAttachments($bill);
+        $manager     = $this->getManager();
+        $pageSize    = $this->parameters->get('limit');
+        $collection  = $this->repository->getAttachments($bill);
 
         $count       = $collection->count();
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.bills.attachments', [$bill->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.bills.attachments', [$bill->id]).$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -106,31 +103,28 @@ class ListController extends Controller
      *
      * List all of them.
      *
-     * @param Bill $bill
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function rules(Bill $bill): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = $this->parameters->get('limit');
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of budgets. Count it and split it.
-        $collection = $this->repository->getRulesForBill($bill);
-        $count      = $collection->count();
-        $rules      = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $collection  = $this->repository->getRulesForBill($bill);
+        $count       = $collection->count();
+        $rules       = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($rules, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.bills.rules', [$bill->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($rules, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.bills.rules', [$bill->id]).$this->buildParams());
 
         /** @var RuleTransformer $transformer */
         $transformer = app(RuleTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new FractalCollection($rules, $transformer, 'rules');
+        $resource    = new FractalCollection($rules, $transformer, 'rules');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -142,28 +136,23 @@ class ListController extends Controller
      *
      * Show all transactions.
      *
-     * @param Request $request
-     *
-     * @param Bill    $bill
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function transactions(Request $request, Bill $bill): JsonResponse
     {
-        $pageSize = $this->parameters->get('limit');
-        $type     = $request->get('type') ?? 'default';
+        $pageSize     = $this->parameters->get('limit');
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
 
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector
             ->setUser($admin)
             // include source + destination account name and type.
@@ -175,7 +164,8 @@ class ListController extends Controller
             // set page to retrieve
             ->setPage($this->parameters->get('page'))
             // set types of transactions to return.
-            ->setTypes($types);
+            ->setTypes($types)
+        ;
 
         if (null !== $this->parameters->get('start')) {
             $collector->setStart($this->parameters->get('start'));
@@ -185,15 +175,19 @@ class ListController extends Controller
         }
 
         // get paginator.
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.bills.transactions', [$bill->id]) . $this->buildParams());
-        $transactions = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.bills.transactions', [$bill->id]).$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($transactions, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);

app/Api/V1/Controllers/Models/Bill/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,7 +28,9 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\SubscriptionEnrichment;
 use FireflyIII\Transformers\BillTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -43,8 +46,6 @@ class ShowController extends Controller
 
     /**
      * BillController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -65,24 +66,32 @@ class ShowController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function index(): JsonResponse
     {
         $this->repository->correctOrder();
-        $bills     = $this->repository->getBills();
-        $manager   = $this->getManager();
-        $pageSize  = $this->parameters->get('limit');
-        $count     = $bills->count();
-        $bills     = $bills->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
-        $paginator = new LengthAwarePaginator($bills, $count, $pageSize, $this->parameters->get('page'));
+        $bills       = $this->repository->getBills();
+        $manager     = $this->getManager();
+        $pageSize    = $this->parameters->get('limit');
+        $count       = $bills->count();
+        $bills       = $bills->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $paginator   = new LengthAwarePaginator($bills, $count, $pageSize, $this->parameters->get('page'));
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new SubscriptionEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $bills       = $enrichment->enrich($bills);
 
         /** @var BillTransformer $transformer */
         $transformer = app(BillTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($bills, $transformer, 'bills');
+        $resource    = new FractalCollection($bills, $transformer, 'bills');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -93,19 +102,25 @@ class ShowController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/bills/getBill
      *
      * Show the specified bill.
-     *
-     * @param Bill $bill
-     *
-     * @return JsonResponse
      */
     public function show(Bill $bill): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new SubscriptionEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $bill        = $enrichment->enrichSingle($bill);
+
         /** @var BillTransformer $transformer */
         $transformer = app(BillTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($bill, $transformer, 'bills');
+        $resource    = new Item($bill, $transformer, 'bills');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Bill/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * StoreController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -28,7 +29,9 @@ use FireflyIII\Api\V1\Requests\Models\Bill\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\SubscriptionEnrichment;
 use FireflyIII\Transformers\BillTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -43,8 +46,6 @@ class StoreController extends Controller
 
     /**
      * BillController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -65,22 +66,28 @@ class StoreController extends Controller
      *
      * Store a bill.
      *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $data    = $request->getAll();
-        $bill    = $this->repository->store($data);
-        $manager = $this->getManager();
+        $data        = $request->getAll();
+        $bill        = $this->repository->store($data);
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new SubscriptionEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $bill        = $enrichment->enrichSingle($bill);
 
         /** @var BillTransformer $transformer */
         $transformer = app(BillTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($bill, $transformer, 'bills');
+        $resource    = new Item($bill, $transformer, 'bills');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Bill/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * UpdateController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,7 +28,9 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Bill\UpdateRequest;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\SubscriptionEnrichment;
 use FireflyIII\Transformers\BillTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -40,8 +43,6 @@ class UpdateController extends Controller
 
     /**
      * BillController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -61,23 +62,27 @@ class UpdateController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/bills/updateBill
      *
      * Update a bill.
-     *
-     * @param UpdateRequest $request
-     * @param Bill          $bill
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Bill $bill): JsonResponse
     {
-        $data    = $request->getAll();
-        $bill    = $this->repository->update($bill, $data);
-        $manager = $this->getManager();
+        $data        = $request->getAll();
+        $bill        = $this->repository->update($bill, $data);
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new SubscriptionEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $bill        = $enrichment->enrichSingle($bill);
 
         /** @var BillTransformer $transformer */
         $transformer = app(BillTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($bill, $transformer, 'bills');
+        $resource    = new Item($bill, $transformer, 'bills');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Budget/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -37,8 +38,6 @@ class DestroyController extends Controller
 
     /**
      * DestroyController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -58,10 +57,6 @@ class DestroyController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/deleteBudget
      *
      * Remove the specified resource from storage.
-     *
-     * @param Budget $budget
-     *
-     * @return JsonResponse
      */
     public function destroy(Budget $budget): JsonResponse
     {

app/Api/V1/Controllers/Models/Budget/ListController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ListController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -24,12 +25,15 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Budget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetLimitEnrichment;
+use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\Transformers\BudgetLimitTransformer;
 use FireflyIII\Transformers\TransactionGroupTransformer;
@@ -40,9 +44,7 @@ use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
 
-/***
- * Class ListController
- */
+// Class ListController
 class ListController extends Controller
 {
     use TransactionFilter;
@@ -52,8 +54,6 @@ class ListController extends Controller
 
     /**
      * ListController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -74,29 +74,26 @@ class ListController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/listAttachmentByBudget
      *
-     * @param Budget $budget
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function attachments(Budget $budget): JsonResponse
     {
-        $manager    = $this->getManager();
-        $pageSize   = $this->parameters->get('limit');
-        $collection = $this->repository->getAttachments($budget);
+        $manager     = $this->getManager();
+        $pageSize    = $this->parameters->get('limit');
+        $collection  = $this->repository->getAttachments($budget);
 
         $count       = $collection->count();
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.budgets.attachments', [$budget->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.budgets.attachments', [$budget->id]).$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -108,26 +105,31 @@ class ListController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @param Budget $budget
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function budgetLimits(Budget $budget): JsonResponse
     {
-        $manager  = $this->getManager();
-        $pageSize = $this->parameters->get('limit');
+        $manager      = $this->getManager();
+        $pageSize     = $this->parameters->get('limit');
         $this->parameters->set('budget_id', $budget->id);
         $collection   = $this->blRepository->getBudgetLimits($budget, $this->parameters->get('start'), $this->parameters->get('end'));
         $count        = $collection->count();
         $budgetLimits = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
         $paginator    = new LengthAwarePaginator($budgetLimits, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.budgets.budget-limits', [$budget->id]) . $this->buildParams());
+        $paginator->setPath(route('api.v1.budgets.budget-limits', [$budget->id]).$this->buildParams());
+
+        // enrich
+        /** @var User $admin */
+        $admin        = auth()->user();
+        $enrichment   = new BudgetLimitEnrichment();
+        $enrichment->setUser($admin);
+        $budgetLimits = $enrichment->enrich($budgetLimits);
+
 
         /** @var BudgetLimitTransformer $transformer */
-        $transformer = app(BudgetLimitTransformer::class);
+        $transformer  = app(BudgetLimitTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
+        $resource     = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -139,29 +141,24 @@ class ListController extends Controller
      *
      * Show all transactions.
      *
-     * @param Request $request
-     *
-     * @param Budget  $budget
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function transactions(Request $request, Budget $budget): JsonResponse
     {
-        $pageSize = $this->parameters->get('limit');
+        $pageSize     = $this->parameters->get('limit');
 
-        $type = $request->get('type') ?? 'default';
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
 
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector
             ->setUser($admin)
             // filter on budget.
@@ -173,7 +170,8 @@ class ListController extends Controller
             // set page to retrieve
             ->setPage($this->parameters->get('page'))
             // set types of transactions to return.
-            ->setTypes($types);
+            ->setTypes($types)
+        ;
 
         if (null !== $this->parameters->get('start')) {
             $collector->setStart($this->parameters->get('start'));
@@ -182,14 +180,18 @@ class ListController extends Controller
             $collector->setEnd($this->parameters->get('end'));
         }
 
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.budgets.transactions', [$budget->id]) . $this->buildParams());
-        $transactions = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.budgets.transactions', [$budget->id]).$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new FractalCollection($transactions, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -201,29 +203,28 @@ class ListController extends Controller
      *
      * Show all transactions.
      *
-     * @param Request $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function withoutBudget(Request $request): JsonResponse
     {
-        $pageSize = $this->parameters->get('limit');
+        $pageSize     = $this->parameters->get('limit');
 
-        $type = $request->get('type') ?? 'default';
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
 
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector
             ->setUser($admin)
+            // withdrawals only
+            ->setTypes([TransactionTypeEnum::WITHDRAWAL->value])
             // filter on budget.
             ->withoutBudget()
             // all info needed for the API:
@@ -233,7 +234,8 @@ class ListController extends Controller
             // set page to retrieve
             ->setPage($this->parameters->get('page'))
             // set types of transactions to return.
-            ->setTypes($types);
+            ->setTypes($types)
+        ;
 
         if (null !== $this->parameters->get('start')) {
             $collector->setStart($this->parameters->get('start'));
@@ -242,14 +244,18 @@ class ListController extends Controller
             $collector->setEnd($this->parameters->get('end'));
         }
 
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.budgets.without-budget') . $this->buildParams());
-        $transactions = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.budgets.without-budget').$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new FractalCollection($transactions, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);

app/Api/V1/Controllers/Models/Budget/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -28,7 +29,9 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetEnrichment;
 use FireflyIII\Transformers\BudgetTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -45,8 +48,6 @@ class ShowController extends Controller
 
     /**
      * ListController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -69,30 +70,38 @@ class ShowController extends Controller
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function index(): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = $this->parameters->get('limit');
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of budgets. Count it and split it.
-        $collection = $this->repository->getBudgets();
-        $count      = $collection->count();
-        $budgets    = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $collection  = $this->repository->getBudgets();
+        $count       = $collection->count();
+        $budgets     = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new BudgetEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $budgets     = $enrichment->enrich($budgets);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($budgets, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.budgets.index') . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($budgets, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.budgets.index').$this->buildParams());
 
         /** @var BudgetTransformer $transformer */
         $transformer = app(BudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($budgets, $transformer, 'budgets');
+        $resource    = new FractalCollection($budgets, $transformer, 'budgets');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -100,20 +109,25 @@ class ShowController extends Controller
 
     /**
      * Show a budget.
-     *
-     * @param Budget $budget
-     *
-     * @return JsonResponse
      */
     public function show(Budget $budget): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new BudgetEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setStart($this->parameters->get('start'));
+        $enrichment->setEnd($this->parameters->get('end'));
+        $budget      = $enrichment->enrichSingle($budget);
 
         /** @var BudgetTransformer $transformer */
         $transformer = app(BudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($budget, $transformer, 'budgets');
+        $resource    = new Item($budget, $transformer, 'budgets');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Budget/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * StoreController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,7 +28,9 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Budget\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetEnrichment;
 use FireflyIII\Transformers\BudgetTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -40,8 +43,6 @@ class StoreController extends Controller
 
     /**
      * StoreController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -62,23 +63,26 @@ class StoreController extends Controller
      *
      * Store a budget.
      *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
-     *
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $budget = $this->repository->store($request->getAll());
+        $budget      = $this->repository->store($request->getAll());
         $budget->refresh();
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new BudgetEnrichment();
+        $enrichment->setUser($admin);
+        $budget      = $enrichment->enrichSingle($budget);
 
         /** @var BudgetTransformer $transformer */
         $transformer = app(BudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($budget, $transformer, 'budgets');
+        $resource    = new Item($budget, $transformer, 'budgets');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Budget/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * UpdateController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,7 +28,9 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Budget\UpdateRequest;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetEnrichment;
 use FireflyIII\Transformers\BudgetTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -40,8 +43,6 @@ class UpdateController extends Controller
 
     /**
      * UpdateController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -61,23 +62,25 @@ class UpdateController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/updateBudget
      *
      * Update a budget.
-     *
-     * @param UpdateRequest $request
-     * @param Budget        $budget
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Budget $budget): JsonResponse
     {
-        $data    = $request->getAll();
-        $budget  = $this->repository->update($budget, $data);
-        $manager = $this->getManager();
+        $data        = $request->getAll();
+        $budget      = $this->repository->update($budget, $data);
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new BudgetEnrichment();
+        $enrichment->setUser($admin);
+        $budget      = $enrichment->enrichSingle($budget);
 
         /** @var BudgetTransformer $transformer */
         $transformer = app(BudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($budget, $transformer, 'budgets');
+        $resource    = new Item($budget, $transformer, 'budgets');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -40,8 +41,6 @@ class DestroyController extends Controller
 
     /**
      * BudgetLimitController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -64,10 +63,6 @@ class DestroyController extends Controller
      *
      * Remove the specified resource from storage.
      *
-     * @param Budget      $budget
-     * @param BudgetLimit $budgetLimit
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function destroy(Budget $budget, BudgetLimit $budgetLimit): JsonResponse

app/Api/V1/Controllers/Models/BudgetLimit/ListController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ListController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -28,8 +29,8 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
-use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
 use FireflyIII\Transformers\TransactionGroupTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
@@ -44,55 +45,28 @@ class ListController extends Controller
 {
     use TransactionFilter;
 
-    private BudgetLimitRepositoryInterface $blRepository;
-
-    /**
-     * BudgetLimitController constructor.
-     *
-
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->middleware(
-            function ($request, $next) {
-                /** @var User $user */
-                $user               = auth()->user();
-                $this->blRepository = app(BudgetLimitRepositoryInterface::class);
-                $this->blRepository->setUser($user);
-
-                return $next($request);
-            }
-        );
-    }
-
     /**
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/listTransactionByBudgetLimit
      * Show all transactions.
      *
-     * @param Request     $request
-     * @param Budget      $budget
-     * @param BudgetLimit $budgetLimit
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function transactions(Request $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse
     {
-        $pageSize = $this->parameters->get('limit');
-        $type     = $request->get('type') ?? 'default';
+        $pageSize     = $this->parameters->get('limit');
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
 
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector
             ->setUser($admin)
             // filter on budget.
@@ -104,19 +78,24 @@ class ListController extends Controller
             // set page to retrieve
             ->setPage($this->parameters->get('page'))
             // set types of transactions to return.
-            ->setTypes($types);
+            ->setTypes($types)
+        ;
 
         $collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
         $collector->setTypes($types);
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.budgets.limits.transactions', [$budget->id, $budgetLimit->id]) . $this->buildParams());
-        $transactions = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.budgets.limits.transactions', [$budget->id, $budgetLimit->id]).$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($transactions, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);

app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -30,10 +31,10 @@ use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetLimitEnrichment;
 use FireflyIII\Transformers\BudgetLimitTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use Illuminate\Http\Request;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
@@ -49,8 +50,6 @@ class ShowController extends Controller
 
     /**
      * BudgetLimitController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -74,29 +73,31 @@ class ShowController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/listBudgetLimitByBudget
      *
      * Display a listing of the budget limits for this budget.
-     *
-     * @param Request $request
-     * @param Budget  $budget
-     *
-     * @return JsonResponse
-     * @throws FireflyException
      */
-    public function index(Request $request, Budget $budget): JsonResponse
+    public function index(Budget $budget): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager      = $this->getManager();
         $manager->parseIncludes('budget');
         $pageSize     = $this->parameters->get('limit');
         $collection   = $this->blRepository->getBudgetLimits($budget, $this->parameters->get('start'), $this->parameters->get('end'));
         $count        = $collection->count();
         $budgetLimits = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
         $paginator    = new LengthAwarePaginator($budgetLimits, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.budgets.limits.index', [$budget->id]) . $this->buildParams());
+        $paginator->setPath(route('api.v1.budgets.limits.index', [$budget->id]).$this->buildParams());
+
+
+        // enrich
+        /** @var User $admin */
+        $admin        = auth()->user();
+        $enrichment   = new BudgetLimitEnrichment();
+        $enrichment->setUser($admin);
+        $budgetLimits = $enrichment->enrich($budgetLimits);
 
         /** @var BudgetLimitTransformer $transformer */
-        $transformer = app(BudgetLimitTransformer::class);
+        $transformer  = app(BudgetLimitTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
+        $resource     = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -108,27 +109,31 @@ class ShowController extends Controller
      *
      * Display a listing of the budget limits for this budget.
      *
-     * @param SameDateRequest $request
-     *
-     * @return JsonResponse
-     * @throws FireflyException
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function indexAll(SameDateRequest $request): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager      = $this->getManager();
         $manager->parseIncludes('budget');
         $pageSize     = $this->parameters->get('limit');
         $collection   = $this->blRepository->getAllBudgetLimits($this->parameters->get('start'), $this->parameters->get('end'));
         $count        = $collection->count();
         $budgetLimits = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
         $paginator    = new LengthAwarePaginator($budgetLimits, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.budget-limits.index') . $this->buildParams());
+        $paginator->setPath(route('api.v1.budget-limits.index').$this->buildParams());
+
+        // enrich
+        /** @var User $admin */
+        $admin        = auth()->user();
+        $enrichment   = new BudgetLimitEnrichment();
+        $enrichment->setUser($admin);
+        $budgetLimits = $enrichment->enrich($budgetLimits);
 
         /** @var BudgetLimitTransformer $transformer */
-        $transformer = app(BudgetLimitTransformer::class);
+        $transformer  = app(BudgetLimitTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
+        $resource     = new FractalCollection($budgetLimits, $transformer, 'budget_limits');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -138,26 +143,28 @@ class ShowController extends Controller
      * This endpoint is documented at:
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/getBudgetLimit
      *
-     * @param Request     $request
-     * @param Budget      $budget
-     * @param BudgetLimit $budgetLimit
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
-    public function show(Request $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse
+    public function show(Budget $budget, BudgetLimit $budgetLimit): JsonResponse
     {
-        if ((int)$budget->id !== (int)$budgetLimit->budget_id) {
+        if ($budget->id !== $budgetLimit->budget_id) {
             throw new FireflyException('20028: The budget limit does not belong to the budget.');
         }
         // continue!
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new BudgetLimitEnrichment();
+        $enrichment->setUser($admin);
+        $budgetLimit = $enrichment->enrichSingle($budgetLimit);
 
         /** @var BudgetLimitTransformer $transformer */
         $transformer = app(BudgetLimitTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($budgetLimit, $transformer, 'budget_limits');
+        $resource    = new Item($budgetLimit, $transformer, 'budget_limits');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * StoreController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -27,6 +28,7 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\BudgetLimit\StoreRequest;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\BudgetLimitEnrichment;
 use FireflyIII\Transformers\BudgetLimitTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
@@ -41,8 +43,6 @@ class StoreController extends Controller
 
     /**
      * BudgetLimitController constructor.
-     *
-
      */
     public function __construct()
     {
@@ -64,11 +64,6 @@ class StoreController extends Controller
      * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/budgets/storeBudgetLimit
      *
      * Store a newly created resource in storage.
-     *
-     * @param StoreRequest $request
-     * @param Budget       $budget
-     *
-     * @return JsonResponse
      */
     public function store(StoreRequest $request, Budget $budget): JsonResponse
     {
@@ -77,13 +72,21 @@ class StoreController extends Controller
         $data['end_date']   = $data['end'];
         $data['budget_id']  = $budget->id;
 
-        $budgetLimit = $this->blRepository->store($data);
-        $manager     = $this->getManager();
+        $budgetLimit        = $this->blRepository->store($data);
+        $manager            = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin              = auth()->user();
+        $enrichment         = new BudgetLimitEnrichment();
+        $enrichment->setUser($admin);
+        $budgetLimit        = $enrichment->enrichSingle($budgetLimit);
+
         /** @var BudgetLimitTransformer $transformer */
-        $transformer = app(BudgetLimitTransformer::class);
+        $transformer        = app(BudgetLimitTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($budgetLimit, $transformer, 'budget_limits');
+        $resource           = new Item($budgetLimit, $transformer, 'budget_limits');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }