(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
Dim success As Boolean
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
bAutoReconnect = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim sbAuth As New Chilkat.StringBuilder
success = sbAuth.Append("Bearer ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString()

success = rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

Dim query As String
query = "select * from Employee"
success = rest.AddQueryParam("query",query)
success = rest.AddQueryParam("minorversion","45")

// The company ID is 123146096291789
Dim responseBody As String
responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Request Header: ")
    System.DebugLog(rest.LastRequestHeader)
    System.DebugLog("----")
    System.DebugLog("Response StatusCode = " + Str(rest.ResponseStatusCode))
    System.DebugLog("Response StatusLine: " + rest.ResponseStatusText)
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog(responseBody)
    Return
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
success = json.Load(responseBody)

// Show the full JSON response.
json.EmitCompact = False
System.DebugLog(json.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..
Dim dtime As New Chilkat.CkDateTime
Dim bLocalTime As Boolean
bLocalTime = True
Dim dt As Chilkat.DtObj

// Iterate over each account returned.
Dim numRecords As Int32
numRecords = json.SizeOfArray("QueryResponse.Employee")
Dim i As Int32
i = 0
While i < numRecords

    json.I = i
    System.DebugLog("DisplayName: " + json.StringOf("QueryResponse.Employee[i].DisplayName"))
    System.DebugLog("Id: " + json.StringOf("QueryResponse.Employee[i].Id"))
    System.DebugLog("Active: " + Str(json.BoolOf("QueryResponse.Employee[i].Active")))

    // Load the CreateTime into a CkDateTime...
    success = dtime.SetFromTimestamp(json.StringOf("QueryResponse.Employee[i].MetaData.CreateTime"))
    dt = dtime.GetDtObj(bLocalTime)
    System.DebugLog(Str(dt.Month) + "/" + Str(dt.Day) + "/" + Str(dt.Year) + "  " + Str(dt.Hour) + ":" + Str(dt.Minute))

    // The the birth year, month, and day, if it exists.
    // The BirthDate contains something like this: "1985-09-11"
    If (json.HasMember("QueryResponse.Employee[i].BirthDate") = True) Then
        Dim sTab As New Chilkat.StringTable
        success = sTab.SplitAndAppend(json.StringOf("QueryResponse.Employee[i].BirthDate"),"-",True,True)
        Dim year As String
        year = sTab.StringAt(0)
        Dim month As String
        month = sTab.StringAt(1)
        Dim day As String
        day = sTab.StringAt(2)
        System.DebugLog("BirthDate: " + month + "/" + day + "/" + year)
    End If

    System.DebugLog("----")
    i = i + 1
Wend

System.DebugLog("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"
//