Metóda THotPDF.AddFacturXAssociatedFile
Súhrn metódy: Metóda THotPDF.AddFacturXAssociatedFile
Deklarácia
function AddFacturXAssociatedFile(const XMLBytes : TBytes; const ConformanceLevel : AnsiString; const FileName : AnsiString = 'factur-x.xml'; const Description : AnsiString = 'Factur-X invoice XML'; const Relationship : AnsiString = 'Alternative'; const Version : AnsiString = '1.0'; const CountryCode : AnsiString = ''): THPDFDictionaryObject;Jednotka
HPDFDoc
Parametre
| Názov | Účel |
|---|---|
XMLBytes | XML bajty faktúry vložené presne tak, ako sú, do streamu PDF/A-3 EmbeddedFile; smernica XML alebo identifikátor profilu sa musí zhodovať s ConformanceLevel |
ConformanceLevel | Povolený profil faktúry alebo úroveň zhody, napríklad EN 16931, EXTENDED, XRECHNUNG alebo COMFORT pre ZUGFeRD 1.0 |
FileName | Názov vloženého súboru XML zapísaný do /F, /UF, stromu názvov EmbeddedFiles a hodnoty XMP DocumentFileName |
Opis | Voliteľný text Filespec /Desc zobrazený spotrebiteľským nástrojom |
Relationship | Vzťah pridruženého súboru zapísaný ako /AFRelationship a povolený vybraným profilom faktúry |
Version | Verzia metadát faktúry, vrátane 1.0, 2p0 alebo zodpovedajúcej verzie XRECHNUNG, napríklad 3.0 |
CountryCode | Regionálny kód pravidiel používaný pri validácii profilu; použite prázdnu hodnotu, DE alebo FR |
Návratová hodnota
Vráti nepriamy slovník Filespec zaregistrovaný pre primárne XML faktúry
Poznámky k používaniu
- Pred použitím tejto metódy nastavte PDFACompliance na 3A, 3B alebo 3U a zavolajte BeginDoc
- Metóda odmieta neplatné kombinácie názvu súboru, profilu a verzie metadát, takže xrechnung.xml sa používa iba s XRECHNUNG, ZUGFeRD-invoice.xml sa používa iba s profilmi ZUGFeRD 1.0, zugferd-invoice.xml sa používa iba s Version 2p0 a factur-x.xml sa používa pre aktuálne profily Factur-X
- Metóda kontroluje smernicu XML alebo identifikátor profilu voči ConformanceLevel, vrátane URN profilov ZUGFeRD 1.0, aktuálnych URN profilov Factur-X, francúzskych podsad EXTENDED, XMP alebo profilového aliasu EN16931, URN profilov ZUGFeRD 2.0 a známych URN profilov XRechnung CII alebo UBL so zodpovedajúcimi verziami metadát
- Pre XRECHNUNG odovzdajte Version ako 1.2, 2.0, 2.1, 2.2, 2.3 alebo 3.0 na zachovanie danej fx:Version; existujúce volania, ktoré ponechávajú predvolenú hodnotu Version na 1.0, sa normalizujú na 3.0
- Pre kontajnery ZUGFeRD 1.0 odovzdajte FileName ako ZUGFeRD-invoice.xml, Version ako 1.0 a ConformanceLevel ako BASIC, COMFORT alebo EXTENDED
- Pre kontajnery ZUGFeRD 2.0 odovzdajte FileName ako zugferd-invoice.xml a Version ako 2p0
- Odovzdajte CountryCode ako DE, keď kontajner faktúry musí spĺňať nemecké pravidlá vzťahov ZUGFeRD; MINIMUM a BASIC WL vyžadujú Data ako AFRelationship, zatiaľ čo BASIC, EN 16931, EXTENDED a XRECHNUNG vyžadujú Alternative
- Odovzdajte CountryCode ako FR, keď faktúra musí spĺňať francúzske pravidlá Factur-X; XRECHNUNG je odmietnuté a BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR a EXTENDED-B2B-FR môžu používať Alternative, Source alebo Data
- Metóda používa MIME typ text/xml, zapisuje /Params /Size, /ModDate a /CheckSum, registruje Filespec v Catalog /AF a pridáva záznam Catalog /Names /EmbeddedFiles pre nástroje na extrakciu XML
- Po zaregistrovaní primárneho XML faktúry môžu neskoršie volania AddPDFA3AssociatedFile pridať podporné dokumenty; skontrolujte FacturXWarnings pre nefatálne varovania ohľadom typu MIME, keď sú tieto prílohy mimo odporúčaných formátov podporných dokumentov
- Generovaný balík XMP obsahuje špecifickú schému rozšírenia PDF/A pre daný profil plus polia DocumentType, DocumentFileName, Version a ConformanceLevel pod zodpovedajúcim menným priestorom faktúry
- Pri použití tohto pomocníka nenastavujte CustomXMP, pretože balík XMP poskytnutý volajúcim by nahradil generované metadáta faktúry
- Počas pracovného postupu dokumentu môže byť prostredníctvom tohto pomocníka pripojené iba jedno primárne XML faktúry
Súvisiace API
- Metóda THotPDF.AddPDFA3AssociatedFile
- Vlastnosť THotPDF.FacturXWarnings
- Metóda THotPDF.AddPDFAOutputIntent
- Vlastnosť THotPDF.PDFACompliance