Get Started

API Reference

Cmdlet

Set-OfficePdfElectronicInvoice

Aliases: PdfElectronicInvoice
Namespace PSWriteOffice
Aliases
PdfElectronicInvoice
Inputs
OfficeIMO.Pdf.PdfDocument
Outputs
OfficeIMO.Pdf.PdfDocument
Source
Sources/PSWriteOffice/Cmdlets/Pdf/SetOfficePdfElectronicInvoiceCommand.cs:18 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Attach CII XML as a Factur-X payload.

PS>


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.

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.

Syntax

Set-OfficePdfElectronicInvoice [-ConformanceLevel <String>] [-Description <String>] [-PassThru] -Path <String> [-Profile <PdfA2B>] [-Relationship <Unspecified|Source|Data|Alternative|Supplement>] [-Version <String>] [<CommonParameters>]
#
Parameter set: Context

Parameters

ConformanceLevel String optionalposition: namedpipeline: False
Factur-X/ZUGFeRD conformance level written to XMP metadata.
Description String optionalposition: namedpipeline: False
Optional human-readable attachment description.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated document.
Path String requiredposition: 0pipeline: Falsealiases: FilePath, InvoiceXmlPath, XmlPath
CrossIndustryInvoice XML file path to embed as canonical factur-x.xml.
Profile PdfComplianceProfile optionalposition: namedpipeline: Falsevalues: 13
E-invoice profile to prepare.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2
Relationship PdfAssociatedFileRelationship optionalposition: namedpipeline: Falsevalues: 5
Associated-file relationship for the embedded XML payload.
Possible values: Unspecified, Source, Data, Alternative, Supplement
Version String optionalposition: namedpipeline: False
Factur-X/ZUGFeRD schema version written to XMP metadata.

Outputs

OfficeIMO.Pdf.PdfDocument

Set-OfficePdfElectronicInvoice [-ConformanceLevel <String>] [-Description <String>] -Document <PdfDocument> [-PassThru] -Path <String> [-Profile <PdfA2B>] [-Relationship <Unspecified|Source|Data|Alternative|Supplement>] [-Version <String>] [<CommonParameters>]
#
Parameter set: Document

Parameters

ConformanceLevel String optionalposition: namedpipeline: False
Factur-X/ZUGFeRD conformance level written to XMP metadata.
Description String optionalposition: namedpipeline: False
Optional human-readable attachment description.
Document PdfDocument requiredposition: namedpipeline: True (ByValue)
PDF document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated document.
Path String requiredposition: 0pipeline: Falsealiases: FilePath, InvoiceXmlPath, XmlPath
CrossIndustryInvoice XML file path to embed as canonical factur-x.xml.
Profile PdfComplianceProfile optionalposition: namedpipeline: Falsevalues: 13
E-invoice profile to prepare.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2
Relationship PdfAssociatedFileRelationship optionalposition: namedpipeline: Falsevalues: 5
Associated-file relationship for the embedded XML payload.
Possible values: Unspecified, Source, Data, Alternative, Supplement
Version String optionalposition: namedpipeline: False
Factur-X/ZUGFeRD schema version written to XMP metadata.

Outputs

OfficeIMO.Pdf.PdfDocument