(Node.js) 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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var jsonToken = new chilkat.JsonObject();
    var success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

    var rest = new 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.
    var bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var sbAuth = new chilkat.StringBuilder();
    sbAuth.Append("Bearer ");
    sbAuth.Append(jsonToken.StringOf("access_token"));
    rest.Authorization = sbAuth.GetAsString();

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

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

    // The company ID is 123146096291789
    var responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/query");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // We should expect a 200 response if successful.
    if (rest.ResponseStatusCode !== 200) {
        console.log("Request Header: ");
        console.log(rest.LastRequestHeader);
        console.log("----");
        console.log("Response StatusCode = " + rest.ResponseStatusCode);
        console.log("Response StatusLine: " + rest.ResponseStatusText);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log(responseBody);
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    var json = new chilkat.JsonObject();
    json.Load(responseBody);

    // Show the full JSON response.
    json.EmitCompact = false;
    console.log(json.Emit());

    // 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..
    var dtime = new chilkat.CkDateTime();
    var bLocalTime = true;
    // dt: DtObj
    var dt;

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

        json.I = i;
        console.log("DisplayName: " + json.StringOf("QueryResponse.Employee[i].DisplayName"));
        console.log("Id: " + json.StringOf("QueryResponse.Employee[i].Id"));
        console.log("Active: " + json.BoolOf("QueryResponse.Employee[i].Active"));

        // Load the CreateTime into a CkDateTime...
        dtime.SetFromTimestamp(json.StringOf("QueryResponse.Employee[i].MetaData.CreateTime"));
        dt = dtime.GetDtObj(bLocalTime);
        console.log(dt.Month + "/" + dt.Day + "/" + dt.Year + "  " + dt.Hour + ":" + dt.Minute);

        // 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) {
            var sTab = new chilkat.StringTable();
            sTab.SplitAndAppend(json.StringOf("QueryResponse.Employee[i].BirthDate"),"-",true,true);
            var year = sTab.StringAt(0);
            var month = sTab.StringAt(1);
            var day = sTab.StringAt(2);
            console.log("BirthDate: " + month + "/" + day + "/" + year);
        }

        console.log("----");
        i = i+1;
    }

    console.log("Success.");

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

}

chilkatExample();