THotPDF.AddFacturXAssociatedFile Method
Resumo do método: THotPDF.AddFacturXAssociatedFile Method
Declaração
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;Unidade
HPDFDoc
Parâmetros
| Nome | Propósito |
|---|---|
XMLBytes | Bytes XML da fatura incorporados literalmente no fluxo EmbeddedFile do PDF/A-3; o identificador da diretriz ou perfil XML deve corresponder a ConformanceLevel |
ConformanceLevel | Perfil de fatura ou nível de conformidade permitido, como EN 16931, EXTENDED, XRECHNUNG ou COMFORT para ZUGFeRD 1.0 |
FileName | Nome do arquivo XML incorporado gravado em /F, /UF, na árvore de nomes EmbeddedFiles e no valor XMP DocumentFileName |
Descrição | Texto opcional Filespec /Desc exibido para as ferramentas de leitura |
Relationship | Relação de arquivo associado gravada como /AFRelationship e permitida pelo perfil de fatura selecionado |
Version | Versão dos metadatos da fatura, incluindo 1.0, 2p0 ou uma versão correspondente do XRECHNUNG, como 3.0 |
CountryCode | Código de política regional usado pela validação do perfil; use um valor vazio, DE ou FR |
Valor de retorno
Retorna o dicionário Filespec indireto registrado para o XML principal da fatura
Notas de uso
- Defina PDFACompliance como 3A, 3B ou 3U e chame BeginDoc antes de usar este método
- O método rejeita combinações inválidas de nome de arquivo, perfil e versão de metadatos, de modo que xrechnung.xml seja usado apenas com XRECHNUNG, ZUGFeRD-invoice.xml seja usado apenas com perfis do ZUGFeRD 1.0, zugferd-invoice.xml seja usado apenas com a versão 2p0 e factur-x.xml seja usado para os perfis atuais do Factur-X
- O método verifica a diretriz XML ou o identificador de perfil em relação a ConformanceLevel, incluindo URNs de perfil do ZUGFeRD 1.0, URNs de perfil atuais do Factur-X, subconjuntos EXTENDED franceses, o alias de perfil ou XMP EN16931, URNs de perfil do ZUGFeRD 2.0 e URNs de perfil conhecidos do XRechnung CII ou UBL com versões de metadatos correspondentes
- Para XRECHNUNG, passe Version como 1.2, 2.0, 2.1, 2.2, 2.3 ou 3.0 para preservar esse fx:Version; chamadas existentes que deixam o valor padrão de Version em 1.0 são normalizadas para 3.0
- Para contêineres ZUGFeRD 1.0, passe FileName como ZUGFeRD-invoice.xml, Version como 1.0 e ConformanceLevel como BASIC, COMFORT ou EXTENDED
- Para contêineres ZUGFeRD 2.0, passe FileName como zugferd-invoice.xml e Version como 2p0
- Passe CountryCode como DE quando o contêiner da fatura deve seguir as regras de relacionamento alemãs do ZUGFeRD; MINIMUM e BASIC WL exigem Data como AFRelationship, enquanto BASIC, EN 16931, EXTENDED e XRECHNUNG exigem Alternative
- Passe CountryCode como FR quando a fatura deve seguir as regras francesas do Factur-X; XRECHNUNG é rejeitado e BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR e EXTENDED-B2B-FR podem usar Alternative, Source ou Data
- O método usa o tipo MIME text/xml, grava /Params /Size, /ModDate e /CheckSum, registra o Filespec no Catalog /AF e adiciona uma entrada de Catalog /Names /EmbeddedFiles para ferramentas de extração de XML
- Depois que o XML da fatura principal for registrado, chamadas posteriores de AddPDFA3AssociatedFile poderão adicionar documentos de suporte; inspecione FacturXWarnings para avisos de tipo MIME não fatais quando esses anexos estiverem fora dos formatos recomendados de documento de suporte
- O pacote XMP gerado inclui o esquema de extensão PDF/A específico do perfil, além dos campos DocumentType, DocumentFileName, Version e ConformanceLevel sob o namespace correspondente da fatura
- Não defina CustomXMP ao usar este assistente, pois um pacote XMP fornecido pelo chamador substituiria os metadatos gerados da fatura
- Apenas um XML de fatura principal pode ser anexado por meio deste assistente em um fluxo de trabalho de documento
APIs relacionadas
- THotPDF.AddPDFA3AssociatedFile Method
- THotPDF.FacturXWarnings Property
- THotPDF.AddPDFAOutputIntent Method
- THotPDF.PDFACompliance Property