Visual FoxPro

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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lcInvoiceId
LOCAL loSbPath
LOCAL loSbJsonResponse

lnSuccess = 0

*  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('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

*  Build the Authorization request header field value.
loSbAuth = CreateObject('Chilkat.StringBuilder')
*  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('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    CANCEL
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('Chilkat.StringBuilder')
loSbPath.Append("/v1/invoicing/invoices/")
loSbPath.Append(lcInvoiceId)

*  Send the DELETE request and get the JSON response.
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("DELETE",loSbPath.GetAsString(),loSbJsonResponse)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loSbJsonResponse
    CANCEL
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
    CANCEL
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