(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringTable, CkDateTime, DtObj, Rest, JsonObject, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
success: Boolean;
rest: HCkRest;
bAutoReconnect: Boolean;
sbAuth: HCkStringBuilder;
query: PWideChar;
responseBody: PWideChar;
json: HCkJsonObject;
dtime: HCkDateTime;
bLocalTime: Boolean;
dt: HCkDtObj;
numRecords: Integer;
i: Integer;
sTab: HCkStringTable;
year: PWideChar;
month: PWideChar;
day: PWideChar;

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

jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/qb-access-token.json');

rest := CkRest_Create();

// 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.
bAutoReconnect := True;
success := CkRest_Connect(rest,'sandbox-quickbooks.api.intuit.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

sbAuth := CkStringBuilder_Create();
CkStringBuilder_Append(sbAuth,'Bearer ');
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'access_token'));
CkRest_putAuthorization(rest,CkStringBuilder__getAsString(sbAuth));

CkRest_AddHeader(rest,'Accept','application/json');
CkRest_putAllowHeaderFolding(rest,False);

query := 'select * from Employee';
CkRest_AddQueryParam(rest,'query',query);
CkRest_AddQueryParam(rest,'minorversion','45');

// The company ID is 123146096291789
responseBody := CkRest__fullRequestNoBody(rest,'GET','/v3/company/123146096291789/query');
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// We should expect a 200 response if successful.
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add('Request Header: ');
    Memo1.Lines.Add(CkRest__lastRequestHeader(rest));
    Memo1.Lines.Add('----');
    Memo1.Lines.Add('Response StatusCode = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('Response StatusLine: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Memo1.Lines.Add(responseBody);
    Exit;
  end;

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
json := CkJsonObject_Create();
CkJsonObject_Load(json,responseBody);

// Show the full JSON response.
CkJsonObject_putEmitCompact(json,False);
Memo1.Lines.Add(CkJsonObject__emit(json));

// 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..
dtime := CkDateTime_Create();
bLocalTime := True;

// Iterate over each account returned.
numRecords := CkJsonObject_SizeOfArray(json,'QueryResponse.Employee');
i := 0;
while i < numRecords do
  begin

    CkJsonObject_putI(json,i);
    Memo1.Lines.Add('DisplayName: ' + CkJsonObject__stringOf(json,'QueryResponse.Employee[i].DisplayName'));
    Memo1.Lines.Add('Id: ' + CkJsonObject__stringOf(json,'QueryResponse.Employee[i].Id'));
    Memo1.Lines.Add('Active: ' + IntToStr(CkJsonObject_BoolOf(json,'QueryResponse.Employee[i].Active')));

    // Load the CreateTime into a CkDateTime...
    CkDateTime_SetFromTimestamp(dtime,CkJsonObject__stringOf(json,'QueryResponse.Employee[i].MetaData.CreateTime'));
    dt := CkDateTime_GetDtObj(dtime,bLocalTime);
    Memo1.Lines.Add(IntToStr(CkDtObj_getMonth(dt)) + '/' + IntToStr(CkDtObj_getDay(dt)) + '/' + IntToStr(CkDtObj_getYear(dt)) + '  '
         + IntToStr(CkDtObj_getHour(dt)) + ':' + IntToStr(CkDtObj_getMinute(dt)));
    CkDtObj_Dispose(dt);

    // The the birth year, month, and day, if it exists.
    // The BirthDate contains something like this: "1985-09-11"
    if (CkJsonObject_HasMember(json,'QueryResponse.Employee[i].BirthDate') = True) then
      begin
        sTab := CkStringTable_Create();
        CkStringTable_SplitAndAppend(sTab,CkJsonObject__stringOf(json,'QueryResponse.Employee[i].BirthDate'),'-',True,True);
        year := CkStringTable__stringAt(sTab,0);
        month := CkStringTable__stringAt(sTab,1);
        day := CkStringTable__stringAt(sTab,2);
        Memo1.Lines.Add('BirthDate: ' + month + '/' + day + '/' + year);
      end;

    Memo1.Lines.Add('----');
    i := i + 1;
  end;

Memo1.Lines.Add('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"
// 

CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(dtime);
        CkStringTable_Dispose(sTab);

end;