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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
Token    Handle hoJsonToken
    Boolean iSuccess
    Handle hoRest
    Boolean iBAutoReconnect
    Handle hoSbAuth
    String sResponseBody
    Handle hoJson
    Handle hoDtime
    Boolean iBLocalTime
    Variant vDt
    Handle hoDt
    String sTemp1
    Integer iTemp1
    Integer iTemp2
    Integer iTemp3
    Integer iTemp4
    Integer iTemp5
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/qb-access-token.json" To iSuccess

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // 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.
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "sandbox-quickbooks.api.intuit.com" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
    If (Not(IsComObjectCreated(hoSbAuth))) Begin
        Send CreateComObject of hoSbAuth
    End
    Get ComAppend Of hoSbAuth "Bearer " To iSuccess
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess
    Get ComGetAsString Of hoSbAuth To sTemp1
    Set ComAuthorization Of hoRest To sTemp1

    Get ComAddHeader Of hoRest "Accept" "application/json" To iSuccess
    Set ComAllowHeaderFolding Of hoRest To False

    // The company ID is 123146096291789
    // The employee ID is 58
    Get ComFullRequestNoBody Of hoRest "GET" "/v3/company/123146096291789/employee/58?minorversion=45" To sResponseBody
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // We should expect a 200 response if successful.
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        Showln "Request Header: "
        Get ComLastRequestHeader Of hoRest To sTemp1
        Showln sTemp1
        Showln "----"
        Get ComResponseStatusCode Of hoRest To iTemp1
        Showln "Response StatusCode = " iTemp1
        Get ComResponseStatusText Of hoRest To sTemp1
        Showln "Response StatusLine: " sTemp1
        Showln "Response Header:"
        Get ComResponseHeader Of hoRest To sTemp1
        Showln sTemp1
        Showln sResponseBody
        Procedure_Return
    End

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComLoad Of hoJson sResponseBody To iSuccess

    // These will be used for parsing date/time strings..
    Get Create (RefClass(cComCkDateTime)) To hoDtime
    If (Not(IsComObjectCreated(hoDtime))) Begin
        Send CreateComObject of hoDtime
    End
    Move True To iBLocalTime

    // Show the JSON.   
    Set ComEmitCompact Of hoJson To False
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

    // Get some information from the JSON..
    Get ComStringOf Of hoJson "Employee.DisplayName" To sTemp1
    Showln "Name: " sTemp1
    Get ComStringOf Of hoJson "Employee.Id" To sTemp1
    Showln "Id: " sTemp1
    Get ComStringOf Of hoJson "Employee.PrimaryAddr.City" To sTemp1
    Showln "City: " sTemp1
    Get ComStringOf Of hoJson "Employee.PrimaryAddr.PostalCode" To sTemp1
    Showln "PostalCode: " sTemp1

    // Load the CreateTime into a CkDateTime...
    Get ComStringOf Of hoJson "Employee.MetaData.CreateTime" To sTemp1
    Get ComSetFromTimestamp Of hoDtime sTemp1 To iSuccess
    Get ComGetDtObj Of hoDtime iBLocalTime To vDt
    If (IsComObject(vDt)) Begin
        Get Create (RefClass(cComChilkatDtObj)) To hoDt
        Set pvComObject Of hoDt To vDt
    End
    Get ComMonth Of hoDt To iTemp1
    Get ComDay Of hoDt To iTemp2
    Get ComYear Of hoDt To iTemp3
    Get ComHour Of hoDt To iTemp4
    Get ComMinute Of hoDt To iTemp5
    Showln iTemp1 "/" iTemp2 "/" iTemp3 "  " iTemp4 ":" iTemp5
    Send Destroy of hoDt

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


End_Procedure