(Excel) QuickBooks - Query a Customer

Demonstrates how to query QuickBooks customers.

A sample JSON response body is available at Sample Quickbooks Customer Query JSON Response

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/customer#query-a-customer

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


query = "select * from Customer"
success = rest.AddQueryParam("query",query)
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

' 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

' 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
json.EmitCompact = False
success = json.Load(responseBody)

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

' Iterate over each customer returned.

numRecords = json.SizeOfArray("QueryResponse.Customer")

i = 0
Do While i < numRecords

    json.I = i
    Debug.Print "Name: "; json.StringOf("QueryResponse.Customer[i].FullyQualifiedName")
    Debug.Print "Id: "; json.StringOf("QueryResponse.Customer[i].Id")
    Debug.Print "City: "; json.StringOf("QueryResponse.Customer[i].BillAddr.City")
    Debug.Print "----"
    i = i + 1
Loop

Debug.Print "Success."