AutoIt

Xero Download Attachment for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to download a particular attachment for a particular Xero item. AutoIt

Local $bSuccess = False

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

$oHttp = ObjCreate("Chilkat.Http")

$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
If ($bSuccess = False) Then
    ConsoleWrite($oJsonToken.LastErrorText & @CRLF)
    Exit
EndIf

$oHttp.AuthToken = $oJsonToken.StringOf("access_token")

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

$oHttp.Accept = "application/json"

; The example to list Xero attachments shows how to get attachment information.
; Here's a sample JSON response obtained form listing attachments:
; Your application can get the AttachmentID's and filenames from it.

; {
;   "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
;     }
;   ]
; }

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

; Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
$oHttp.SetUrlVar("Endpoint","Invoices")

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

; AttachmentId is the ID of the particular attachment to be downloaded
$oHttp.SetUrlVar("AttachmentId","daf106e2-8634-4349-bfcc-86c1df0793b2")

; Download the attachment data into bd.
$oBd = ObjCreate("Chilkat.BinData")
$bSuccess = $oHttp.QuickGetBd($sUrl,$oBd)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Response Status Code: " & $oHttp.LastStatus & @CRLF)

If ($oHttp.LastStatus = 200) Then
    ; Success
    ; Save to a file..
    $bSuccess = $oBd.WriteFile("qa_output/penguines.jpg")
Else
    ; Failed.  bd contains error information..
    ConsoleWrite($oBd.GetString("utf-8") & @CRLF)
EndIf