PowerShell

PayPal - Delete Draft Invoice

See more PayPal Examples

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can cancel the invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

# Note: Requires Chilkat v9.5.0.65 or greater.

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Load our previously obtained access token. (see PayPal OAuth2 Access Token)
$jsonToken = New-Object Chilkat.JsonObject
$jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
$sbAuth = New-Object Chilkat.StringBuilder
# token_type should be "Bearer"
$sbAuth.Append($jsonToken.StringOf("token_type"))
$sbAuth.Append(" ")
$sbAuth.Append($jsonToken.StringOf("access_token"))

# Make the initial connection.
# A single REST object, once connected, can be used for many PayPal REST API calls.
# The auto-reconnect indicates that if the already-established HTTPS connection is closed,
# then it will be automatically re-established as needed.
$rest = New-Object Chilkat.Rest
$bAutoReconnect = $true
$success = $rest.Connect("api.sandbox.paypal.com",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# ----------------------------------------------------------------------------------------------
# The code above this comment could be placed inside a function/subroutine within the application
# because the connection does not need to be made for every request.  Once the connection is made
# the app may send many requests..
# ----------------------------------------------------------------------------------------------

$rest.AddHeader("Authorization",$sbAuth.GetAsString())

$invoiceId = "INV2-29Z4-EB7M-MUCY-327J"

$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/v1/invoicing/invoices/")
$sbPath.Append($invoiceId)

# Send the DELETE request and get the JSON response.
$sbJsonResponse = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("DELETE",$sbPath.GetAsString(),$sbJsonResponse)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# A 204 response is expected for success.
$("Response Status Code = " + $rest.ResponseStatusCode)

# Did we get a 204 success response?
if ($rest.ResponseStatusCode -ne 204) {
    $("Failed.")
    exit
}

$("Received successful 204 status code response.")
$("There is no response body, as expected.")
$("Success.")