THotPDF.AddFacturXAssociatedFile-Methode
Methodenzusammenfassung: THotPDF.AddFacturXAssociatedFile-Methode
Deklaration
function AddFacturXAssociatedFile(const XMLBytes : TBytes; const ConformanceLevel : AnsiString; const FileName : AnsiString = 'factur-x.xml'; const Beschreibung : AnsiString = 'Factur-X invoice XML'; const Relationship : AnsiString = 'Alternative'; const Version : AnsiString = '1.0'; const CountryCode : AnsiString = ''): THPDFDictionaryObject;Einheit
HPDFDoc
Parameter
| Name | Zweck |
|---|---|
XMLBytes | Rechnungs-XML-Bytes werden unverändert in den PDF/A-3 EmbeddedFile-Stream eingebettet; der XML-Richtlinien- oder Profilidentifikator muss mit ConformanceLevel übereinstimmen |
ConformanceLevel | Zulässiges Rechnungsprofil oder Konformitätsstufe, wie EN 16931, EXTENDED, XRECHNUNG oder COMFORT für ZUGFeRD 1.0 |
FileName | Eingebetteter XML-Dateiname, geschrieben in /F, /UF, den EmbeddedFiles-Namensbaum und den XMP-Wert DocumentFileName |
Beschreibung | Optionaler Filespec-Text (/Desc), der für anwendende Werkzeuge angezeigt wird |
Relationship | Zugeordnete Dateibeziehung (AFRelationship), geschrieben als /AFRelationship und durch das ausgewählte Rechnungsprofil zulässig |
Version | Version der Rechnungs-Metadaten, einschließlich 1.0, 2p0 oder einer passenden XRECHNUNG-Version wie 3.0 |
CountryCode | Regionaler Richtliniencode, der von der Profilvalidierung verwendet wird; verwenden Sie einen leeren Wert, DE oder FR |
Rückgabewert
Gibt das indirekte Filespec-Dictionary zurück, das für die primäre Rechnungs-XML registriert wurde
Verwendungshinweise
- Setzen Sie PDFACompliance auf 3A, 3B oder 3U und rufen Sie BeginDoc auf, bevor Sie diese Methode verwenden
- Die Methode weist ungültige Kombinationen aus Dateiname, Profil und Metadatenversion zurück, sodass xrechnung.xml nur mit XRECHNUNG, ZUGFeRD-invoice.xml nur mit ZUGFeRD 1.0-Profilen, zugferd-invoice.xml nur mit Version 2p0 und factur-x.xml für aktuelle Factur-X-Profile verwendet wird
- Die Methode prüft die XML-Guideline oder Profilkennung gegen ConformanceLevel, einschließlich ZUGFeRD 1.0-Profil-URNs, aktueller Factur-X-Profil-URNs, französischer EXTENDED-Teilmengen, des EN16931-XMP- oder Profilalias, ZUGFeRD 2.0-Profil-URNs und bekannter XRechnung-CII- oder UBL-Profil-URNs mit passenden Metadatenversionen
- Für XRECHNUNG übergeben Sie Version als 1.2, 2.0, 2.1, 2.2, 2.3 oder 3.0, um diese fx:Version beizubehalten; bestehende Aufrufe, die den Standardwert von Version bei 1.0 belassen, werden auf 3.0 normalisiert
- Für ZUGFeRD 1.0-Container übergeben Sie FileName als ZUGFeRD-invoice.xml, Version als 1.0 und ConformanceLevel als BASIC, COMFORT oder EXTENDED
- Für ZUGFeRD 2.0-Container übergeben Sie FileName als zugferd-invoice.xml und Version als 2p0
- Übergeben Sie CountryCode als DE, wenn der Rechnungscontainer den deutschen ZUGFeRD-Beziehungsregeln folgen muss; MINIMUM und BASIC WL erfordern Data als AFRelationship, während BASIC, EN 16931, EXTENDED und XRECHNUNG Alternative erfordern
- Übergeben Sie CountryCode als FR, wenn die Rechnung den französischen Factur-X-Regeln folgen muss; XRECHNUNG wird abgelehnt, und BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR und EXTENDED-B2B-FR können Alternative, Source oder Data verwenden
- Die Methode verwendet den MIME-Typ text/xml, schreibt /Params /Size, /ModDate und /CheckSum, registriert die Filespec in Catalog /AF und fügt einen Catalog-/Names-/EmbeddedFiles-Eintrag für XML-Extraktionswerkzeuge hinzu
- Nachdem die primäre Rechnungs-XML registriert wurde, können spätere Aufrufe von AddPDFA3AssociatedFile unterstützende Dokumente hinzufügen; untersuchen Sie FacturXWarnings auf nicht fatale MIME-Typ-Warnungen, wenn diese Anhänge außerhalb der empfohlenen Formate für unterstützende Dokumente liegen
- Das erzeugte XMP-Paket enthält das profilspezifische PDF/A-Erweiterungsschema sowie die Felder DocumentType, DocumentFileName, Version und ConformanceLevel im passenden Rechnungs-Namespace
- Legen Sie CustomXMP nicht fest, wenn Sie diesen Helfer verwenden, da ein vom Aufrufer bereitgestelltes XMP-Paket die generierten Rechnungs-Metadaten ersetzen würde
- Es kann nur eine primäre Rechnungs-XML über diesen Helfer in einem Dokument-Workflow angehängt werden
Verwandte APIs
- THotPDF.AddPDFA3AssociatedFile-Methode
- THotPDF.FacturXWarnings Property
- THotPDF.AddPDFAOutputIntent-Methode
- THotPDF.PDFACompliance Property