Lua

Xero Download Attachment for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to download a particular attachment for a particular Xero item. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/xero-access-token.json")
if not success then
    print(jsonToken.last_error_text)
    return
end

http.auth_token = jsonToken:string_of("access_token")

-- Replace the value here with an actual tenant ID obtained from this example:
-- Get Xero Tenant IDs
http:set_request_header("Xero-tenant-id", "83299b9e-5747-4a14-a18a-a6c94f824eb7")

http.accept = "application/json"

-- The example to list Xero attachments shows how to get attachment information.
-- Here's a sample JSON response obtained form listing attachments:
-- Your application can get the AttachmentID's and filenames from it.

-- {
--   "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
--     }
--   ]
-- }

local url = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$AttachmentId}"

-- Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
http:set_url_var("Endpoint", "Invoices")

-- Guid is the ID of the item, such as the InvoiceID.
http:set_url_var("Guid", "0032f627-3156-4d30-9b1c-4d3b994dc921")

-- AttachmentId is the ID of the particular attachment to be downloaded
http:set_url_var("AttachmentId", "daf106e2-8634-4349-bfcc-86c1df0793b2")

-- Download the attachment data into bd.
local bd = chilkat.BinData.new()
success = http:quick_get_bd(url, bd)
if not success then
    print(http.last_error_text)
    return
end

print("Response Status Code: " .. http.last_status)

if http.last_status == 200 then
    -- Success
    -- Save to a file..
    success = bd:write_file("qa_output/penguines.jpg")
else
    -- Failed.  bd contains error information..
    print(bd:get_string("utf-8"))
end