(Excel) QuickBooks - Read an Employee (with Error Response)

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch using an invalid employee id. Shows the error response and how to parse it.

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 999  (There is no employee with this ID and we should get a 400 response code w/ a response body indicating the error.)

responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    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)
json.EmitCompact = False
Debug.Print json.Emit()

' A 400 response is what we'd expect if trying to query for a non-existent employee ID
If (rest.ResponseStatusCode <> 400) 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
    Exit Sub
End If

' If we got here, the response status code was 400..
' Iterate over the errors..

numErrors = json.SizeOfArray("Fault.Error")

i = 0
Do While i < numErrors

    json.I = i
    Debug.Print "Message: "; json.StringOf("Fault.Error[i].Message")
    Debug.Print "Detail: "; json.StringOf("Fault.Error[i].Detail")
    Debug.Print "code: "; json.StringOf("Fault.Error[i].code")
    Debug.Print "----"
    i = i + 1
Loop

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

' {
'   "Fault": {
'     "Error": [
'       {
'         "Message": "Object Not Found",
'         "Detail": "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
'         "code": "610",
'         "element": ""
'       }
'     ],
'     "type": "ValidationFault"
'   },
'   "time": "2020-03-07T10:21:19.089-08:00"
' }