Pascal (Lazarus/Delphi)

Xero Download Attachment for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to download a particular attachment for a particular Xero item. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Http,
  Chilkat.BinData,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  http: THttp;
  jsonToken: TJsonObject;
  url: string;
  bd: TBinData;

begin
  success := False;

  //  This example requires the Chilkat API to have been previously unlocked.
  //  See Global Unlock Sample for sample code.

  http := THttp.Create;

  jsonToken := TJsonObject.Create;
  success := jsonToken.LoadFile('qa_data/tokens/xero-access-token.json');
  if (success = False) then
    begin
      WriteLn(jsonToken.LastErrorText);
      Exit;
    end;

  http.AuthToken := jsonToken.StringOf('access_token');

  //  Replace the value here with an actual tenant ID obtained from this example:
  //  Get Xero Tenant IDs
  http.SetRequestHeader('Xero-tenant-id','83299b9e-5747-4a14-a18a-a6c94f824eb7');

  http.Accept := 'application/json';

  //  The example to list Xero attachments shows how to get attachment information.
  //  Here's a sample JSON response obtained form listing attachments:
  //  Your application can get the AttachmentID's and filenames from it.

  //  {
  //    "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
  //    "Status": "OK",
  //    "ProviderName": "Chilkat2222",
  //    "DateTimeUTC": "\/Date(1587213296972)\/",
  //    "Attachments": [
  //      {
  //        "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
  //        "FileName": "penguins.jpg",
  //        "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
  //        "MimeType": "image/jpg",
  //        "ContentLength": 777835
  //      }
  //    ]
  //  }

  url := 'https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$AttachmentId}';

  //  Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
  http.SetUrlVar('Endpoint','Invoices');

  //  Guid is the ID of the item, such as the InvoiceID.
  http.SetUrlVar('Guid','0032f627-3156-4d30-9b1c-4d3b994dc921');

  //  AttachmentId is the ID of the particular attachment to be downloaded
  http.SetUrlVar('AttachmentId','daf106e2-8634-4349-bfcc-86c1df0793b2');

  //  Download the attachment data into bd.
  bd := TBinData.Create;
  success := http.QuickGetBd(url,bd);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  WriteLn('Response Status Code: ' + http.LastStatus);

  if (http.LastStatus = 200) then
    begin
      //  Success
      //  Save to a file..
      success := bd.WriteFile('qa_output/penguines.jpg');
    end
  else
    begin
      //  Failed.  bd contains error information..
      WriteLn(bd.GetString('utf-8'));
    end;


  http.Free;
  jsonToken.Free;
  bd.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.