Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Set-OfficePdfElectronicInvoice

Aliases: PdfElectronicInvoice
Module PSWriteOffice
Aliases
PdfElectronicInvoice
Inputs
OfficeIMO.Pdf.PdfDocument
Outputs
OfficeIMO.Pdf.PdfDocument

Configures Factur-X/ZUGFeRD e-invoice groundwork on a generated PDF document.

Syntax

Set-OfficePdfElectronicInvoice [-ConformanceLevel <String>] [-Description <String>] [-PassThru] [-Path] <String> [-Profile <PdfComplianceProfile>] [-Relationship <PdfAssociatedFileRelationship>] [-Version <String>] [<CommonParameters>]
#
Parameter set: Context
Set-OfficePdfElectronicInvoice [-ConformanceLevel <String>] [-Description <String>] -Document <PdfDocument> [-PassThru] [-Path] <String> [-Profile <PdfComplianceProfile>] [-Relationship <PdfAssociatedFileRelationship>] [-Version <String>] [<CommonParameters>]
#
Parameter set: Document

Examples

Authored help example

Attach CII XML as a Factur-X payload.

New-OfficePdf -Path .\Examples\Documents\Invoice.pdf {
    Set-OfficePdfElectronicInvoice -Path .\Examples\Documents\factur-x.xml -Profile FacturX
    Add-OfficePdfHeading -Text 'Invoice'
}

Embeds the XML as canonical factur-x.xml, emits matching XMP metadata, and configures PDF/A-3 groundwork.

Parameters

-ConformanceLevel String optional
Factur-X/ZUGFeRD conformance level written to XMP metadata.
-Description String optional
Optional human-readable attachment description.
-PassThru SwitchParameter optional
Emit the updated document.
-Path String requiredposition: 0aliases: FilePath, InvoiceXmlPath, XmlPath
CrossIndustryInvoice XML file path to embed as canonical factur-x.xml.
-Profile PdfComplianceProfile optional
E-invoice profile to prepare.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2, PdfX1A2003, PdfX4
-Relationship PdfAssociatedFileRelationship optional
Associated-file relationship for the embedded XML payload.
Possible values: Unspecified, Source, Data, Alternative, Supplement, C2paManifest
-Version String optional
Factur-X/ZUGFeRD schema version written to XMP metadata.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document
Compatibility parameter. Electronic-invoice options must be declared inside New-OfficePdf.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.