(Tcl) Xero Update Account Details

Update some details of an account in a Xero company (Accounting API)

For more information, see https://developer.xero.com/documentation/api/accounts#POST

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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 following JSON is sent in the request body:

# {
#   "AccountID": "54ddab14-4a8d-45cf-86be-076c99a0cea0",
#   "Name": "Sales account",
#   "Type": "REVENUE",
#   "TaxType": "OUTPUT",
#   "Description": "Income from any normal business trading activity",
#   "EnablePaymentsToAccount": "false",
#   "ShowInExpenseClaims": "false"
# }

# Use this online tool to generate the code from sample JSON: 
# Generate Code to Create JSON

set jsonRequestBody [new_CkJsonObject]

CkJsonObject_UpdateString $jsonRequestBody "AccountID" "54ddab14-4a8d-45cf-86be-076c99a0cea0"
CkJsonObject_UpdateString $jsonRequestBody "Name" "Sales account"
CkJsonObject_UpdateString $jsonRequestBody "Type" "REVENUE"
CkJsonObject_UpdateString $jsonRequestBody "TaxType" "OUTPUT"
CkJsonObject_UpdateString $jsonRequestBody "Description" "Income from any normal business trading activity"
CkJsonObject_UpdateString $jsonRequestBody "EnablePaymentsToAccount" "false"
CkJsonObject_UpdateString $jsonRequestBody "ShowInExpenseClaims" "false"

set url "https://api.xero.com/api.xro/2.0/Accounts/54ddab14-4a8d-45cf-86be-076c99a0cea0"

# resp is a CkHttpResponse
set resp [CkHttp_PText $http "POST" $url [CkJsonObject_emit $jsonRequestBody] "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jsonRequestBody
    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] >= 300} then {
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jsonRequestBody
    delete_CkJsonObject $jsonResponse
    exit
}

delete_CkHttpResponse $resp

# Sample output...
# (See the parsing code below..)
# 
# Use the this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "Id": "430e92a8-de02-41d5-a00e-3ef899188aea",
#   "Status": "OK",
#   "ProviderName": "Chilkat2222",
#   "DateTimeUTC": "\/Date(1587162517005)\/",
#   "Accounts": [
#     {
#       "AccountID": "54ddab14-4a8d-45cf-86be-076c99a0cea0",
#       "Code": "201",
#       "Name": "Sales account",
#       "Status": "ACTIVE",
#       "Type": "REVENUE",
#       "TaxType": "OUTPUT",
#       "Description": "Income from any normal business trading activity",
#       "Class": "REVENUE",
#       "EnablePaymentsToAccount": false,
#       "ShowInExpenseClaims": false,
#       "ReportingCode": "REV",
#       "ReportingCodeName": "Revenue",
#       "UpdatedDateUTC": "\/Date(1587162517090+0000)\/",
#       "AddToWatchlist": false
#     }
#   ]
# }
# 

set Id [CkJsonObject_stringOf $jsonResponse "Id"]
set Status [CkJsonObject_stringOf $jsonResponse "Status"]
set ProviderName [CkJsonObject_stringOf $jsonResponse "ProviderName"]
set DateTimeUTC [CkJsonObject_stringOf $jsonResponse "DateTimeUTC"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "Accounts"]
while {$i < $count_i} {
    CkJsonObject_put_I $jsonResponse $i
    set AccountID [CkJsonObject_stringOf $jsonResponse "Accounts[i].AccountID"]
    set Code [CkJsonObject_stringOf $jsonResponse "Accounts[i].Code"]
    set Name [CkJsonObject_stringOf $jsonResponse "Accounts[i].Name"]
    set Status [CkJsonObject_stringOf $jsonResponse "Accounts[i].Status"]
    set Type [CkJsonObject_stringOf $jsonResponse "Accounts[i].Type"]
    set TaxType [CkJsonObject_stringOf $jsonResponse "Accounts[i].TaxType"]
    set Description [CkJsonObject_stringOf $jsonResponse "Accounts[i].Description"]
    set Class [CkJsonObject_stringOf $jsonResponse "Accounts[i].Class"]
    set EnablePaymentsToAccount [CkJsonObject_BoolOf $jsonResponse "Accounts[i].EnablePaymentsToAccount"]
    set ShowInExpenseClaims [CkJsonObject_BoolOf $jsonResponse "Accounts[i].ShowInExpenseClaims"]
    set ReportingCode [CkJsonObject_stringOf $jsonResponse "Accounts[i].ReportingCode"]
    set ReportingCodeName [CkJsonObject_stringOf $jsonResponse "Accounts[i].ReportingCodeName"]
    set UpdatedDateUTC [CkJsonObject_stringOf $jsonResponse "Accounts[i].UpdatedDateUTC"]
    set AddToWatchlist [CkJsonObject_BoolOf $jsonResponse "Accounts[i].AddToWatchlist"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkJsonObject $jsonRequestBody
delete_CkJsonObject $jsonResponse