Perl

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. Perl

use chilkat();

$success = 0;

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

$http = chilkat::CkHttp->new();

$jsonToken = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/xero-access-token.json");
if ($success == 0) {
    print $jsonToken->lastErrorText() . "\r\n";
    exit;
}

$http->put_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->put_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 = chilkat::CkHttpResponse->new();
$success = $http->HttpNoBody("GET",$url,$resp);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print "Response Status Code: " . $resp->get_StatusCode() . "\r\n";

$jsonResponse = chilkat::CkJsonObject->new();
$jsonResponse->Load($resp->bodyStr());
$jsonResponse->put_EmitCompact(0);
print $jsonResponse->emit() . "\r\n";

if ($resp->get_StatusCode() != 200) {
    print "Failed." . "\r\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->put_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;
}