Delphi DLL

QuickBooks - Read an Employee

See more QuickBooks Examples

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. Delphi DLL

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
jsonToken: HCkJsonObject;
rest: HCkRest;
bAutoReconnect: Boolean;
sbAuth: HCkStringBuilder;
responseBody: PWideChar;
json: HCkJsonObject;
dtime: HCkDateTime;
bLocalTime: Boolean;
dt: HCkDtObj;

begin
success := False;

// 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 = False) 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);

// The company ID is 123146096291789
// The employee ID is 58
responseBody := CkRest__fullRequestNoBody(rest,'GET','/v3/company/123146096291789/employee/58?minorversion=45');
if (CkRest_getLastMethodSuccess(rest) = False) 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);

// These will be used for parsing date/time strings..
dtime := CkDateTime_Create();

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

// Get some information from the JSON..
Memo1.Lines.Add('Name: ' + CkJsonObject__stringOf(json,'Employee.DisplayName'));
Memo1.Lines.Add('Id: ' + CkJsonObject__stringOf(json,'Employee.Id'));
Memo1.Lines.Add('City: ' + CkJsonObject__stringOf(json,'Employee.PrimaryAddr.City'));
Memo1.Lines.Add('PostalCode: ' + CkJsonObject__stringOf(json,'Employee.PrimaryAddr.PostalCode'));

// Load the CreateTime into a CkDateTime...
CkDateTime_SetFromTimestamp(dtime,CkJsonObject__stringOf(json,'Employee.MetaData.CreateTime'));
bLocalTime := True;
dt := CkDtObj_Create();
CkDateTime_ToDtObj(dtime,bLocalTime,dt);

Memo1.Lines.Add(IntToStr(CkDtObj_getMonth(dt)) + '/' + IntToStr(CkDtObj_getDay(dt)) + '/' + IntToStr(CkDtObj_getYear(dt)) + '  '
     + IntToStr(CkDtObj_getHour(dt)) + ':' + IntToStr(CkDtObj_getMinute(dt)));

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

CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(dtime);
CkDtObj_Dispose(dt);

end;