(Delphi DLL) Xero Get Invoices

Get Xero company invoices.

For more information, see https://developer.xero.com/documentation/api/invoices

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, Http, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
jsonToken: HCkJsonObject;
success: Boolean;
resp: HCkHttpResponse;
jsonResponse: HCkJsonObject;
Type: PWideChar;
InvoiceID: PWideChar;
InvoiceNumber: PWideChar;
Reference: PWideChar;
AmountDue: PWideChar;
AmountPaid: PWideChar;
AmountCredited: PWideChar;
IsDiscounted: Boolean;
HasAttachments: Boolean;
HasErrors: Boolean;
ContactContactID: PWideChar;
ContactName: PWideChar;
ContactHasValidationErrors: Boolean;
DateString: PWideChar;
Date: PWideChar;
DueDateString: PWideChar;
DueDate: PWideChar;
LineAmountTypes: PWideChar;
SubTotal: PWideChar;
TotalTax: PWideChar;
Total: PWideChar;
UpdatedDateUTC: PWideChar;
CurrencyCode: PWideChar;
FullyPaidOnDate: PWideChar;
CurrencyRate: PWideChar;
j: Integer;
count_j: Integer;
PaymentID: PWideChar;
Amount: PWideChar;
HasAccount: Boolean;
HasValidationErrors: Boolean;
CreditNoteID: PWideChar;
CreditNoteNumber: PWideChar;
ID: PWideChar;
AppliedAmount: PWideChar;
k: Integer;
count_k: Integer;
Id: PWideChar;
Status: PWideChar;
ProviderName: PWideChar;
DateTimeUTC: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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');

resp := CkHttp_QuickRequest(http,'GET','https://api.xero.com/api.xro/2.0/Invoices');
if (CkHttp_getLastMethodSuccess(http) <> True) 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.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;

CkHttpResponse_Dispose(resp);

// Sample output...
// (See the parsing code below..)
// 
// Use the this online tool to generate parsing code from sample JSON: 
// Generate Parsing Code from JSON

// {
//   "Id": "bda1f62f-0d63-4178-8d54-e91fd226987a",
//   "Status": "OK",
//   "ProviderName": "Chilkat2222",
//   "DateTimeUTC": "\/Date(1587210234493)\/",
//   "Invoices": [
//     {
//       "Type": "ACCPAY",
//       "InvoiceID": "0032f627-3156-4d30-9b1c-4d3b994dc921",
//       "InvoiceNumber": "9871",
//       "Reference": "",
//       "Payments": [
//         {
//           "PaymentID": "22974891-3689-4694-9ee7-fd2ba917af55",
//           "Date": "\/Date(1579737600000+0000)\/",
//           "Amount": 148.50,
//           "Reference": "Chq 409",
//           "HasAccount": false,
//           "HasValidationErrors": false
//         }
//       ],
//       "CreditNotes": [
//       ],
//       "Prepayments": [
//       ],
//       "Overpayments": [
//       ],
//       "AmountDue": 0.00,
//       "AmountPaid": 148.50,
//       "AmountCredited": 0.00,
//       "IsDiscounted": false,
//       "HasAttachments": false,
//       "HasErrors": false,
//       "Contact": {
//         "ContactID": "d6a384fb-f46f-41a3-8ac7-b7bc9e0b5efa",
//         "Name": "Melrose Parking",
//         "Addresses": [
//         ],
//         "Phones": [
//         ],
//         "ContactGroups": [
//         ],
//         "ContactPersons": [
//         ],
//         "HasValidationErrors": false
//       },
//       "DateString": "2020-01-15T00:00:00",
//       "Date": "\/Date(1579046400000+0000)\/",
//       "DueDateString": "2020-01-24T00:00:00",
//       "DueDate": "\/Date(1579824000000+0000)\/",
//       "Status": "PAID",
//       "LineAmountTypes": "Exclusive",
//       "LineItems": [
//       ],
//       "SubTotal": 135.00,
//       "TotalTax": 13.50,
//       "Total": 148.50,
//       "UpdatedDateUTC": "\/Date(1221560931500+0000)\/",
//       "CurrencyCode": "AUD",
//       "FullyPaidOnDate": "\/Date(1579737600000+0000)\/"
//     },
//     {
//       "Type": "ACCPAY",
//       "InvoiceID": "673dd7cc-beb7-4697-83d4-0c47cb400cc2",
//       "InvoiceNumber": "",
//       "Reference": "",
//       "Payments": [
//         {
//           "PaymentID": "4d06f609-5200-4364-9c8b-d4379a945252",
//           "Date": "\/Date(1580688000000+0000)\/",
//           "Amount": 974.60,
//           "Reference": "DD # 96013",
//           "HasAccount": false,
//           "HasValidationErrors": false
//         }
//       ],
//       "CreditNotes": [
//         {
//           "CreditNoteID": "7df8949c-b71f-40c0-bbcf-39f2f450f286",
//           "CreditNoteNumber": "03391",
//           "ID": "7df8949c-b71f-40c0-bbcf-39f2f450f286",
//           "HasErrors": false,
//           "AppliedAmount": 218.90,
//           "DateString": "2020-01-29T00:00:00",
//           "Date": "\/Date(1580256000000+0000)\/",
//           "LineItems": [
//           ],
//           "Total": 218.90
//         }
//       ],
//       "Prepayments": [
//       ],
//       "Overpayments": [
//       ],
//       "AmountDue": 0.00,
//       "AmountPaid": 974.60,
//       "AmountCredited": 218.90,
//       "IsDiscounted": false,
//       "HasAttachments": false,
//       "HasErrors": false,
//       "Contact": {
//         "ContactID": "d0cd2c4f-18a0-4f7c-a32a-2db00f29d298",
//         "Name": "PC Complete",
//         "Addresses": [
//         ],
//         "Phones": [
//         ],
//         "ContactGroups": [
//         ],
//         "ContactPersons": [
//         ],
//         "HasValidationErrors": false
//       },
//       "DateString": "2020-01-28T00:00:00",
//       "Date": "\/Date(1580169600000+0000)\/",
//       "DueDateString": "2020-02-04T00:00:00",
//       "DueDate": "\/Date(1580774400000+0000)\/",
//       "Status": "PAID",
//       "LineAmountTypes": "Exclusive",
//       "LineItems": [
//       ],
//       "SubTotal": 1085.00,
//       "TotalTax": 108.50,
//       "Total": 1193.50,
//       "UpdatedDateUTC": "\/Date(1221561913790+0000)\/",
//       "CurrencyCode": "AUD",
//       "FullyPaidOnDate": "\/Date(1580688000000+0000)\/"
//     },
//     {
//       "Type": "ACCPAY",
//       "InvoiceID": "c12aff7e-12bf-4185-8702-460929f19674",
//       "InvoiceNumber": "",
//       "Reference": "",
//       "Payments": [
//       ],
//       "CreditNotes": [
//       ],
//       "Prepayments": [
//       ],
//       "Overpayments": [
//       ],
//       "AmountDue": 2166.99,
//       "AmountPaid": 0.00,
//       "AmountCredited": 0.00,
//       "CurrencyRate": 1.000000,
//       "IsDiscounted": false,
//       "HasAttachments": false,
//       "HasErrors": false,
//       "Contact": {
//         "ContactID": "d0cd2c4f-18a0-4f7c-a32a-2db00f29d298",
//         "Name": "PC Complete",
//         "Addresses": [
//         ],
//         "Phones": [
//         ],
//         "ContactGroups": [
//         ],
//         "ContactPersons": [
//         ],
//         "HasValidationErrors": false
//       },
//       "DateString": "2020-04-10T00:00:00",
//       "Date": "\/Date(1586476800000+0000)\/",
//       "DueDateString": "2020-05-05T00:00:00",
//       "DueDate": "\/Date(1588636800000+0000)\/",
//       "Status": "AUTHORISED",
//       "LineAmountTypes": "Exclusive",
//       "LineItems": [
//       ],
//       "SubTotal": 1969.99,
//       "TotalTax": 197.00,
//       "Total": 2166.99,
//       "UpdatedDateUTC": "\/Date(1497965301980+0000)\/",
//       "CurrencyCode": "AUD"
//     }
//   ]
// }
// 

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,'Invoices');
while i < count_i do
  begin
    CkJsonObject_putI(jsonResponse,i);
    Type := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Type');
    InvoiceID := CkJsonObject__stringOf(jsonResponse,'Invoices[i].InvoiceID');
    InvoiceNumber := CkJsonObject__stringOf(jsonResponse,'Invoices[i].InvoiceNumber');
    Reference := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Reference');
    AmountDue := CkJsonObject__stringOf(jsonResponse,'Invoices[i].AmountDue');
    AmountPaid := CkJsonObject__stringOf(jsonResponse,'Invoices[i].AmountPaid');
    AmountCredited := CkJsonObject__stringOf(jsonResponse,'Invoices[i].AmountCredited');
    IsDiscounted := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].IsDiscounted');
    HasAttachments := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].HasAttachments');
    HasErrors := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].HasErrors');
    ContactContactID := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Contact.ContactID');
    ContactName := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Contact.Name');
    ContactHasValidationErrors := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].Contact.HasValidationErrors');
    DateString := CkJsonObject__stringOf(jsonResponse,'Invoices[i].DateString');
    Date := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Date');
    DueDateString := CkJsonObject__stringOf(jsonResponse,'Invoices[i].DueDateString');
    DueDate := CkJsonObject__stringOf(jsonResponse,'Invoices[i].DueDate');
    Status := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Status');
    LineAmountTypes := CkJsonObject__stringOf(jsonResponse,'Invoices[i].LineAmountTypes');
    SubTotal := CkJsonObject__stringOf(jsonResponse,'Invoices[i].SubTotal');
    TotalTax := CkJsonObject__stringOf(jsonResponse,'Invoices[i].TotalTax');
    Total := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Total');
    UpdatedDateUTC := CkJsonObject__stringOf(jsonResponse,'Invoices[i].UpdatedDateUTC');
    CurrencyCode := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CurrencyCode');
    FullyPaidOnDate := CkJsonObject__stringOf(jsonResponse,'Invoices[i].FullyPaidOnDate');
    CurrencyRate := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CurrencyRate');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Payments');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        PaymentID := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Payments[j].PaymentID');
        Date := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Payments[j].Date');
        Amount := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Payments[j].Amount');
        Reference := CkJsonObject__stringOf(jsonResponse,'Invoices[i].Payments[j].Reference');
        HasAccount := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].Payments[j].HasAccount');
        HasValidationErrors := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].Payments[j].HasValidationErrors');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].CreditNotes');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        CreditNoteID := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].CreditNoteID');
        CreditNoteNumber := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].CreditNoteNumber');
        ID := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].ID');
        HasErrors := CkJsonObject_BoolOf(jsonResponse,'Invoices[i].CreditNotes[j].HasErrors');
        AppliedAmount := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].AppliedAmount');
        DateString := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].DateString');
        Date := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].Date');
        Total := CkJsonObject__stringOf(jsonResponse,'Invoices[i].CreditNotes[j].Total');
        k := 0;
        count_k := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].CreditNotes[j].LineItems');
        while k < count_k do
          begin
            CkJsonObject_putK(jsonResponse,k);
            k := k + 1;
          end;

        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Prepayments');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Overpayments');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Contact.Addresses');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Contact.Phones');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Contact.ContactGroups');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].Contact.ContactPersons');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jsonResponse,'Invoices[i].LineItems');
    while j < count_j do
      begin
        CkJsonObject_putJ(jsonResponse,j);
        j := j + 1;
      end;

    i := i + 1;
  end;

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

end;