(MFC) 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 C/C++ Library Downloads MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkJsonObject.h>
#include <CkRest.h>
#include <CkStringBuilder.h>
#include <CkDateTime.h>
#include <CkDtObj.h>
#include <CkStringTable.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

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

    CkRest 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.
    bool bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success != true) {
        strOut.append(rest.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    CkStringBuilder sbAuth;
    sbAuth.Append("Bearer ");
    sbAuth.Append(jsonToken.stringOf("access_token"));
    rest.put_Authorization(sbAuth.getAsString());

    rest.AddHeader("Accept","application/json");
    rest.put_AllowHeaderFolding(false);

    const char *query = "select * from Employee";
    rest.AddQueryParam("query",query);
    rest.AddQueryParam("minorversion","45");

    // The company ID is 123146096291789
    const char *responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/query");
    if (rest.get_LastMethodSuccess() != true) {
        strOut.append(rest.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // We should expect a 200 response if successful.
    if (rest.get_ResponseStatusCode() != 200) {
        strOut.append("Request Header: ");
        strOut.append("\r\n");
        strOut.append(rest.lastRequestHeader());
        strOut.append("\r\n");
        strOut.append("----");
        strOut.append("\r\n");
        strOut.append("Response StatusCode = ");
        strOut.appendInt(rest.get_ResponseStatusCode());
        strOut.append("\r\n");
        strOut.append("Response StatusLine: ");
        strOut.append(rest.responseStatusText());
        strOut.append("\r\n");
        strOut.append("Response Header:");
        strOut.append("\r\n");
        strOut.append(rest.responseHeader());
        strOut.append("\r\n");
        strOut.append(responseBody);
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    CkJsonObject json;
    json.Load(responseBody);

    // Show the full JSON response.
    json.put_EmitCompact(false);
    strOut.append(json.emit());
    strOut.append("\r\n");

    // 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..
    CkDateTime dtime;
    bool bLocalTime = true;
    CkDtObj *dt = 0;

    // Iterate over each account returned.
    int numRecords = json.SizeOfArray("QueryResponse.Employee");
    int i = 0;
    while (i < numRecords) {

        json.put_I(i);
        strOut.append("DisplayName: ");
        strOut.append(json.stringOf("QueryResponse.Employee[i].DisplayName"));
        strOut.append("\r\n");
        strOut.append("Id: ");
        strOut.append(json.stringOf("QueryResponse.Employee[i].Id"));
        strOut.append("\r\n");
        strOut.append("Active: ");
        strOut.appendInt(json.BoolOf("QueryResponse.Employee[i].Active"));
        strOut.append("\r\n");

        // Load the CreateTime into a CkDateTime...
        dtime.SetFromTimestamp(json.stringOf("QueryResponse.Employee[i].MetaData.CreateTime"));
        dt = dtime.GetDtObj(bLocalTime);
        strOut.appendInt(dt->get_Month());
        strOut.append("/");
        strOut.appendInt(dt->get_Day());
        strOut.append("/");
        strOut.appendInt(dt->get_Year());
        strOut.append("  ");
        strOut.appendInt(dt->get_Hour());
        strOut.append(":");
        strOut.appendInt(dt->get_Minute());
        strOut.append("\r\n");
        delete dt;

        // The the birth year, month, and day, if it exists.
        // The BirthDate contains something like this: "1985-09-11"
        if (json.HasMember("QueryResponse.Employee[i].BirthDate") == true) {
            CkStringTable sTab;
            sTab.SplitAndAppend(json.stringOf("QueryResponse.Employee[i].BirthDate"),"-",true,true);
            const char *year = sTab.stringAt(0);
            const char *month = sTab.stringAt(1);
            const char *day = sTab.stringAt(2);
            strOut.append("BirthDate: ");
            strOut.append(month);
            strOut.append("/");
            strOut.append(day);
            strOut.append("/");
            strOut.append(year);
            strOut.append("\r\n");
        }

        strOut.append("----");
        strOut.append("\r\n");
        i = i + 1;
    }

    strOut.append("Success.");
    strOut.append("\r\n");

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


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }