Méthode THotPDF.AddFacturXAssociatedFile
Résumé de la méthode: Méthode THotPDF.AddFacturXAssociatedFile
Déclaration
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;Unité
HPDFDoc
Paramètres
| Nom | Objectif |
|---|---|
XMLBytes | Octets XML de la facture incorporés textuellement dans le flux EmbeddedFile du PDF/A-3 ; la directive XML ou l'identifiant de profil doit correspondre à ConformanceLevel |
ConformanceLevel | Profil de facture ou niveau de conformité autorisé, tel que EN 16931, EXTENDED, XRECHNUNG ou COMFORT pour ZUGFeRD 1.0 |
FileName | Nom du fichier XML incorporé écrit dans /F, /UF, l'arborescence de noms EmbeddedFiles et la valeur XMP DocumentFileName |
Description | Texte optionnel Filespec /Desc affiché pour les outils d'analyse |
Relationship | Relation de fichier associé écrite en tant que /AFRelationship et autorisée par le profil de facture sélectionné |
Version | Version des métadonnées de la facture, incluant 1.0, 2p0 ou une version XRECHNUNG correspondante telle que 3.0 |
CountryCode | Code de politique régionale utilisé par la validation du profil ; utiliser une valeur vide, DE ou FR |
Valeur de retour
Renvoie le dictionnaire Filespec indirect enregistré pour le XML de facture principal
Remarques d'utilisation
- Définir PDFACompliance sur 3A, 3B ou 3U et appeler BeginDoc avant d'utiliser cette méthode
- La méthode rejette les combinaisons invalides de nom de fichier, de profil et de version de métadonnées, de sorte que xrechnung.xml est uniquement utilisé avec XRECHNUNG, ZUGFeRD-invoice.xml uniquement avec les profils ZUGFeRD 1.0, zugferd-invoice.xml uniquement avec Version 2p0 et factur-x.xml pour les profils Factur-X actuels
- La méthode vérifie la directive XML ou l'identifiant de profil par rapport à ConformanceLevel, y compris les URN de profil ZUGFeRD 1.0, les URN de profil Factur-X actuels, les sous-ensembles EXTENDED français, l'alias XMP ou de profil EN16931, les URN de profil ZUGFeRD 2.0 et les URN de profil CII ou UBL XRechnung connus avec les versions de métadonnées correspondantes
- Pour XRECHNUNG, transmettre Version sous la forme 1.2, 2.0, 2.1, 2.2, 2.3 ou 3.0 afin de préserver cette valeur fx:Version ; les appels existants qui laissent la valeur par défaut de Version à 1.0 sont normalisés à 3.0
- Pour les conteneurs ZUGFeRD 1.0, transmettre FileName sous la forme ZUGFeRD-invoice.xml, Version sous la forme 1.0 et ConformanceLevel sous la forme BASIC, COMFORT ou EXTENDED
- Pour les conteneurs ZUGFeRD 2.0, transmettre FileName sous la forme zugferd-invoice.xml et Version sous la forme 2p0
- Transmettre CountryCode sous la forme DE lorsque le conteneur de facture doit suivre les règles de relation allemandes ZUGFeRD ; MINIMUM et BASIC WL requièrent Data comme AFRelationship, tandis que BASIC, EN 16931, EXTENDED et XRECHNUNG requièrent Alternative
- Transmettre CountryCode sous la forme FR lorsque la facture doit suivre les règles françaises Factur-X ; XRECHNUNG est rejeté et BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR et EXTENDED-B2B-FR peuvent utiliser Alternative, Source ou Data
- La méthode utilise le type MIME text/xml, écrit /Params /Size, /ModDate et /CheckSum, enregistre le Filespec dans le Catalog /AF, et ajoute une entrée Catalog /Names /EmbeddedFiles pour les outils d'extraction XML
- Après l'enregistrement du XML de facture principal, les appels ultérieurs à AddPDFA3AssociatedFile peuvent ajouter des documents d'accompagnement ; inspecter FacturXWarnings pour les avertissements de type MIME non fatals lorsque ces pièces jointes sont en dehors des formats de documents d'accompagnement recommandés
- Le paquet XMP généré inclut le schéma d'extension PDF/A spécifique au profil ainsi que les champs DocumentType, DocumentFileName, Version et ConformanceLevel sous le namespace de facture correspondant
- Ne pas définir CustomXMP lors de l'utilisation de cet assistant, car un paquet XMP fourni par l'appelant remplacerait les métadonnées de facture générées
- Un seul XML de facture principal peut être attaché via cet assistant dans un flux de travail de document
APIs associées
- Méthode THotPDF.AddPDFA3AssociatedFile
- Propriété THotPDF.FacturXWarnings
- Méthode THotPDF.AddPDFAOutputIntent
- Propriété THotPDF.PDFACompliance