AutoIt

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.

AutoIt

Local $bSuccess = 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)
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$oJsonToken.LoadFile("qa_data/tokens/paypal.json")

; Build the Authorization request header field value.
$oSbAuth = ObjCreate("Chilkat.StringBuilder")
; token_type should be "Bearer"
$oSbAuth.Append($oJsonToken.StringOf("token_type"))
$oSbAuth.Append(" ")
$oSbAuth.Append($oJsonToken.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.
$oRest = ObjCreate("Chilkat.Rest")
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("api.sandbox.paypal.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; ----------------------------------------------------------------------------------------------
; 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..
; ----------------------------------------------------------------------------------------------

$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())

Local $sInvoiceId = "INV2-29Z4-EB7M-MUCY-327J"

$oSbPath = ObjCreate("Chilkat.StringBuilder")
$oSbPath.Append("/v1/invoicing/invoices/")
$oSbPath.Append($sInvoiceId)

; Send the DELETE request and get the JSON response.
$oSbJsonResponse = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oRest.FullRequestNoBodySb("DELETE",$oSbPath.GetAsString(),$oSbJsonResponse)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; A 204 response is expected for success.
ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)

; Did we get a 204 success response?
If ($oRest.ResponseStatusCode <> 204) Then
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

ConsoleWrite("Received successful 204 status code response." & @CRLF)
ConsoleWrite("There is no response body, as expected." & @CRLF)
ConsoleWrite("Success." & @CRLF)