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 و مقدار DocumentFileName XMP نوشته میشود |
توضیح | متن اختیاری 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 ارسال کنید
- زمانی که کانتینر فاکتور باید از قوانین رابطه ZUGFeRD آلمان پیروی کند، CountryCode را به صورت DE ارسال کنید؛ MINIMUM و BASIC WL به Data به عنوان AFRelationship نیاز دارند، در حالی که BASIC، EN 16931، EXTENDED و XRECHNUNG به Alternative نیاز دارند
- زمانی که فاکتور باید از قوانین Factur-X فرانسه پیروی کند، CountryCode را به صورت FR ارسال کنید؛ 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