JavaScript

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

var success = false;

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

var http = new CkHttp();

var jsonToken = new CkJsonObject();
success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json");
if (success == false) {
    console.log(jsonToken.LastErrorText);
    return;
}

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";

var 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");

var resp = new CkHttpResponse();
success = http.HttpNoBody("GET",url,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

console.log("Response Status Code: " + resp.StatusCode);

var jsonResponse = new CkJsonObject();
jsonResponse.Load(resp.BodyStr);
jsonResponse.EmitCompact = false;
console.log(jsonResponse.Emit());

if (resp.StatusCode !== 200) {
    console.log("Failed.");
    return;
}

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

var AttachmentID;
var FileName;
var v_Url;
var MimeType;
var ContentLength;

var Id = jsonResponse.StringOf("Id");
var Status = jsonResponse.StringOf("Status");
var ProviderName = jsonResponse.StringOf("ProviderName");
var DateTimeUTC = jsonResponse.StringOf("DateTimeUTC");
var i = 0;
var 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;
}