(Visual FoxPro) QuickBooks - Query Employees

Demonstrates how to query the QuickBooks employee data.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#query-an-employee

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL loSbAuth
LOCAL lcQuery
LOCAL lcResponseBody
LOCAL loJson
LOCAL loDtime
LOCAL lnBLocalTime
LOCAL loDt
LOCAL lnNumRecords
LOCAL i
LOCAL loSTab
LOCAL lcYear
LOCAL lcMonth
LOCAL lcDay

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
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 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 <> 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(lcResponseBody)

* Show the full JSON response.
loJson.EmitCompact = 0
? 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..
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.CkDateTime')
loDtime = CreateObject('Chilkat.CkDateTime')
lnBLocalTime = 1

* 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"))
    loDt = loDtime.GetDtObj(lnBLocalTime)
    ? STR(loDt.Month) + "/" + STR(loDt.Day) + "/" + STR(loDt.Year) + "  " + STR(loDt.Hour) + ":" + STR(loDt.Minute)
    RELEASE loDt

    * 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") = 1) THEN
        * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringTable')
        loSTab = CreateObject('Chilkat.StringTable')
        loSTab.SplitAndAppend(loJson.StringOf("QueryResponse.Employee[i].BirthDate"),"-",1,1)
        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 loSTab