Lianja

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

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

// Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
loHttp.SetUrlVar("Endpoint","Invoices")

// Guid is the ID of the item, such as the InvoiceID.
loHttp.SetUrlVar("Guid","0032f627-3156-4d30-9b1c-4d3b994dc921")

loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpNoBody("GET",lcUrl,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 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
//     }
//   ]
// }

lcId = loJsonResponse.StringOf("Id")
lcStatus = loJsonResponse.StringOf("Status")
lcProviderName = loJsonResponse.StringOf("ProviderName")
lcDateTimeUTC = loJsonResponse.StringOf("DateTimeUTC")
i = 0
lnCount_i = loJsonResponse.SizeOfArray("Attachments")
do while i < lnCount_i
    loJsonResponse.I = i
    lcAttachmentID = loJsonResponse.StringOf("Attachments[i].AttachmentID")
    lcFileName = loJsonResponse.StringOf("Attachments[i].FileName")
    lcV_Url = loJsonResponse.StringOf("Attachments[i].Url")
    lcMimeType = loJsonResponse.StringOf("Attachments[i].MimeType")
    lnContentLength = loJsonResponse.IntOf("Attachments[i].ContentLength")
    i = i + 1
enddo


release loHttp
release loJsonToken
release loResp
release loJsonResponse