Ruby

QuickBooks - Full Update an Account

See more QuickBooks Examples

Demonstrates how to update any of the writable fields of an existing account. The example first reads the JSON data for the account, makes some changes, and then POST's the updated JSON to update the account. Ruby

require 'chilkat'

success = false

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

# Get our previously obtained OAuth2 access token, which should contain JSON like this:
# {
#   "expires_in": 3600,
#   "x_refresh_token_expires_in": 8726400,
#   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
#   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
#   "token_type": "bearer"
# }

jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = Chilkat::CkRest.new()

# Connect using TLS.
# A single REST object, once connected, can be used for many Quickbooks 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.
bAutoReconnect = true
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_Authorization(sbAuth.getAsString())

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

# First get the full JSON for the account we'll be updating..
# The company ID is the 123146096291789
# The account ID is 29
responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/account/29?minorversion=45")
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print responseBody + "\n";
    exit
end

# Load the JSON response into a JSON object for parsing/updating
json = Chilkat::CkJsonObject.new()
json.Load(responseBody)

# Show the JSON..
json.put_EmitCompact(false)
print json.emit() + "\n";
print "----" + "\n";

# The JSON passed in the HTTP POST for updating is the inner content of the Account
updateJson = Chilkat::CkJsonObject.new()
json.ObjectOf2("Account",updateJson)

# Add or update the Description.
# (If a Description already exists, it is replace, otherwise the Description is added.)
updateJson.UpdateString("Description","Description added during update.")

# Examine the JSON we'll be sending in the body of the POST.
updateJson.put_EmitCompact(false)
print updateJson.emit() + "\n";
print "----" + "\n";

# Now we're going to POST the changes to update the Quickbooks account.
rest.ClearAllHeaders()
rest.put_Authorization(sbAuth.getAsString())
rest.AddHeader("Accept","application/json")
rest.AddHeader("Content-Type","application/json")

# The updated JSON is passed as the HTTP request body.
responseBody = rest.fullRequestString("POST","/v3/company/123146096291789/account?minorversion=45",updateJson.emit())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print responseBody + "\n";
    exit
end

# Load the JSON response into a JSON object to emit in indented form..
json.Load(responseBody)
print json.emit() + "\n";

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

print "Success." + "\n";