VB.NET

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

VB.NET

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 New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As New Chilkat.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
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


Dim sbAuth As New Chilkat.StringBuilder
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
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
End If


' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    Debug.WriteLine("Request Header: ")
    Debug.WriteLine(rest.LastRequestHeader)
    Debug.WriteLine("----")
    Debug.WriteLine("Response StatusCode = " & rest.ResponseStatusCode)
    Debug.WriteLine("Response StatusLine: " & rest.ResponseStatusText)
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(rest.ResponseHeader)
    Debug.WriteLine(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 New Chilkat.JsonObject
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 Integer = json.SizeOfArray("QueryResponse.Customer")
Dim i As Integer = 0
While i < numRecords

    json.I = i
    Debug.WriteLine("Name: " & json.StringOf("QueryResponse.Customer[i].FullyQualifiedName"))
    Debug.WriteLine("Id: " & json.StringOf("QueryResponse.Customer[i].Id"))
    Debug.WriteLine("City: " & json.StringOf("QueryResponse.Customer[i].BillAddr.City"))
    Debug.WriteLine("----")
    i = i + 1
End While

Debug.WriteLine("Success.")