Metoda THotPDF.AddFacturXAssociatedFile
Podsumowanie metody: Metoda THotPDF.AddFacturXAssociatedFile
Deklaracja
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;Moduł
HPDFDoc
Parametry
| Nazwa | Cel |
|---|---|
XMLBytes | Bajty XML faktury osadzone dosłownie w strumieniu EmbeddedFile PDF/A-3; identyfikator profilu lub wytycznych XML musi być zgodny z ConformanceLevel |
ConformanceLevel | Dozwolony profil faktury lub poziom zgodności, taki jak EN 16931, EXTENDED, XRECHNUNG lub COMFORT dla ZUGFeRD 1.0 |
FileName | Nazwa osadzonego pliku XML zapisana w /F, /UF, drzewie nazw EmbeddedFiles oraz wartości XMP DocumentFileName |
Opis | Opcjonalny tekst Filespec /Desc pokazywany narzędziom przetwarzającym |
Relationship | Relacja pliku powiązanego zapisana jako /AFRelationship i dozwolona przez wybrany profil faktury |
Version | Wersja metadanych faktury, w tym 1.0, 2p0 lub pasująca wersja XRECHNUNG, taka jak 3.0 |
CountryCode | Kod polityki regionalnej używany do walidacji profilu; należy użyć pustej wartości, DE lub FR |
Wartość zwracana
Zwraca pośredni słownik Filespec zarejestrowany dla głównego pliku XML faktury
Uwagi dotyczące użycia
- Ustaw PDFACompliance na 3A, 3B lub 3U i wywołaj BeginDoc przed użyciem tej metody
- Metoda odrzuca nieprawidłowe kombinacje nazwy pliku, profilu i wersji metadanych, dzięki czemu xrechnung.xml jest używany tylko z XRECHNUNG, ZUGFeRD-invoice.xml jest używany tylko z profilami ZUGFeRD 1.0, zugferd-invoice.xml jest używany tylko z wersją 2p0, a factur-x.xml jest używany dla bieżących profili Factur-X
- Metoda sprawdza wytyczne XML lub identyfikator profilu pod kątem zgodności z ConformanceLevel, w tym URN profili ZUGFeRD 1.0, URN bieżących profili Factur-X, francuskie podzbiory EXTENDED, alias profilu lub XMP EN16931, URN profili ZUGFeRD 2.0 oraz znane URN profili XRechnung CII lub UBL z pasującymi wersjami metadanych
- Dla XRECHNUNG przekaż wersję Version jako 1.2, 2.0, 2.1, 2.2, 2.3 lub 3.0, aby zachować tę wartość fx:Version; istniejące wywołania pozostawiające domyślną wersję Version na poziomie 1.0 są normalizowane do 3.0
- Dla kontenerów ZUGFeRD 1.0 przekaż FileName jako ZUGFeRD-invoice.xml, Version jako 1.0, a ConformanceLevel jako BASIC, COMFORT lub EXTENDED
- Dla kontenerów ZUGFeRD 2.0 przekaż FileName jako zugferd-invoice.xml, a Version jako 2p0
- Przekaż CountryCode jako DE, gdy kontener faktury musi być zgodny z niemieckimi regułami relacji ZUGFeRD; MINIMUM i BASIC WL wymagają Data jako AFRelationship, natomiast BASIC, EN 16931, EXTENDED i XRECHNUNG wymagają Alternative
- Przekaż CountryCode jako FR, gdy faktura musi być zgodny z francuskimi regułami Factur-X; XRECHNUNG jest odrzucane, a BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR i EXTENDED-B2B-FR mogą używać Alternative, Source lub Data
- Metoda używa typu MIME text/xml, zapisuje /Params /Size, /ModDate i /CheckSum, rejestruje Filespec w Catalog /AF oraz dodaje wpis Catalog /Names /EmbeddedFiles dla narzędzi do ekstrakcji XML
- Po zarejestrowaniu głównego pliku XML faktury kolejne wywołania AddPDFA3AssociatedFile mogą dodawać dokumenty uzupełniające; sprawdź FacturXWarnings pod kątem niekrytycznych ostrzeżeń dotyczących typu MIME, gdy te załączniki wykraczają poza zalecane formaty dokumentów uzupełniających
- Wygenerowany pakiet XMP zawiera schemat rozszerzenia PDF/A specyficzny dla profilu oraz pola DocumentType, DocumentFileName, Version i ConformanceLevel w pasującej przestrzeni nazw faktury
- Nie ustawiaj CustomXMP podczas korzystania z tej funkcji pomocniczej, ponieważ dostarczony przez wywołującego pakiet XMP zastąpiłby wygenerowane metadane faktury
- Tylko jeden główny plik XML faktury może być dołączony za pomocą tej funkcji pomocniczej w przepływie pracy nad dokumentem
Powiązane interfejsy API
- Metoda THotPDF.AddPDFA3AssociatedFile
- Właściwość THotPDF.FacturXWarnings
- Metoda THotPDF.AddPDFAOutputIntent
- Właściwość THotPDF.PDFACompliance