PowerShell

Xero Update Account Details

See more Xero Examples

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

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

$jsonToken = New-Object Chilkat.JsonObject
$success = $jsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
if ($success -eq $false) {
    $($jsonToken.LastErrorText)
    exit
}

$http.AuthToken = $jsonToken.StringOf("access_token")

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

$http.Accept = "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

$jsonRequestBody = New-Object Chilkat.JsonObject
$jsonRequestBody.UpdateString("AccountID","54ddab14-4a8d-45cf-86be-076c99a0cea0")
$jsonRequestBody.UpdateString("Name","Sales account")
$jsonRequestBody.UpdateString("Type","REVENUE")
$jsonRequestBody.UpdateString("TaxType","OUTPUT")
$jsonRequestBody.UpdateString("Description","Income from any normal business trading activity")
$jsonRequestBody.UpdateString("EnablePaymentsToAccount","false")
$jsonRequestBody.UpdateString("ShowInExpenseClaims","false")

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

$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpJson("POST",$url,$jsonRequestBody,"application/json",$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$("Response Status Code: " + $resp.StatusCode)

$jsonResponse = New-Object Chilkat.JsonObject
$jsonResponse.Load($resp.BodyStr)
$jsonResponse.EmitCompact = $false
$($jsonResponse.Emit())

if ($resp.StatusCode -ge 300) {
    $("Failed.")
    exit
}

# 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
#     }
#   ]
# }
# 

$Id = $jsonResponse.StringOf("Id")
$Status = $jsonResponse.StringOf("Status")
$ProviderName = $jsonResponse.StringOf("ProviderName")
$DateTimeUTC = $jsonResponse.StringOf("DateTimeUTC")
$i = 0
$count_i = $jsonResponse.SizeOfArray("Accounts")
while ($i -lt $count_i) {
    $jsonResponse.I = $i
    $AccountID = $jsonResponse.StringOf("Accounts[i].AccountID")
    $Code = $jsonResponse.StringOf("Accounts[i].Code")
    $Name = $jsonResponse.StringOf("Accounts[i].Name")
    $Status = $jsonResponse.StringOf("Accounts[i].Status")
    $Type = $jsonResponse.StringOf("Accounts[i].Type")
    $TaxType = $jsonResponse.StringOf("Accounts[i].TaxType")
    $Description = $jsonResponse.StringOf("Accounts[i].Description")
    $Class = $jsonResponse.StringOf("Accounts[i].Class")
    $EnablePaymentsToAccount = $jsonResponse.BoolOf("Accounts[i].EnablePaymentsToAccount")
    $ShowInExpenseClaims = $jsonResponse.BoolOf("Accounts[i].ShowInExpenseClaims")
    $ReportingCode = $jsonResponse.StringOf("Accounts[i].ReportingCode")
    $ReportingCodeName = $jsonResponse.StringOf("Accounts[i].ReportingCodeName")
    $UpdatedDateUTC = $jsonResponse.StringOf("Accounts[i].UpdatedDateUTC")
    $AddToWatchlist = $jsonResponse.BoolOf("Accounts[i].AddToWatchlist")
    $i = $i + 1
}