AutoIt

QuickBooks - Read an Employee (with Error Response)

See more QuickBooks Examples

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

Local $bSuccess = False

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

$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

$oRest = ObjCreate("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.
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("sandbox-quickbooks.api.intuit.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oSbAuth = ObjCreate("Chilkat.StringBuilder")
$oSbAuth.Append("Bearer ")
$oSbAuth.Append($oJsonToken.StringOf("access_token"))
$oRest.Authorization = $oSbAuth.GetAsString()

$oRest.AddHeader("Accept","application/json")
$oRest.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.)
Local $sResponseBody = $oRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45")
If ($oRest.LastMethodSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Load the JSON response into a JSON object for parsing.
; A sample JSON response is shown below.
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($sResponseBody)
$oJson.EmitCompact = False
ConsoleWrite($oJson.Emit() & @CRLF)

; A 400 response is what we'd expect if trying to query for a non-existent employee ID
If ($oRest.ResponseStatusCode <> 400) Then
    ConsoleWrite("Request Header: " & @CRLF)
    ConsoleWrite($oRest.LastRequestHeader & @CRLF)
    ConsoleWrite("----" & @CRLF)
    ConsoleWrite("Response StatusCode = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("Response StatusLine: " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oRest.ResponseHeader & @CRLF)
    Exit
EndIf

; If we got here, the response status code was 400..
; Iterate over the errors..
Local $iNumErrors = $oJson.SizeOfArray("Fault.Error")
Local $i = 0
While $i < $iNumErrors

    $oJson.I = $i
    ConsoleWrite("Message: " & $oJson.StringOf("Fault.Error[i].Message") & @CRLF)
    ConsoleWrite("Detail: " & $oJson.StringOf("Fault.Error[i].Detail") & @CRLF)
    ConsoleWrite("code: " & $oJson.StringOf("Fault.Error[i].code") & @CRLF)
    ConsoleWrite("----" & @CRLF)
    $i = $i + 1
Wend

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