Visual FoxPro

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

Visual FoxPro

LOCAL lnSuccess
LOCAL loJsonToken
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL loSbAuth
LOCAL lcQuery
LOCAL lcResponseBody
LOCAL loJson
LOCAL lnNumRecords
LOCAL i

lnSuccess = 0

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

loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = CreateObject('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.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loRest
    CANCEL
ENDIF

loSbAuth = CreateObject('Chilkat.StringBuilder')
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.GetAsString()

loRest.AddHeader("Accept","application/json")
loRest.AllowHeaderFolding = 0

lcQuery = "select * from Customer"
loRest.AddQueryParam("query",lcQuery)
loRest.AddQueryParam("minorversion","45")

* The company ID is 123146096291789
lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    CANCEL
ENDIF

* We should expect a 200 response if successful.
IF (loRest.ResponseStatusCode <> 200) THEN
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + STR(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? lcResponseBody
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    CANCEL
ENDIF

* Load the JSON response into a JSON object for parsing.
* A sample JSON response is shown below.
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.Load(lcResponseBody)

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

* Iterate over each customer returned.
lnNumRecords = loJson.SizeOfArray("QueryResponse.Customer")
i = 0
DO WHILE i < lnNumRecords

    loJson.I = i
    ? "Name: " + loJson.StringOf("QueryResponse.Customer[i].FullyQualifiedName")
    ? "Id: " + loJson.StringOf("QueryResponse.Customer[i].Id")
    ? "City: " + loJson.StringOf("QueryResponse.Customer[i].BillAddr.City")
    ? "----"
    i = i + 1
ENDDO

? "Success."

RELEASE loJsonToken
RELEASE loRest
RELEASE loSbAuth
RELEASE loJson