PowerBuilder / New FreshBooks / Update Client
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Accounting_systemid
integer li_Allow_late_fees
integer li_Allow_late_notifications
string ls_Bus_phone
string ls_Company_industry
string ls_Company_size
string ls_Currency_code
string ls_Direct_link_token
string ls_V_Email
string ls_Fax
string ls_Fname
string ls_Has_retainer
string ls_Home_phone
integer li_Id
string ls_Language
string ls_Last_activity
string ls_Last_login
integer li_Level
string ls_Lname
string ls_Mob_phone
string ls_Note
integer li_Notified
integer li_Num_logins
string ls_Organization
string ls_P_city
string ls_P_code
string ls_P_country
string ls_P_province
string ls_P_street
string ls_P_street2
integer li_Pref_email
integer li_Pref_gmail
string ls_Retainer_id
string ls_Role
string ls_S_city
string ls_S_code
string ls_S_country
string ls_S_province
string ls_S_street
string ls_S_street2
string ls_Signup_date
string ls_Statement_token
string ls_Subdomain
string ls_Updated
integer li_Userid
string ls_Username
string ls_Vat_name
string ls_Vat_number
integer li_Vis_state
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "client": {
// "fname": "Nicolas"
// }
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("client.fname","Nicolas")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "client": {
// "accounting_systemid": "wkMd2g",
// "allow_late_fees": true,
// "allow_late_notifications": true,
// "bus_phone": "",
// "company_industry": null,
// "company_size": null,
// "currency_code": "USD",
// "direct_link_token": null,
// "email": "first@company.com",
// "fax": "",
// "fname": "Nicolas",
// "has_retainer": null,
// "home_phone": "555-555-1234",
// "id": 31006,
// "language": "en",
// "last_activity": null,
// "last_login": null,
// "level": 0,
// "lname": "one",
// "mob_phone": "",
// "note": null,
// "notified": false,
// "num_logins": 0,
// "organization": "first company",
// "p_city": "",
// "p_code": "",
// "p_country": "Canada",
// "p_province": "",
// "p_street": "",
// "p_street2": "",
// "pref_email": true,
// "pref_gmail": false,
// "retainer_id": null,
// "role": "client",
// "s_city": "",
// "s_code": "",
// "s_country": "",
// "s_province": "",
// "s_street": "",
// "s_street2": "",
// "signup_date": "2019-04-18 13:38:23",
// "statement_token": null,
// "subdomain": null,
// "updated": "2019-04-24 13:47:39",
// "userid": 31006,
// "username": "clientone",
// "vat_name": null,
// "vat_number": "",
// "vis_state": 0
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Accounting_systemid = loo_JResp.StringOf("response.result.client.accounting_systemid")
li_Allow_late_fees = loo_JResp.BoolOf("response.result.client.allow_late_fees")
li_Allow_late_notifications = loo_JResp.BoolOf("response.result.client.allow_late_notifications")
ls_Bus_phone = loo_JResp.StringOf("response.result.client.bus_phone")
ls_Company_industry = loo_JResp.StringOf("response.result.client.company_industry")
ls_Company_size = loo_JResp.StringOf("response.result.client.company_size")
ls_Currency_code = loo_JResp.StringOf("response.result.client.currency_code")
ls_Direct_link_token = loo_JResp.StringOf("response.result.client.direct_link_token")
ls_V_Email = loo_JResp.StringOf("response.result.client.email")
ls_Fax = loo_JResp.StringOf("response.result.client.fax")
ls_Fname = loo_JResp.StringOf("response.result.client.fname")
ls_Has_retainer = loo_JResp.StringOf("response.result.client.has_retainer")
ls_Home_phone = loo_JResp.StringOf("response.result.client.home_phone")
li_Id = loo_JResp.IntOf("response.result.client.id")
ls_Language = loo_JResp.StringOf("response.result.client.language")
ls_Last_activity = loo_JResp.StringOf("response.result.client.last_activity")
ls_Last_login = loo_JResp.StringOf("response.result.client.last_login")
li_Level = loo_JResp.IntOf("response.result.client.level")
ls_Lname = loo_JResp.StringOf("response.result.client.lname")
ls_Mob_phone = loo_JResp.StringOf("response.result.client.mob_phone")
ls_Note = loo_JResp.StringOf("response.result.client.note")
li_Notified = loo_JResp.BoolOf("response.result.client.notified")
li_Num_logins = loo_JResp.IntOf("response.result.client.num_logins")
ls_Organization = loo_JResp.StringOf("response.result.client.organization")
ls_P_city = loo_JResp.StringOf("response.result.client.p_city")
ls_P_code = loo_JResp.StringOf("response.result.client.p_code")
ls_P_country = loo_JResp.StringOf("response.result.client.p_country")
ls_P_province = loo_JResp.StringOf("response.result.client.p_province")
ls_P_street = loo_JResp.StringOf("response.result.client.p_street")
ls_P_street2 = loo_JResp.StringOf("response.result.client.p_street2")
li_Pref_email = loo_JResp.BoolOf("response.result.client.pref_email")
li_Pref_gmail = loo_JResp.BoolOf("response.result.client.pref_gmail")
ls_Retainer_id = loo_JResp.StringOf("response.result.client.retainer_id")
ls_Role = loo_JResp.StringOf("response.result.client.role")
ls_S_city = loo_JResp.StringOf("response.result.client.s_city")
ls_S_code = loo_JResp.StringOf("response.result.client.s_code")
ls_S_country = loo_JResp.StringOf("response.result.client.s_country")
ls_S_province = loo_JResp.StringOf("response.result.client.s_province")
ls_S_street = loo_JResp.StringOf("response.result.client.s_street")
ls_S_street2 = loo_JResp.StringOf("response.result.client.s_street2")
ls_Signup_date = loo_JResp.StringOf("response.result.client.signup_date")
ls_Statement_token = loo_JResp.StringOf("response.result.client.statement_token")
ls_Subdomain = loo_JResp.StringOf("response.result.client.subdomain")
ls_Updated = loo_JResp.StringOf("response.result.client.updated")
li_Userid = loo_JResp.IntOf("response.result.client.userid")
ls_Username = loo_JResp.StringOf("response.result.client.username")
ls_Vat_name = loo_JResp.StringOf("response.result.client.vat_name")
ls_Vat_number = loo_JResp.StringOf("response.result.client.vat_number")
li_Vis_state = loo_JResp.IntOf("response.result.client.vis_state")
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"client": {
"fname": "Nicolas"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}
Postman Collection Item JSON
{
"name": "Update Client",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"Nicolas\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
}
]
}
},
"response": [
{
"name": "Update Client",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"Nicolas\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
],
"query": [
{
"key": "",
"value": "",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sLUAdSBVNRBAVXUVcNBQBRVE4CAxtEBQUGBVBTUQNVVA9bCg4AVBFJXwBdElY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 17:47:39 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 17:47:39 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"client\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"allow_late_fees\": true,\n \"allow_late_notifications\": true,\n \"bus_phone\": \"\",\n \"company_industry\": null,\n \"company_size\": null,\n \"currency_code\": \"USD\",\n \"direct_link_token\": null,\n \"email\": \"first@company.com\",\n \"fax\": \"\",\n \"fname\": \"Nicolas\",\n \"has_retainer\": null,\n \"home_phone\": \"555-555-1234\",\n \"id\": 31006,\n \"language\": \"en\",\n \"last_activity\": null,\n \"last_login\": null,\n \"level\": 0,\n \"lname\": \"one\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"notified\": false,\n \"num_logins\": 0,\n \"organization\": \"first company\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"Canada\",\n \"p_province\": \"\",\n \"p_street\": \"\",\n \"p_street2\": \"\",\n \"pref_email\": true,\n \"pref_gmail\": false,\n \"retainer_id\": null,\n \"role\": \"client\",\n \"s_city\": \"\",\n \"s_code\": \"\",\n \"s_country\": \"\",\n \"s_province\": \"\",\n \"s_street\": \"\",\n \"s_street2\": \"\",\n \"signup_date\": \"2019-04-18 13:38:23\",\n \"statement_token\": null,\n \"subdomain\": null,\n \"updated\": \"2019-04-24 13:47:39\",\n \"userid\": 31006,\n \"username\": \"clientone\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
