df38bde: Billing - price per period - settings for rounding

Mapiiik · May 3, 2024 · c12c562 · c12c562
1 parent a93c229
commit c12c562
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 12 deletions.
diff --git a/config/.env.example b/config/.env.example
@@ -25,6 +25,9 @@ export STRIP_PHONE_PREFIX_FOR_SUMMARY_TEXT="false"
 #export OFFSET_OF_FIRST_AVAILABLE_IP_ADDRESS=1
 #export MINIMUM_NUMBER_OF_DAYS_SINCE_LAST_USE_FOR_AVAILABLE_IP_ADDRESSES=365
 
+#export BILLING_PERIOD_ROUNDING_PLACES=2
+#export BILLING_PERIOD_ROUNDING_TYPE="HALF_UP" # (HALF_UP/CEIL/FLOOR)
+
 #export REPORT_EMAILS="space separated"
 
 #export APP_DEFAULT_CURRENCY="CZK"

diff --git a/src/Model/Entity/Billing.php b/src/Model/Entity/Billing.php
@@ -202,6 +202,26 @@ public static function calcVatBaseFromTotal(Decimal $total, float $vat_rate): De
         );
     }
 
+    /**
+     * Round for the billing period.
+     *
+     * @param \PhpCollective\DecimalObject\Decimal $price Unrounded price.
+     * @return \PhpCollective\DecimalObject\Decimal Rounded price.
+     * @throws \Exception When BILLING_PERIOD_ROUNDING_TYPE has an invalid value.
+     */
+    public static function roundForBillingPeriod(Decimal $price): Decimal
+    {
+        return $price->round(
+            (int)env('BILLING_PERIOD_ROUNDING_PLACES', '2'),
+            match (env('BILLING_PERIOD_ROUNDING_TYPE', 'HALF_UP')) {
+                'HALF_UP' => Decimal::ROUND_HALF_UP,
+                'CEIL' => Decimal::ROUND_CEIL,
+                'FLOOR' => Decimal::ROUND_FLOOR,
+                default => throw new Exception('BILLING_PERIOD_ROUNDING_TYPE has an invalid value.'),
+            }
+        );
+    }
+
     /**
      * getter for VAT
      *
@@ -252,30 +272,32 @@ public function periodTotal(Date $from, Date $until): Decimal
         if (is_null($this->billing_until) || (!is_null($this->billing_until) && $this->billing_until >= $until)) { // billing_until is not limiting
             // whole period
             if ($this->billing_from <= $from) {
-                return $this->total_price
-                    ->round(0, Decimal::ROUND_CEIL);
+                return self::roundForBillingPeriod($this->total_price);
             }
             // later billing_from
             if ($this->billing_from <= $until) {
-                return $this->total_price
-                    ->multiply($this->billing_from->diffInDays($until->addDays(1)))
-                    ->divide($period_days, 4)
-                    ->round(0, Decimal::ROUND_CEIL);
+                return self::roundForBillingPeriod(
+                    $this->total_price
+                        ->multiply($this->billing_from->diffInDays($until->addDays(1)))
+                        ->divide($period_days, 4)
+                );
             }
         } else { // billing_until is limiting
             // earlier billing_until
             if ($this->billing_from <= $from) {
-                return $this->total_price
+                return self::roundForBillingPeriod(
+                    $this->total_price
                     ->multiply($from->diffInDays($this->billing_until->addDays(1)))
                     ->divide($period_days, 4)
-                    ->round(0, Decimal::ROUND_CEIL);
+                );
             }
             // later billing_from and earlier billing_until
             if ($this->billing_from <= $until) {
-                return $this->total_price
-                    ->multiply($this->billing_from->diffInDays($this->billing_until->addDays(1)))
-                    ->divide($period_days, 4)
-                    ->round(0, Decimal::ROUND_CEIL);
+                return self::roundForBillingPeriod(
+                    $this->total_price
+                        ->multiply($this->billing_from->diffInDays($this->billing_until->addDays(1)))
+                        ->divide($period_days, 4)
+                );
             }
         }