Powershell / New FreshBooks / Update Client
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# 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"
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("client.fname","Nicolas")
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$http.SetRequestHeader("Content-Type","application/json")
$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$resp = $http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",$sbRequestBody,"utf-8","application/json",$false,$false)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$Accounting_systemid = $jResp.StringOf("response.result.client.accounting_systemid")
$Allow_late_fees = $jResp.BoolOf("response.result.client.allow_late_fees")
$Allow_late_notifications = $jResp.BoolOf("response.result.client.allow_late_notifications")
$Bus_phone = $jResp.StringOf("response.result.client.bus_phone")
$Company_industry = $jResp.StringOf("response.result.client.company_industry")
$Company_size = $jResp.StringOf("response.result.client.company_size")
$Currency_code = $jResp.StringOf("response.result.client.currency_code")
$Direct_link_token = $jResp.StringOf("response.result.client.direct_link_token")
$v_Email = $jResp.StringOf("response.result.client.email")
$Fax = $jResp.StringOf("response.result.client.fax")
$Fname = $jResp.StringOf("response.result.client.fname")
$Has_retainer = $jResp.StringOf("response.result.client.has_retainer")
$Home_phone = $jResp.StringOf("response.result.client.home_phone")
$Id = $jResp.IntOf("response.result.client.id")
$Language = $jResp.StringOf("response.result.client.language")
$Last_activity = $jResp.StringOf("response.result.client.last_activity")
$Last_login = $jResp.StringOf("response.result.client.last_login")
$Level = $jResp.IntOf("response.result.client.level")
$Lname = $jResp.StringOf("response.result.client.lname")
$Mob_phone = $jResp.StringOf("response.result.client.mob_phone")
$Note = $jResp.StringOf("response.result.client.note")
$Notified = $jResp.BoolOf("response.result.client.notified")
$Num_logins = $jResp.IntOf("response.result.client.num_logins")
$Organization = $jResp.StringOf("response.result.client.organization")
$P_city = $jResp.StringOf("response.result.client.p_city")
$P_code = $jResp.StringOf("response.result.client.p_code")
$P_country = $jResp.StringOf("response.result.client.p_country")
$P_province = $jResp.StringOf("response.result.client.p_province")
$P_street = $jResp.StringOf("response.result.client.p_street")
$P_street2 = $jResp.StringOf("response.result.client.p_street2")
$Pref_email = $jResp.BoolOf("response.result.client.pref_email")
$Pref_gmail = $jResp.BoolOf("response.result.client.pref_gmail")
$Retainer_id = $jResp.StringOf("response.result.client.retainer_id")
$Role = $jResp.StringOf("response.result.client.role")
$S_city = $jResp.StringOf("response.result.client.s_city")
$S_code = $jResp.StringOf("response.result.client.s_code")
$S_country = $jResp.StringOf("response.result.client.s_country")
$S_province = $jResp.StringOf("response.result.client.s_province")
$S_street = $jResp.StringOf("response.result.client.s_street")
$S_street2 = $jResp.StringOf("response.result.client.s_street2")
$Signup_date = $jResp.StringOf("response.result.client.signup_date")
$Statement_token = $jResp.StringOf("response.result.client.statement_token")
$Subdomain = $jResp.StringOf("response.result.client.subdomain")
$Updated = $jResp.StringOf("response.result.client.updated")
$Userid = $jResp.IntOf("response.result.client.userid")
$Username = $jResp.StringOf("response.result.client.username")
$Vat_name = $jResp.StringOf("response.result.client.vat_name")
$Vat_number = $jResp.StringOf("response.result.client.vat_number")
$Vis_state = $jResp.IntOf("response.result.client.vis_state")
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}"
}
]
}
