THotPDF.AddFacturXAssociatedFile metódus
Metódus összefoglaló: THotPDF.AddFacturXAssociatedFile metódus
Deklaráció
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;
Egység
HPDFDoc
Paraméterek
| Név | Cél |
|---|---|
XMLBytes | A PDF/A-3 EmbeddedFile streambe szó szerint beágyazott számla XML bájtok; az XML irányelvnek vagy profilazonosítónak meg kell egyeznie a ConformanceLevel értékkel |
ConformanceLevel | Engedélyezett számlaprofil vagy megfelelőségi szint, például EN 16931, EXTENDED, XRECHNUNG, vagy COMFORT a ZUGFeRD 1.0-hoz |
FileName | Beágyazott XML fájlnév, amely az /F, /UF elemekbe, az EmbeddedFiles név fába és az XMP DocumentFileName értékbe íródik |
Leírás | Opcionális Filespec /Desc szöveg, amely a feldolgozó eszközök számára látható |
Relationship | Társított-fájl kapcsolat, amely /AFRelationship értékként íródik be, és amelyet a kiválasztott számlaprofil engedélyez |
Version | Számla metaadat verziója, beleértve az 1.0-t, 2p0-t vagy egy egyező XRECHNUNG verziót, mint például a 3.0 |
CountryCode | A profilvalidálás által használt regionális irányelv kód; használjon üres értéket, DE-t vagy FR-t |
Visszatérési érték
Visszaadja az elsődleges számla XML-hez regisztrált közvetett Filespec szótárt
Használati megjegyzések
- Állítsa be a PDFACompliance tulajdonságot 3A, 3B vagy 3U értékre, és hívja meg a BeginDoc metódust a metódus használata előtt
- A metódus elutasítja a helytelen fájlnév, profil és metaadat-verzió kombinációkat, így az xrechnung.xml csak az XRECHNUNG-hoz, a ZUGFeRD-invoice.xml csak a ZUGFeRD 1.0 profilokhoz, a zugferd-invoice.xml csak a 2p0 verzióhoz, a factur-x.xml pedig a jelenlegi Factur-X profilokhoz használatos
- A metódus ellenőrzi az XML irányelvet vagy profilazonosítót a ConformanceLevel értékkel szemben, beleértve a ZUGFeRD 1.0 profil URN-eket, a jelenlegi Factur-X profil URN-eket, a francia EXTENDED részhalmazokat, az EN16931 XMP-t vagy profil álnevet, a ZUGFeRD 2.0 profil URN-eket, valamint az ismert XRechnung CII vagy UBL profil URN-eket a megfelelő metaadat-verziókkal
- XRECHNUNG esetén adja meg a Version paramétert 1.2, 2.0, 2.1, 2.2, 2.3 vagy 3.0 értékként az fx:Version megőrzéséhez; a meglévő hívások, amelyek a Version alapértelmezett értékét 1.0-n hagyják, 3.0-ra lesznek normalizálva
- ZUGFeRD 1.0 konténerek esetén adja meg a FileName paramétert ZUGFeRD-invoice.xml-ként, a Version paramétert 1.0-ként, a ConformanceLevel paramétert pedig BASIC, COMFORT vagy EXTENDED értékként
- ZUGFeRD 2.0 konténerek esetén adja meg a FileName paramétert zugferd-invoice.xml-ként, a Version paramétert pedig 2p0-ként
- Adja meg a CountryCode paramétert DE-ként, ha a számlakonténernek a német ZUGFeRD kapcsolati szabályokat kell követnie; a MINIMUM és a BASIC WL az AFRelationship értéket követeli meg Data-ként, míg a BASIC, az EN 16931, az EXTENDED és az XRECHNUNG az Alternative értéket igényli
- Adja meg a CountryCode paramétert FR-ként, ha a számlának a francia Factur-X szabályokat kell követnie; az XRECHNUNG elutasításra kerül, míg a BASIC, az EN 16931, az EXTENDED, az EXTENDED-CTC-FR és az EXTENDED-B2B-FR az Alternative, Source vagy Data értéket használhatja
- A metódus a text/xml MIME-típust használja, beírja a /Params /Size, /ModDate és /CheckSum értékeket, regisztrálja a Filespec-et a Catalog /AF-ben, és hozzáad egy Catalog /Names /EmbeddedFiles bejegyzést az XML kinyerő eszközök számára
- Az elsődleges számla XML regisztrálása után a későbbi AddPDFA3AssociatedFile hívások támogató dokumentumokat adhatnak hozzá; ellenőrizze a FacturXWarnings tulajdonságot a nem kritikus MIME-típus figyelmeztetésekért, ha ezek a mellékletek kívül esnek az ajánlott támogató dokumentumformátumokon
- A generált XMP csomag tartalmazza a profilspecifikus PDF/A kiterjesztési sémát, valamint a DocumentType, DocumentFileName, Version és ConformanceLevel mezőket a megfelelő számla névtér alatt
- Ne állítsa be a CustomXMP tulajdonságot ezen segédfüggvény használatakor, mert a hívó által megadott XMP csomag felülírná a generált számla metaadatokat
- Dokumentum-munkafolyamatonként csak egy elsődleges számla XML csatolható ezen segédfüggvény segítségével
Kapcsolódó API-k
- THotPDF.AddPDFA3AssociatedFile metódus
- THotPDF.FacturXWarnings tulajdonság
- THotPDF.AddPDFAOutputIntent metódus
- THotPDF.PDFACompliance tulajdonság