B4X

QuickBooks - Query a Customer

See more QuickBooks Examples

Demonstrates how to query QuickBooks customers.

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

B4X

Dim success As Boolean = 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"
'  }

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

Dim rest As ChilkatRest
rest.Initialize("rest")

'  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.
Dim bAutoReconnect As Boolean = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com", 443, True, bAutoReconnect)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString

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

Dim query As String = "select * from Customer"
rest.AddQueryParam("query", query)
rest.AddQueryParam("minorversion", "45")

'  The company ID is 123146096291789
Dim responseBody As String = rest.FullRequestNoBody("GET", "/v3/company/123146096291789/query")
If rest.LastMethodSuccess <> True Then
    Log(rest.LastErrorText)
    Return
End If


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


'  Load the JSON response into a JSON object for parsing.
'  A sample JSON response is shown below.
Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.Load(responseBody)

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

'  Iterate over each customer returned.
Dim numRecords As Int = json.SizeOfArray("QueryResponse.Customer")
Dim i As Int = 0
Do While i < numRecords

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

Log("Success.")