Get-OCIOspgatewayInvoicesList

SYNOPSIS

Invokes InvoiceService service - ListInvoices operation.

SYNTAX

Limit

Get-OCIOspgatewayInvoicesList -OspHomeRegion <String> -CompartmentId <String> [-OpcRequestId <String>] [-InvoiceId <String>] [-Type <System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+TypeEnum]>] [-SearchText <String>] [-TimeInvoiceStart <DateTime>] [-TimeInvoiceEnd <DateTime>] [-TimePaymentStart <DateTime>] [-TimePaymentEnd <DateTime>] [-Status <System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+StatusEnum]>] [-Page <String>] [-Limit <Int32>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIOspgatewayInvoicesList -OspHomeRegion <String> -CompartmentId <String> [-OpcRequestId <String>] [-InvoiceId <String>] [-Type <System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+TypeEnum]>] [-SearchText <String>] [-TimeInvoiceStart <DateTime>] [-TimeInvoiceEnd <DateTime>] [-TimePaymentStart <DateTime>] [-TimePaymentEnd <DateTime>] [-Status <System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+StatusEnum]>] [-Page <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Returns a list of invoices

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompartmentId

The OCID of the compartment.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InvoiceId

The invoice query param (not unique).

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OpcRequestId

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OspHomeRegion

The home region's public name of the logged in user.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

For list pagination. The value of the opc-next-page response header from the previous "List" call.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SearchText

A filter to only return resources that match the given value. Looking for partial matches in the following fileds: Invoice No., Reference No. (plan number), Payment Ref, Total Amount(plan number), Balance Due(plan number) and Party/Customer Name

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The field to sort by. Only one field can be selected for sorting.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: InvoiceNo, RefNo, Status, Type, InvoiceDate, DueDate, PaymRef, TotalAmount, BalanceDue

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use (ascending or descending).

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Status

A filter to only return resources that match one of the status elements.

Type: System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+StatusEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Open, PastDue, PaymentSubmitted, Closed

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeInvoiceEnd

description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeInvoiceStart

description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TimePaymentEnd

description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimePaymentStart

description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).

Type: DateTime
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Type

A filter to only return resources that match the given type exactly.

Type: System.Collections.Generic.List`1[Oci.OspgatewayService.Requests.ListInvoicesRequest+TypeEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Hardware, Subscription, Support, License, Education, Consulting, Service, Usage

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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

OUTPUTS

• Oci.OspgatewayService.Models.InvoiceCollection
• Oci.OspgatewayService.Responses.ListInvoicesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples