Sample code for 30+ languages & platforms
Lianja

QuickBooks - Query Employees

See more QuickBooks Examples

Demonstrates how to query the QuickBooks employee data.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

// 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("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = createobject("CkRest")

// 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.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",443,.T.,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    return
endif

loSbAuth = createobject("CkStringBuilder")
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.GetAsString()

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

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

// The company ID is 123146096291789
lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    release loSbAuth
    return
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
    return
endif

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
loJson = createobject("CkJsonObject")
loJson.Load(lcResponseBody)

// Show the full JSON response.
loJson.EmitCompact = .F.
? loJson.Emit()

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

// These will be used for parsing date/time strings..
loDtime = createobject("CkDateTime")
llBLocalTime = .T.
loDt = createobject("CkDtObj")

// Iterate over each account returned.
lnNumRecords = loJson.SizeOfArray("QueryResponse.Employee")
i = 0
do while i < lnNumRecords

    loJson.I = i
    ? "DisplayName: " + loJson.StringOf("QueryResponse.Employee[i].DisplayName")
    ? "Id: " + loJson.StringOf("QueryResponse.Employee[i].Id")
    ? "Active: " + str(loJson.BoolOf("QueryResponse.Employee[i].Active"))

    // Load the CreateTime into a CkDateTime...
    loDtime.SetFromTimestamp(loJson.StringOf("QueryResponse.Employee[i].MetaData.CreateTime"))
    loDtime.ToDtObj(llBLocalTime,loDt)

    ? str(loDt.Month) + "/" + str(loDt.Day) + "/" + str(loDt.Year) + "  " + str(loDt.Hour) + ":" + str(loDt.Minute)

    // The the birth year, month, and day, if it exists.
    // The BirthDate contains something like this: "1985-09-11"
    if (loJson.HasMember("QueryResponse.Employee[i].BirthDate") = .T.) then
        loSTab = createobject("CkStringTable")
        loSTab.SplitAndAppend(loJson.StringOf("QueryResponse.Employee[i].BirthDate"),"-",.T.,.T.)
        lcYear = loSTab.StringAt(0)
        lcMonth = loSTab.StringAt(1)
        lcDay = loSTab.StringAt(2)
        ? "BirthDate: " + lcMonth + "/" + lcDay + "/" + lcYear
    endif

    ? "----"
    i = i + 1
enddo

? "Success."

// ------------------------------------------------------
// The JSON response looks like this:

// {
//   "QueryResponse": {
//     "Employee": [
//       {
//         "BillableTime": false,
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "55",
//         "SyncToken": "0",
//         "MetaData": {
//           "CreateTime": "2016-09-15T11:21:48-07:00",
//           "LastUpdatedTime": "2016-09-15T11:21:48-07:00"
//         },
//         "GivenName": "Emily",
//         "FamilyName": "Platt",
//         "DisplayName": "Emily Platt",
//         "PrintOnCheckName": "Emily Platt",
//         "Active": true
//       },
//       {
//         "BillableTime": false,
//         "BirthDate": "1985-09-11",
//         "HiredDate": "2016-08-17",
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "54",
//         "SyncToken": "1",
//         "MetaData": {
//           "CreateTime": "2016-09-15T11:21:28-07:00",
//           "LastUpdatedTime": "2016-09-15T11:46:26-07:00"
//         },
//         "GivenName": "John",
//         "FamilyName": "Johnson",
//         "DisplayName": "John Johnson",
//         "PrintOnCheckName": "John Johnson",
//         "Active": true,
//         "PrimaryPhone": {
//           "FreeFormNumber": "(540) 555-9645"
//         }
//       },
//       {
//         "SSN": "XXX-XX-XXXX",
//         "PrimaryAddr": {
//           "Id": "98",
//           "Line1": "45 N. Elm Street",
//           "City": "Middlefield",
//           "CountrySubDivisionCode": "CA",
//           "PostalCode": "93242"
//         },
//         "BillableTime": false,
//         "domain": "QBO",
//         "sparse": false,
//         "Id": "60",
//         "SyncToken": "0",
//         "MetaData": {
//           "CreateTime": "2016-10-25T14:08:18-07:00",
//           "LastUpdatedTime": "2016-10-25T14:08:18-07:00"
//         },
//         "GivenName": "John",
//         "FamilyName": "Meuller",
//         "DisplayName": "John Meuller",
//         "PrintOnCheckName": "John Meuller",
//         "Active": true,
//         "PrimaryPhone": {
//           "FreeFormNumber": "408-525-1234"
//         }
//       }
//     ],
//     "startPosition": 1,
//     "maxResults": 3
//   },
//   "time": "2016-10-25T14:18:38.487-07:00"
// 


release loJsonToken
release loRest
release loSbAuth
release loJson
release loDtime
release loDt
release loSTab