Tcl

Xero Upload Attachment

See more Xero Examples

Demonstrates how to upload an attachment to Xero. 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]

# Important: Make sure your OAuth2 access token was obtained with the scope "accounting.attachments"
# included in the list of scopes.

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"

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

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

# Filename is the filename of the attachment you are uploading.
CkHttp_SetUrlVar $http "Filename" "penguins.jpg"

# Load the file to be uploaded (from the local filesystem).
set bd [new_CkBinData]

set success [CkBinData_LoadFile $bd "qa_data/jpg/penguins.jpg"]
if {$success == 0} then {
    puts "Failed to load attachment file."
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkBinData $bd
    exit
}

# Indicate the content-type according to the file content type.
# Common content-types are:   image/jpg, image/png, application/pdf, application/zip, application/msword
# If you don't know, use application/octet-stream
set resp [new_CkHttpResponse]

set success [CkHttp_HttpBd $http "POST" $url $bd "image/jpg" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkBinData $bd
    delete_CkHttpResponse $resp
    exit
}

puts "Response Status Code: [CkHttpResponse_get_StatusCode $resp]"

set jsonResponse [new_CkJsonObject]

CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
CkJsonObject_put_EmitCompact $jsonResponse 0
puts [CkJsonObject_emit $jsonResponse]

if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkBinData $bd
    delete_CkHttpResponse $resp
    delete_CkJsonObject $jsonResponse
    exit
}

# A sample response:

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "Id": "35333c64-4449-457b-bf6a-1b64d538e3c7",
#   "Status": "OK",
#   "ProviderName": "Chilkat2222",
#   "DateTimeUTC": "\/Date(1587212597758)\/",
#   "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
#     }
#   ]
# }

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkBinData $bd
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse