Xbase++

Quickbooks Delete an Invoice

See more QuickBooks Examples

Demonstrates how to delete an invoice using the Quickbooks REST API. Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oSbAuth
LOCAL oJsonReq
LOCAL oSbRequestBody
LOCAL oSbResponseBody
LOCAL nRespStatusCode
LOCAL oJsonResponse
LOCAL cInvoiceStatus
LOCAL cInvoiceDomain
LOCAL cInvoiceId
LOCAL cTime

nSuccess := 0

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  First get our previously obtained OAuth2 access token.
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/qb-access-token.json")

oRest := CreateObject("Chilkat.Rest")

//  Connect to the REST server.
nBTls := 1
nPort := 443
nBAutoReconnect := 1
nSuccess := oRest:Connect("sandbox-quickbooks.api.intuit.com", nPort, nBTls, nBAutoReconnect)

oSbAuth := CreateObject("Chilkat.StringBuilder")
oSbAuth:Append("Bearer ")
oSbAuth:Append(oJsonToken:StringOf("access_token"))
oRest:Authorization := oSbAuth:GetAsString()

//  --------------------------------------------------------------------------
//  Note: The above code to setup the initial REST connection
//  can be done once.  After connecting, any number of REST calls can be made.
//  If the connection is lost, the next REST method call will automatically
//  reconnect if needed.
//  --------------------------------------------------------------------------

//  Create the following JSON:

//  {
//    "SyncToken": "3",
//    "Id": "33"
//  }
//  
//  Use the this online tool to generate the code from sample JSON: 
//  Generate Code to Create JSON

oJsonReq := CreateObject("Chilkat.JsonObject")
oJsonReq:UpdateString("SyncToken", "3")
oJsonReq:UpdateString("Id", "33")

oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oJsonReq:EmitSb(oSbRequestBody)

oRest:AddHeader("Content-Type", "application/json")
oRest:AddHeader("Accept", "application/json")
oRest:AllowHeaderFolding := 0

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestSb("POST", "/v3/company/<realmID>/invoice?operation=delete", oSbRequestBody, oSbResponseBody)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    oJsonReq:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

nRespStatusCode := oRest:ResponseStatusCode

//  Success is indicated by a 200 response status code.
? "response status code = " + Str(nRespStatusCode)

oJsonResponse := CreateObject("Chilkat.JsonObject")
oJsonResponse:LoadSb(oSbResponseBody)
oJsonResponse:EmitCompact := 0
? oJsonResponse:Emit()

IF (oRest:ResponseStatusCode != 200)
    ? "Failed."
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    oJsonReq:destroy()
    oSbRequestBody:destroy()
    oSbResponseBody:destroy()
    oJsonResponse:destroy()
    RETURN
ENDIF

//  Sample output...
//  (See the parsing code below..)
//  
//  Use the this online tool to generate parsing code from sample JSON: 
//  Generate Parsing Code from JSON

//  {
//    "Invoice": {
//      "status": "Deleted",
//      "domain": "QBO",
//      "Id": "33"
//    },
//    "time": "2013-03-15T00:18:15.322-07:00"
//  }
//  

cInvoiceStatus := oJsonResponse:StringOf("Invoice.status")
cInvoiceDomain := oJsonResponse:StringOf("Invoice.domain")
cInvoiceId := oJsonResponse:StringOf("Invoice.Id")
cTime := oJsonResponse:StringOf("time")

oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJsonReq:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()