Get-PortInvoiceVisualCopy

ÜBERSICHT

Erzeugt eine visuelle PDF-Kopie einer E-Rechnung über die portinvoice.com API.

SYNTAX

Get-PortInvoiceVisualCopy [-FilePath] <string> [-ApiToken] <string> [[-OutputPath] <string>]
    [[-Language] <string>] [[-BaseUrl] <string>] [-PassThru] [<CommonParameters>]

BESCHREIBUNG

Sendet eine Rechnungsdatei (XML oder ZUGFeRD-PDF) an die portinvoice.com REST-API und erhält eine menschenlesbare PDF-Darstellung zurück. Das Ergebnis kann als Datei gespeichert oder als Byte-Array zurückgegeben werden.

Voraussetzung: Ein portinvoice.com-Konto mit Embedded-Edition-Zugang. Der API-Token wird im Konto unter OpenAPI generiert.

PARAMETER

-FilePath

Type: string

Pfad zur Rechnungsdatei (XML oder PDF).

-ApiToken

Type: string

Bearer-Token für die portinvoice.com API (aus dem Konto-Bereich).

-OutputPath

Type: string

Optionaler Pfad für die Ausgabe-PDF. Wenn nicht angegeben, wird der Dateiname der Eingabe mit dem Suffix '-visual' verwendet.

-Language

Type: string
Default: 'de'

Sprache für die visuelle Darstellung. Standard: 'de'.

-BaseUrl

Type: string
Default: 'https://portinvoice.obwyse.net/API'

Basis-URL der API. Standard: 'https://portinvoice.obwyse.net/API'.

-PassThru

Type: switch

Gibt das PDF als Byte-Array zurück statt es in eine Datei zu schreiben.

AUSGABEN

string

Pfad zur erzeugten PDF-Datei (Standardverhalten). byte[] PDF-Bytes wenn -PassThru angegeben ist.

BEISPIELE

Get-PortInvoiceVisualCopy -FilePath 'rechnung.xml' -ApiToken 'eyJ...'

Get-PortInvoiceVisualCopy -FilePath 'zugferd.pdf' -ApiToken 'eyJ...' -OutputPath 'visual.pdf'

$pdfBytes = Get-PortInvoiceVisualCopy -FilePath 'rechnung.xml' -ApiToken $token -PassThru