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

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

For more information, see https://developer.xero.com/documentation/api/attachments#GET

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonToken = new COM("Chilkat.JsonObject");
$success = $jsonToken->LoadFile('qa_data/tokens/xero-access-token.json');
if ($success == 0) {
    print $jsonToken->LastErrorText . "\n";
    exit;
}

$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';

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

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

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('GET',$url);
if ($http->LastMethodSuccess != 1) {
    print $http->LastErrorText . "\n";
    exit;
}

print 'Response Status Code: ' . $resp->StatusCode . "\n";

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonResponse = new COM("Chilkat.JsonObject");
$jsonResponse->Load($resp->BodyStr);
$jsonResponse->EmitCompact = 0;
print $jsonResponse->emit() . "\n";

if ($resp->StatusCode != 200) {
    print 'Failed.' . "\n";

    exit;
}

// 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 = $jsonResponse->stringOf('Id');
$Status = $jsonResponse->stringOf('Status');
$ProviderName = $jsonResponse->stringOf('ProviderName');
$DateTimeUTC = $jsonResponse->stringOf('DateTimeUTC');
$i = 0;
$count_i = $jsonResponse->SizeOfArray('Attachments');
while ($i < $count_i) {
    $jsonResponse->I = $i;
    $AttachmentID = $jsonResponse->stringOf('Attachments[i].AttachmentID');
    $FileName = $jsonResponse->stringOf('Attachments[i].FileName');
    $v_Url = $jsonResponse->stringOf('Attachments[i].Url');
    $MimeType = $jsonResponse->stringOf('Attachments[i].MimeType');
    $ContentLength = $jsonResponse->IntOf('Attachments[i].ContentLength');
    $i = $i + 1;
}


?>