Merge branch 'release/5.7.7'

Bump guzzlehttp/guzzle from 7.4.2 to 7.4.3

.ci/.env.ci

@@ -260,12 +260,6 @@ DISABLE_CSP_HEADER=false
 TRACKER_SITE_ID=
 TRACKER_URL=
 
-#
-# Firefly III can collect telemetry on how you use Firefly III. This is opt-in.
-# In order to allow this, change the following variable to true.
-# To read more about this feature, go to this page: https://docs.firefly-iii.org/support/telemetry
-SEND_TELEMETRY=false
-
 # 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 lost of inconsistent data.
 # However if you know what you're doing you can significantly speed up container start times.

.deploy/heroku/.env.heroku

@@ -261,12 +261,6 @@ DISABLE_CSP_HEADER=false
 TRACKER_SITE_ID=
 TRACKER_URL=
 
-#
-# Firefly III can collect telemetry on how you use Firefly III. This is opt-in.
-# In order to allow this, change the following variable to true.
-# To read more about this feature, go to this page: https://docs.firefly-iii.org/support/telemetry
-SEND_TELEMETRY=false
-
 # 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 lost of inconsistent data.
 # However if you know what you're doing you can significantly speed up container start times.

.env.example

@@ -37,15 +37,16 @@ TRUSTED_PROXIES=
 # Several other options exist. You can use 'single' for one big fat error log (not recommended).
 # Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
 # A rotating log option is 'daily', creates 5 files that (surprise) rotate.
+# A cool option is 'papertrail' for cloud logging
 # Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
-
-# - Docker + versions <= 4.8.1.8 and before: use "stdout"
-# - Docker + versions >  4.8.1.8           : use "docker_out"
-# - Docker + versions >=  5.1.1            : use "stack"
-# - For everything else (als not Docker)   : use 'stack'
-
 LOG_CHANNEL=stack
 
+#
+# Used when logging to papertrail:
+#
+PAPERTRAIL_HOST=
+PAPERTRAIL_PORT=
+
 # Log level. You can set this from least severe to most severe:
 # debug, info, notice, warning, error, critical, alert, emergency
 # If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
@@ -68,6 +69,8 @@ DB_PORT=3306
 DB_DATABASE=firefly
 DB_USERNAME=firefly
 DB_PASSWORD=secret_firefly_password
+# leave empty or omit when not using a socket connection
+DB_SOCKET=
 
 # MySQL supports SSL. You can configure it here.
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
@@ -88,6 +91,9 @@ PGSQL_SSL_CERT=null
 PGSQL_SSL_KEY=null
 PGSQL_SSL_CRL_FILE=null
 
+# more PostgreSQL settings
+PGSQL_SCHEMA=public
+
 # If you're looking for performance improvements, you could install memcached or redis
 CACHE_DRIVER=file
 SESSION_DRIVER=file
@@ -136,7 +142,6 @@ MAIL_ENCRYPTION=null
 MAILGUN_DOMAIN=
 MAILGUN_SECRET=
 
-
 # If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
 # If you use Docker or similar, you can set this variable from a file by appending it with _FILE
 MAILGUN_ENDPOINT=api.mailgun.net
@@ -170,36 +175,20 @@ MAP_DEFAULT_ZOOM=6
 #
 # Firefly III supports a few authentication methods:
 # - 'web' (default, uses built in DB)
-# - 'ldap'
 # - 'remote_user_guard' for Authelia etc
 # Read more about these settings in the documentation.
 # https://docs.firefly-iii.org/advanced-installation/authentication
-
 #
-# Set to 'ldap' to enable LDAP
+# LDAP is no longer supported :(
 #
 AUTHENTICATION_GUARD=web
 
-#
-# LDAP connection settings:
-#
-LDAP_HOST=ldap.yourserver.com
-LDAP_USERNAME="uid=X,ou=,o=,dc=something,dc=com"
-LDAP_PASSWORD=super_secret
-LDAP_PORT=389
-LDAP_BASE_DN="o=something,dc=site,dc=com"
-LDAP_TIMEOUT=5
-LDAP_SSL=false
-LDAP_TLS=false
-LDAP_AUTH_FIELD=uid
-
 #
 # Remote user guard settings
 #
 AUTHENTICATION_GUARD_HEADER=REMOTE_USER
 AUTHENTICATION_GUARD_EMAIL=
 
-
 #
 # Extra authentication settings
 #
@@ -236,6 +225,8 @@ ALLOW_WEBHOOKS=false
 #
 # For more info: https://docs.firefly-iii.org/firefly-iii/advanced-installation/cron/
 #
+# You can set this variable from a file by appending it with _FILE
+#
 STATIC_CRON_TOKEN=
 
 # You can fine tune the start-up of a Docker container by editing these environment variables.
@@ -243,6 +234,13 @@ STATIC_CRON_TOKEN=
 # 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
@@ -271,7 +269,6 @@ 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
-ADLDAP_CONNECTION=default
 BROADCAST_DRIVER=log
 QUEUE_DRIVER=sync
 CACHE_PREFIX=firefly
@@ -289,6 +286,8 @@ FIREFLY_III_LAYOUT=v1
 # 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.
 #
+# Notable exception to this rule is Synology, which, according to some users, will use APP_URL to rewrite stuff.
+#
 # 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
 #

.github/.mergify.yml

@@ -1,7 +0,0 @@
-pull_request_rules:
-  - name: PR on main is never approved.
-    conditions:
-      - base=main
-    actions:
-      close:
-        message: Please reopen this PR on the `develop` branch. Thank you.

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -1,33 +0,0 @@
----
-name: Bug report
-about: Create a report to help Firefly III improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Bug description**
-I am running Firefly III version x.x.x, and my problem is:
-
-<!-- Replace the version and describe your problem or your issue may be closed. -->
-
-**Steps to reproduce**
-<!-- What do you need to do to trigger this bug? -->
-
-**Extra info**
-<!-- Please add extra info here, such as OS, browser, and the output from the /debug page of your Firefly III installation (click the version at the bottom). 
-
-DO NOT PUT ```BACKTICKS``` AROUND THE OUTPUT OF THE /debug PAGE
-
--->
-
-
-**Bonus points**
-<!-- Before you submit, verify the following please: -->
-
-- I searched and nobody reported this bug before
-- I have added a stack trace from my log files <!-- (see https://bit.ly/FF3-get-debug-info) -->
-- I have added a screenshot.
-- I was able to replicate it on the demo site https://demo.firefly-iii.org/
-<!-- - I donated money (this is a joke ;)-->

.github/ISSUE_TEMPLATE/Custom.md

@@ -1,27 +0,0 @@
----
-name: I have a question or a problem
-about: Ask away!
-
----
-
-I am running Firefly III version x.x.x.
-
-**Description**
-<!-- (if relevant of course) -->
-
-**Extra info**
-<!-- Please add extra info here, such as OS, browser, and the output from the `/debug`-page of your Firefly III installation (click the version at the bottom). 
-
-DO NOT PUT ```BACKTICKS``` AROUND THE OUTPUT OF THE /debug PAGE
-
---> 
-
-**Bonus points**
-
-<!-- Complete the following checklist for bonus points -->
-
-- I have read the FAQ at https://bit.ly/FF3-FAQ
-- I added a screenshot
-- I added log files <!-- (see https://bit.ly/FF3-get-debug-info) -->
-- I was able to replicate the issue on the demo site.
-<!-- - I donated money (this is a joke :wink:)-->

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -1,34 +0,0 @@
----
-name: Feature request
-about: Suggest an idea or feature for Firefly III
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Description**
-<!--
-Please describe your feature request:
-
-- I would like Firefly III to do ABC.
-- What if you would add feature XYZ?
-- Firefly III doesn't do DEF.
-
--->
-
-**Solution**
-<!-- Describe what your feature would add to Firefly III. -->
-
-**What are alternatives?**
-<!-- Please describe what alternatives currently exist. -->
-
-**Additional context**
-<!-- Add any other context or screenshots about the feature request here. -->
-
-**Bonus points**
-<!-- Earn bonus points by:
-
-- Make a drawing
-- Donate money (just kidding ;)
--->

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,57 @@
+name: Bug Report
+description: Report a bug in Firefly III (or associated tools)
+body:
+  - type: checkboxes
+    attributes:
+      label: Support guidelines
+      description: Please read the support guidelines before proceeding.
+      options:
+        - label: I've read the [support guidelines](https://github.com/firefly-iii/firefly-iii/blob/main/.github/support.md)
+          required: true
+
+  - 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.
+      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
+        - label: ... it's [definitely me, not you](https://github.com/firefly-iii/firefly-iii/blob/main/.github/its_you_not_me.md)
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: Please provide a brief description of the bug in 1-2 sentences.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected behaviour
+      description: Please describe precisely what you'd expect to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Debug information
+      description: Please provide the table from the /debug page
+      placeholder: The output from the /debug page
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Please describe the steps to reproduce the bug.
+      placeholder: |
+        1. ...
+        2. ...
+        3. ...
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Please provide any additional information that seem useful.

.github/ISSUE_TEMPLATE/fr.yml

@@ -0,0 +1,42 @@
+name: Feature Request
+description: Request a feature or enhancement in Firefly III (or associated tools)
+body:
+  - type: checkboxes
+    attributes:
+      label: Support guidelines
+      description: Please read the support guidelines before proceeding.
+      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/about-firefly-iii/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 discussed before.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: Please describe your feature request
+      placeholder: |
+        - I would like Firefly III to do ABC.
+        - What if you would add feature XYZ?
+        - Firefly III doesn't do DEF.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Solution
+      description: Describe what your feature would add to Firefly III.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What are alternatives?
+      description: Please describe what alternatives currently exist.
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -19,11 +19,10 @@ updates:
     schedule:
       interval: "weekly"
 
-  # yarn / JS updates for new frontend
-  - package-ecosystem: "npm"
-    directory: "/frontend"
+  - package-ecosystem: "github-actions"
+    directory: "/" 
     target-branch: develop
-    versioning-strategy: increase
     labels: ["bug"]
+    versioning-strategy: increase
     schedule:
       interval: "weekly"

.github/its_you_not_me.md

@@ -0,0 +1,16 @@
+# It's not you, it's me
+
+Sometimes bugs reported to Firefly III are configuration and system problems on the user's side.
+
+If you run into any of the following problems, there's a good chance it's not a Firefly III issue, but a configuration issue.
+
+- ⚠️ Firefly III can't connect to the database when starting or the password is wrong, even though you're sure it's correct.
+- ⚠️ Errors about a missing `APP_KEY` or other encryption/hash problems
+- ⚠️ You can't login due to `419` errors (page expired)
+- ⚠️ Any `500` error when starting Firefly III
+- ⚠️ Any white page when starting Firefly III
+- ⚠️ Time-out when starting Firefly III for the first time
+- ⚠️ Firefly III does not work behind your reverse proxy
+- ⚠️ You can't connect to the Data Importer due to 404's or authentication issues.
+
+If you run into an issue like this, please start a [discussion](https://github.com/firefly-iii/firefly-iii/discussions) or chat on [Gitter.im](https://gitter.im/firefly-iii/firefly-iii). There's a good chance it's not a bug but something we can fix rather quickly :+1:

.github/mergify.yml

@@ -0,0 +1,8 @@
+pull_request_rules:
+  - name: Close all on main
+    conditions:
+      - base=main
+      - -author~=^dependabot(|-preview)\[bot\]$
+    actions:
+      close:
+        message: Please do not open PR's on the `main` branch, but on the `develop` branch only. Thank you!

.github/stale.yml

@@ -1,11 +1,11 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 
 # Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 7
+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: 7
+daysUntilClose: 14
 
 # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
 # - "[Status] Maybe Later"

.github/support.md

@@ -1,12 +1,32 @@
-# Welcome to Firefly III on Github!
+# Support [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/firefly-iii/firefly-iii.svg)](http://isitmaintained.com/project/firefly-iii/firefly-iii "Average time to resolve an issue")
 
 :+1::tada: Thank you for taking the time to contribute something to Firefly III!
 
-## Bugs
+## Reporting an issue
 
-First of all: thank you for reporting a bug instead of ditching the tool altogether. If you find a bug, please take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from this bug. Include as many log files and details as you think are necessary. Bugs have a lot of priority! 
+First of all: thank you for reporting a bug instead of ditching the tool altogether. Bugs have a lot of priority! 
 
-## Installation problems
+1. Open bugs will have open issues, so search for one first.
+2. If your feature request is already there, vote on it with :+1: or :-1: reactions.
+3. Do NOT hijack old issues with the bug you found, open your own issue.
+4. If relevant, take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from your issue.
+5. If relevant, read the [documentation](https://docs.firefly-iii.org/).
 
-Please take the time to read the [documentation](https://docs.firefly-iii.org/) and make sure you search through closed issues for the problems other people
- have had. Your problem may be among them! If not, open an issue and I will help where I can.
+Please follow these guidelines when opening new issues:
+
+## Writing good issues
+
+- File a single issue for a single problem or feature requests. Feel free to open multiple issues.
+- Collect as many details as you can.
+- Be clear and specific, and state what you're not sure about.
+
+Only then [create a new issue](https://github.com/firefly-iii/firefly-iii/issues/new/choose)!
+
+## Issue closure and abandonment policy
+
+- 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/).
+- 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.
+- Issues will be locked automatically after 90 days.

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Sonarcloud CI
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/depsreview.yaml

@@ -0,0 +1,14 @@
+name: '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@v1

.github/workflows/lock.yml

@@ -5,8 +5,14 @@ on:
   schedule:
     - cron: '0 0 * * *'
 
+permissions:
+  contents: read
+
 jobs:
   lock:
+    permissions:
+      issues: write  # for dessant/lock-threads to lock issues
+      pull-requests: write  # for dessant/lock-threads to lock PRs
     runs-on: ubuntu-latest
     steps:
       - uses: dessant/lock-threads@v2

.github/workflows/stale.yml

@@ -3,8 +3,14 @@ on:
   schedule:
     - cron: "30 1 * * *"
 
+permissions:
+  contents: read
+
 jobs:
   stale:
+    permissions:
+      issues: write  # for actions/stale to close stale issues
+      pull-requests: write  # for actions/stale to close stale PRs
     runs-on: ubuntu-latest
     steps:
       - uses: actions/stale@v3

.gitignore

@@ -1,18 +1,8 @@
 /node_modules
 /frontend/node_modules
-/frontend/fonts
-/frontend/images
-/public/hot
-/public/storage
 /storage/*.key
 /vendor
 /.vagrant
-Homestead.json
-Homestead.yaml
 npm-debug.log
 yarn-error.log
 .env
-public/google*.html
-report.html
-composer.phar
-app.js.map

.scrutinizer.yml

@@ -1,58 +0,0 @@
---- 
-build: 
-  nodes: 
-    analysis: 
-      project_setup: 
-        override: true
-      tests: 
-        override: 
-          - php-scrutinizer-run
-checks: 
-  javascript: true
-  php: 
-    align_assignments: true
-    avoid_fixme_comments: true
-    avoid_multiple_statements_on_same_line: true
-    avoid_perl_style_comments: true
-    avoid_todo_comments: true
-    duplication: false
-    encourage_single_quotes: true
-    newline_at_end_of_file: true
-    no_goto: true
-    no_long_variable_names: 
-      maximum: "20"
-    no_short_method_names: 
-      minimum: "3"
-    no_short_variable_names: 
-      minimum: "3"
-    optional_parameters_at_the_end: true
-    parameter_doc_comments: true
-    remove_extra_empty_lines: true
-    return_doc_comment_if_not_inferrable: true
-    return_doc_comments: true
-    uppercase_constants: true
-    use_self_instead_of_fqcn: true
-coding_style: 
-  php: 
-    spaces: 
-      around_operators: 
-        concatenation: true
-      other: 
-        after_type_cast: false
-filter: 
-  excluded_paths: 
-    - database/migrations/*
-    - bootstrap/*
-    - config/*
-    - docker/*
-    - public/js/lib/*
-    - public/lib/adminlte/js/*
-    - public/lib/bootstrap/js/*
-    - resources/*
-    - routes/*
-    - storage/*
-  paths: 
-    - app/*
-    - public/js/ff/*
-tools: 
-  external_code_coverage: false

.travis.yml

@@ -1,20 +0,0 @@
-language: php
-php:
-- '7.4'
-dist: xenial
-os: linux
-cache:
-  directories:
-  - "/home/travis/.config"
-  - "/home/travis/build/firefly-iii/firefly-iii/vendor"
-
-branches:
-  only:
-  - develop
-
-before_script:
-- phpenv config-rm xdebug.ini || return 0
-
-script:
-- "./.ci/phpstan.sh"
-- "./.ci/phpunit.sh"

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

@@ -25,12 +25,14 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use JsonException;
 
 /**
  * Class AccountController
@@ -62,9 +64,15 @@ class AccountController extends Controller
     }
 
     /**
+     * Documentation for this endpoint:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getAccountsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
+     * @throws JsonException
+     * @throws FireflyException
+     * @throws FireflyException
      */
     public function accounts(AutocompleteRequest $request): JsonResponse
     {
@@ -74,7 +82,7 @@ class AccountController extends Controller
         $date  = $data['date'] ?? today(config('app.timezone'));
 
         $return          = [];
-        $result          = $this->repository->searchAccount((string)$query, $types, $data['limit']);
+        $result          = $this->repository->searchAccount((string) $query, $types, $data['limit']);
         $defaultCurrency = app('amount')->getDefaultCurrency();
 
         /** @var Account $account */
@@ -88,7 +96,7 @@ class AccountController extends Controller
             }
 
             $return[] = [
-                'id'                      => (string)$account->id,
+                'id'                      => (string) $account->id,
                 'name'                    => $account->name,
                 'name_with_balance'       => $nameWithBalance,
                 'type'                    => $account->accountType->type,

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

@@ -56,6 +56,9 @@ class BillController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getBillsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -67,7 +70,7 @@ class BillController extends Controller
         $filtered = $result->map(
             static function (Bill $item) {
                 return [
-                    'id'   => (string)$item->id,
+                    'id'   => (string) $item->id,
                     'name' => $item->name,
                 ];
             }

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

@@ -56,6 +56,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getBudgetsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -67,7 +70,7 @@ class BudgetController extends Controller
         $filtered = $result->map(
             static function (Budget $item) {
                 return [
-                    'id'   => (string)$item->id,
+                    'id'   => (string) $item->id,
                     'name' => $item->name,
                 ];
             }

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

@@ -56,6 +56,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCategoriesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -67,7 +70,7 @@ class CategoryController extends Controller
         $filtered = $result->map(
             static function (Category $item) {
                 return [
-                    'id'   => (string)$item->id,
+                    'id'   => (string) $item->id,
                     'name' => $item->name,
                 ];
             }

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

@@ -56,6 +56,9 @@ class CurrencyController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -69,7 +72,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,
@@ -81,9 +84,13 @@ class CurrencyController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesCodeAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
+     * @deprecated
      */
     public function currenciesWithCode(AutocompleteRequest $request): JsonResponse
     {
@@ -94,7 +101,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,

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

@@ -56,6 +56,9 @@ class ObjectGroupController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getObjectGroupsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -69,7 +72,7 @@ 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,
             ];

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

@@ -60,6 +60,9 @@ class PiggyBankController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -75,11 +78,12 @@ class PiggyBankController extends Controller
         foreach ($piggies as $piggy) {
             $currency   = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
             $response[] = [
-                'id'                      => (string)$piggy->id,
+                'id'                      => (string) $piggy->id,
                 'name'                    => $piggy->name,
                 'currency_id'             => $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
+                'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
             ];
         }
@@ -88,6 +92,9 @@ class PiggyBankController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesBalanceAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -103,7 +110,7 @@ class PiggyBankController extends Controller
             $currency      = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
             $currentAmount = $this->piggyRepository->getRepetition($piggy)->currentamount ?? '0';
             $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),
@@ -112,6 +119,7 @@ class PiggyBankController extends Controller
                 'currency_id'             => $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
+                'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
             ];
         }

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

@@ -25,7 +25,7 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
-use FireflyIII\Models\Rule;
+use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
 use Illuminate\Http\JsonResponse;
 
@@ -53,6 +53,9 @@ class RecurrenceController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRecurringAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -60,15 +63,15 @@ class RecurrenceController extends Controller
     public function recurring(AutocompleteRequest $request): JsonResponse
     {
         $data        = $request->getData();
-        $rules    = $this->repository->searchRecurrence($data['query'], $data['limit']);
+        $recurrences = $this->repository->searchRecurrence($data['query'], $data['limit']);
         $response    = [];
 
-        /** @var Rule $rule */
-        foreach ($rules as $rule) {
+        /** @var Recurrence $recurrence */
+        foreach ($recurrences as $recurrence) {
             $response[] = [
-                'id'          => (string)$rule->id,
-                'name'        => $rule->title,
-                'description' => $rule->description,
+                'id'          => (string) $recurrence->id,
+                'name'        => $recurrence->title,
+                'description' => $recurrence->description,
             ];
         }
 

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

@@ -53,6 +53,9 @@ class RuleController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRulesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -66,7 +69,7 @@ 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,
             ];

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

@@ -53,6 +53,9 @@ class RuleGroupController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRuleGroupsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -66,7 +69,7 @@ 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,
             ];

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

@@ -56,6 +56,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTagAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -69,7 +72,7 @@ class TagController extends Controller
         /** @var Tag $tag */
         foreach ($result as $tag) {
             $array[] = [
-                'id'   => (string)$tag->id,
+                'id'   => (string) $tag->id,
                 'name' => $tag->tag,
                 'tag'  => $tag->tag,
             ];

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

@@ -61,6 +61,9 @@ class TransactionController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -77,8 +80,8 @@ 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,
             ];
@@ -88,6 +91,9 @@ class TransactionController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsIDAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -98,7 +104,7 @@ class TransactionController extends Controller
         $result = new Collection;
         if (is_numeric($data['query'])) {
             // search for group, not journal.
-            $firstResult = $this->groupRepository->find((int)$data['query']);
+            $firstResult = $this->groupRepository->find((int) $data['query']);
             if (null !== $firstResult) {
                 // group may contain multiple journals, each a result:
                 foreach ($firstResult->transactionJournals as $journal) {
@@ -116,8 +122,8 @@ class TransactionController extends Controller
         /** @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),
             ];

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

@@ -52,6 +52,9 @@ class TransactionTypeController extends Controller
     }
 
     /**
+     * This endpoint is documented at
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionTypesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -67,7 +70,7 @@ 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,
             ];

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

@@ -27,6 +27,7 @@ namespace FireflyIII\Api\V1\Controllers\Chart;
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
@@ -34,6 +35,9 @@ use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
 use FireflyIII\Support\Http\Api\ApiSupport;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use JsonException;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 
 /**
  * Class AccountController
@@ -69,9 +73,16 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/charts/getChartAccountOverview
+     *
      * @param DateRequest $request
      *
      * @return JsonResponse
+     * @throws FireflyException
+     * @throws JsonException
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
      */
     public function overview(DateRequest $request): JsonResponse
     {
@@ -104,7 +115,7 @@ class AccountController extends Controller
             }
             $currentSet   = [
                 'label'                   => $account->name,
-                'currency_id'             => (string)$currency->id,
+                'currency_id'             => (string) $currency->id,
                 'currency_code'           => $currency->code,
                 'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
@@ -116,11 +127,11 @@ class AccountController extends Controller
             ];
             $currentStart = clone $start;
             $range        = app('steam')->balanceInRange($account, $start, clone $end);
-            $previous     = round((float)array_values($range)[0], 12);
+            $previous     = round((float) array_values($range)[0], 12);
             while ($currentStart <= $end) {
                 $format   = $currentStart->format('Y-m-d');
                 $label    = $currentStart->toAtomString();
-                $balance  = array_key_exists($format, $range) ? round((float)$range[$format], 12) : $previous;
+                $balance  = array_key_exists($format, $range) ? round((float) $range[$format], 12) : $previous;
                 $previous = $balance;
                 $currentStart->addDay();
                 $currentSet['entries'][$label] = $balance;

app/Api/V1/Controllers/Controller.php

@@ -26,6 +26,7 @@ namespace FireflyIII\Api\V1\Controllers;
 
 use Carbon\Carbon;
 use Carbon\Exceptions\InvalidDateException;
+use Carbon\Exceptions\InvalidFormatException;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
@@ -33,6 +34,8 @@ use Illuminate\Routing\Controller as BaseController;
 use League\Fractal\Manager;
 use League\Fractal\Serializer\JsonApiSerializer;
 use Log;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 use Symfony\Component\HttpFoundation\ParameterBag;
 
 /**
@@ -45,8 +48,8 @@ abstract class Controller extends BaseController
     use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
 
     protected const CONTENT_TYPE = 'application/vnd.api+json';
-    protected ParameterBag $parameters;
     protected array        $allowedSort;
+    protected ParameterBag $parameters;
 
     /**
      * Controller constructor.
@@ -70,9 +73,11 @@ abstract class Controller extends BaseController
     }
 
     /**
-     * Method to grab all parameters from the URI.
+     * Method to grab all parameters from the URL.
      *
      * @return ParameterBag
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
      */
     private function getParameters(): ParameterBag
     {
@@ -91,9 +96,9 @@ abstract class Controller extends BaseController
             if (null !== $date) {
                 try {
                     $obj = Carbon::parse($date);
-                } catch (InvalidDateException $e) {
+                } catch (InvalidDateException | InvalidFormatException $e) {
                     // don't care
-                    Log::error(sprintf('Invalid date exception in API controller: %s', $e->getMessage()));
+                    Log::warning(sprintf('Ignored invalid date "%s" in API controller parameter check: %s', $date, $e->getMessage()));
                 }
             }
             $bag->set($field, $obj);
@@ -143,7 +148,7 @@ abstract class Controller extends BaseController
 
 
     /**
-     * Method to help build URI's.
+     * Method to help build URL's.
      *
      * @return string
      */

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

@@ -1,4 +1,25 @@
 <?php
+
+/*
+ * AccountController.php
+ * 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/>.
+ */
+
 declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Data\Bulk;
@@ -12,11 +33,16 @@ use Illuminate\Http\JsonResponse;
 
 /**
  * Class AccountController
+ *
+ * @deprecated
  */
 class AccountController extends Controller
 {
     private AccountRepositoryInterface $repository;
 
+    /**
+     *
+     */
     public function __construct()
     {
         parent::__construct();
@@ -31,9 +57,12 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is deprecated and not documented.
+     *
      * @param MoveTransactionsRequest $request
      *
      * @return JsonResponse
+     * @deprecated
      */
     public function moveTransactions(MoveTransactionsRequest $request): JsonResponse
     {

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

@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * TransactionController.php
+ * 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/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Data\Bulk;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Data\Bulk\TransactionRequest;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Services\Internal\Destroy\AccountDestroyService;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class TransactionController
+ *
+ * Endpoint to update transactions by submitting
+ * (optional) a "where" clause and an "update"
+ * clause.
+ *
+ * Because this is a security nightmare waiting to happen validation
+ * is pretty strict.
+ */
+class TransactionController extends Controller
+{
+    private AccountRepositoryInterface $repository;
+
+    /**
+     *
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(AccountRepositoryInterface::class);
+                $this->repository->setUser(auth()->user());
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * This endpoint is documented at:
+     *
+     * @param TransactionRequest $request
+     *
+     * @return JsonResponse
+     */
+    public function update(TransactionRequest $request): JsonResponse
+    {
+        $query  = $request->getAll();
+        $params = $query['query'];
+
+        // 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']);
+
+            /** @var AccountDestroyService $service */
+            $service = app(AccountDestroyService::class);
+            $service->moveTransactions($original, $destination);
+        }
+
+        return response()->json([], 204);
+    }
+
+    /**
+     * @param array $params
+     *
+     * @return bool
+     */
+    private function updatesTransactionAccount(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

@@ -52,6 +52,9 @@ use Illuminate\Http\JsonResponse;
 class DestroyController extends Controller
 {
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/destroyData
+     *
      * @param DestroyRequest $request
      *
      * @return JsonResponse

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

@@ -1,7 +1,7 @@
 <?php
-declare(strict_types=1);
+
 /*
- * AccountController.php
+ * ExportController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,13 +20,15 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+declare(strict_types=1);
+
 namespace FireflyIII\Api\V1\Controllers\Data\Export;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Support\Export\ExportDataGenerator;
 use Illuminate\Http\Response as LaravelResponse;
-use League\Csv\CannotInsertRecord;
 
 /**
  * Class ExportController
@@ -52,10 +54,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportAccounts
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function accounts(ExportRequest $request): LaravelResponse
     {
@@ -69,9 +74,7 @@ class ExportController extends Controller
      * @param string $key
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
-     * @throws \FireflyIII\Exceptions\FireflyException
-     * @throws \League\Csv\Exception
+     * @throws FireflyException
      */
     private function returnExport(string $key): LaravelResponse
     {
@@ -90,16 +93,19 @@ class ExportController extends Controller
             ->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($data[$key]));
 
         return $response;
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportBills
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function bills(ExportRequest $request): LaravelResponse
     {
@@ -109,10 +115,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportBudgets
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function budgets(ExportRequest $request): LaravelResponse
     {
@@ -122,10 +131,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportCategories
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function categories(ExportRequest $request): LaravelResponse
     {
@@ -135,10 +147,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportPiggies
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function piggyBanks(ExportRequest $request): LaravelResponse
     {
@@ -148,10 +163,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportRecurring
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function recurring(ExportRequest $request): LaravelResponse
     {
@@ -161,10 +179,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportRules
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function rules(ExportRequest $request): LaravelResponse
     {
@@ -174,10 +195,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportTags
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function tags(ExportRequest $request): LaravelResponse
     {
@@ -187,10 +211,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportTransactions
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function transactions(ExportRequest $request): LaravelResponse
     {

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

@@ -37,7 +37,7 @@ use Illuminate\Http\JsonResponse;
  * Class AccountController
  *
  * Shows expense information grouped or limited by date.
- * Ie. all expenses grouped by account + currency.
+ * I.e. all expenses grouped by account + currency.
  */
 class AccountController extends Controller
 {
@@ -73,6 +73,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseAsset
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -88,11 +91,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'],
-                'currency_id'      => (string)$expense['currency_id'],
+                'difference_float' => (float) $expense['sum'],
+                'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }
@@ -101,6 +104,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseExpense
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -117,11 +123,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'],
-                '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/Expense/BillController.php

@@ -1,7 +1,7 @@
 <?php
-declare(strict_types=1);
+
 /*
- * PeriodController.php
+ * BillController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,6 +20,8 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+declare(strict_types=1);
+
 namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
@@ -54,6 +56,9 @@ class BillController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBill
+     *
      * Expenses per bill, possibly filtered by bill and account.
      *
      * @param GenericRequest $request
@@ -80,33 +85,33 @@ class BillController extends Controller
 
         $genericSet = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $billId            = (int)$journal['bill_id'];
-            $currencyId        = (int)$journal['currency_id'];
-            $foreignCurrencyId = (int)$journal['foreign_currency_id'];
+            $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);
 
             if (0 !== $currencyId) {
                 $response[$key]                     = $response[$key] ?? [
-                        'id'               => (string)$billId,
+                        'id'               => (string) $billId,
                         'name'             => $journal['bill_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'];
+                $response[$key]['difference_float'] = (float) $response[$key]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignKey]                     = $response[$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'];
+                $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
             }
         }
 
@@ -114,6 +119,9 @@ class BillController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBill
+     *
      * Expenses for no bill filtered by account.
      *
      * @param GenericRequest $request
@@ -135,28 +143,28 @@ class BillController extends Controller
         $genericSet = $collector->getExtractedJournals();
 
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 

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

@@ -65,6 +65,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBudget
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -85,11 +88,11 @@ class BudgetController extends Controller
             /** @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'],
-                    'currency_id'      => (string)$expense['currency_id'],
+                    'difference_float' => (float) $expense['sum'],
+                    'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
             }
@@ -99,6 +102,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBudget
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -114,8 +120,8 @@ class BudgetController extends Controller
         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/Expense/CategoryController.php

@@ -66,6 +66,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -86,11 +89,11 @@ class CategoryController extends Controller
             /** @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'],
                 ];
             }
@@ -100,6 +103,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -115,8 +121,8 @@ class CategoryController extends Controller
         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/Expense/PeriodController.php

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -52,28 +55,28 @@ class PeriodController extends Controller
         $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
         $genericSet = $collector->getExtractedJournals();
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 

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

@@ -1,7 +1,7 @@
 <?php
-declare(strict_types=1);
+
 /*
- * PeriodController.php
+ * TagController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,6 +20,8 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+declare(strict_types=1);
+
 namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
@@ -53,6 +55,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoTag
+     *
      * Expenses for no tag filtered by account.
      *
      * @param GenericRequest $request
@@ -74,28 +79,28 @@ class TagController extends Controller
         $genericSet = $collector->getExtractedJournals();
 
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 
@@ -103,6 +108,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTag
+     *
      * Expenses per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request
@@ -129,8 +137,8 @@ class TagController extends Controller
         $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) {
@@ -141,15 +149,15 @@ class TagController extends Controller
                 // on currency ID
                 if (0 !== $currencyId) {
                     $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string)$tagId,
+                            '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'];
+                    $response[$key]['difference_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
@@ -157,11 +165,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'];
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
                 }
             }
         }

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

@@ -38,7 +38,6 @@ use Illuminate\Http\JsonResponse;
  *
  * Shows income information grouped or limited by date.
  * Ie. all income grouped by account + currency.
- * See reference nr. 75
  */
 class AccountController extends Controller
 {
@@ -74,8 +73,8 @@ class AccountController extends Controller
     }
 
     /**
-     * See reference nr. 76
-     * See reference nr. 77
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeAsset
      *
      * @param GenericRequest $request
      *
@@ -91,11 +90,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'],
-                'currency_id'      => (string)$entry['currency_id'],
+                'difference_float' => (float) $entry['sum'],
+                'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
         }
@@ -104,7 +103,8 @@ class AccountController extends Controller
     }
 
     /**
-     * See reference nr. 78
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeRevenue
      *
      * @param GenericRequest $request
      *
@@ -122,11 +122,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'],
-                'currency_id'      => (string)$entry['currency_id'],
+                'difference_float' => (float) $entry['sum'],
+                'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
         }

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

@@ -35,7 +35,6 @@ use Illuminate\Support\Collection;
 
 /**
  * Class CategoryController
-* See reference nr. 79
  */
 class CategoryController extends Controller
 {
@@ -67,6 +66,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -87,11 +89,11 @@ class CategoryController extends Controller
             /** @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'],
                 ];
             }
@@ -101,6 +103,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -116,8 +121,8 @@ class CategoryController extends Controller
         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/Income/PeriodController.php

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -52,30 +55,30 @@ class PeriodController extends Controller
         $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
         $genericSet = $collector->getExtractedJournals();
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 

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

@@ -1,7 +1,7 @@
 <?php
-declare(strict_types=1);
+
 /*
- * PeriodController.php
+ * TagController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,6 +20,8 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+declare(strict_types=1);
+
 namespace FireflyIII\Api\V1\Controllers\Insight\Income;
 
 use FireflyIII\Api\V1\Controllers\Controller;
@@ -54,6 +56,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTag
+     *
      * Expenses for no tag filtered by account.
      *
      * @param GenericRequest $request
@@ -75,30 +80,30 @@ class TagController extends Controller
         $genericSet = $collector->getExtractedJournals();
 
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 
@@ -106,6 +111,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoTag
+     *
      * Expenses per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request
@@ -132,8 +140,8 @@ class TagController extends Controller
         $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) {
@@ -144,15 +152,15 @@ class TagController extends Controller
                 // on currency ID
                 if (0 !== $currencyId) {
                     $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string)$tagId,
+                            '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_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
@@ -160,13 +168,13 @@ 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'])
                     );
-                    $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference'];
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
                 }
             }
         }

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

@@ -58,8 +58,8 @@ class AccountController extends Controller
     }
 
     /**
-* See reference nr. 80
-* See reference nr. 81
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransfers
      *
      * @param GenericRequest $request
      *
@@ -71,6 +71,7 @@ class AccountController extends Controller
         $end           = $request->getEnd();
         $assetAccounts = $request->getAssetAccounts();
         $transfers     = $this->opsRepository->sumTransfers($start, $end, $assetAccounts);
+
         return response()->json($transfers);
     }
 }

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

@@ -65,6 +65,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -85,11 +88,11 @@ class CategoryController extends Controller
             /** @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'],
                 ];
             }
@@ -99,6 +102,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -114,8 +120,8 @@ class CategoryController extends Controller
         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

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -52,30 +55,30 @@ class PeriodController extends Controller
         $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
         $genericSet = $collector->getExtractedJournals();
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 

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

@@ -39,7 +39,6 @@ class TagController extends Controller
 
     /**
      * TagController constructor.
-* See reference nr. 82
      */
     public function __construct()
     {
@@ -56,7 +55,8 @@ class TagController extends Controller
     }
 
     /**
-     * Expenses for no tag filtered by account.
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoTag
      *
      * @param GenericRequest $request
      *
@@ -77,30 +77,30 @@ class TagController extends Controller
         $genericSet = $collector->getExtractedJournals();
 
         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'];
 
             if (0 !== $currencyId) {
                 $response[$currencyId]                     = $response[$currencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$currencyId,
+                        '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'];
+                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
             }
             if (0 !== $foreignCurrencyId) {
                 $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
                         'difference'       => '0',
                         'difference_float' => 0,
-                        'currency_id'      => (string)$foreignCurrencyId,
+                        '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'];
+                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
             }
         }
 
@@ -108,6 +108,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferTag
+     *
      * Transfers per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request
@@ -134,8 +137,8 @@ class TagController extends Controller
         $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) {
@@ -146,15 +149,15 @@ class TagController extends Controller
                 // on currency ID
                 if (0 !== $currencyId) {
                     $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string)$tagId,
+                            '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_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
@@ -162,13 +165,13 @@ 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'])
                     );
-                    $response[$foreignKey]['difference_float'] = (float)$response[$foreignKey]['difference'];
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
                 }
             }
         }

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

@@ -56,6 +56,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/deleteAccount
+     *
      * Remove the specified resource from storage.
      *
      * @param Account $account

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Account;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
@@ -69,16 +70,19 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/listAttachmentByAccount
+     *
      * @param Account $account
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
      * @codeCoverageIgnore
+     * @throws FireflyException
      */
     public function attachments(Account $account): JsonResponse
     {
         $manager    = $this->getManager();
-        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $collection = $this->repository->getAttachments($account);
 
         $count       = $collection->count();
@@ -99,12 +103,13 @@ class ListController extends Controller
     }
 
     /**
-     * List all piggies.
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/listPiggyBankByAccount
      *
      * @param Account $account
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBanks(Account $account): JsonResponse
@@ -113,7 +118,7 @@ class ListController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of budgets. Count it and split it.
         $collection = $this->repository->getPiggyBanks($account);
@@ -136,6 +141,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/listTransactionByAccount
+     *
      * Show all transaction groups related to the account.
      *
      * @codeCoverageIgnore
@@ -144,11 +152,11 @@ class ListController extends Controller
      * @param Account $account
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      */
     public function transactions(Request $request, Account $account): JsonResponse
     {
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $type     = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Account;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
@@ -65,12 +66,15 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/listAccount
+     *
      * Display a listing of the resource.
      *
      * @param Request $request
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
@@ -81,7 +85,7 @@ class ShowController extends Controller
 
         // types to get, page size:
         $types    = $this->mapAccountTypes($this->parameters->get('type'));
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of accounts. Count it and split it.
         $this->repository->resetAccountOrder();
@@ -108,6 +112,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/getAccount
+     *
      * Show single instance.
      *
      * @param Account $account

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

@@ -58,6 +58,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/storeAccount
+     *
      * Store a new instance.
      *
      * @param StoreRequest $request

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

@@ -61,6 +61,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/updateAccount
+     *
      * Update account.
      *
      * @param UpdateRequest $request

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

@@ -59,6 +59,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/deleteAttachment
+     *
      * Remove the specified resource from storage.
      *
      * @codeCoverageIgnore

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

@@ -66,6 +66,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/downloadAttachment
+     *
      * Download an attachment.
      *
      * @param Attachment $attachment
@@ -100,7 +103,7 @@ class ShowController extends Controller
                 ->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;
         }
@@ -108,6 +111,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/listAttachment
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
@@ -119,7 +125,7 @@ class ShowController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of attachments. Count it and split it.
         $collection  = $this->repository->get();
@@ -141,6 +147,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/getAttachment
+     *
      * Display the specified resource.
      *
      * @param Attachment $attachment

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

@@ -66,6 +66,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/uploadAttachment
+     *
      * Store a newly created resource in storage.
      *
      * @param StoreRequest $request

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

@@ -62,6 +62,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/attachments/updateAttachment
+     *
      * Update the specified resource in storage.
      *
      * @param UpdateRequest $request

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

@@ -57,6 +57,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/listAvailableBudget
+     *
      * Remove the specified resource from storage.
      *
      * @param AvailableBudget $availableBudget

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\AvailableBudget;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
 use FireflyIII\Transformers\AvailableBudgetTransformer;
@@ -62,10 +63,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -73,7 +77,7 @@ class ShowController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         $start = $this->parameters->get('start');
         $end   = $this->parameters->get('end');
@@ -98,6 +102,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
+     *
      * Display the specified resource.
      *
      * @param AvailableBudget $availableBudget

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

@@ -25,11 +25,13 @@ namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Factory\TransactionCurrencyFactory;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
 use FireflyIII\Transformers\AvailableBudgetTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use JsonException;
 use League\Fractal\Resource\Item;
 
 /**
@@ -60,11 +62,16 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/storeAvailableBudget
+     *
      * Store a newly created resource in storage.
      *
      * @param Request $request
      *
      * @return JsonResponse
+     * @throws FireflyException
+     * @throws JsonException
      */
     public function store(Request $request): JsonResponse
     {

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

@@ -61,6 +61,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/updateAvailableBudget
+     *
      * Update the specified resource in storage.
      *
      * @param Request         $request

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

@@ -26,7 +26,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -55,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/deleteBill
+     *
      * Remove the specified resource from storage.
      *
      * @param Bill $bill

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
@@ -66,18 +67,21 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listAttachmentByBill
+     *
      * Display a listing of the resource.
      *
      * @param Bill $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Bill $bill): JsonResponse
     {
         $manager    = $this->getManager();
-        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $collection = $this->repository->getAttachments($bill);
 
         $count       = $collection->count();
@@ -98,12 +102,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listRuleByBill
+     *
      * List all of them.
      *
      * @param Bill $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function rules(Bill $bill): JsonResponse
@@ -111,7 +118,7 @@ class ListController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of budgets. Count it and split it.
         $collection = $this->repository->getRulesForBill($bill);
@@ -133,6 +140,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listTransactionByBill
+     *
      * Show all transactions.
      *
      * @param Request $request
@@ -140,12 +150,12 @@ class ListController extends Controller
      * @param Bill    $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Bill $bill): JsonResponse
     {
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $type     = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 

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

@@ -24,10 +24,10 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -60,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listBill
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -71,7 +74,7 @@ class ShowController extends Controller
         $this->repository->correctOrder();
         $bills     = $this->repository->getBills();
         $manager   = $this->getManager();
-        $pageSize  = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize  = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $count     = $bills->count();
         $bills     = $bills->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
         $paginator = new LengthAwarePaginator($bills, $count, $pageSize, $this->parameters->get('page'));
@@ -87,6 +90,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/getBill
+     *
      * Show the specified bill.
      *
      * @param Bill $bill

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

@@ -29,7 +29,6 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -61,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/storeBill
+     *
      * Store a bill.
      *
      * @param StoreRequest $request

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

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Bill\UpdateRequest;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/updateBill
+     *
      * Update a bill.
      *
      * @param UpdateRequest $request

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

@@ -54,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/deleteBudget
+     *
      * Remove the specified resource from storage.
      *
      * @param Budget $budget

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Budget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
@@ -70,16 +71,19 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listAttachmentByBudget
+     *
      * @param Budget $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Budget $budget): JsonResponse
     {
         $manager    = $this->getManager();
-        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $collection = $this->repository->getAttachments($budget);
 
         $count       = $collection->count();
@@ -100,18 +104,21 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimitByBudget
+     *
      * Display a listing of the resource.
      *
      * @param Budget $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function budgetLimits(Budget $budget): JsonResponse
     {
         $manager  = $this->getManager();
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $this->parameters->set('budget_id', $budget->id);
         $collection   = $this->blRepository->getBudgetLimits($budget, $this->parameters->get('start'), $this->parameters->get('end'));
         $count        = $collection->count();
@@ -129,6 +136,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listTransactionByBudget
+     *
      * Show all transactions.
      *
      * @param Request $request
@@ -136,12 +146,12 @@ class ListController extends Controller
      * @param Budget  $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Budget $budget): JsonResponse
     {
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // user can overrule page size with limit parameter.
         $limit = $this->parameters->get('limit');
@@ -191,4 +201,68 @@ class ListController extends Controller
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
+    /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listTransactionWithoutBudget
+     *
+     * Show all transactions.
+     *
+     * @param Request $request
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     * @codeCoverageIgnore
+     */
+    public function withoutBudget(Request $request): JsonResponse
+    {
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+
+        // user can overrule page size with limit parameter.
+        $limit = $this->parameters->get('limit');
+        if (null !== $limit && $limit > 0) {
+            $pageSize = $limit;
+        }
+
+        $type = $request->get('type') ?? 'default';
+        $this->parameters->set('type', $type);
+
+        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager = $this->getManager();
+
+        /** @var User $admin */
+        $admin = auth()->user();
+
+        // use new group collector:
+        /** @var GroupCollectorInterface $collector */
+        $collector = app(GroupCollectorInterface::class);
+        $collector
+            ->setUser($admin)
+            // filter on budget.
+            ->withoutBudget()
+            // all info needed for the API:
+            ->withAPIInformation()
+            // set page size:
+            ->setLimit($pageSize)
+            // set page to retrieve
+            ->setPage($this->parameters->get('page'))
+            // set types of transactions to return.
+            ->setTypes($types);
+
+        if (null !== $this->parameters->get('start') && null !== $this->parameters->get('end')) {
+            $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
+        }
+
+        $paginator = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.budgets.without-budget') . $this->buildParams());
+        $transactions = $paginator->getCollection();
+
+        /** @var TransactionGroupTransformer $transformer */
+        $transformer = app(TransactionGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+        $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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Budget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
@@ -63,10 +64,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudget
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -74,7 +78,7 @@ class ShowController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of budgets. Count it and split it.
         $collection = $this->repository->getBudgets();

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

@@ -57,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/storeBudget
+     *
      * Store a budget.
      *
      * @param StoreRequest $request

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

@@ -57,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/updateBudget
+     *
      * Update a budget.
      *
      * @param UpdateRequest $request

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

@@ -59,6 +59,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/deleteBudgetLimit
+     *
      * Remove the specified resource from storage.
      *
      * @param Budget      $budget

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\BudgetLimit;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
@@ -66,6 +67,8 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listTransactionByBudgetLimit
      * Show all transactions.
      *
      * @param Request     $request
@@ -73,12 +76,12 @@ class ListController extends Controller
      * @param BudgetLimit $budgetLimit
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse
     {
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $type     = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 

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

@@ -70,7 +70,10 @@ class ShowController extends Controller
     }
 
     /**
-     * Display a listing of the budget limits for this budget..
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimitByBudget
+     *
+     * Display a listing of the budget limits for this budget.
      *
      * @param Request $request
      * @param Budget  $budget
@@ -83,7 +86,7 @@ class ShowController extends Controller
     {
         $manager = $this->getManager();
         $manager->parseIncludes('budget');
-        $pageSize     = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize     = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $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);
@@ -101,7 +104,10 @@ class ShowController extends Controller
     }
 
     /**
-     * Display a listing of the budget limits for this budget..
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimit
+     *
+     * Display a listing of the budget limits for this budget.
      *
      * @param DateRequest $request
      *
@@ -113,7 +119,7 @@ class ShowController extends Controller
     {
         $manager = $this->getManager();
         $manager->parseIncludes('budget');
-        $pageSize     = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize     = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $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);
@@ -131,6 +137,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/getBudgetLimit
+     *
      * @param Request     $request
      * @param Budget      $budget
      * @param BudgetLimit $budgetLimit
@@ -140,7 +149,7 @@ class ShowController extends Controller
      */
     public function show(Request $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse
     {
-        if ((int)$budget->id !== (int)$budgetLimit->budget_id) {
+        if ((int) $budget->id !== (int) $budgetLimit->budget_id) {
             throw new FireflyException('20028: The budget limit does not belong to the budget.');
         }
         // continue!

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

@@ -25,7 +25,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\BudgetLimit;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\BudgetLimit\StoreRequest;
-use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Transformers\BudgetLimitTransformer;
@@ -61,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/storeBudgetLimit
+     *
      * Store a newly created resource in storage.
      *
      * @param StoreRequest $request

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

@@ -42,6 +42,9 @@ class UpdateController extends Controller
     private BudgetLimitRepositoryInterface $blRepository;
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/updateBudgetLimit
+     *
      * BudgetLimitController constructor.
      *
      * @codeCoverageIgnore
@@ -74,7 +77,7 @@ class UpdateController extends Controller
     public function update(UpdateRequest $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse
     {
 
-        if ((int)$budget->id !== (int)$budgetLimit->budget_id) {
+        if ((int) $budget->id !== (int) $budgetLimit->budget_id) {
             throw new FireflyException('20028: The budget limit does not belong to the budget.');
         }
         $data              = $request->getAll();

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

@@ -26,7 +26,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\Category;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -55,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/deleteCategory
+     *
      * Remove the specified resource from storage.
      *
      * @param Category $category

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Category;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
@@ -65,16 +66,19 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listAttachmentByCategory
+     *
      * @param Category $category
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Category $category): JsonResponse
     {
         $manager    = $this->getManager();
-        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $collection = $this->repository->getAttachments($category);
 
         $count       = $collection->count();
@@ -95,6 +99,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listTransactionByCategory
+     *
      * Show all transactions.
      *
      * @param Request  $request
@@ -102,12 +109,12 @@ class ListController extends Controller
      * @param Category $category
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Category $category): JsonResponse
     {
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $type     = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
 

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

@@ -24,10 +24,10 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Category;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -60,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listCategory
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -71,7 +74,7 @@ class ShowController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of budgets. Count it and split it.
         $collection = $this->repository->getCategories();
@@ -92,6 +95,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/getCategory
+     *
      * Show the category.
      *
      * @param Category $category

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

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Category\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/storeCategory
+     *
      * Store new category.
      *
      * @param StoreRequest $request

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

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Category\UpdateRequest;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/updateCategory
+     *
      * Update the category.
      *
      * @param UpdateRequest $request

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

@@ -57,6 +57,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/deleteObjectGroup
+     *
      * Remove the specified resource from storage.
      *
      * @param ObjectGroup $objectGroup

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\ObjectGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\ObjectGroup;
 use FireflyIII\Repositories\ObjectGroup\ObjectGroupRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
@@ -62,19 +63,22 @@ class ListController extends Controller
     }
 
     /**
-     * List all bills
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listBillByObjectGroup
+     *
+     * List all bills in this object group
      *
      * @param ObjectGroup $objectGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function bills(ObjectGroup $objectGroup): JsonResponse
     {
         $manager = $this->getManager();
 
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         // get list of piggy banks. Count it and split it.
         $collection = $this->repository->getBills($objectGroup);
         $count      = $collection->count();
@@ -95,12 +99,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listPiggyBankByObjectGroup
+     *
      * List all piggies under the object group.
      *
      * @param ObjectGroup $objectGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBanks(ObjectGroup $objectGroup): JsonResponse
@@ -109,7 +116,7 @@ class ListController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of piggy banks. Count it and split it.
         $collection = $this->repository->getPiggyBanks($objectGroup);

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\ObjectGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\ObjectGroup;
 use FireflyIII\Repositories\ObjectGroup\ObjectGroupRepositoryInterface;
 use FireflyIII\Transformers\ObjectGroupTransformer;
@@ -63,12 +64,15 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listObjectGroups
+     *
      * Display a listing of the resource.
      *
      * @param Request $request
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
@@ -76,7 +80,7 @@ class ShowController extends Controller
         $manager = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         $this->repository->resetOrder();
         $collection   = $this->repository->get();
@@ -98,6 +102,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/getObjectGroup
+     *
      * Show single instance.
      *
      * @param ObjectGroup $objectGroup

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

@@ -60,6 +60,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/updateObjectGroup
+     *
      * @param UpdateRequest $request
      * @param ObjectGroup   $objectGroup
      *

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

@@ -54,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/deletePiggyBank
+     *
      * Delete the resource.
      *
      * @param PiggyBank $piggyBank

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\PiggyBank;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\PiggyBank;
 use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
 use FireflyIII\Transformers\AttachmentTransformer;
@@ -59,16 +60,19 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listAttachmentByPiggyBank
+     *
      * @param PiggyBank $piggyBank
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(PiggyBank $piggyBank): JsonResponse
     {
         $manager    = $this->getManager();
-        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $collection = $this->repository->getAttachments($piggyBank);
 
         $count       = $collection->count();
@@ -89,18 +93,21 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listEventByPiggyBank
+     *
      * List single resource.
      *
      * @param PiggyBank $piggyBank
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBankEvents(PiggyBank $piggyBank): JsonResponse
     {
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
         $manager  = $this->getManager();
 
         $collection = $this->repository->getEvents($piggyBank);

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

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\PiggyBank;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\PiggyBank;
 use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
 use FireflyIII\Transformers\PiggyBankTransformer;
@@ -59,17 +60,20 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listPiggyBank
+     *
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
     {
         $manager = $this->getManager();
         // types to get, page size:
-        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of budgets. Count it and split it.
         $collection = $this->repository->getPiggyBanks();
@@ -92,6 +96,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/getPiggyBank
+     *
      * List single resource.
      *
      * @param PiggyBank $piggyBank

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

@@ -57,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/storePiggyBank
+     *
      * Store new object.
      *
      * @param StoreRequest $request

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

@@ -57,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/updatePiggyBank
+     *
      * Update piggy bank.
      *
      * @param UpdateRequest $request