Output/HaloAPI/Public/Set/Set-HaloInvoice.ps1
|
Function Set-HaloInvoice { <# .SYNOPSIS Updates an invoice via the Halo API. .DESCRIPTION Function to send an invoice update request to the Halo API .OUTPUTS Outputs an object containing the response from the web request. #> [CmdletBinding( SupportsShouldProcess = $True )] [OutputType([Object])] Param ( # Object containing properties and values used to update an existing invoice. [Parameter( Mandatory = $True )] [Object]$Invoice ) Invoke-HaloPreFlightChecks $CommandName = $MyInvocation.InvocationName try { $ObjectToUpdate = Get-HaloInvoice -InvoiceID $Invoice.id if ($ObjectToUpdate) { if ($PSCmdlet.ShouldProcess("Invoice '$($ObjectToUpdate.invoicenumber)'", 'Update')) { New-HaloPOSTRequest -Object $Invoice -Endpoint 'invoice' -Update } } else { Throw 'Invoice was not found in Halo to update.' } } catch { $Command = $CommandName -Replace '-', '' $ErrorRecord = @{ ExceptionType = 'System.Exception' ErrorMessage = "$($CommandName) failed." InnerException = $_.Exception ErrorID = "Halo$($Command)CommandFailed" ErrorCategory = 'ReadError' TargetObject = $_.TargetObject ErrorDetails = $_.ErrorDetails BubbleUpDetails = $False } $CommandError = New-HaloErrorRecord @ErrorRecord $PSCmdlet.ThrowTerminatingError($CommandError) } } |