(Delphi DLL) QuickBooks - Full Update an Employee

Demonstrates how to update any of the writable fields of an existing employee. The example first reads the JSON data for the employee, makes some changes, and then POST's the updated JSON to update the employee.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#full-update-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, StringBuilder, Rest, JsonObject;

...

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

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

// First get the data for the employee we'll be updating..
// 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) <> 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/updating
json := CkJsonObject_Create();
CkJsonObject_Load(json,responseBody);

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

// The JSON passed in the HTTP POST for updating is the inner content of the Employee
updateJson := CkJsonObject_ObjectOf(json,'Employee');

// Add or update the Line1 of the PrimaryAddr.
CkJsonObject_UpdateString(updateJson,'PrimaryAddr.Line1','2W 298 Campton Hills Rd.');

// Examine the JSON we'll be sending in the body of the POST.
CkJsonObject_putEmitCompact(updateJson,False);
Memo1.Lines.Add(CkJsonObject__emit(updateJson));
Memo1.Lines.Add('----');

// Now we're going to POST the changes to update the Quickbooks account.
CkRest_ClearAllHeaders(rest);
CkRest_putAuthorization(rest,CkStringBuilder__getAsString(sbAuth));
CkRest_AddHeader(rest,'Accept','application/json');
CkRest_AddHeader(rest,'Content-Type','application/json');

// The updated JSON is passed as the HTTP request body.
// (The employee ID is specified in the JSON body of the request, and therefore is is not in the path.)
responseBody := CkRest__fullRequestString(rest,'POST','/v3/company/123146096291789/employee?minorversion=45',CkJsonObject__emit(updateJson));
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    CkJsonObject_Dispose(updateJson);
    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);
    CkJsonObject_Dispose(updateJson);
    Exit;
  end;

CkJsonObject_Dispose(updateJson);

// Load the JSON response into a JSON object to emit in indented form..
CkJsonObject_Load(json,responseBody);
Memo1.Lines.Add(CkJsonObject__emit(json));

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

Memo1.Lines.Add('Success.');

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

end;