Share via


Get-PartnerInvoiceStatement

Gets an invoice statement using the invoice identifier.

Syntax

Default (Default)

Get-PartnerInvoiceStatement
    -InvoiceId <String>
    [-OutputPath <String>]
    [-Overwrite]
    [<CommonParameters>]

Description

Gets an invoice statement using the invoice identifier and writes it to the specified path.

Examples

Example 1

PS C:\> Get-PartnerInvoiceStatement -InvoiceId G000024135 -OutputPath 'C:\Invoices\'

Downloads the invoice statement associated with the invoice with the identifier of G000024135.

Parameters

-InvoiceId

The invoice id of the statement to retrieve.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutputPath

The output path of the PDF statement file.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Overwrite

A flag indicating whether or to overwrite the file if it exists.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object