WPXOrder - X-Factur (ZUGFeRD) XML Daten lesen und erzeugen

[jziersch]

WPXOrder ist eine Sammlung von Delphi-Units zur Erstellung und Auswertung von X-Factur (ZUGFeRD) XML-Daten.

Diese Library ist eine möglichst komplette Repräsentierung des ZUGFeRD XSD Schemas als Delphi Klassen.

Sie wurde erstellt, um Rechnungs Daten zu laden, zu verarbeiten und zu speichern. Es beinhaltet noch nicht den E-Invoice-Standard und ist darauf ausgerichtet, XML-Daten zu erstellen, die in PDF-Rechnungen eingebettet werden. Um solche Rechnungen zu erstellen, können Sie die praktische PDF-Erstellungs-VCL wPDF verwenden. Um solche Rechnungen zu lesen, können Sie WPViewPDF PLUS verwenden, das nicht nur X-Factur Daten extrahieren, sondern auch anhängen kann.

Bitte schauen Sie sich den Quellcode auf unserer WPXOrder GitHub Seite an.

Zweck und Lizenzierung
WPXOrder wurde entwickelt, um XML-Anhänge für Rechnungen zu erstellen, die als PDFs verteilt werden. Es wurde in Delphi 10.1 entwickelt und funktioniert am besten mit unseren Produkten wPDF oder WPViewPDF PLUS. Es kann auch verwendet werden, um solche XML-Daten zu lesen und auf alle Eigenschaften einfach zuzugreifen. Es kann auch zur Überprüfung der Berechnung (Gesamtsummen) verwendet werden - bitte beachten Sie jedoch, dass wir nicht garantieren können, dass solche Berechnungen in jedem Fall korrekt funktionieren.

Durch die Art der Implementierung werden folgende Fehler bei der Erstellung von XML Daten:
1) Schreibfehler der XML namen
2) Eigenschaften in falschem Eltern XML Element
3) Falsche Reihenfolge der Elemente (Wichtig für die Validierung)
Desweitern kann man Werte wie TDateTime zuweisen.


Mit der mitgelieferten EXE können Sie die Beispiel-PDFs öffnen und die internen Berechnungen mit den in den PDFs hinterlegten Zahlen vergleichen. Mit nur einem Klick können Sie Delphi-Code erstellen, der die Daten so erzeugt, wie sie in die Rechnung geladen werden. Dies wird Ihnen sehr helfen, das XML-Format besser zu verstehen und Ihre Rechnungserstellungssoftware zu konvertieren.

Sie können die Komponente ohne Lizenzkosten verwenden, wenn Sie sie in ein Open-Source-Projekt einbinden, das unter der GNU-Lizenz vertrieben wird - mit Ausnahme von Komponenten jeglicher Art oder „Forks“.

Wenn Sie die Komponente intern oder in einem Closed-Source-Produkt kommerziell nutzen wollen, ist eine kommerzielle Lizenz erforderlich. Diese Lizenz ist zu einem angemessenen Preis pro Unternehmen erhältlich (named license). Die kommerzielle Lizenz beinhaltet auch Support für 60 Tage nach dem Kauf. Bitte beachten Sie, dass wir uns zu rechtlichen und kalkulatorischen Fragen im Zusammenhang mit X-Factur nicht äußern können.

Programmier Referenz (alle Klassen):
https://www.wpcubed.com/manuals/wpxorder/index.html

Beschreibung:
https://www.wpcubed.com/pdf/products/xorder/

GitHub:
https://github.com/wpcubed/xorder

wPDF - PDF Erzeugen:
https://www.wpcubed.com/pdf/products/wpdf/

WPViewPDF PLUS - XML aus PDFs extrahieren oder hinzufügen:
https://www.wpcubed.com/pdf/products/pdf-edit/

Hinweise:
Auf GitHub befindet sich auch eine (signierte!) EXE welche aus PDFs XML extrahieren kann und direkt Delphi code erzeugen kann, der genau einen XML Rechnungsanhang mit den selben Werte erstellt.

Der Code verwendet Generics, erfordert also neuere Delphi Versionen.

Viel Erfolg,
Julian

Anhang: Automatisch generierter code der mit WPXOrder das ZUGFeRD Beispiel "Warenrechnung" erzeugt

[jziersch]

Jetzt gibt es auch ein Beispiel Projekt mit folgenden Features:

1) XML laden und Kontrollrechnung ausführen
2) XML laden um Rechnungsdaten vorzubelegen (Adresse etc)
3) Aus Rechnungsdaten neue XML erzeugen
4) Geladene oder erzeugte Daten als Pascal Quellcode abspeichern

Dies ist der implementation code des Demo Projekts:

Code:

{ TInvoiceCompanyData }
procedure TInvoiceCompanyData.ReadFromStrings(str: TStrings);
begin
  Name := str.Values['Name'];
  PostcodeCode := str.Values['PostcodeCode'];
  Addres := str.Values['Addres'];
  CityName := str.Values['CityName'];
  CountryIDText := str.Values['CountryID'];
  // Optional
  DepartmentName := str.Values['DepartmentName'];
  // Required for Seller
  TAXId := str.Values['TAXId'];
  // Required for EU Sales
  VATID := str.Values['VATID'];
  // Optional: Full text, several lines  for Seller!
  ContactInfo := str.Values['ContactInfo'];
  // Optional
  ID := str.Values['ID'];
  GlobalID := str.Values['GlobalID'];
  GlobalIDScheme := str.Values['GlobalIDScheme'];
  // Optional, Reg Nr
  SpecifiedLegalOrganization := str.Values['SpecifiedLegalOrganization'];
end;

procedure TInvoiceCompanyData.WriteToStrings(str: TStrings);
begin
  str.Values['Name'] := Name;
  str.Values['PostcodeCode'] := PostcodeCode;
  str.Values['Addres'] := Addres;
  str.Values['CityName'] := CityName;
  str.Values['CountryID'] := CountryIDText;
  // Optional
  str.Values['DepartmentName'] := DepartmentName;
  // Required for Seller
  str.Values['TAXId'] := TAXId;
  // Required for EU Sales
  str.Values['VATID'] := VATID;
  // Optional: Full text, several lines  for Seller!
  str.Values['ContactInfo'] := ContactInfo;
  // Optional
  str.Values['ID'] := ID;
  str.Values['GlobalID'] := GlobalID;
  str.Values['GlobalIDScheme'] := GlobalIDScheme;
  // Optional, Reg Nr
  str.Values['SpecifiedLegalOrganization'] := SpecifiedLegalOrganization;
end;

procedure TInvoiceForm.SaveasDelphiCode1Click(Sender: TObject);
begin
  SaveDialog1.FilterIndex := 1;
  if SaveDialog1.Execute then
     WPXFactur1.SaveToFile(SaveDialog1.FileName, TWPXOrderDumpMode.DelphiCodeCompact);
end;

procedure TInvoiceForm.SaveXML1Click(Sender: TObject);
begin
  SaveDialog1.FilterIndex := 0;
  if SaveDialog1.Execute then
     WPXFactur1.SaveToFile(SaveDialog1.FileName);
end;

procedure TInvoiceForm.btnCalculateClick(Sender: TObject);
begin
   WPXFactur1.VerifySummation;
   outText.Lines  := WPXFactur1.Messages;
end;

procedure TInvoiceForm.btnGenerateInvoiceClick(Sender: TObject);
var i : Integer;
begin
   WPXPaymentData.DueDateDateTime :=  Now;
   WPXPaymentData.TAXCategory := TTaxCategory(taxCombo.ItemIndex);

   WPXFactur1.StartInvoice(
         TDocumentCode.c380_Commercial_invoice,
         WPXPaymentData.DueDateDateTime,
         edREID.Text,
         edREName.Text,
         WPXSeller, WPXBuyer, nil,
         nil, // from Order
         WPXOrderData,
         nil,
         WPXPaymentData
        );

   for I := 1 to ItemGrid.RowCount-1 do
   if ItemGrid.Cells[1,i]<>'' then
   begin
      WPXFactur1.AddSale(
         ItemGrid.Cells[1,i],
         WPXCurrencyStrToFloat( ItemGrid.Cells[2,i] ),
         WPXCurrencyStrToFloat( ItemGrid.Cells[3,i] ),
         WPXCurrencyStrToFloat( ItemGrid.Cells[5,i] ),
         WPXPaymentData.TAXCategory );
   end;

   WPXFactur1.FinalizeInvoice(true,TCurrencyCode.EUR,0,WPXPaymentData);

   outText.Lines.Assign(WPXFactur1.Messages);
end;

procedure TInvoiceForm.FormCreate(Sender: TObject);
begin
  WPXFactur1 := TWPXFactur.Create(Self);

  WPXSeller := TInvoiceCompanyData.Create;
  WPXBuyer  := TInvoiceCompanyData.Create;
  WPXShipTo := TInvoiceCompanyData.Create;
  WPXPaymentData := TPaymentData.Create;
  WPXOrderData := TOrderData.Create;

  ReadItems;
end;

procedure TInvoiceForm.FormDestroy(Sender: TObject);
begin
  WPXFactur1.Free;
  WPXSeller.Free;
  WPXBuyer.Free;
  WPXShipTo.Free;
  WPXPaymentData.Free;
  WPXOrderData.Free;
end;

procedure TInvoiceForm.LoadXML1Click(Sender: TObject);
begin
   if OpenDialog1.Execute then
   begin
     WPXFactur1.LoadFromFile(OpenDialog1.FileName);
     WPXFactur1.ReadCompanyData(WPXSeller,TReadCompanyDataMode.Seller);
     WPXFactur1.ReadCompanyData(WPXBuyer,TReadCompanyDataMode.Buyer);
     WPXFactur1.ReadCompanyData(WPXShipTo,TReadCompanyDataMode.ShipTo);
     // WPXFactur1.ReadCompanyData(xxx,TReadCompanyDataMode.Payee);
     WPXSeller.WriteToStrings(valSeller.Strings);
     WPXBuyer.WriteToStrings(valBuyer.Strings);
     ReadItems;
   end;
end;

procedure TInvoiceForm.ReadItems;
var i : Integer;
    item : TSupplyChainTradeItem;
begin
    ItemGrid.RowCount := 0;
    ItemGrid.RowCount := WPXFactur1.Transaction.Items.Count + 4;
    ItemGrid.ColCount := 7;

    ItemGrid.Cells[0,0] := 'LineID';
    ItemGrid.Cells[1,0] := 'Name';
    ItemGrid.Cells[2,0] := 'Net Charge';
    ItemGrid.Cells[3,0] := 'Quantity';
    ItemGrid.Cells[4,0] := 'TAX Category';
    ItemGrid.Cells[5,0] := 'RateApplicablePercent';
    ItemGrid.Cells[6,0] := 'LineTotalAmount';

    for i := 1 to WPXFactur1.Transaction.Items.Count do
    begin
        item := WPXFactur1.Transaction.Items[i-1];
        with item.Line do
        begin
            ItemGrid.Cells[0,i] := AssociatedDocumentLineDocument.LineID.ValueStr;
            ItemGrid.Cells[1,i] := SpecifiedTradeProduct.Name.ValueStr;
            ItemGrid.Cells[2,i] := SpecifiedLineTradeAgreement.NetPriceProductTradePrice.ChargeAmount.ValueStr;
            ItemGrid.Cells[3,i] := SpecifiedLineTradeAgreement.NetPriceProductTradePrice.BasisQuantity.ValueStr;
            if ItemGrid.Cells[3,i]='' then ItemGrid.Cells[3,i] := '1';
            ItemGrid.Cells[4,i] := SpecifiedLineTradeSettlement.ApplicableTradeTax.CategoryCode.ValueStr;
            ItemGrid.Cells[5,i] := SpecifiedLineTradeSettlement.ApplicableTradeTax.RateApplicablePercent.ValueStr;
            ItemGrid.Cells[6,i] := SpecifiedLineTradeSettlement.SpecifiedTradeSettlementLineMonetarySummation.LineTotalAmount.ValueStr;
            // ItemGrid.Cells[7,i] := SpecifiedLineTradeDelivery.BilledQuantity.ValueStr;
            // ItemGrid.Cells[8,i] := SpecifiedLineTradeSettlement.ApplicableTradeTax.TypeCode.ValueStr;

        end;
    end;
end;

In der unit WPXFactur befindet sich der code zum erzeugen und auslesen der XML Daten sowie zur Berechnung. Hier kann man ganz gut sehen, wie XML Daten ausgelesen werden können, insbesondere die Funktion die die Adressen ausliest.

Code:

procedure TCompanyData.AssignFrom(Source: TTradeParty);
var val : TWPXElement;
begin
  if Source<>nil then
  begin
    // This code reads the value of properties but does not create the elements
    // If they are not existing.
    Source.ReadElementValue([Integer(TXTradeParty.Name)], Name);
    if Source.ReadElementValue([Integer(TXTradeParty.DefinedTradeContact),
            Integer(TXTradeContact.DepartmentName)], val) then
         DepartmentName := val.ValueStr else DepartmentName := '';
    // This code first checks the property exists and then read the values
    Source.ReadElementValue([Integer(TXTradeParty.PostalTradeAddress),
            Integer(TXTradeAddress.PostcodeCode)], PostcodeCode);
    Source.ReadElementValue([Integer(TXTradeParty.PostalTradeAddress),
            Integer(TXTradeAddress.LineOne)], Addres);
    Source.ReadElementValue([Integer(TXTradeParty.PostalTradeAddress),
            Integer(TXTradeAddress.CityName)], CityName);
    if Source.ReadElementValue([Integer(TXTradeParty.PostalTradeAddress),
            Integer(TXTradeAddress.CountryID)], val) then
         CountryIDText := val.ValueStr else CountryID := TCountryID.UNDEFINED;
    Source.ReadElementValue([Integer(TXTradeParty.ID)], ID);
    Source.ReadElementValue([Integer(TXTradeParty.GlobalID)], GlobalID);
    if Source.ReadElementValue([Integer(TXTradeParty.SpecifiedTaxRegistration),
            Integer(TXTaxRegistration.ID)], val) then
         VATID := val.ValueStr else VATID := '';
    if Source.ReadElementValue([Integer(TXTradeParty.SpecifiedLegalOrganization),
            Integer(TXLegalOrganization.ID)], val) then
         SpecifiedLegalOrganization := val.ValueStr else SpecifiedLegalOrganization := '';
  end;
end;

Sie verwendet die Methode ReadElementValue welche auf ein Rechnungsobjekt angewendet, benutzt werden kann ein bestimmtes Unterelement auszulesen, ohne dass diese erzeugt wird, wenn es nicht existiert.

Da der Übergabeparameter ein Array ist, kann man hier auch ein unter-unter Element auslesen.

So liest dieser Code das Element aus:

Code:

if Source.ReadElementValue([Integer(TXTradeParty.DefinedTradeContact),
            Integer(TXTradeContact.DepartmentName)], val) then
         DepartmentName := val.ValueStr else DepartmentName := '';

Welches so geschrieben wird:

TTradeParty(Dest).DefinedTradeContact.DepartmentName.SetValue(DepartmentName);

geschrieben wird. Ohne die Verwendung vom ReadElementValue würde das Unterobjekt DefinedTradeContact und DepartmentName automatisch angelegt, wenn man also einfach auf Source.DefinedTradeContact.DepartmentName.ValueStr zugreifen würde.

Ich hoffe dies erklärt etwas, wie die automatische Erzeugung der Eigenschaften funktioniert.

Übrigens: Viele Eigenschaften in der Rechnung können mehrfach auftreten. Mit Aussnahme der Rechnungsposten (lines), welche durch eine eigene Collection verwaltet werden, wird dies durch eine default Array property von ausgewählten Klassen implementiert.

IncludedNote[1].ContentCode...

greift hier auf die erste Notiz zu, IncludedNote[2].ContentCode... auf die zweite usw. Der Zugriff muss in der richtigen, aufsteigenden Reihenfolge erfolgen. Zu auslesen kann man 'Count' abfragen. Zum sequentiellen Hinzufügen ohne index gibt es ListAdd.