THotPDF.AddFacturXAssociatedFile – metoda
Souhrn metody: THotPDF.AddFacturXAssociatedFile – metoda
Deklarace
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
Parametry
| Název | Účel |
|---|---|
XMLBytes | Bajty fakturačního XML vložené beze změny do streamu PDF/A-3 EmbeddedFile; XML guideline nebo identifikátor profilu musí odpovídat ConformanceLevel |
ConformanceLevel | Povolený fakturační profil nebo úroveň souladu, například EN 16931, EXTENDED, XRECHNUNG nebo COMFORT pro ZUGFeRD 1.0 |
FileName | Název vloženého XML souboru zapsaný do /F, /UF, stromu názvů EmbeddedFiles a hodnoty XMP DocumentFileName |
Popis | Volitelný text Filespec /Desc zobrazovaný nástrojům, které soubor konzumují |
Relationship | Vztah associated-file zapsaný jako /AFRelationship a povolený vybraným fakturačním profilem |
Version | Verze fakturačních metadat, včetně 1.0, 2p0 nebo odpovídající verze XRECHNUNG, například 3.0 |
CountryCode | Kód regionální politiky používaný validací profilu; použijte prázdnou hodnotu, DE nebo FR |
Návratová hodnota
Vrací nepřímý slovník Filespec registrovaný pro primární fakturační XML
Poznámky k použití
- Před použitím této metody nastavte PDFACompliance na 3A, 3B nebo 3U a zavolejte BeginDoc
- Metoda odmítá neplatné kombinace názvu souboru, profilu a verze metadat, takže xrechnung.xml se používá pouze s XRECHNUNG, ZUGFeRD-invoice.xml pouze s profily ZUGFeRD 1.0, zugferd-invoice.xml pouze s Version 2p0 a factur-x.xml pro aktuální profily Factur-X
- Metoda kontroluje XML guideline nebo identifikátor profilu proti ConformanceLevel, včetně URN profilů ZUGFeRD 1.0, aktuálních URN profilů Factur-X, francouzských podmnožin EXTENDED, aliasu EN16931 XMP nebo profilu, URN profilů ZUGFeRD 2.0 a známých URN profilů XRechnung CII nebo UBL s odpovídajícími verzemi metadat
- Pro XRECHNUNG předejte Version jako 1.2, 2.0, 2.1, 2.2, 2.3 nebo 3.0, aby se zachovala daná fx:Version; existující volání, která ponechají výchozí hodnotu Version na 1.0, se normalizují na 3.0
- Pro kontejnery ZUGFeRD 1.0 předejte FileName jako ZUGFeRD-invoice.xml, Version jako 1.0 a ConformanceLevel jako BASIC, COMFORT nebo EXTENDED
- Pro kontejnery ZUGFeRD 2.0 předejte FileName jako zugferd-invoice.xml a Version jako 2p0
- CountryCode nastavte na DE, když se fakturační kontejner musí řídit německými pravidly vztahů ZUGFeRD; MINIMUM a BASIC WL vyžadují Data jako AFRelationship, zatímco BASIC, EN 16931, EXTENDED a XRECHNUNG vyžadují Alternative
- CountryCode nastavte na FR, když se faktura musí řídit francouzskými pravidly Factur-X; XRECHNUNG se odmítá a BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR a EXTENDED-B2B-FR mohou použít Alternative, Source nebo Data
- Metoda používá MIME typ text/xml, zapisuje /Params /Size, /ModDate a /CheckSum, registruje Filespec v Catalog /AF a přidává položku Catalog /Names /EmbeddedFiles pro nástroje extrakce XML
- Po registraci primárního fakturačního XML mohou pozdější volání AddPDFA3AssociatedFile přidávat podpůrné dokumenty; ve FacturXWarnings zkontrolujte nefatální varování MIME typů, pokud jsou tyto přílohy mimo doporučené formáty podpůrných dokumentů
- Generovaný XMP paket obsahuje schéma rozšíření PDF/A specifické pro profil a pole DocumentType, DocumentFileName, Version a ConformanceLevel pod odpovídajícím fakturačním jmenným prostorem
- Při použití tohoto pomocníka nenastavujte CustomXMP, protože volajícím dodaný XMP paket by nahradil generovaná fakturační metadata
- V jednom workflow dokumentu lze tímto pomocníkem připojit pouze jedno primární fakturační XML
Související API
- Metoda THotPDF.AddPDFA3AssociatedFile
- Vlastnost THotPDF.FacturXWarnings
- Metoda THotPDF.AddPDFAOutputIntent
- Vlastnost THotPDF.PDFACompliance