Get-HaloInvoice
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets invoices from the Halo API.
SYNTAX
Multi (Default)
Get-HaloInvoice [-Count <Int32>] [-Search <String>] [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>]
[-OrderBy <String>] [-OrderByDesc] [-OrderBy2 <String>] [-OrderByDesc2] [-OrderBy3 <String>] [-OrderByDesc3]
[-OrderBy4 <String>] [-OrderByDesc4] [-OrderBy5 <String>] [-OrderByDesc5] [-TicketID <Int32>]
[-ClientID <Int32>] [-SiteID <Int32>] [-UserID <Int32>] [-PostedOnly] [-NotPostedOnly]
[-PaymentStatuses <String>] [-PaymentStatusIds <Int64[]>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Single
Get-HaloInvoice -InvoiceID <Int64> [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves invoices from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-InvoiceID
Invoice ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Count
The number of invoices to return if not using pagination.
Type: Int32
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Search
Return contracts matching the search term in the results.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Paginate
Paginate results
Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
Number of results per page.
Type: Int32
Parameter Sets: Multi
Aliases: page_size
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PageNo
Which page to return.
Type: Int32
Parameter Sets: Multi
Aliases: page_no
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy
First field to order the results by.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc
Order results for the first field in descending order (respects the field choice in '-OrderBy')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy2
Second field to order the results by.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc2
Order results for the second field in descending order (respects the field choice in '-OrderBy2')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy3
Third field to order the results by.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc3
Order results for the third field in descending order (respects the field choice in '-OrderBy3')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy4
Fourth field to order the results by.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc4
Order results for the fourth field in descending order (respects the field choice in '-OrderBy4')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OrderBy5
Fifth field to order the results by.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrderByDesc5
Order results for the fifth field in descending order (respects the field choice in '-OrderBy5')
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TicketID
Filter by the specified ticket ID.
Type: Int32
Parameter Sets: Multi
Aliases: ticket_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ClientID
Filter by the specified client ID.
Type: Int32
Parameter Sets: Multi
Aliases: client_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-SiteID
Filter by the specified site ID.
Type: Int32
Parameter Sets: Multi
Aliases: site_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-UserID
Filter by the specified user ID.
Type: Int32
Parameter Sets: Multi
Aliases: user_id
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-PostedOnly
Filter for posted invoices only.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-NotPostedOnly
Filter for non-posted invoices only.
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PaymentStatuses
Filter by payment status. Provide a string separated by HTML encoded commas.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PaymentStatusIds
Filter by payment status. Provide an array of integers.
Type: Int64[]
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.