THotPDF.AddFacturXAssociatedFile Method
Сводка метода: THotPDF.AddFacturXAssociatedFile Method
Объявление
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;Модуль
HPDFDoc
Параметры
| Имя | Назначение |
|---|---|
XMLBytes | Байты XML счета, встроенные буквально в поток EmbeddedFile PDF/A-3; идентификатор руководства или профиля XML должен соответствовать ConformanceLevel |
ConformanceLevel | Допустимый профиль счета или уровень соответствия, например EN 16931, EXTENDED, XRECHNUNG или COMFORT для ZUGFeRD 1.0 |
FileName | Имя файла встроенного XML, записываемое в /F, /UF, дерево имен EmbeddedFiles и значение XMP DocumentFileName |
Описание | Необязательный текст Filespec /Desc, отображаемый для инструментов чтения |
Relationship | Связь ассоциированного файла, записываемая как /AFRelationship и разрешенная выбранным профилем счета |
Version | Версия метаданных счета, включая 1.0, 2p0 или соответствующую версию XRECHNUNG, например 3.0 |
CountryCode | Код региональной политики, используемый при валидации профиля; используйте пустое значение, DE или FR |
Возвращаемое значение
Возвращает косвенный словарь Filespec, зарегистрированный для основного XML-файла счета
Примечания по использованию
- Установите PDFACompliance в значение 3A, 3B или 3U и вызовите BeginDoc перед использованием этого метода
- Метод отклоняет недопустимые комбинации имени файла, профиля и версии метаданных, поэтому xrechnung.xml используется только с XRECHNUNG, ZUGFeRD-invoice.xml — только с профилями ZUGFeRD 1.0, zugferd-invoice.xml — только с версией 2p0, а factur-x.xml — с текущими профилями Factur-X
- Метод сверяет руководство XML или идентификатор профиля с ConformanceLevel, включая URN профилей ZUGFeRD 1.0, текущие URN профилей Factur-X, французские подмножества EXTENDED, XMP или псевдоним профиля EN16931, URN профилей ZUGFeRD 2.0 и известные URN профилей XRechnung CII или UBL с соответствующими версиями метаданных
- Для XRECHNUNG передайте Version как 1.2, 2.0, 2.1, 2.2, 2.3 или 3.0, чтобы сохранить fx:Version; существующие вызовы, которые оставляют значение Version по умолчанию равным 1.0, нормализуются до 3.0
- Для контейнеров ZUGFeRD 1.0 передайте FileName как ZUGFeRD-invoice.xml, Version как 1.0, а ConformanceLevel как BASIC, COMFORT или EXTENDED
- Для контейнеров ZUGFeRD 2.0 передайте FileName как zugferd-invoice.xml, а Version как 2p0
- Передайте CountryCode как DE, если контейнер счета должен соответствовать немецким правилам отношений ZUGFeRD; для MINIMUM и BASIC WL требуется Data в качестве AFRelationship, а для BASIC, EN 16931, EXTENDED и XRECHNUNG требуется Alternative
- Передайте CountryCode как FR, если счет должен соответствовать французским правилам Factur-X; XRECHNUNG отклоняется, а BASIC, EN 16931, EXTENDED, EXTENDED-CTC-FR и EXTENDED-B2B-FR могут использовать Alternative, Source или Data
- Метод использует MIME-тип text/xml, записывает /Params /Size, /ModDate и /CheckSum, регистрирует Filespec в Catalog /AF и добавляет запись Catalog /Names /EmbeddedFiles для инструментов извлечения XML
- После регистрации основного XML-файла счета последующие вызовы AddPDFA3AssociatedFile могут добавлять сопроводительные документы; проверяйте FacturXWarnings на наличие некритических предупреждений о MIME-типе, если эти вложения выходят за рамки рекомендуемых форматов сопроводительных документов
- Сгенерированный пакет XMP включает схему расширения PDF/A, специфичную для профиля, плюс поля DocumentType, DocumentFileName, Version и ConformanceLevel под соответствующим пространством имен счета
- Не устанавливайте CustomXMP при использовании этого помощника, так как предоставленный вызывающей стороной пакет XMP заменит сгенерированные метаданные счета
- В рамках рабочего процесса документа через этот помощник можно прикрепить только один основной XML-файл счета
Связанные API
- THotPDF.AddPDFA3AssociatedFile Method
- THotPDF.FacturXWarnings Property
- THotPDF.AddPDFAOutputIntent Method
- THotPDF.PDFACompliance Property