(Excel) QuickBooks - Read an Employee

Demonstrates how to fetch the information for a specific Quickbooks employee. The employee information is fetched by Id. The employee Ids can be obtained by querying the employees and parsing the JSON that is returned.

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

Download Excel Class Modules Chilkat Excel Class Modules

' 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 Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' 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.

bAutoReconnect = True
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

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

' The company ID is 123146096291789
' The employee ID is 58

responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print "Request Header: "
    Debug.Print rest.LastRequestHeader
    Debug.Print "----"
    Debug.Print "Response StatusCode = "; rest.ResponseStatusCode
    Debug.Print "Response StatusLine: "; rest.ResponseStatusText
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print responseBody
    Exit Sub
End If

' Load the JSON response into a JSON object for parsing.
' A sample JSON response is shown below.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(responseBody)

' These will be used for parsing date/time strings..
Dim dtime As Chilkat.CkDateTime
Set dtime = Chilkat.NewCkDateTime

bLocalTime = True

' Show the JSON.   
json.EmitCompact = False
Debug.Print json.Emit()

' Get some information from the JSON..
Debug.Print "Name: "; json.StringOf("Employee.DisplayName")
Debug.Print "Id: "; json.StringOf("Employee.Id")
Debug.Print "City: "; json.StringOf("Employee.PrimaryAddr.City")
Debug.Print "PostalCode: "; json.StringOf("Employee.PrimaryAddr.PostalCode")

' Load the CreateTime into a CkDateTime...
success = dtime.SetFromTimestamp(json.StringOf("Employee.MetaData.CreateTime"))
Set dt = dtime.GetDtObj(bLocalTime)
Debug.Print dt.Month; "/"; dt.Day; "/"; dt.Year; "  "; dt.Hour; ":"; dt.Minute

Debug.Print "Success."

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

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

' {
'   "Employee": {
'     "SSN": "XXX-XX-XXXX",
'     "PrimaryAddr": {
'       "Id": "116",
'       "Line1": "45 N. Elm Street",
'       "City": "Middlefield",
'       "CountrySubDivisionCode": "CA",
'       "PostalCode": "93242"
'     },
'     "BillableTime": false,
'     "domain": "QBO",
'     "sparse": false,
'     "Id": "98",
'     "SyncToken": "0",
'     "MetaData": {
'       "CreateTime": "2015-07-24T09:34:35-07:00",
'       "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
'     },
'     "GivenName": "Bill",
'     "FamilyName": "Miller",
'     "DisplayName": "Bill Miller",
'     "PrintOnCheckName": "Bill Miller",
'     "Active": true,
'     "PrimaryPhone": {
'       "FreeFormNumber": "234-525-1234"
'     }
'   },
'   "time": "2015-07-24T09:35:54.805-07:00"
'