(Excel) PayPal - Delete Draft Invoice

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.

Download Excel Class Modules Chilkat Excel Class Modules

' 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)
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
Dim success As Boolean
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = 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.
Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

success = rest.AddHeader("Authorization",sbAuth.GetAsString())


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

Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/invoicing/invoices/")
success = sbPath.Append(invoiceId)

' Send the DELETE request and get the JSON response.
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("DELETE",sbPath.GetAsString(),sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' A 204 response is expected for success.
Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 204 success response?
If (rest.ResponseStatusCode <> 204) Then
    Debug.Print "Failed."
    Exit Sub
End If

Debug.Print "Received successful 204 status code response."
Debug.Print "There is no response body, as expected."
Debug.Print "Success."