Delphi DLL

Xero List Attachments for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to get information about the attachments for a particular Xero item. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
jsonToken: HCkJsonObject;
url: PWideChar;
resp: HCkHttpResponse;
jsonResponse: HCkJsonObject;
AttachmentID: PWideChar;
FileName: PWideChar;
v_Url: PWideChar;
MimeType: PWideChar;
ContentLength: Integer;
Id: PWideChar;
Status: PWideChar;
ProviderName: PWideChar;
DateTimeUTC: PWideChar;
i: Integer;
count_i: Integer;

begin
success := False;

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

http := CkHttp_Create();

jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/xero-access-token.json');
if (success = False) then
  begin
    Memo1.Lines.Add(CkJsonObject__lastErrorText(jsonToken));
    Exit;
  end;

CkHttp_putAuthToken(http,CkJsonObject__stringOf(jsonToken,'access_token'));

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

CkHttp_putAccept(http,'application/json');

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

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

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

resp := CkHttpResponse_Create();
success := CkHttp_HttpNoBody(http,'GET',url,resp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add('Response Status Code: ' + IntToStr(CkHttpResponse_getStatusCode(resp)));

jsonResponse := CkJsonObject_Create();
CkJsonObject_Load(jsonResponse,CkHttpResponse__bodyStr(resp));
CkJsonObject_putEmitCompact(jsonResponse,False);
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));

if (CkHttpResponse_getStatusCode(resp) <> 200) then
  begin
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

// {
//   "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
//     }
//   ]
// }

Id := CkJsonObject__stringOf(jsonResponse,'Id');
Status := CkJsonObject__stringOf(jsonResponse,'Status');
ProviderName := CkJsonObject__stringOf(jsonResponse,'ProviderName');
DateTimeUTC := CkJsonObject__stringOf(jsonResponse,'DateTimeUTC');
i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'Attachments');
while i < count_i do
  begin
    CkJsonObject_putI(jsonResponse,i);
    AttachmentID := CkJsonObject__stringOf(jsonResponse,'Attachments[i].AttachmentID');
    FileName := CkJsonObject__stringOf(jsonResponse,'Attachments[i].FileName');
    v_Url := CkJsonObject__stringOf(jsonResponse,'Attachments[i].Url');
    MimeType := CkJsonObject__stringOf(jsonResponse,'Attachments[i].MimeType');
    ContentLength := CkJsonObject_IntOf(jsonResponse,'Attachments[i].ContentLength');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(jsonToken);
CkHttpResponse_Dispose(resp);
CkJsonObject_Dispose(jsonResponse);

end;