(Excel) QuickBooks - Query an Account

Demonstrates how to query the QuickBooks chart of accounts.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/ecommerce/account#query-an-account

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' 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) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
Dim success As Boolean
success = sbAuth.Append("Bearer ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString()

success = rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

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

' The company ID is 123146096291789

responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

success = rest.ClearAllQueryParams()

' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print "Request Header: "
    Debug.Print rest.LastRequestHeader
    Debug.Print "----"
    Debug.Print "Response StatusCode = "; rest.ResponseStatusCode
    Debug.Print "Response StatusLine: "; rest.ResponseStatusText
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print responseBody
    Exit Sub
End If

' 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.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(responseBody)

' These will be used for parsing date/time strings..
Dim dtime As Chilkat.CkDateTime
Set dtime = Chilkat.NewCkDateTime

bLocalTime = True

' Iterate over each account returned.

numAccounts = json.SizeOfArray("QueryResponse.Account")

i = 0
Do While i < numAccounts

    json.I = i
    Debug.Print "Name: "; json.StringOf("QueryResponse.Account[i].Name")
    Debug.Print "Id: "; json.StringOf("QueryResponse.Account[i].Id")

    ' Load the CreateTime into a CkDateTime...
    success = dtime.SetFromTimestamp(json.StringOf("QueryResponse.Account[i].MetaData.CreateTime"))
    Set dt = dtime.GetDtObj(bLocalTime)
    Debug.Print dt.Month; "/"; dt.Day; "/"; dt.Year; "  "; dt.Hour; ":"; dt.Minute

    Debug.Print "----"
    i = i + 1
Loop

Debug.Print "Success."

' ------------------------------------------------------
' 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"
'