VB.NET

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.

VB.NET

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

' Build the Authorization request header field value.
Dim sbAuth As New 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.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.WriteLine(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..
' ----------------------------------------------------------------------------------------------

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

Dim invoiceId As String = "INV2-29Z4-EB7M-MUCY-327J"

Dim sbPath As New Chilkat.StringBuilder
sbPath.Append("/v1/invoicing/invoices/")
sbPath.Append(invoiceId)

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


' A 204 response is expected for success.
Debug.WriteLine("Response Status Code = " & rest.ResponseStatusCode)

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


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