(.NET Core C#) 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 .NET Downloads Chilkat .NET Assemblies Chilkat for .NET Core Chilkat for Mono

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

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

Chilkat.Rest 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.
bool bAutoReconnect = true;
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Chilkat.StringBuilder 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;

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

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

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

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

// Show the full JSON response.
json.EmitCompact = false;
Debug.WriteLine(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..
Chilkat.CkDateTime dtime = new Chilkat.CkDateTime();
bool bLocalTime = true;
Chilkat.DtObj dt = null;

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

    json.I = i;
    Debug.WriteLine("DisplayName: " + json.StringOf("QueryResponse.Employee[i].DisplayName"));
    Debug.WriteLine("Id: " + json.StringOf("QueryResponse.Employee[i].Id"));
    Debug.WriteLine("Active: " + Convert.ToString(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);
    Debug.WriteLine(Convert.ToString(dt.Month) + "/" + Convert.ToString(dt.Day) + "/" + Convert.ToString(dt.Year) + "  "
         + Convert.ToString(dt.Hour) + ":" + Convert.ToString(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) {
        Chilkat.StringTable sTab = new Chilkat.StringTable();
        sTab.SplitAndAppend(json.StringOf("QueryResponse.Employee[i].BirthDate"),"-",true,true);
        string year = sTab.StringAt(0);
        string month = sTab.StringAt(1);
        string day = sTab.StringAt(2);
        Debug.WriteLine("BirthDate: " + month + "/" + day + "/" + year);
    }

    Debug.WriteLine("----");
    i = i + 1;
}

Debug.WriteLine("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"
//