Lua Requires Chilkat v11.0.0+

Xero Upload Attachment

See more Xero Examples

Demonstrates how to upload an attachment to Xero. 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()

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

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"

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

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

-- Filename is the filename of the attachment you are uploading.
http:set_url_var("Filename", "penguins.jpg")

-- Load the file to be uploaded (from the local filesystem).
local bd = chilkat.BinData.new()
success = bd:load_file("qa_data/jpg/penguins.jpg")
if not success then
    print("Failed to load attachment file.")
    return
end

-- 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
local resp = chilkat.HttpResponse.new()
success = http:http_bd("POST", url, bd, "image/jpg", resp)
if not success then
    print(http.last_error_text)
    return
end

print("Response Status Code: " .. resp.status_code)

local jsonResponse = chilkat.JsonObject.new()
jsonResponse:load(resp.body_str)
jsonResponse.emit_compact = false
print(jsonResponse:emit())

if resp.status_code ~= 200 then
    print("Failed.")
    return
end

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