Xbase++

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

Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oSbAuth
LOCAL cQuery
LOCAL cResponseBody
LOCAL oJson
LOCAL nNumRecords
LOCAL i

nSuccess := 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"
//  }

oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/qb-access-token.json")

oRest := 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.
nBAutoReconnect := 1
nSuccess := oRest:Connect("sandbox-quickbooks.api.intuit.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oRest:destroy()
    RETURN
ENDIF

oSbAuth := CreateObject("Chilkat.StringBuilder")
oSbAuth:Append("Bearer ")
oSbAuth:Append(oJsonToken:StringOf("access_token"))
oRest:Authorization := oSbAuth:GetAsString()

oRest:AddHeader("Accept", "application/json")
oRest:AllowHeaderFolding := 0

cQuery := "select * from Customer"
oRest:AddQueryParam("query", cQuery)
oRest:AddQueryParam("minorversion", "45")

//  The company ID is 123146096291789
cResponseBody := oRest:FullRequestNoBody("GET", "/v3/company/123146096291789/query")
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    RETURN
ENDIF

//  We should expect a 200 response if successful.
IF (oRest:ResponseStatusCode != 200)
    ? "Request Header: "
    ? oRest:LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + Str(oRest:ResponseStatusCode)
    ? "Response StatusLine: " + oRest:ResponseStatusText
    ? "Response Header:"
    ? oRest:ResponseHeader
    ? cResponseBody
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    RETURN
ENDIF

//  Load the JSON response into a JSON object for parsing.
//  A sample JSON response is shown below.
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
oJson:Load(cResponseBody)

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

//  Iterate over each customer returned.
nNumRecords := oJson:SizeOfArray("QueryResponse.Customer")
i := 0
DO WHILE i < nNumRecords

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

? "Success."

oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJson:destroy()