Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfInvoiceDocument

OfficeIMO.Invoicing.Pdf

Namespace
OfficeIMO.Invoicing.Pdf
Assembly
OfficeIMO.Invoicing.Pdf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Captures a typed invoice once for visible PDF content and its embedded CII attachment.

Inheritance

  • object
  • PdfInvoiceDocument

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Methods

public static PdfInvoiceDocument Create(Invoice invoice, InvoiceXmlOptions contract, InvoicePdfLayoutOptions? layout = null) #

Creates 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 required
contract OfficeIMO.Invoicing.InvoiceXmlOptions required
layout OfficeIMO.Invoicing.Pdf.InvoicePdfLayoutOptions? = null optional
public Invoice ToInvoice() #

Returns an independent editable model. After edits, call PdfInvoiceDocument.Create with an explicit contract preserving this snapshot's release and profile.

Returns

Invoice
ToPdfBytes 2 overloads
public byte[] ToPdfBytes(PdfCreateOptions? options = null) #

Renders the captured invoice and attaches its exact CII XML using Factur-X PDF/A-3 groundwork. Supported hybrid profiles are PDF/A-3a, PDF/A-3b and PDF/A-3u, optionally with PDF/UA-1. A PDF/A-3 compliance profile without identification metadata configures that requested conformance level. A PDF/UA-1 compliance profile without identification metadata configures PDF/UA-1 alongside the invoice carrier. Supply embedded fonts through the PDF options. Validate the exact output with PDF/A and invoice validators before claiming compliance.

Parameters

options OfficeIMO.Pdf.PdfCreateOptions? = null optional

Returns

byte[]
public byte[] ToPdfBytes(PdfCreateOptions? options, CancellationToken cancellationToken) #

Renders the captured hybrid invoice with cancellation support.

Parameters

options OfficeIMO.Pdf.PdfCreateOptions? required
cancellationToken System.Threading.CancellationToken required

Returns

byte[]
ToPresentationPdfBytes 2 overloads
public byte[] ToPresentationPdfBytes(PdfCreateOptions? options = null) #

Renders the captured invoice as a presentation-only PDF without attaching CII XML. Use PdfInvoiceDocument.ToPdfBytes when a Factur-X/ZUGFeRD hybrid document is required.

Parameters

options OfficeIMO.Pdf.PdfCreateOptions? = null optional

Returns

byte[]
public byte[] ToPresentationPdfBytes(PdfCreateOptions? options, CancellationToken cancellationToken) #

Renders the presentation-only invoice with cancellation support.

Parameters

options OfficeIMO.Pdf.PdfCreateOptions? required
cancellationToken System.Threading.CancellationToken required

Returns

byte[]
public byte[] ToXmlBytes() #

Returns a defensive copy of the exact CII bytes embedded in generated PDFs.

Returns

byte[]

Properties

public string Number { get; } #

Captured invoice number.

public InvoiceProfile Profile { get; } #

Captured CII authoring profile. Pass this value to PdfInvoiceDocument.Create 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.