Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL cInvoiceId
LOCAL oSbPath
LOCAL oSbJsonResponse

nSuccess := 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)
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/paypal.json")

//  Build the Authorization request header field value.
oSbAuth := CreateObject("Chilkat.StringBuilder")
//  token_type should be "Bearer"
oSbAuth:Append(oJsonToken:StringOf("token_type"))
oSbAuth:Append(" ")
oSbAuth:Append(oJsonToken: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.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.sandbox.paypal.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    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..
//  ----------------------------------------------------------------------------------------------

oRest:AddHeader("Authorization", oSbAuth:GetAsString())

cInvoiceId := "INV2-29Z4-EB7M-MUCY-327J"

oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/v1/invoicing/invoices/")
oSbPath:Append(cInvoiceId)

//  Send the DELETE request and get the JSON response.
oSbJsonResponse := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestNoBodySb("DELETE", oSbPath:GetAsString(), oSbJsonResponse)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oSbPath:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

//  A 204 response is expected for success.
? "Response Status Code = " + Str(oRest:ResponseStatusCode)

//  Did we get a 204 success response?
IF (oRest:ResponseStatusCode != 204)
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oSbPath:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

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

oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oSbPath:destroy()
oSbJsonResponse:destroy()