Lua Requires Chilkat v11.0.0+

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

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

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

local resp = chilkat.HttpResponse.new()
success = http:http_no_body("GET", url, 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

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

local AttachmentID = ""
local FileName = ""
local v_Url = ""
local MimeType = ""
local ContentLength = 0

local Id = jsonResponse:string_of("Id")
local Status = jsonResponse:string_of("Status")
local ProviderName = jsonResponse:string_of("ProviderName")
local DateTimeUTC = jsonResponse:string_of("DateTimeUTC")
local i = 0
local count_i = jsonResponse:size_of_array("Attachments")
while i < count_i do
    jsonResponse.i = i
    AttachmentID = jsonResponse:string_of("Attachments[i].AttachmentID")
    FileName = jsonResponse:string_of("Attachments[i].FileName")
    v_Url = jsonResponse:string_of("Attachments[i].Url")
    MimeType = jsonResponse:string_of("Attachments[i].MimeType")
    ContentLength = jsonResponse:int_of("Attachments[i].ContentLength")
    i = i + 1
end