Merge pull request #266 from dbingham-tl/feature/DespatchAdviceReferencedDocument

Feature/despatch advice referenced document

Author: stephanstapel

ZUGFeRD-Test/ZUGFeRD22Tests.cs

@@ -1909,5 +1909,22 @@ public void TestReferenceXRechnung21UBL()
 
             Assert.AreEqual(desc.PaymentMeans.TypeCode, (PaymentMeansTypeCodes)30);
         } // !TestReferenceXRechnung21UBL()
+
+        [TestMethod]
+        public void TestWriteAndReadDespatchAdviceDocumentReferenceXRechnung()
+        {
+            InvoiceDescriptor desc = this.InvoiceProvider.CreateInvoice();
+            string despatchAdviceNo = "421567982";
+            DateTime despatchAdviceDate = new DateTime(2024, 5, 14);
+            desc.SetDespatchAdviceReferencedDocument(despatchAdviceNo, despatchAdviceDate);
+
+            MemoryStream ms = new MemoryStream();
+            desc.Save(ms, ZUGFeRDVersion.Version22, Profile.XRechnung);
+            ms.Seek(0, SeekOrigin.Begin);
+            InvoiceDescriptor loadedInvoice = InvoiceDescriptor.Load(ms);
+
+            Assert.AreEqual(despatchAdviceNo, loadedInvoice.DespatchAdviceReferencedDocument.ID);
+            Assert.AreEqual(despatchAdviceDate, loadedInvoice.DespatchAdviceReferencedDocument.IssueDateTime);
+        } //!TestWriteAndReadDespatchAdviceDocumentReference
     }
 }

ZUGFeRD/DespatchAdviceReferencedDocument.cs

@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace s2industries.ZUGFeRD
+{
+    /// <summary>
+    /// Structure containing detailed information about the corresponding despatch advice
+    /// </summary>
+    public class DespatchAdviceReferencedDocument : BaseReferencedDocument
+    {
+    }
+}

ZUGFeRD/InvoiceDescriptor.cs

@@ -62,6 +62,11 @@ public class InvoiceDescriptor
         /// </summary>
         public List<AdditionalReferencedDocument> AdditionalReferencedDocuments { get; internal set; } = new List<AdditionalReferencedDocument>();
 
+        /// <summary>
+        /// Detailed information about the corresponding despatch advice
+        /// </summary>
+        public DespatchAdviceReferencedDocument DespatchAdviceReferencedDocument { get; internal set; } = null;
+
         /// <summary>
         /// Detailed information about the corresponding delivery note
         /// </summary>
@@ -664,6 +669,19 @@ public void SetBuyerOrderReferenceDocument(string orderNo, DateTime? orderDate =
             this.OrderDate = orderDate;
         } // !SetBuyerOrderReferenceDocument()
 
+        /// <summary>
+        /// Sets detailed information about the corresponding despatch advice
+        /// </summary>
+        /// <param name="deliveryNoteNo"></param>
+        /// <param name="deliveryNoteDate"></param>
+        public void SetDespatchAdviceReferencedDocument(string despatchAdviceNo, DateTime? despatchAdviceDate = null)
+        {
+            this.DespatchAdviceReferencedDocument = new DespatchAdviceReferencedDocument()
+            {
+                ID = despatchAdviceNo,
+                IssueDateTime = despatchAdviceDate
+            };
+        } // !SetDespatchAdviceReferencedDocument()
 
         /// <summary>
         /// Sets detailed information about the corresponding delivery note

ZUGFeRD/InvoiceDescriptor22Reader.cs

@@ -188,6 +188,23 @@ public override InvoiceDescriptor Load(Stream stream)
       retval.ShipFrom = _nodeAsParty(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty", nsmgr);
       retval.ActualDeliveryDate = _nodeAsDateTime(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString", nsmgr);
 
+      string _despatchAdviceNo = _nodeAsString(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:IssuerAssignedID", nsmgr);
+      DateTime? _despatchAdviceDate = _nodeAsDateTime(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:FormattedIssueDateTime/udt:DateTimeString", nsmgr);
+
+      if (!_despatchAdviceDate.HasValue)
+      {
+        _despatchAdviceDate = _nodeAsDateTime(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:DespatchAdviceReferencedDocument/ram:FormattedIssueDateTime", nsmgr);
+      }
+      
+      if (_despatchAdviceDate.HasValue || !String.IsNullOrWhiteSpace(_despatchAdviceNo))
+      {
+          retval.DespatchAdviceReferencedDocument = new DespatchAdviceReferencedDocument()
+          {
+            ID = _despatchAdviceNo,
+            IssueDateTime = _despatchAdviceDate
+          };
+      }
+
       string _deliveryNoteNo = _nodeAsString(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:DeliveryNoteReferencedDocument/ram:IssuerAssignedID", nsmgr);
       DateTime? _deliveryNoteDate = _nodeAsDateTime(doc.DocumentElement, "//ram:ApplicableHeaderTradeDelivery/ram:DeliveryNoteReferencedDocument/ram:IssueDateTime/udt:DateTimeString", nsmgr);
 

ZUGFeRD/InvoiceDescriptor22Writer.cs

@@ -646,6 +646,26 @@ public override void Save(InvoiceDescriptor descriptor, Stream stream)
             }
             #endregion
 
+            #region DespatchAdviceReferencedDocument
+            if(this.Descriptor.DespatchAdviceReferencedDocument != null)
+            {
+                Writer.WriteStartElement("ram:DespatchAdviceReferencedDocument");
+                Writer.WriteElementString("ram:IssuerAssignedID", this.Descriptor.DespatchAdviceReferencedDocument.ID);
+
+                if (this.Descriptor.DespatchAdviceReferencedDocument.IssueDateTime.HasValue)
+                {
+                    Writer.WriteStartElement("ram:FormattedIssueDateTime");
+                    Writer.WriteStartElement("qdt:DateTimeString");
+                    Writer.WriteAttributeString("format", "102");
+                    Writer.WriteValue(_formatDate(this.Descriptor.DespatchAdviceReferencedDocument.IssueDateTime.Value));
+                    Writer.WriteEndElement(); // "qdt:DateTimeString
+                    Writer.WriteEndElement(); // !ram:FormattedIssueDateTime
+                }
+
+                Writer.WriteEndElement(); // !DespatchAdviceReferencedDocument
+            }
+            #endregion
+
             #region DeliveryNoteReferencedDocument
             if (this.Descriptor.DeliveryNoteReferencedDocument != null)
             {