Ruby

QuickBooks - Query an Account

See more QuickBooks Examples

Demonstrates how to query the QuickBooks chart of accounts. 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)

# Add a SELECT statement 
rest.AddQueryParam("query","select * from Account where Metadata.CreateTime > '2014-12-31'")
rest.AddQueryParam("minorversion","45")

# The company ID is 123146096291789
responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/query")
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

rest.ClearAllQueryParams()

# 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

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

# 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
dt = Chilkat::CkDtObj.new()

# Iterate over each account returned.
numAccounts = json.SizeOfArray("QueryResponse.Account")
i = 0
while i < numAccounts

    json.put_I(i)
    print "Name: " + json.stringOf("QueryResponse.Account[i].Name") + "\n";
    print "Id: " + json.stringOf("QueryResponse.Account[i].Id") + "\n";

    # Load the CreateTime into a CkDateTime...
    dtime.SetFromTimestamp(json.stringOf("QueryResponse.Account[i].MetaData.CreateTime"))
    dtime.ToDtObj(bLocalTime,dt)

    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 "----" + "\n";
    i = i + 1
end

print "Success." + "\n";

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

# {
#   "QueryResponse": {
#     "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"
#         }
#       },
#       {
#         "Name": "Accounts Receivable (A/R)",
#         "SubAccount": false,
#         "FullyQualifiedName": "Accounts Receivable (A/R)",
#         "Active": true,
#         "Classification": "Asset",
#         "AccountType": "Accounts Receivable",
#         "AccountSubType": "AccountsReceivable",
#         "CurrentBalance": 5281.52,
#         "CurrentBalanceWithSubAccounts": 5281.52,
#         "CurrencyRef": {
#           "value": "USD",
#           "name": "United States Dollar"
#         },
#         "domain": "QBO",
#         "sparse": false,
#         "Id": "84",
#         "SyncToken": "0",
#         "MetaData": {
#           "CreateTime": "2016-09-14T14:49:29-07:00",
#           "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
#         }
#       },
#       {
#         "Name": "Advertising",
#         "SubAccount": false,
#         "FullyQualifiedName": "Advertising",
#         "Active": true,
#         "Classification": "Expense",
#         "AccountType": "Expense",
#         "AccountSubType": "AdvertisingPromotional",
#         "CurrentBalance": 0,
#         "CurrentBalanceWithSubAccounts": 0,
#         "CurrencyRef": {
#           "value": "USD",
#           "name": "United States Dollar"
#         },
#         "domain": "QBO",
#         "sparse": false,
#         "Id": "7",
#         "SyncToken": "0",
#         "MetaData": {
#           "CreateTime": "2016-09-09T14:42:07-07:00",
#           "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
#         }
#       },
# ...
#   "time": "2016-10-24T15:35:25.067-07:00"
#