API Reference
PdfInvoiceDocument
Captures a typed invoice once for visible PDF content and its embedded CII attachment.
Inheritance
- Object
- PdfInvoiceDocument
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method PdfInvoiceDocument.Create
Methods
public static PdfInvoiceDocument Create(Invoice invoice, InvoiceXmlOptions contract, InvoicePdfLayoutOptions layout = null) #PdfInvoiceDocumentCreates an independent snapshot for a document type in InvoiceDocumentTypes. Later edits to the supplied invoice cannot change its PDF or XML.
Parameters
- invoice OfficeIMO.Invoicing.Invoice
- contract OfficeIMO.Invoicing.InvoiceXmlOptions
- layout OfficeIMO.Invoicing.Pdf.InvoicePdfLayoutOptions = null
public Invoice ToInvoice() #InvoiceReturns an independent editable model. After edits, call InvoicePdfLayoutOptions) with an explicit contract preserving this snapshot's release and profile.
public Byte[] ToPdfBytes(PdfOptions options = null) #Byte[]Renders the captured invoice and attaches its exact CII XML using Factur-X PDF/A-3 groundwork. Supply embedded fonts through the PDF options. Validate the exact output with PDF/A and invoice validators before claiming compliance.
Parameters
- options OfficeIMO.Pdf.PdfOptions = null
public Byte[] ToPdfBytes(PdfOptions options, CancellationToken cancellationToken) #Byte[]Renders the captured hybrid invoice with cancellation support.
Parameters
- options OfficeIMO.Pdf.PdfOptions
- cancellationToken System.Threading.CancellationToken
public Byte[] ToPresentationPdfBytes(PdfOptions options = null) #Byte[]Renders the captured invoice as a presentation-only PDF without attaching CII XML. Use PdfOptions) when a Factur-X/ZUGFeRD hybrid document is required.
Parameters
- options OfficeIMO.Pdf.PdfOptions = null
public Byte[] ToPresentationPdfBytes(PdfOptions options, CancellationToken cancellationToken) #Byte[]Renders the presentation-only invoice with cancellation support.
Parameters
- options OfficeIMO.Pdf.PdfOptions
- cancellationToken System.Threading.CancellationToken
public Byte[] ToXmlBytes() #Byte[]Returns a defensive copy of the exact CII bytes embedded in generated PDFs.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Number { get; } #Captured invoice number.
public InvoiceProfile Profile { get; } #Captured CII authoring profile. Pass this value to InvoicePdfLayoutOptions) when recapturing an edited model.
public InvoiceSpecificationRelease Release { get; } #Captured specification release. Preserve it when recapturing an edited model.
public Decimal PayableAmount { get; } #Captured amount due in the document currency.