AutoCaptZUGFeRD

Navigation:  Entwicklerhilfe > Makro-Referenz OmAPI > AutoCapt: Automatische Dokumentenerkennung

AutoCaptZUGFeRD

Previous pageReturn to chapter overviewNext page

Makro-Variable AutoCaptZUGFeRD

Daten einer ZUGFeRD-Rechnung einlesen.

Syntax

{AutoCaptZUGFeRD:Path}

Parameter

Path: Pfad zum gewünschten Wert, wie in der technischen ZUGFeRD-Dokumentation beschrieben.
Oder:
DocFileName: Dateiname des derzeit eingelesenen Dokuments, sofern dieses erfolgreich verarbeitet wurde. Anderenfalls wird ein Leerstring zurückgegeben.
XMLFileName: Dateiname der verarbeiteten (ev. temporär gespeicherten) XML-Datei
XML: gibt den Inhalt der ZUGFeRD-invoice.xml als String zurück
(Pfad)/dmsAsString: nur bei Datum, siehe Beschreibung
(Pfad)/dmsAsDate: nur bei Datum, siehe Beschreibung
(Pfad)/dmsDateCode: nur bei Datum, siehe Beschreibung
TagList: alle erfassten Werte als mehrzeiliger Text in Form "Path=Value"
Profile: das verwendete Rechnungsprofil. 1 = Basic, 2 = Comfort, 3 = Extended, 0 = unbekannt oder Fehler.
DocNo: Rechnungsnummer, Kurzschreibweise für den Pfad "CrossIndustryDocument/HeaderExchangedDocument/ID"
ReceiptDate: Rechnungsdatum "CrossIndustryDocument/HeaderExchangedDocument/IssueDateTime/DateTimeString/dmsAsDate"
Description: für die Dokumentbezeichnung geeigneter Text

Rückgabewert

Wert aus der ZUGFeRD-invoice.xml

Beschreibung

ZUGFeRD (Zentraler User Guide des Forum elektronische Rechnung Deutschland) ist eine Spezifikation für den Austausch von elektronischen Rechnungen. Eine ZUGFeRD-Rechnung besteht aus einer PDF/A-3 Datei mit der visuellen Darstellung der Rechnung und einer anliegenden XML-Datei mit den maschinenlesbaren strukturierten Daten.

Die Standard-Dokumentenerkennung liest bereits wichtige Attribute ein, ohne dass die Makro-Funktionen erforderlich sind.

Mit Aufruf der Prozedur {AutoCaptCreate:FileName} wird, sofern enthalten, die XML-Datei ausgewertet und eine Liste aller enthaltenen Daten zusammengestellt. Mit {AutoCaptZUGFeRD:Path} können Sie diese Daten abrufen. Als Path geben Sie bitte den in der technischen Dokumentation beschriebenen Pfad zum gewünschten Wert an. Die Dokumentation können Sie auf der FeRD-Website laden bzw. anfordern.

Datum

Ein Datum kann als Kalenderdatum (Code 102 JJJJMMTT), Kalenderwoche (Code 616 JJJJWW) oder Monat (Code 610 JJJJMM) angegeben sein. Die Pfade enden bei einem Datum mit "/DateTimeString". Beispiel XML-Knoten:

<ram:IssueDateTime>

  <udt:DateTimeString format="102">20141219</udt:DateTimeString>

</ram:IssueDateTime>

Mit der Makrovariable

{AutoCaptZUGFeRD:CrossIndustryDocument/HeaderExchangedDocument/IssueDateTime/DateTimeString}

erhalten Sie den kodierten Wert "20141219". Um Ihnen die Abfrage zu vereinfachen, dekodiert der Office Manager die Datumsangaben und stellt diese in drei Unterpfaden zur Verfügung:

(Pfad)/dmsAsString: enthält bei Code 102 z. B. "19.12.2014", bei Code 610 "Dezember 2014" und bei Code 616 "KW 51, 2014".

(Pfad)/dmsAsDate: gibt immer ein Kalenderdatum zurück und ist bei Code 102 mit dmsAsString identisch. Bei Code 610 der letzte Tag im Monat, bei Code 616 der Freitag in der angegebenen Woche.

(Pfad)/dmsDateCode: der Code "102", "610" oder "616".

Beispiel für die Abfrage eines dekodierten Datums:

{AutoCaptZUGFeRD:CrossIndustryDocument/HeaderExchangedDocument/IssueDateTime/DateTimeString/dmsAsDate}

Beispiel

Profil und Rechnungsnummer in globale Variablen kopieren:

{AutoCaptCreate:{Source}}

{RaiseError:Ungültige ZUGFeRD-Datei,{AutoCaptZUGFeRD:DocFileName}=}

{SetPublVar:ZFProfile={AutoCaptZUGFeRD:Profile}}

{SetPublVar:ZFDocNo={AutoCaptZUGFeRD:CrossIndustryDocument/HeaderExchangedDocument/ID}}

{AutoCaptDestroy}

{MessageDlg:{GetPublVar:*List}}

Siehe auch

Makro-Referenz

Übersicht Belegerfassung

AutoCaptCreate zur Initialisierung der Funktion

Importprofile. Insbesondere "E-Mail", Seite "Feldwerte". Hier werden die Rechnungsdaten den Archivfeldern zugewiesen.

Forum elektronische Rechnung Deutschland

Hinweise zur elektronischen Rechnungsarchivierung