Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loJsonToken
LOCAL lcUrl
LOCAL loResp
LOCAL loJsonResponse
LOCAL lcAttachmentID
LOCAL lcFileName
LOCAL lcV_Url
LOCAL lcMimeType
LOCAL lnContentLength
LOCAL lcId
LOCAL lcStatus
LOCAL lcProviderName
LOCAL lcDateTimeUTC
LOCAL i
LOCAL lnCount_i

lnSuccess = 0

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

loHttp = CreateObject('Chilkat.Http')

loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
IF (lnSuccess = 0) THEN
    ? loJsonToken.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    CANCEL
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('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpNoBody("GET",lcUrl,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loResp
    CANCEL
ENDIF

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

loJsonResponse = CreateObject('Chilkat.JsonObject')
loJsonResponse.Load(loResp.BodyStr)
loJsonResponse.EmitCompact = 0
? loJsonResponse.Emit()

IF (loResp.StatusCode <> 200) THEN
    ? "Failed."
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loResp
    RELEASE loJsonResponse
    CANCEL
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