Merge pull request #529 from timrasche/feature/single-booking-sepa-transfer

Add singleBookingRequested option to SendSEPATransfer

Author: nemiah

lib/Fhp/Action/SendSEPATransfer.php

@@ -26,6 +26,8 @@ class SendSEPATransfer extends BaseAction
     private $painMessage;
     /** @var string */
     private $xmlSchema;
+    /** @var bool */
+    private $singleBookingRequested = false;
 
     // There are no result fields. This action is simply marked as done to indicate that the transfer was executed.
 
@@ -47,6 +49,19 @@ public static function create(SEPAAccount $account, string $painMessage): SendSE
         return $result;
     }
 
+    /**
+     * Request individual bookings instead of a batch booking on the bank statement.
+     * Only applicable for batch transfers (Sammelüberweisung).
+     *
+     * @param bool $singleBookingRequested If true, each transaction appears separately on the statement.
+     * @return $this
+     */
+    public function setSingleBookingRequested(bool $singleBookingRequested): self
+    {
+        $this->singleBookingRequested = $singleBookingRequested;
+        return $this;
+    }
+
     /**
      * @deprecated Beginning from PHP7.4 __unserialize is used for new generated strings, then this method is only used for previously generated strings - remove after May 2023
      */
@@ -59,7 +74,7 @@ public function __serialize(): array
     {
         return [
             parent::__serialize(),
-            $this->account, $this->painMessage, $this->xmlSchema,
+            $this->account, $this->painMessage, $this->xmlSchema, $this->singleBookingRequested,
         ];
     }
 
@@ -78,7 +93,7 @@ public function __unserialize(array $serialized): void
     {
         list(
             $parentSerialized,
-            $this->account, $this->painMessage, $this->xmlSchema,
+            $this->account, $this->painMessage, $this->xmlSchema, $this->singleBookingRequested,
         ) = $serialized;
 
         is_array($parentSerialized) ?
@@ -144,6 +159,16 @@ protected function createRequest(BPD $bpd, ?UPD $upd)
         $segment->kontoverbindungInternational = Kti::fromAccount($this->account);
         $segment->sepaDescriptor = $this->xmlSchema;
         $segment->sepaPainMessage = new Bin($this->painMessage);
+
+        // For batch transfers: set einzelbuchungGewuenscht if bank allows it
+        if ($numberOfTransactions > 1) {
+            $paramSegmentId = $hasReqdExDates ? 'HICMES' : 'HICCMS';
+            $paramSegment = $bpd->getLatestSupportedParameters($paramSegmentId);
+            if ($paramSegment !== null && $paramSegment->getParameter()->einzelbuchungErlaubt) {
+                $segment->einzelbuchungGewuenscht = $this->singleBookingRequested;
+            }
+        }
+
         return $segment;
     }
 

lib/Fhp/Segment/CCM/HICCMSv1.php

@@ -14,7 +14,7 @@ class HICCMSv1 extends BaseGeschaeftsvorfallparameter
 {
     public ParameterSEPASammelueberweisungV1 $parameter;
 
-    public function getParameter()
+    public function getParameter(): ParameterSEPASammelueberweisungV1
     {
         return $this->parameter;
     }

lib/Fhp/Segment/CME/HICMESv1.php

@@ -13,4 +13,9 @@
 class HICMESv1 extends BaseGeschaeftsvorfallparameter
 {
     public ParameterTerminierteSEPASammelueberweisungEinreichenV1 $parameter;
+
+    public function getParameter(): ParameterTerminierteSEPASammelueberweisungEinreichenV1
+    {
+        return $this->parameter;
+    }
 }