[FEATURE] Add CreditDebitIdentifier to entry transaction detail

The credit-debit-identifier (CrdDbtInd) have been used for several details, e.g. amount, to proper represent values. The information itself is not added. As it could not be reliable retrieved from subvalues what the original state was, this change now adds that detail directly to the transaction details and the entry itself. Test fixture files are updated to contain the added fields. Resolves: genkgo#146 Related: genkgo#116 Conflicts: src/DTO/Entry.php src/DTO/EntryTransactionDetail.php src/Decoder/EntryTransactionDetail.php
impact-media-GmbH · Jun 5, 2023 · e1c42f1 · e1c42f1
1 parent 65b786b
commit e1c42f1
Show file tree

Hide file tree

Showing 23 changed files with 103 additions and 0 deletions.
diff --git a/src/DTO/Entry.php b/src/DTO/Entry.php
@@ -77,6 +77,11 @@ class Entry
      */
     private $status;
 
+    /**
+     * @var string|null
+     */
+    private $creditDebitIndicator;
+
     /**
      * @param int $index
      */
@@ -311,4 +316,21 @@ public function setStatus($status)
     {
         $this->status = $status;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getCreditDebitIndicator()
+    {
+        return $this->creditDebitIndicator;
+    }
+
+    /**
+     * @param string|null $creditDebitIndicator
+     * @return void
+     */
+    public function setCreditDebitIndicator($creditDebitIndicator)
+    {
+        $this->creditDebitIndicator = $creditDebitIndicator;
+    }
 }
diff --git a/src/DTO/EntryTransactionDetail.php b/src/DTO/EntryTransactionDetail.php
@@ -61,6 +61,11 @@ class EntryTransactionDetail
      */
     private $amount;
 
+    /**
+     * @var string|null
+     */
+    private $creditDebitIndicator;
+
     /**
      * @param \Genkgo\Camt\DTO\Reference|null $reference
      * @return void
@@ -271,4 +276,21 @@ public function setAmount($amount)
     {
         $this->amount = $amount;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getCreditDebitIndicator()
+    {
+        return $this->creditDebitIndicator;
+    }
+
+    /**
+     * @param string|null $creditDebitIndicator
+     * @return void
+     */
+    public function setCreditDebitIndicator($creditDebitIndicator)
+    {
+        $this->creditDebitIndicator = $creditDebitIndicator;
+    }
 }
diff --git a/src/Decoder/Entry.php b/src/Decoder/Entry.php
@@ -29,6 +29,7 @@ public function addTransactionDetails($entry, $xmlEntry)
         if ($xmlDetails !== null) {
             foreach ($xmlDetails as $xmlDetail) {
                 $detail = new DTO\EntryTransactionDetail();
+                $this->entryTransactionDetailDecoder->addCreditDebitIdentifier($detail, $xmlEntry->CdtDbtInd);
                 $this->entryTransactionDetailDecoder->addReference($detail, $xmlDetail);
                 $this->entryTransactionDetailDecoder->addRelatedParties($detail, $xmlDetail);
                 $this->entryTransactionDetailDecoder->addRelatedAgents($detail, $xmlDetail);

diff --git a/src/Decoder/EntryTransactionDetail.php b/src/Decoder/EntryTransactionDetail.php
@@ -30,6 +30,20 @@ public function __construct(DateDecoderInterface $dateDecoder)
         $this->moneyFactory = new MoneyFactory();
     }
 
+    /**
+     * @param \Genkgo\Camt\DTO\EntryTransactionDetail $detail
+     * @param \SimpleXMLElement $CdtDbtInd
+     * @return void
+     */
+    public function addCreditDebitIdentifier($detail, $CdtDbtInd)
+    {
+        $creditDebitIdentifier = (string) $CdtDbtInd;
+        $creditDebitIdentifier = in_array($creditDebitIdentifier, ['CRDT', 'DBIT'], true)
+            ? $creditDebitIdentifier
+            : null;
+        $detail->setCreditDebitIndicator($creditDebitIdentifier);
+    }
+
     /**
      * @param \Genkgo\Camt\DTO\EntryTransactionDetail $detail
      * @param \SimpleXMLElement $xmlDetail

diff --git a/src/Decoder/Record.php b/src/Decoder/Record.php
@@ -138,6 +138,10 @@ public function addEntries($record, $xmlRecord)
                 $entry->setBatchPaymentId((string) $xmlEntry->NtryDtls->TxDtls->Refs->PmtInfId);
             }
 
+            if (isset($xmlEntry->CdtDbtInd) && in_array((string) $xmlEntry->CdtDbtInd, ['CRDT', 'DBIT'], true)) {
+                $entry->setCreditDebitIndicator((string) $xmlEntry->CdtDbtInd);
+            }
+
             $entry->setStatus($this->readStatus($xmlEntry));
 
             if (isset($xmlEntry->BkTxCd)) {

diff --git a/test/data/camt052.v1.json b/test/data/camt052.v1.json
@@ -32,6 +32,7 @@
                 "0": "2007-10-18T09:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",

diff --git a/test/data/camt052.v2.json b/test/data/camt052.v2.json
@@ -36,6 +36,7 @@
                 "0": "2007-10-18T09:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",
@@ -86,6 +87,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": null,
                 "getRelatedAgent": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",

diff --git a/test/data/camt052.v2.other-account.json b/test/data/camt052.v2.other-account.json
@@ -36,6 +36,7 @@
                 "0": "2007-10-18T09:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",
@@ -86,6 +87,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": null,
                 "getRelatedAgent": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\RelatedAgent",

diff --git a/test/data/camt052.v4.json b/test/data/camt052.v4.json
@@ -36,6 +36,7 @@
                 "0": "2007-10-18T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",
@@ -139,6 +140,7 @@
                         }
                     }
                 },
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt052.v6.json b/test/data/camt052.v6.json
@@ -36,6 +36,7 @@
                 "0": "2007-10-18T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",
@@ -139,6 +140,7 @@
                         }
                     }
                 },
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt052.v8.json b/test/data/camt052.v8.json
@@ -32,6 +32,7 @@
                 "0": "2007-10-18T09:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt052\\DTO\\Report",

diff --git a/test/data/camt053.v2.five.decimals.json b/test/data/camt053.v2.five.decimals.json
@@ -28,6 +28,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -107,6 +108,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v2.minimal.json b/test/data/camt053.v2.minimal.json
@@ -28,6 +28,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -145,6 +146,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v2.minimal.ultimate.json b/test/data/camt053.v2.minimal.ultimate.json
@@ -28,6 +28,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -145,6 +146,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v2.multi.statement.json b/test/data/camt053.v2.multi.statement.json
@@ -28,6 +28,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -107,6 +108,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v3.json b/test/data/camt053.v3.json
@@ -36,6 +36,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -154,6 +155,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v4.json b/test/data/camt053.v4.json
@@ -32,6 +32,7 @@
                 "0": "2014-12-31T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -153,6 +154,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt053.v8.json b/test/data/camt053.v8.json
@@ -32,6 +32,7 @@
                 "0": "2014-12-31T12:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "CRDT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt053\\DTO\\Statement",
@@ -153,6 +154,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "CRDT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt054.v2.json b/test/data/camt054.v2.json
@@ -32,6 +32,7 @@
                 "0": "2007-10-18T12:15:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt054\\DTO\\Notification",
@@ -77,6 +78,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,
@@ -150,6 +152,7 @@
                         "getProprietary": null
                     },
                     "getCharges": null,
+                    "getCreditDebitIndicator": "DBIT",
                     "getReference": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                         "getAccountOwnerTransactionId": null,
@@ -216,6 +219,7 @@
                         "getProprietary": null
                     },
                     "getCharges": null,
+                    "getCreditDebitIndicator": "DBIT",
                     "getReference": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                         "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt054.v4.json b/test/data/camt054.v4.json
@@ -36,6 +36,7 @@
                 "0": "2007-10-18T00:00:00+00:00"
             },
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt054\\DTO\\Notification",
@@ -112,6 +113,7 @@
                     }
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,
@@ -262,6 +264,7 @@
                         }
                     },
                     "getCharges": null,
+                    "getCreditDebitIndicator": "DBIT",
                     "getReference": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                         "getAccountOwnerTransactionId": null,
@@ -405,6 +408,7 @@
                         }
                     },
                     "getCharges": null,
+                    "getCreditDebitIndicator": "DBIT",
                     "getReference": {
                         "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                         "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt054.v8-with-UETR.json b/test/data/camt054.v8-with-UETR.json
@@ -21,6 +21,7 @@
             "getBatchPaymentId": null,
             "getBookingDate": null,
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt054\\DTO\\Notification",
@@ -62,6 +63,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": {
                     "__CLASS__": "Genkgo\\Camt\\DTO\\Reference",
                     "getAccountOwnerTransactionId": null,

diff --git a/test/data/camt054.v8-with-financial-institution.json b/test/data/camt054.v8-with-financial-institution.json
@@ -21,6 +21,7 @@
             "getBatchPaymentId": null,
             "getBookingDate": null,
             "getCharges": null,
+            "getCreditDebitIndicator": "DBIT",
             "getIndex": 0,
             "getRecord": {
                 "__CLASS__": "Genkgo\\Camt\\Camt054\\DTO\\Notification",
@@ -62,6 +63,7 @@
                     "getProprietary": null
                 },
                 "getCharges": null,
+                "getCreditDebitIndicator": "DBIT",
                 "getReference": null,
                 "getRelatedAgent": null,
                 "getRelatedAgents": [],