Sample code for 30+ languages & platforms
JavaScript

Xero Upload Attachment

See more Xero Examples

Demonstrates how to upload an attachment to Xero.
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.
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();

// Important: Make sure your OAuth2 access token was obtained with the scope "accounting.attachments"
// included in the list of scopes.

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/{$Filename}";

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

// Filename is the filename of the attachment you are uploading.
http.SetUrlVar("Filename","penguins.jpg");

// Load the file to be uploaded (from the local filesystem).
var bd = new CkBinData();
success = bd.LoadFile("qa_data/jpg/penguins.jpg");
if (success == false) {
    console.log("Failed to load attachment file.");
    return;
}

// Indicate the content-type according to the file content type.
// Common content-types are:   image/jpg, image/png, application/pdf, application/zip, application/msword
// If you don't know, use application/octet-stream
var resp = new CkHttpResponse();
success = http.HttpBd("POST",url,bd,"image/jpg",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;
}

// A sample response:

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

// {
//   "Id": "35333c64-4449-457b-bf6a-1b64d538e3c7",
//   "Status": "OK",
//   "ProviderName": "Chilkat2222",
//   "DateTimeUTC": "\/Date(1587212597758)\/",
//   "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
//     }
//   ]
// }