Delphi DLL

QuickBooks - Create an Employee

See more QuickBooks Examples

Demonstrates how to send an JSON request to create a QuickBooks employee 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, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
jsonToken: HCkJsonObject;
rest: HCkRest;
bAutoReconnect: Boolean;
sbAuth: HCkStringBuilder;
json: HCkJsonObject;
responseBody: PWideChar;
jsonResponse: HCkJsonObject;

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 <> 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));

// Create the following JSON:

// Use this online tool to generate code from sample JSON: 
// Generate Code to Create JSON

// {
//   "SSN": "444-55-6666",
//   "PrimaryAddr": {
//     "Id": "50",
//     "Line1": "45 N. Elm Street",
//     "City": "Middlefield",
//     "CountrySubDivisionCode": "CA",
//     "PostalCode": "93242"
//   },
//   "GivenName": "John",
//   "FamilyName": "Meuller",
//   "PrimaryPhone": {
//     "FreeFormNumber": "408-525-1234"
//   }
// }
// 
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'SSN','444-55-6666');
CkJsonObject_UpdateString(json,'PrimaryAddr.Id','50');
CkJsonObject_UpdateString(json,'PrimaryAddr.Line1','45 N. Elm Street');
CkJsonObject_UpdateString(json,'PrimaryAddr.City','Middlefield');
CkJsonObject_UpdateString(json,'PrimaryAddr.CountrySubDivisionCode','CA');
CkJsonObject_UpdateString(json,'PrimaryAddr.PostalCode','93242');
CkJsonObject_UpdateString(json,'GivenName','John');
CkJsonObject_UpdateString(json,'FamilyName','Meuller');
CkJsonObject_UpdateString(json,'PrimaryPhone.FreeFormNumber','408-525-1234');

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

// The company ID is 123146096291789
responseBody := CkRest__fullRequestString(rest,'POST','/v3/company/123146096291789/employee?minorversion=45',CkJsonObject__emit(json));
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;

jsonResponse := CkJsonObject_Create();
CkJsonObject_Load(jsonResponse,responseBody);
CkJsonObject_putEmitCompact(jsonResponse,False);
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));
Memo1.Lines.Add('Success.');

// Use this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// A sample JSON response:
// {
//   "Employee": {
//     "SSN": "XXX-XX-XXXX",
//     "PrimaryAddr": {
//       "Id": "97",
//       "Line1": "45 N. Elm Street",
//       "City": "Middlefield",
//       "CountrySubDivisionCode": "CA",
//       "PostalCode": "93242"
//     },
//     "BillableTime": false,
//     "domain": "QBO",
//     "sparse": false,
//     "Id": "59",
//     "SyncToken": "0",
//     "MetaData": {
//       "CreateTime": "2016-10-25T14:05:05-07:00",
//       "LastUpdatedTime": "2016-10-25T14:05:05-07:00"
//     },
//     "GivenName": "John",
//     "FamilyName": "Meuller",
//     "DisplayName": "John Meuller",
//     "PrintOnCheckName": "John Meuller",
//     "Active": true,
//     "PrimaryPhone": {
//       "FreeFormNumber": "408-525-1234"
//     }
//   },
//   "time": "2016-10-25T14:05:05.661-07:00"
// }
// 

CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkJsonObject_Dispose(json);
CkJsonObject_Dispose(jsonResponse);

end;