(PowerBuilder) 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

integer li_rc
oleobject loo_JsonToken
integer li_Success
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_SbAuth
string ls_Query
string ls_ResponseBody
oleobject loo_Json
oleobject loo_Dtime
integer li_BLocalTime
oleobject loo_Dt
integer li_NumRecords
integer i
oleobject loo_STab
string ls_Year
string ls_Month
string ls_Day

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

loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("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.
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("sandbox-quickbooks.api.intuit.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_Rest
    return
end if

loo_SbAuth = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbAuth.Append("Bearer ")
loo_SbAuth.Append(loo_JsonToken.StringOf("access_token"))
loo_Rest.Authorization = loo_SbAuth.GetAsString()

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

ls_Query = "select * from Employee"
loo_Rest.AddQueryParam("query",ls_Query)
loo_Rest.AddQueryParam("minorversion","45")

// The company ID is 123146096291789
ls_ResponseBody = loo_Rest.FullRequestNoBody("GET","/v3/company/123146096291789/query")
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_Rest
    destroy loo_SbAuth
    return
end if

// We should expect a 200 response if successful.
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug "Request Header: "
    Write-Debug loo_Rest.LastRequestHeader
    Write-Debug "----"
    Write-Debug "Response StatusCode = " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "Response StatusLine: " + loo_Rest.ResponseStatusText
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug ls_ResponseBody
    destroy loo_JsonToken
    destroy loo_Rest
    destroy loo_SbAuth
    return
end if

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_ResponseBody)

// Show the full JSON response.
loo_Json.EmitCompact = 0
Write-Debug loo_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..
loo_Dtime = create oleobject
// Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
li_rc = loo_Dtime.ConnectToNewObject("Chilkat.CkDateTime")

li_BLocalTime = 1

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

    loo_Json.I = i
    Write-Debug "DisplayName: " + loo_Json.StringOf("QueryResponse.Employee[i].DisplayName")
    Write-Debug "Id: " + loo_Json.StringOf("QueryResponse.Employee[i].Id")
    Write-Debug "Active: " + string(loo_Json.BoolOf("QueryResponse.Employee[i].Active"))

    // Load the CreateTime into a CkDateTime...
    loo_Dtime.SetFromTimestamp(loo_Json.StringOf("QueryResponse.Employee[i].MetaData.CreateTime"))
    loo_Dt = loo_Dtime.GetDtObj(li_BLocalTime)
    Write-Debug string(loo_Dt.Month) + "/" + string(loo_Dt.Day) + "/" + string(loo_Dt.Year) + "  " + string(loo_Dt.Hour) + ":" + string(loo_Dt.Minute)
    destroy loo_Dt

    // The the birth year, month, and day, if it exists.
    // The BirthDate contains something like this: "1985-09-11"
    if loo_Json.HasMember("QueryResponse.Employee[i].BirthDate") = 1 then
        loo_STab = create oleobject
        // Use "Chilkat_9_5_0.StringTable" for versions of Chilkat < 10.0.0
        li_rc = loo_STab.ConnectToNewObject("Chilkat.StringTable")

        loo_STab.SplitAndAppend(loo_Json.StringOf("QueryResponse.Employee[i].BirthDate"),"-",1,1)
        ls_Year = loo_STab.StringAt(0)
        ls_Month = loo_STab.StringAt(1)
        ls_Day = loo_STab.StringAt(2)
        Write-Debug "BirthDate: " + ls_Month + "/" + ls_Day + "/" + ls_Year
    end if

    Write-Debug "----"
    i = i + 1
loop

Write-Debug "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"
// 


destroy loo_JsonToken
destroy loo_Rest
destroy loo_SbAuth
destroy loo_Json
destroy loo_Dtime
destroy loo_STab