Ruby

Quickbooks Delete an Invoice

See more QuickBooks Examples

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

require 'chilkat'

success = false

# 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.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = Chilkat::CkRest.new()

# Connect to the REST server.
bTls = true
port = 443
bAutoReconnect = true
success = rest.Connect("sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect)

sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_Authorization(sbAuth.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

jsonReq = Chilkat::CkJsonObject.new()
jsonReq.UpdateString("SyncToken","3")
jsonReq.UpdateString("Id","33")

sbRequestBody = Chilkat::CkStringBuilder.new()
jsonReq.EmitSb(sbRequestBody)

rest.AddHeader("Content-Type","application/json")
rest.AddHeader("Accept","application/json")
rest.put_AllowHeaderFolding(false)

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/v3/company/<realmID>/invoice?operation=delete",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()

# Success is indicated by a 200 response status code.
print "response status code = " + respStatusCode.to_s() + "\n";

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)
jsonResponse.put_EmitCompact(false)
print jsonResponse.emit() + "\n";

if (rest.get_ResponseStatusCode() != 200)
    print "Failed." + "\n";
    exit
end

# 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"
# }
# 

InvoiceStatus = jsonResponse.stringOf("Invoice.status")
InvoiceDomain = jsonResponse.stringOf("Invoice.domain")
InvoiceId = jsonResponse.stringOf("Invoice.Id")
time = jsonResponse.stringOf("time")