Sample code for 30+ languages & platforms
Lua Requires Chilkat v11.0.0+

Xero Get Invoices

See more Xero Examples

Get Xero company invoices.

Chilkat Lua Downloads

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 resp = chilkat.HttpResponse.new()
success = http:http_no_body("GET", "https://api.xero.com/api.xro/2.0/Invoices", 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 output...
-- (See the parsing code below..)
--
-- Use the this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON

-- {
--   "Id": "bda1f62f-0d63-4178-8d54-e91fd226987a",
--   "Status": "OK",
--   "ProviderName": "Chilkat2222",
--   "DateTimeUTC": "\/Date(1587210234493)\/",
--   "Invoices": [
--     {
--       "Type": "ACCPAY",
--       "InvoiceID": "0032f627-3156-4d30-9b1c-4d3b994dc921",
--       "InvoiceNumber": "9871",
--       "Reference": "",
--       "Payments": [
--         {
--           "PaymentID": "22974891-3689-4694-9ee7-fd2ba917af55",
--           "Date": "\/Date(1579737600000+0000)\/",
--           "Amount": 148.50,
--           "Reference": "Chq 409",
--           "HasAccount": false,
--           "HasValidationErrors": false
--         }
--       ],
--       "CreditNotes": [
--       ],
--       "Prepayments": [
--       ],
--       "Overpayments": [
--       ],
--       "AmountDue": 0.00,
--       "AmountPaid": 148.50,
--       "AmountCredited": 0.00,
--       "IsDiscounted": false,
--       "HasAttachments": false,
--       "HasErrors": false,
--       "Contact": {
--         "ContactID": "d6a384fb-f46f-41a3-8ac7-b7bc9e0b5efa",
--         "Name": "Melrose Parking",
--         "Addresses": [
--         ],
--         "Phones": [
--         ],
--         "ContactGroups": [
--         ],
--         "ContactPersons": [
--         ],
--         "HasValidationErrors": false
--       },
--       "DateString": "2020-01-15T00:00:00",
--       "Date": "\/Date(1579046400000+0000)\/",
--       "DueDateString": "2020-01-24T00:00:00",
--       "DueDate": "\/Date(1579824000000+0000)\/",
--       "Status": "PAID",
--       "LineAmountTypes": "Exclusive",
--       "LineItems": [
--       ],
--       "SubTotal": 135.00,
--       "TotalTax": 13.50,
--       "Total": 148.50,
--       "UpdatedDateUTC": "\/Date(1221560931500+0000)\/",
--       "CurrencyCode": "AUD",
--       "FullyPaidOnDate": "\/Date(1579737600000+0000)\/"
--     },
--     {
--       "Type": "ACCPAY",
--       "InvoiceID": "673dd7cc-beb7-4697-83d4-0c47cb400cc2",
--       "InvoiceNumber": "",
--       "Reference": "",
--       "Payments": [
--         {
--           "PaymentID": "4d06f609-5200-4364-9c8b-d4379a945252",
--           "Date": "\/Date(1580688000000+0000)\/",
--           "Amount": 974.60,
--           "Reference": "DD # 96013",
--           "HasAccount": false,
--           "HasValidationErrors": false
--         }
--       ],
--       "CreditNotes": [
--         {
--           "CreditNoteID": "7df8949c-b71f-40c0-bbcf-39f2f450f286",
--           "CreditNoteNumber": "03391",
--           "ID": "7df8949c-b71f-40c0-bbcf-39f2f450f286",
--           "HasErrors": false,
--           "AppliedAmount": 218.90,
--           "DateString": "2020-01-29T00:00:00",
--           "Date": "\/Date(1580256000000+0000)\/",
--           "LineItems": [
--           ],
--           "Total": 218.90
--         }
--       ],
--       "Prepayments": [
--       ],
--       "Overpayments": [
--       ],
--       "AmountDue": 0.00,
--       "AmountPaid": 974.60,
--       "AmountCredited": 218.90,
--       "IsDiscounted": false,
--       "HasAttachments": false,
--       "HasErrors": false,
--       "Contact": {
--         "ContactID": "d0cd2c4f-18a0-4f7c-a32a-2db00f29d298",
--         "Name": "PC Complete",
--         "Addresses": [
--         ],
--         "Phones": [
--         ],
--         "ContactGroups": [
--         ],
--         "ContactPersons": [
--         ],
--         "HasValidationErrors": false
--       },
--       "DateString": "2020-01-28T00:00:00",
--       "Date": "\/Date(1580169600000+0000)\/",
--       "DueDateString": "2020-02-04T00:00:00",
--       "DueDate": "\/Date(1580774400000+0000)\/",
--       "Status": "PAID",
--       "LineAmountTypes": "Exclusive",
--       "LineItems": [
--       ],
--       "SubTotal": 1085.00,
--       "TotalTax": 108.50,
--       "Total": 1193.50,
--       "UpdatedDateUTC": "\/Date(1221561913790+0000)\/",
--       "CurrencyCode": "AUD",
--       "FullyPaidOnDate": "\/Date(1580688000000+0000)\/"
--     },
--     {
--       "Type": "ACCPAY",
--       "InvoiceID": "c12aff7e-12bf-4185-8702-460929f19674",
--       "InvoiceNumber": "",
--       "Reference": "",
--       "Payments": [
--       ],
--       "CreditNotes": [
--       ],
--       "Prepayments": [
--       ],
--       "Overpayments": [
--       ],
--       "AmountDue": 2166.99,
--       "AmountPaid": 0.00,
--       "AmountCredited": 0.00,
--       "CurrencyRate": 1.000000,
--       "IsDiscounted": false,
--       "HasAttachments": false,
--       "HasErrors": false,
--       "Contact": {
--         "ContactID": "d0cd2c4f-18a0-4f7c-a32a-2db00f29d298",
--         "Name": "PC Complete",
--         "Addresses": [
--         ],
--         "Phones": [
--         ],
--         "ContactGroups": [
--         ],
--         "ContactPersons": [
--         ],
--         "HasValidationErrors": false
--       },
--       "DateString": "2020-04-10T00:00:00",
--       "Date": "\/Date(1586476800000+0000)\/",
--       "DueDateString": "2020-05-05T00:00:00",
--       "DueDate": "\/Date(1588636800000+0000)\/",
--       "Status": "AUTHORISED",
--       "LineAmountTypes": "Exclusive",
--       "LineItems": [
--       ],
--       "SubTotal": 1969.99,
--       "TotalTax": 197.00,
--       "Total": 2166.99,
--       "UpdatedDateUTC": "\/Date(1497965301980+0000)\/",
--       "CurrencyCode": "AUD"
--     }
--   ]
-- }
--

local Type = ""
local InvoiceID = ""
local InvoiceNumber = ""
local Reference = ""
local AmountDue = ""
local AmountPaid = ""
local AmountCredited = ""
local IsDiscounted = false
local HasAttachments = false
local HasErrors = false
local ContactContactID = ""
local ContactName = ""
local ContactHasValidationErrors = false
local DateString = ""
local Date = ""
local DueDateString = ""
local DueDate = ""
local LineAmountTypes = ""
local SubTotal = ""
local TotalTax = ""
local Total = ""
local UpdatedDateUTC = ""
local CurrencyCode = ""
local FullyPaidOnDate = ""
local CurrencyRate = ""
local j = 0
local count_j = 0
local PaymentID = ""
local Amount = ""
local HasAccount = false
local HasValidationErrors = false
local CreditNoteID = ""
local CreditNoteNumber = ""
local ID = ""
local AppliedAmount = ""
local k = 0
local count_k = 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("Invoices")
while i < count_i do
    jsonResponse.i = i
    Type = jsonResponse:string_of("Invoices[i].Type")
    InvoiceID = jsonResponse:string_of("Invoices[i].InvoiceID")
    InvoiceNumber = jsonResponse:string_of("Invoices[i].InvoiceNumber")
    Reference = jsonResponse:string_of("Invoices[i].Reference")
    AmountDue = jsonResponse:string_of("Invoices[i].AmountDue")
    AmountPaid = jsonResponse:string_of("Invoices[i].AmountPaid")
    AmountCredited = jsonResponse:string_of("Invoices[i].AmountCredited")
    IsDiscounted = jsonResponse:bool_of("Invoices[i].IsDiscounted")
    HasAttachments = jsonResponse:bool_of("Invoices[i].HasAttachments")
    HasErrors = jsonResponse:bool_of("Invoices[i].HasErrors")
    ContactContactID = jsonResponse:string_of("Invoices[i].Contact.ContactID")
    ContactName = jsonResponse:string_of("Invoices[i].Contact.Name")
    ContactHasValidationErrors = jsonResponse:bool_of("Invoices[i].Contact.HasValidationErrors")
    DateString = jsonResponse:string_of("Invoices[i].DateString")
    Date = jsonResponse:string_of("Invoices[i].Date")
    DueDateString = jsonResponse:string_of("Invoices[i].DueDateString")
    DueDate = jsonResponse:string_of("Invoices[i].DueDate")
    Status = jsonResponse:string_of("Invoices[i].Status")
    LineAmountTypes = jsonResponse:string_of("Invoices[i].LineAmountTypes")
    SubTotal = jsonResponse:string_of("Invoices[i].SubTotal")
    TotalTax = jsonResponse:string_of("Invoices[i].TotalTax")
    Total = jsonResponse:string_of("Invoices[i].Total")
    UpdatedDateUTC = jsonResponse:string_of("Invoices[i].UpdatedDateUTC")
    CurrencyCode = jsonResponse:string_of("Invoices[i].CurrencyCode")
    FullyPaidOnDate = jsonResponse:string_of("Invoices[i].FullyPaidOnDate")
    CurrencyRate = jsonResponse:string_of("Invoices[i].CurrencyRate")
    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Payments")
    while j < count_j do
        jsonResponse.j = j
        PaymentID = jsonResponse:string_of("Invoices[i].Payments[j].PaymentID")
        Date = jsonResponse:string_of("Invoices[i].Payments[j].Date")
        Amount = jsonResponse:string_of("Invoices[i].Payments[j].Amount")
        Reference = jsonResponse:string_of("Invoices[i].Payments[j].Reference")
        HasAccount = jsonResponse:bool_of("Invoices[i].Payments[j].HasAccount")
        HasValidationErrors = jsonResponse:bool_of("Invoices[i].Payments[j].HasValidationErrors")
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].CreditNotes")
    while j < count_j do
        jsonResponse.j = j
        CreditNoteID = jsonResponse:string_of("Invoices[i].CreditNotes[j].CreditNoteID")
        CreditNoteNumber = jsonResponse:string_of("Invoices[i].CreditNotes[j].CreditNoteNumber")
        ID = jsonResponse:string_of("Invoices[i].CreditNotes[j].ID")
        HasErrors = jsonResponse:bool_of("Invoices[i].CreditNotes[j].HasErrors")
        AppliedAmount = jsonResponse:string_of("Invoices[i].CreditNotes[j].AppliedAmount")
        DateString = jsonResponse:string_of("Invoices[i].CreditNotes[j].DateString")
        Date = jsonResponse:string_of("Invoices[i].CreditNotes[j].Date")
        Total = jsonResponse:string_of("Invoices[i].CreditNotes[j].Total")
        k = 0
        count_k = jsonResponse:size_of_array("Invoices[i].CreditNotes[j].LineItems")
        while k < count_k do
            jsonResponse.k = k
            k = k + 1
        end

        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Prepayments")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Overpayments")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Contact.Addresses")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Contact.Phones")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Contact.ContactGroups")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].Contact.ContactPersons")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    j = 0
    count_j = jsonResponse:size_of_array("Invoices[i].LineItems")
    while j < count_j do
        jsonResponse.j = j
        j = j + 1
    end

    i = i + 1
end