(Ruby) QuickBooks - Read an Account

Demonstrates how to fetch the information for a specific Quickbooks account. The account information is fetched by Id. The account Ids can be obtained by querying the accounts and parsing the JSON that is returned.

Chilkat Ruby Downloads Ruby Library for Linux and MAC OS X

require 'chilkat'

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

# This example also assumes an OAuth1 access token was previously fetched.
# and saved in a JSON file.  See the Chilkat online examples at example-code.com
# for Quickbooks OAuth1 examples (in the Quickbooks and OAuth1 categories)
# 

# First get our previously obtained access token.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/quickbooks.json")

oauth1 = Chilkat::CkOAuth1.new()
oauth1.put_ConsumerKey("QUICKBOOKS_CONSUMER_KEY")
oauth1.put_ConsumerSecret("QUICKBOOKS_CONSUMER_SECRET")
oauth1.put_Token(jsonToken.stringOf("oauth_token"))
oauth1.put_TokenSecret(jsonToken.stringOf("oauth_token_secret"))

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 != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.SetAuthOAuth1(oauth1,false)

# The company ID is the realmId
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/v3/company/<companyID>/account/<accountID>")
numReplacements = sbPath.Replace("<companyID>",jsonToken.stringOf("realmId"))
# Assume we already know that we want to read the account whose Id = 33.
numReplacements = sbPath.Replace("<accountID>","33")

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

responseBody = rest.fullRequestNoBody("GET",sbPath.getAsString())
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 for parsing.
# A sample JSON response is shown below.
json = Chilkat::CkJsonObject.new()
json.Load(responseBody)

# These will be used for parsing date/time strings..
dtime = Chilkat::CkDateTime.new()
bLocalTime = true

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

# Get some information from the JSON..
print "Name: " + json.stringOf("Account.Name") + "\n";
print "Id: " + json.stringOf("Account.Id") + "\n";

# Load the CreateTime into a CkDateTime...
dtime.SetFromTimestamp(json.stringOf("Account.MetaData.CreateTime"))
# dt is a CkDtObj
dt = dtime.GetDtObj(bLocalTime)
print dt.get_Month().to_s() + "/" + dt.get_Day().to_s() + "/" + dt.get_Year().to_s() + "  " + dt.get_Hour().to_s() + 
    ":" + dt.get_Minute().to_s() + "\n";

print "Success." + "\n";

# ------------------------------------------------------
# The JSON response looks like this:

# {
#   "Account": {
#         "Name": "Accounts Payable (A/P)",
#         "SubAccount": false,
#         "FullyQualifiedName": "Accounts Payable (A/P)",
#         "Active": true,
#         "Classification": "Liability",
#         "AccountType": "Accounts Payable",
#         "AccountSubType": "AccountsPayable",
#         "CurrentBalance": -1602.67,
#         "CurrentBalanceWithSubAccounts": -1602.67,
#         "CurrencyRef": {
#           "value": "USD",
#           "name": "United States Dollar"
#         },
#         "domain": "QBO",
#         "sparse": false,
#         "Id": "33",
#         "SyncToken": "0",
#         "MetaData": {
#           "CreateTime": "2016-09-10T10:12:02-07:00",
#           "LastUpdatedTime": "2016-09-17T13:10:36-07:00"
#         }
#       },
#   "time": "2016-10-24T15:35:25.067-07:00"
#