(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    return
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..
// ----------------------------------------------------------------------------------------------

loRest.AddHeader("Authorization",loSbAuth.GetAsString())

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

loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/v1/invoicing/invoices/")
loSbPath.Append(lcInvoiceId)

// Send the DELETE request and get the JSON response.
loSbJsonResponse = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestNoBodySb("DELETE",loSbPath.GetAsString(),loSbJsonResponse)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loSbPath
    release loSbJsonResponse
    return
endif

// A 204 response is expected for success.
? "Response Status Code = " + str(loRest.ResponseStatusCode)

// Did we get a 204 success response?
if (loRest.ResponseStatusCode <> 204) then
    ? "Failed."
    release loJsonToken
    release loSbAuth
    release loRest
    release loSbPath
    release loSbJsonResponse
    return
endif

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


release loJsonToken
release loSbAuth
release loRest
release loSbPath
release loSbJsonResponse