(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/xero-access-token.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

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

    CkHttp::setCkAccept(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

    jsonRequestBody.i = CkJsonObject::ckCreate()
    If jsonRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

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

    resp.i = CkHttp::ckPText(http,"POST",url,CkJsonObject::ckEmit(jsonRequestBody),"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkJsonObject::ckDispose(jsonRequestBody)
        ProcedureReturn
    EndIf

    Debug "Response Status Code: " + Str(CkHttpResponse::ckStatusCode(resp))

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(jsonResponse,CkHttpResponse::ckBodyStr(resp))
    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    Debug CkJsonObject::ckEmit(jsonResponse)

    If CkHttpResponse::ckStatusCode(resp) >= 300
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkJsonObject::ckDispose(jsonRequestBody)
        CkJsonObject::ckDispose(jsonResponse)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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
    ;     }
    ;   ]
    ; }
    ; 

    AccountID.s
    Code.s
    Name.s
    Type.s
    TaxType.s
    Description.s
    Class.s
    EnablePaymentsToAccount.i
    ShowInExpenseClaims.i
    ReportingCode.s
    ReportingCodeName.s
    UpdatedDateUTC.s
    AddToWatchlist.i

    Id.s = CkJsonObject::ckStringOf(jsonResponse,"Id")
    Status.s = CkJsonObject::ckStringOf(jsonResponse,"Status")
    ProviderName.s = CkJsonObject::ckStringOf(jsonResponse,"ProviderName")
    DateTimeUTC.s = CkJsonObject::ckStringOf(jsonResponse,"DateTimeUTC")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Accounts")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        AccountID = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].AccountID")
        Code = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Code")
        Name = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Name")
        Status = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Status")
        Type = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Type")
        TaxType = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].TaxType")
        Description = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Description")
        Class = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].Class")
        EnablePaymentsToAccount = CkJsonObject::ckBoolOf(jsonResponse,"Accounts[i].EnablePaymentsToAccount")
        ShowInExpenseClaims = CkJsonObject::ckBoolOf(jsonResponse,"Accounts[i].ShowInExpenseClaims")
        ReportingCode = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].ReportingCode")
        ReportingCodeName = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].ReportingCodeName")
        UpdatedDateUTC = CkJsonObject::ckStringOf(jsonResponse,"Accounts[i].UpdatedDateUTC")
        AddToWatchlist = CkJsonObject::ckBoolOf(jsonResponse,"Accounts[i].AddToWatchlist")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonToken)
    CkJsonObject::ckDispose(jsonRequestBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure