(Tcl) 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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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)
set jsonToken [new_CkJsonObject]

CkJsonObject_LoadFile $jsonToken "qa_data/tokens/paypal.json"

# Build the Authorization request header field value.
set sbAuth [new_CkStringBuilder]

# token_type should be "Bearer"
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "token_type"]
CkStringBuilder_Append $sbAuth " "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "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.
set rest [new_CkRest]

set bAutoReconnect 1
set success [CkRest_Connect $rest "api.sandbox.paypal.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    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..
# ----------------------------------------------------------------------------------------------

CkRest_AddHeader $rest "Authorization" [CkStringBuilder_getAsString $sbAuth]

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

set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/v1/invoicing/invoices/"
CkStringBuilder_Append $sbPath $invoiceId

# Send the DELETE request and get the JSON response.
set sbJsonResponse [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "DELETE" [CkStringBuilder_getAsString $sbPath] $sbJsonResponse]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonResponse
    exit
}

# A 204 response is expected for success.
puts "Response Status Code = [CkRest_get_ResponseStatusCode $rest]"

# Did we get a 204 success response?
if {[CkRest_get_ResponseStatusCode $rest] != 204} then {
    puts "Failed."
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbAuth
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkStringBuilder $sbJsonResponse
    exit
}

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

delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbAuth
delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkStringBuilder $sbJsonResponse