(Excel) Xero List Attachments for an Item (such as an Invoice)

Demonstrates how to get information about the attachments for a particular Xero item.

For more information, see https://developer.xero.com/documentation/api/attachments#GET

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
If (success = False) Then
    Debug.Print jsonToken.LastErrorText
    Exit Sub
End If

http.AuthToken = jsonToken.StringOf("access_token")

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

http.Accept = "application/json"


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

' Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
Dim success As Boolean
success = http.SetUrlVar("Endpoint","Invoices")

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


Set resp = http.QuickRequest("GET",url)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "Response Status Code: "; resp.StatusCode

Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
success = jsonResponse.Load(resp.BodyStr)
jsonResponse.EmitCompact = False
Debug.Print jsonResponse.Emit()

If (resp.StatusCode <> 200) Then
    Debug.Print "Failed."

    Exit Sub
End If

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


Id = jsonResponse.StringOf("Id")

Status = jsonResponse.StringOf("Status")

ProviderName = jsonResponse.StringOf("ProviderName")

DateTimeUTC = jsonResponse.StringOf("DateTimeUTC")

i = 0

count_i = jsonResponse.SizeOfArray("Attachments")
Do While i < count_i
    jsonResponse.I = i
    AttachmentID = jsonResponse.StringOf("Attachments[i].AttachmentID")
    FileName = jsonResponse.StringOf("Attachments[i].FileName")
    v_Url = jsonResponse.StringOf("Attachments[i].Url")
    MimeType = jsonResponse.StringOf("Attachments[i].MimeType")
    ContentLength = jsonResponse.IntOf("Attachments[i].ContentLength")
    i = i + 1
Loop