Sample code for 30+ languages & platforms
Lianja

Xero Get Invoices

See more Xero Examples

Get Xero company invoices.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

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

loHttp = createobject("CkHttp")

loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
if (llSuccess = .F.) then
    ? loJsonToken.LastErrorText
    release loHttp
    release loJsonToken
    return
endif

loHttp.AuthToken = loJsonToken.StringOf("access_token")

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

loHttp.Accept = "application/json"

loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpNoBody("GET","https://api.xero.com/api.xro/2.0/Invoices",loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJsonToken
    release loResp
    return
endif

? "Response Status Code: " + str(loResp.StatusCode)

loJsonResponse = createobject("CkJsonObject")
loJsonResponse.Load(loResp.BodyStr)
loJsonResponse.EmitCompact = .F.
? loJsonResponse.Emit()

if (loResp.StatusCode <> 200) then
    ? "Failed."
    release loHttp
    release loJsonToken
    release loResp
    release loJsonResponse
    return
endif

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

lcId = loJsonResponse.StringOf("Id")
lcStatus = loJsonResponse.StringOf("Status")
lcProviderName = loJsonResponse.StringOf("ProviderName")
lcDateTimeUTC = loJsonResponse.StringOf("DateTimeUTC")
i = 0
lnCount_i = loJsonResponse.SizeOfArray("Invoices")
do while i < lnCount_i
    loJsonResponse.I = i
    lcType = loJsonResponse.StringOf("Invoices[i].Type")
    lcInvoiceID = loJsonResponse.StringOf("Invoices[i].InvoiceID")
    lcInvoiceNumber = loJsonResponse.StringOf("Invoices[i].InvoiceNumber")
    lcReference = loJsonResponse.StringOf("Invoices[i].Reference")
    lcAmountDue = loJsonResponse.StringOf("Invoices[i].AmountDue")
    lcAmountPaid = loJsonResponse.StringOf("Invoices[i].AmountPaid")
    lcAmountCredited = loJsonResponse.StringOf("Invoices[i].AmountCredited")
    llIsDiscounted = loJsonResponse.BoolOf("Invoices[i].IsDiscounted")
    llHasAttachments = loJsonResponse.BoolOf("Invoices[i].HasAttachments")
    llHasErrors = loJsonResponse.BoolOf("Invoices[i].HasErrors")
    lcContactContactID = loJsonResponse.StringOf("Invoices[i].Contact.ContactID")
    lcContactName = loJsonResponse.StringOf("Invoices[i].Contact.Name")
    llContactHasValidationErrors = loJsonResponse.BoolOf("Invoices[i].Contact.HasValidationErrors")
    lcDateString = loJsonResponse.StringOf("Invoices[i].DateString")
    lcDate = loJsonResponse.StringOf("Invoices[i].Date")
    lcDueDateString = loJsonResponse.StringOf("Invoices[i].DueDateString")
    lcDueDate = loJsonResponse.StringOf("Invoices[i].DueDate")
    lcStatus = loJsonResponse.StringOf("Invoices[i].Status")
    lcLineAmountTypes = loJsonResponse.StringOf("Invoices[i].LineAmountTypes")
    lcSubTotal = loJsonResponse.StringOf("Invoices[i].SubTotal")
    lcTotalTax = loJsonResponse.StringOf("Invoices[i].TotalTax")
    lcTotal = loJsonResponse.StringOf("Invoices[i].Total")
    lcUpdatedDateUTC = loJsonResponse.StringOf("Invoices[i].UpdatedDateUTC")
    lcCurrencyCode = loJsonResponse.StringOf("Invoices[i].CurrencyCode")
    lcFullyPaidOnDate = loJsonResponse.StringOf("Invoices[i].FullyPaidOnDate")
    lcCurrencyRate = loJsonResponse.StringOf("Invoices[i].CurrencyRate")
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Payments")
    do while j < lnCount_j
        loJsonResponse.J = j
        lcPaymentID = loJsonResponse.StringOf("Invoices[i].Payments[j].PaymentID")
        lcDate = loJsonResponse.StringOf("Invoices[i].Payments[j].Date")
        lcAmount = loJsonResponse.StringOf("Invoices[i].Payments[j].Amount")
        lcReference = loJsonResponse.StringOf("Invoices[i].Payments[j].Reference")
        llHasAccount = loJsonResponse.BoolOf("Invoices[i].Payments[j].HasAccount")
        llHasValidationErrors = loJsonResponse.BoolOf("Invoices[i].Payments[j].HasValidationErrors")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].CreditNotes")
    do while j < lnCount_j
        loJsonResponse.J = j
        lcCreditNoteID = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].CreditNoteID")
        lcCreditNoteNumber = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].CreditNoteNumber")
        lcID = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].ID")
        llHasErrors = loJsonResponse.BoolOf("Invoices[i].CreditNotes[j].HasErrors")
        lcAppliedAmount = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].AppliedAmount")
        lcDateString = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].DateString")
        lcDate = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].Date")
        lcTotal = loJsonResponse.StringOf("Invoices[i].CreditNotes[j].Total")
        k = 0
        lnCount_k = loJsonResponse.SizeOfArray("Invoices[i].CreditNotes[j].LineItems")
        do while k < lnCount_k
            loJsonResponse.K = k
            k = k + 1
        enddo
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Prepayments")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Overpayments")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Contact.Addresses")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Contact.Phones")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Contact.ContactGroups")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].Contact.ContactPersons")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("Invoices[i].LineItems")
    do while j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loJsonToken
release loResp
release loJsonResponse