Modules.Interfaces & Modules.Jobs: Neue eInvoice Spezifikation "ebInterface 6.1" implementiert

Logik zum Abfragen von Attributen von root ergänzt

Interfaces/Interfaces.vbproj

@@ -265,6 +265,7 @@
     <Compile Include="GrapQLInterface\LoginData.vb" />
     <Compile Include="GrapQLInterface\LogoutData.vb" />
     <Compile Include="GrapQLInterface\QueryData.vb" />
+    <Compile Include="ZUGFeRDInterface\ebInterface6.1\InvoiceType.vb" />
     <Compile Include="ZUGFeRDInterface\Enums\ErrorCodes.vb" />
     <Compile Include="ZUGFeRDInterface\Enums\Item_Types.vb" />
     <Compile Include="ZUGFeRDInterface\Exceptions.vb" />

Interfaces/ZUGFeRDInterface.vb

@@ -3,6 +3,7 @@ Imports System.Xml
 Imports System.Xml.Serialization
 Imports DigitalData.Modules.Interfaces.Exceptions
 Imports DigitalData.Modules.Interfaces.PDFEmbeds
+Imports DigitalData.Modules.Interfaces.PropertyValues
 Imports DigitalData.Modules.Interfaces.ZUGFeRD
 Imports DigitalData.Modules.Logging
 Imports GdPicture14
@@ -21,8 +22,6 @@ Public Class ZUGFeRDInterface
     Public Const ZUGFERD_SPEC_2x = "ZUGFERD_2x"
     Public Const ZUGFERD_SPEC_2_3x = "ZUGFERD_2_3x"
 
-    Public Const UBL_SPEC_21 = "UBL_21"
-
     Public Const XMLSCHEMA_ZUGFERD_10 = "Version1_0"
     Public Const XMLSCHEMA_ZUGFERD_20 = "Version2_0"
     Public Const XMLSCHEMA_ZUGFERD_211 = "Version2_1_1"
@@ -31,9 +30,14 @@ Public Class ZUGFeRDInterface
     Public Const XMLSCHEMA_ZUGFERD_233 = "Version2_3_3_FacturX"
     Public Const XMLSCHEMA_ZUGFERD_24 = "Version2_4_FacturX"
     Public Const XMLSCHEMA_ZUGFERD_25 = "Version2_5_FacturX"
+
+    Public Const UBL_SPEC_21 = "UBL_21"
     Public Const XMLSCHEMA_UBL_21_INVOICE = "UBL2_1_INVOICE"
     Public Const XMLSCHEMA_UBL_21_CREDITNOTE = "UBL2_1_CREDITNOTE"
 
+    Public Const EBINTERFACE_SPEC_61 = "EBINTERFACE_61"
+    Public Const XMLSCHEMA_EBINTERFACE_61 = "Version6_1"
+
     Public Const RECEIPT_TYPE_XML = "XML"
     Public Const RECEIPT_TYPE_PDF = "PDF"
 
@@ -67,6 +71,7 @@ Public Class ZUGFeRDInterface
         Public Property AllowZugferd_2_x_Schema As Boolean = True
         Public Property AllowZugferd_2_3_x_Schema As Boolean = True
         Public Property AllowPeppol_3_x_Schema As Boolean = False
+        Public Property AllowEBInterface_Schema As Boolean = False
     End Class
 
     Public Class ZugferdResult
@@ -152,6 +157,20 @@ Public Class ZUGFeRDInterface
                         Where(Function(kv) kv.Specification = pSpecification Or kv.Specification = ZUGFERD_SPEC_DEFAULT).
                         ToDictionary(Function(kv) kv.XMLPath, Function(kv) kv)
 
+            Catch ex As Exception
+                _logger.Error(ex)
+            End Try
+        ElseIf pSpecification = EBINTERFACE_SPEC_61 Then
+
+            Try
+                ' root-Elemente werden hier herausgefiltert
+                Dim countElements As Integer = pPropertyMapList.Where(Function(x) x.Specification = pSpecification And Not x.XMLPath.StartsWith("root.")).Count
+                _logger.Debug("Property map list contains [{0}] elements for specification [{1}]", countElements, pSpecification)
+
+                Return pPropertyMapList.
+                        Where(Function(kv) kv.Specification = pSpecification And Not kv.XMLPath.StartsWith("root.")).
+                        ToDictionary(Function(kv) kv.XMLPath, Function(kv) kv)
+
             Catch ex As Exception
                 _logger.Error(ex)
             End Try
@@ -174,6 +193,28 @@ Public Class ZUGFeRDInterface
         Return Nothing
     End Function
 
+    Public Function FilterRootPropertyMap(pPropertyMapList As List(Of XmlItemProperty), pSpecification As String) As Dictionary(Of String, XmlItemProperty)
+
+        ' Aktuell verwendet nur ebeInterafce attribute im root-Knoten
+        If pSpecification = EBINTERFACE_SPEC_61 Then
+            Try
+                ' root-Elemente werden hier herausgefiltert
+                Dim countElements As Integer = pPropertyMapList.Where(Function(x) x.Specification = pSpecification And x.XMLPath.StartsWith("root.")).Count
+                _logger.Debug("Property map list contains [{0}] root attribute elements for specification [{1}]", countElements, pSpecification)
+
+                Return pPropertyMapList.
+                        Where(Function(kv) kv.Specification = pSpecification And kv.XMLPath.StartsWith("root.")).
+                        ToDictionary(Function(kv) kv.XMLPath, Function(kv) kv)
+
+            Catch ex As Exception
+                _logger.Error(ex)
+            End Try
+        Else
+            Return Nothing
+        End If
+
+    End Function
+
     Public Function GetSerializedXMLContentFromFile(oFileInfo As FileInfo) As ZugferdResult
         Dim oResult = New ZugferdResult()
         Dim oMessage As String = String.Empty
@@ -455,6 +496,16 @@ Public Class ZUGFeRDInterface
                 })
             End If
 
+            If _Options.AllowEBInterface_Schema Then
+                oAllowedTypes.AddRange(New List(Of AllowedType) From {
+                    New AllowedType With {
+                        .SchemaType = GetType(EBINTERFACE_61.InvoiceType),
+                        .Specification = EBINTERFACE_SPEC_61,
+                        .XMLSchema = XMLSCHEMA_EBINTERFACE_61
+                    }
+                })
+            End If
+
             For Each oType In oAllowedTypes
                 Dim oTypeName As String = oType.SchemaType.FullName
                 Dim oSerializer As New XmlSerializer(oType.SchemaType)
@@ -497,4 +548,5 @@ Public Class ZUGFeRDInterface
             Throw New ZUGFeRDExecption(ErrorCodes.UnsupportedFerdException, oMessage)
         End Try
     End Function
+
 End Class

Interfaces/ZUGFeRDInterface/PropertyValues.vb

@@ -275,6 +275,121 @@ Public Class PropertyValues
         Return oResult
     End Function
 
+    Public Function CheckRootAttributeValues(pDocument As Object, pPropertyMap As Dictionary(Of String, XmlItemProperty), pMessageId As String, pCheckResult As CheckPropertyValuesResult) As CheckPropertyValuesResult
+
+        If pPropertyMap Is Nothing Then
+            Return pCheckResult
+        End If
+
+        ' PropertyMap items with `IsGrouped = False` are handled normally
+        Dim oRootAttributeProperties As Dictionary(Of String, XmlItemProperty) = pPropertyMap.
+            ToDictionary(Function(Item) Item.Key,
+                         Function(Item) Item.Value)
+
+        For Each oItem As KeyValuePair(Of String, XmlItemProperty) In oRootAttributeProperties
+            Dim oTableColumn As String = oItem.Value.TableColumn
+            Dim oPropertyDescription As String = oItem.Value.Description
+            Dim oPropertyPath As String = oItem.Value.XMLPath
+            Dim oPropertyValue As Object = Nothing
+            Dim oTableName = oItem.Value.TableName
+            Dim oIsRequired = oItem.Value.IsRequired
+            Dim oDescription = oItem.Value.Description
+            Dim oItemType = oItem.Value.ItemType
+            Dim oEN16931_ID = oItem.Value.EN16931_ID
+
+            Try
+                oPropertyValue = GetRootAttributeValue(pDocument, oItem.Key)
+            Catch ex As Exception
+                _logger.Error(ex)
+                oPropertyValue = Nothing
+            End Try
+
+            If IsNothing(oPropertyValue) OrElse String.IsNullOrEmpty(oPropertyValue) Then
+                If oItem.Value.IsRequired Then
+                    _logger.Warn("Column [{0}] is empty, but marked as required! Adding MissingProperty.", oTableColumn)
+                    Dim oMissingProperty = New MissingProperty With
+                    {
+                        .EN16931_ID = oEN16931_ID,
+                        .Description = oPropertyDescription,
+                        .XMLPath = oPropertyPath
+                    }
+                    pCheckResult.MissingProperties.Add(oMissingProperty)
+                    Continue For
+                Else
+                    _logger.Debug("oPropertyValue for Column [{0}] is empty or not found. Skipping.", oTableColumn)
+                    Continue For
+                End If
+            End If
+
+            If pDocument.Specification = "EBINTERFACE_61" Then
+
+                ' ebInterface DocumentType in UNTDID 1001 — Document type
+                If oTableColumn = "INVOICE_TYPE" Then
+                    oPropertyValue = GetUNTDID1001_DocumentType(oPropertyValue)
+                End If
+
+            End If
+
+            pCheckResult.ValidProperties.Add(New ValidProperty() With {
+                .MessageId = pMessageId,
+                .Description = oPropertyDescription,
+                .Value = oPropertyValue,
+                .GroupCounter = 0,
+                .TableName = oTableName,
+                .TableColumn = oTableColumn,
+                .IsRequired = oIsRequired,
+                .XMLPath = oPropertyPath,
+                .ItemType = oItemType,
+                .EN16931_ID = oEN16931_ID
+            })
+
+        Next
+
+        Return pCheckResult
+    End Function
+
+    Private Function GetUNTDID1001_DocumentType(oPropertyValue As String) As String
+
+        Select Case oPropertyValue
+            Case "CreditMemo"
+                Return 1
+            Case "FinalSettlement"
+                Return 1
+            Case "Invoice"
+                Return 380
+            Case "InvoiceForAdvancePayment"
+                Return 1
+            Case "InvoiceForPartialDelivery"
+                Return 1
+            Case "SelfBilling"
+                Return 1
+            Case "SubsequentCredit"
+                Return 1
+            Case "SubsequentDebit"
+                Return 1
+            Case Else
+                Return 380
+        End Select
+
+    End Function
+
+    Private Function GetRootAttributeValue(pDocument As Object, pXmlPath As String) As String
+        If pDocument.XElementObject Is Nothing Then
+            Return Nothing
+        End If
+
+        Try
+            Dim attributeName As String = pXmlPath.Replace("root.", "")
+            Dim attributeValue As String = pDocument.XElementObject.Attribute(attributeName).Value
+            Return attributeValue
+
+        Catch ex As Exception
+            _logger.Error(ex)
+            Return Nothing
+        End Try
+
+    End Function
+
     Public Function GetPropValue(Obj As Object, PropertyName As String) As List(Of Object)
         Dim oNameParts As String() = PropertyName.Split("."c)
 

Jobs/ZUGFeRD/ImportZUGFeRDFiles.vb

@@ -120,7 +120,8 @@ Public Class ImportZUGFeRDFiles
         _zugferd = New ZUGFeRDInterface(_logConfig, _gdpictureLicenseKey, New ZUGFeRDInterface.ZugferdOptions() With {
             .AllowFacturX_Filename = oArgs.AllowFacturX,
             .AllowXRechnung_Filename = oArgs.AllowXRechnung,
-            .AllowPeppol_3_x_Schema = oArgs.AllowPeppolBISBill3x
+            .AllowPeppol_3_x_Schema = oArgs.AllowPeppolBISBill3x,
+            .AllowEBInterface_Schema = oArgs.AllowEBInterface
         })
 
         _logger.Debug("Starting Job {0}", [GetType].Name)
@@ -719,6 +720,10 @@ Public Class ImportZUGFeRDFiles
         Dim oPropertyMap As Dictionary(Of String, XmlItemProperty) = _zugferd.FilterPropertyMap(pArgs.PropertyMapList, pDocument.Specification)
         Dim oCheckResult = _zugferd.PropertyValues.CheckPropertyValues(pDocument.SchemaObject, oPropertyMap, pMessageId)
 
+        ' root-Attribute falls konfiguriert auslesen, Ergebnis im oCheckResult enthalten
+        Dim oRootAttributePropertyMap As Dictionary(Of String, XmlItemProperty) = _zugferd.FilterRootPropertyMap(pArgs.PropertyMapList, pDocument.Specification)
+        oCheckResult = _zugferd.PropertyValues.CheckRootAttributeValues(pDocument, oRootAttributePropertyMap, pMessageId, oCheckResult)
+
         _logger.Info("Properties checked: [{0}] missing properties / [{1}] valid properties found.", oCheckResult.MissingProperties.Count, oCheckResult.ValidProperties.Count)
 
         If oCheckResult.MissingProperties.Count > 0 Then

Jobs/ZUGFeRD/WorkerArgs.vb

@@ -33,5 +33,6 @@ Public Class WorkerArgs
     Public AllowZugferd2x As Boolean = True
     Public AllowZugferd23x As Boolean = True
     Public AllowPeppolBISBill3x As Boolean = False
+    Public AllowEBInterface As Boolean = False
 
 End Class