Tcl

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

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/xero-access-token.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonToken]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

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

CkHttp_put_Accept $http "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
#     }
#   ]
# }

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

# Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
CkHttp_SetUrlVar $http "Endpoint" "Invoices"

# Guid is the ID of the item, such as the InvoiceID.
CkHttp_SetUrlVar $http "Guid" "0032f627-3156-4d30-9b1c-4d3b994dc921"

# AttachmentId is the ID of the particular attachment to be downloaded
CkHttp_SetUrlVar $http "AttachmentId" "daf106e2-8634-4349-bfcc-86c1df0793b2"

# Download the attachment data into bd.
set bd [new_CkBinData]

set success [CkHttp_QuickGetBd $http $url $bd]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkBinData $bd
    exit
}

puts "Response Status Code: [CkHttp_get_LastStatus $http]"

if {[CkHttp_get_LastStatus $http] == 200} then {
    # Success
    # Save to a file..
    set success [CkBinData_WriteFile $bd "qa_output/penguines.jpg"]
} else {
    # Failed.  bd contains error information..
    puts [CkBinData_getString $bd utf-8]
}


delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkBinData $bd