Update budget box and rebuild frontend.

app/Api/V2/Controllers/Model/Budget/ShowController.php

@@ -0,0 +1,85 @@
+<?php
+/*
+ * ShowController.php
+ * Copyright (c) 2023 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace FireflyIII\Api\V2\Controllers\Model\Budget;
+
+use FireflyIII\Api\V2\Controllers\Controller;
+use FireflyIII\Api\V2\Request\Generic\DateRequest;
+use FireflyIII\Models\Budget;
+use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Support\Http\Api\ConvertsExchangeRates;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class ShowController
+ */
+class ShowController extends Controller
+{
+    use ConvertsExchangeRates;
+
+    private BudgetRepositoryInterface $repository;
+
+    /**
+     *
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(BudgetRepositoryInterface::class);
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * This endpoint is documented at:
+     * TODO add URL
+     *
+     * @param  DateRequest  $request
+     * @return JsonResponse
+     */
+    public function budgeted(DateRequest $request, Budget $budget): JsonResponse
+    {
+        $data      = $request->getAll();
+        $result    = $this->repository->budgetedInPeriodForBudget($budget, $data['start'], $data['end']);
+        $converted = $this->cerSum(array_values($result));
+
+        return response()->json($converted);
+    }
+
+    /**
+     * This endpoint is documented at:
+     * TODO add URL
+     *
+     * @param  DateRequest  $request
+     * @return JsonResponse
+     */
+    public function spent(DateRequest $request, Budget $budget): JsonResponse
+    {
+        $data      = $request->getAll();
+        $result    = $this->repository->spentInPeriodForBudget($budget, $data['start'], $data['end']);
+        $converted = $this->cerSum(array_values($result));
+
+        return response()->json($converted);
+    }
+}

app/Repositories/Budget/BudgetRepository.php

@@ -25,7 +25,6 @@ namespace FireflyIII\Repositories\Budget;
 
 use Carbon\Carbon;
 use DB;
-use Exception;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Account;
@@ -752,4 +751,122 @@ class BudgetRepository implements BudgetRepositoryInterface
     {
         return (int)$this->user->budgets()->max('order');
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function spentInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array
+    {
+        Log::debug(sprintf('Now in %s', __METHOD__));
+        $start->startOfDay();
+        $end->endOfDay();
+
+        // exclude specific liabilities
+        $repository = app(AccountRepositoryInterface::class);
+        $repository->setUser($this->user);
+        $subset    = $repository->getAccountsByType(config('firefly.valid_liabilities'));
+        $selection = new Collection();
+        /** @var Account $account */
+        foreach ($subset as $account) {
+            if ('credit' === $repository->getMetaValue($account, 'liability_direction')) {
+                $selection->push($account);
+            }
+        }
+
+        // start collecting:
+        /** @var GroupCollectorInterface $collector */
+        $collector = app(GroupCollectorInterface::class);
+        $collector->setUser($this->user)
+                  ->setRange($start, $end)
+                  ->excludeDestinationAccounts($selection)
+                  ->setTypes([TransactionType::WITHDRAWAL])
+                  ->setBudget($budget);
+
+        $journals = $collector->getExtractedJournals();
+        $array    = [];
+
+        foreach ($journals as $journal) {
+            $currencyId                = (int)$journal['currency_id'];
+            $array[$currencyId]        = $array[$currencyId] ?? [
+                'id'             => (string)$currencyId,
+                'name'           => $journal['currency_name'],
+                'symbol'         => $journal['currency_symbol'],
+                'code'           => $journal['currency_code'],
+                'decimal_places' => $journal['currency_decimal_places'],
+                'sum'            => '0',
+            ];
+            $array[$currencyId]['sum'] = bcadd($array[$currencyId]['sum'], app('steam')->negative($journal['amount']));
+
+            // also do foreign amount:
+            $foreignId = (int)$journal['foreign_currency_id'];
+            if (0 !== $foreignId) {
+                $array[$foreignId]        = $array[$foreignId] ?? [
+                    'id'             => (string)$foreignId,
+                    'name'           => $journal['foreign_currency_name'],
+                    'symbol'         => $journal['foreign_currency_symbol'],
+                    'code'           => $journal['foreign_currency_code'],
+                    'decimal_places' => $journal['foreign_currency_decimal_places'],
+                    'sum'            => '0',
+                ];
+                $array[$foreignId]['sum'] = bcadd($array[$foreignId]['sum'], app('steam')->negative($journal['foreign_amount']));
+            }
+        }
+
+        return $array;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function budgetedInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array
+    {
+        Log::debug(sprintf('Now in budgetedInPeriod(#%d, "%s", "%s")', $budget->id, $start->format('Y-m-d'), $end->format('Y-m-d')));
+        $return = [];
+        /** @var BudgetLimitRepository $limitRepository */
+        $limitRepository = app(BudgetLimitRepository::class);
+        $limitRepository->setUser($this->user);
+
+        Log::debug(sprintf('Budget #%d: "%s"', $budget->id, $budget->name));
+        $limits = $limitRepository->getBudgetLimits($budget, $start, $end);
+        /** @var BudgetLimit $limit */
+        foreach ($limits as $limit) {
+            Log::debug(sprintf('Budget limit #%d', $limit->id));
+            $currency              = $limit->transactionCurrency;
+            $return[$currency->id] = $return[$currency->id] ?? [
+                'id'             => (string)$currency->id,
+                'name'           => $currency->name,
+                'symbol'         => $currency->symbol,
+                'code'           => $currency->code,
+                'decimal_places' => $currency->decimal_places,
+                'sum'            => '0',
+            ];
+            // same period
+            if ($limit->start_date->isSameDay($start) && $limit->end_date->isSameDay($end)) {
+                $return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], (string)$limit->amount);
+                Log::debug(sprintf('Add full amount [1]: %s', $limit->amount));
+                continue;
+            }
+            // limit is inside of date range
+            if ($start->lte($limit->start_date) && $end->gte($limit->end_date)) {
+                $return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], (string)$limit->amount);
+                Log::debug(sprintf('Add full amount [2]: %s', $limit->amount));
+                continue;
+            }
+            $total                        = $limit->start_date->diffInDays($limit->end_date) + 1; // include the day itself.
+            $days                         = $this->daysInOverlap($limit, $start, $end);
+            $amount                       = bcmul(bcdiv((string)$limit->amount, (string)$total), (string)$days);
+            $return[$currency->id]['sum'] = bcadd($return[$currency->id]['sum'], $amount);
+            Log::debug(
+                sprintf(
+                    'Amount per day: %s (%s over %d days). Total amount for %d days: %s',
+                    bcdiv((string)$limit->amount, (string)$total),
+                    $limit->amount,
+                    $total,
+                    $days,
+                    $amount
+                )
+            );
+        }
+        return $return;
+    }
 }

app/Repositories/Budget/BudgetRepositoryInterface.php

@@ -60,6 +60,16 @@ interface BudgetRepositoryInterface
      */
     public function budgetedInPeriod(Carbon $start, Carbon $end): array;
 
+    /**
+     * Returns the amount that is budgeted in a period.
+     *
+     * @param Budget $budget
+     * @param  Carbon  $start
+     * @param  Carbon  $end
+     * @return array
+     */
+    public function budgetedInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array;
+
     /**
      * @return bool
      */
@@ -195,6 +205,16 @@ interface BudgetRepositoryInterface
      */
     public function spentInPeriod(Carbon $start, Carbon $end): array;
 
+    /**
+     * Used in the v2 API to calculate the amount of money spent in a single budget..
+     *
+     * @param  Carbon  $start
+     * @param  Carbon  $end
+     *
+     * @return array
+     */
+    public function spentInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array;
+
     /**
      * @param  array  $data
      *