Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.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.
# {
# "retainer": {
# "client_user_id": "75162",
# "start_date": "2019-06-03",
# "next_period_start_date": "2019-07-03",
# "fee": 20,
# "excess_rate": 700,
# "budgeted_time": 180000,
# "active": true,
# "frequency": "m",
# "number_recurring": 0,
# "is_infinitely_recurring": true
# }
# }
json = chilkat2.JsonObject()
json.UpdateString("retainer.client_user_id","75162")
json.UpdateString("retainer.start_date","2019-06-03")
json.UpdateString("retainer.next_period_start_date","2019-07-03")
json.UpdateInt("retainer.fee",20)
json.UpdateInt("retainer.excess_rate",700)
json.UpdateInt("retainer.budgeted_time",180000)
json.UpdateBool("retainer.active",True)
json.UpdateString("retainer.frequency","m")
json.UpdateInt("retainer.number_recurring",0)
json.UpdateBool("retainer.is_infinitely_recurring",True)
# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "retainer": {
# "id": 2248,
# "business_id": 1966214,
# "system_id": 4236410,
# "invoice_profile_id": null,
# "client_user_id": 75162,
# "start_date": "2019-06-03",
# "next_period_start_date": "2019-07-03",
# "fee": "20.00",
# "excess_rate": "700.00",
# "budgeted_time": 180000,
# "active": true,
# "created_at": "2019-06-03T15:42:49",
# "updated_at": "2019-06-03T18:18:48"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id = jResp.IntOf("retainer.id")
Business_id = jResp.IntOf("retainer.business_id")
System_id = jResp.IntOf("retainer.system_id")
Invoice_profile_id = jResp.StringOf("retainer.invoice_profile_id")
Client_user_id = jResp.IntOf("retainer.client_user_id")
Start_date = jResp.StringOf("retainer.start_date")
Next_period_start_date = jResp.StringOf("retainer.next_period_start_date")
Fee = jResp.StringOf("retainer.fee")
Excess_rate = jResp.StringOf("retainer.excess_rate")
Budgeted_time = jResp.IntOf("retainer.budgeted_time")
Active = jResp.BoolOf("retainer.active")
Created_at = jResp.StringOf("retainer.created_at")
Updated_at = jResp.StringOf("retainer.updated_at")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"retainer": {
"client_user_id": "75162",
"start_date": "2019-06-03",
"next_period_start_date": "2019-07-03",
"fee": 20,
"excess_rate": 700,
"budgeted_time": 180000,
"active": true,
"frequency": "m",
"number_recurring": 0,
"is_infinitely_recurring": true
}
}'
https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}
Postman Collection Item JSON
{
"name": "Update Retainer",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"client_user_id\": \"75162\",\n \"start_date\": \"2019-06-03\",\n \"next_period_start_date\": \"2019-07-03\",\n \"fee\": 20,\n \"excess_rate\": 700,\n \"budgeted_time\": 180000,\n \"active\": true,\n \"frequency\": \"m\",\n \"number_recurring\": 0,\n \"is_infinitely_recurring\": true\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainer",
"{{retainerId}}"
]
}
},
"response": [
{
"name": "Update Retainer Success",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"client_user_id\": \"75162\",\n \"start_date\": \"2019-06-03\",\n \"next_period_start_date\": \"2019-07-03\",\n \"fee\": 20,\n \"excess_rate\": 700,\n \"budgeted_time\": 180000,\n \"active\": true,\n \"frequency\": \"m\",\n \"number_recurring\": 0,\n \"is_infinitely_recurring\": true\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainer",
"{{retainerId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1905.33.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlVUwUPBFpRW1IHVg5WDQENBB9WDVYdQwBaVQYCVFJUW1dRVVMABwcVSgJQWkAHOw=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1559585988"
},
{
"key": "Retry-After",
"value": "59"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Sun, 03 Jun 2018 18:18:48 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "349"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Mon, 03 Jun 2019 18:18:48 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17376-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"retainer\": {\n \"id\": 2248,\n \"business_id\": 1966214,\n \"system_id\": 4236410,\n \"invoice_profile_id\": null,\n \"client_user_id\": 75162,\n \"start_date\": \"2019-06-03\",\n \"next_period_start_date\": \"2019-07-03\",\n \"fee\": \"20.00\",\n \"excess_rate\": \"700.00\",\n \"budgeted_time\": 180000,\n \"active\": true,\n \"created_at\": \"2019-06-03T15:42:49\",\n \"updated_at\": \"2019-06-03T18:18:48\"\n }\n}"
}
]
}
