Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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": "32040",
; "start_date": "2019-06-05",
; "next_period_start_date": "2019-06-03",
; "fee": 600,
; "excess_rate": 200,
; "budgeted_time": 144000,
; "active": true,
; "frequency": "m",
; "number_recurring": 0,
; "is_infinitely_recurring": true
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("retainer.client_user_id","32040")
$oJson.UpdateString("retainer.start_date","2019-06-05")
$oJson.UpdateString("retainer.next_period_start_date","2019-06-03")
$oJson.UpdateInt("retainer.fee",600)
$oJson.UpdateInt("retainer.excess_rate",200)
$oJson.UpdateInt("retainer.budgeted_time",144000)
$oJson.UpdateBool("retainer.active",True)
$oJson.UpdateString("retainer.frequency","m")
$oJson.UpdateInt("retainer.number_recurring",0)
$oJson.UpdateBool("retainer.is_infinitely_recurring",True)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://api.freshbooks.com/comments/business/{{businessId}}/retainers","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "retainer": {
; "id": 2274,
; "business_id": 1966214,
; "system_id": 4236410,
; "invoice_profile_id": null,
; "client_user_id": 32040,
; "start_date": "2019-06-05",
; "next_period_start_date": "2019-06-03",
; "fee": "600.00",
; "excess_rate": "200.00",
; "budgeted_time": 144000,
; "active": true,
; "created_at": "2019-06-03T18:11:26",
; "updated_at": "2019-06-03T18:11:26"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $iId = $oJResp.IntOf("retainer.id")
Local $iBusiness_id = $oJResp.IntOf("retainer.business_id")
Local $iSystem_id = $oJResp.IntOf("retainer.system_id")
Local $sInvoice_profile_id = $oJResp.StringOf("retainer.invoice_profile_id")
Local $iClient_user_id = $oJResp.IntOf("retainer.client_user_id")
Local $sStart_date = $oJResp.StringOf("retainer.start_date")
Local $sNext_period_start_date = $oJResp.StringOf("retainer.next_period_start_date")
Local $sFee = $oJResp.StringOf("retainer.fee")
Local $sExcess_rate = $oJResp.StringOf("retainer.excess_rate")
Local $iBudgeted_time = $oJResp.IntOf("retainer.budgeted_time")
Local $bActive = $oJResp.BoolOf("retainer.active")
Local $sCreated_at = $oJResp.StringOf("retainer.created_at")
Local $sUpdated_at = $oJResp.StringOf("retainer.updated_at")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"retainer": {
"client_user_id": "32040",
"start_date": "2019-06-05",
"next_period_start_date": "2019-06-03",
"fee": 600,
"excess_rate": 200,
"budgeted_time": 144000,
"active": true,
"frequency": "m",
"number_recurring": 0,
"is_infinitely_recurring": true
}
}'
https://api.freshbooks.com/comments/business/{{businessId}}/retainers
Postman Collection Item JSON
{
"name": "Create Retainer",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"client_user_id\": \"32040\",\n \"start_date\": \"2019-06-05\",\n \"next_period_start_date\": \"2019-06-03\",\n \"fee\": 600,\n \"excess_rate\": 200,\n \"budgeted_time\": 144000,\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}}/retainers",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainers"
]
}
},
"response": [
{
"name": "Create Retainer Retainer for client already exists",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"client_user_id\": \"32040\",\n \"start_date\": \"2019-06-05\",\n \"next_period_start_date\": \"2019-06-03\",\n \"fee\": 600,\n \"excess_rate\": 200,\n \"budgeted_time\": 144000,\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}}/retainers",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainers"
]
}
},
"status": "UNPROCESSABLE ENTITY",
"code": 422,
"_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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlWXQEPClRTU1EIUAFbDQ4EBx9WDVkdQwMHBgdTAgdSWgFUBQdTBwkVSgJQWkAHOw=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1559585586"
},
{
"key": "Retry-After",
"value": "57"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "62"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Mon, 03 Jun 2019 18:12:08 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 \"errno\": 2001,\n \"error\": \"Retainer for client already exists\"\n}"
},
{
"name": "Create Retainer Success",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"client_user_id\": \"32040\",\n \"start_date\": \"2019-06-05\",\n \"next_period_start_date\": \"2019-06-03\",\n \"fee\": 600,\n \"excess_rate\": 200,\n \"budgeted_time\": 144000,\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}}/retainers",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainers"
]
}
},
"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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlVUQkBClBWVVQFVQxSAQ4DHgBRAU0TBQUEVFACB1MCCwtVUVIGUxMbAAVdRVY/"
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1559585547"
},
{
"key": "Retry-After",
"value": "59"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Sun, 03 Jun 2018 18:11:27 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "350"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Mon, 03 Jun 2019 18:11:27 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\": 2274,\n \"business_id\": 1966214,\n \"system_id\": 4236410,\n \"invoice_profile_id\": null,\n \"client_user_id\": 32040,\n \"start_date\": \"2019-06-05\",\n \"next_period_start_date\": \"2019-06-03\",\n \"fee\": \"600.00\",\n \"excess_rate\": \"200.00\",\n \"budgeted_time\": 144000,\n \"active\": true,\n \"created_at\": \"2019-06-03T18:11:26\",\n \"updated_at\": \"2019-06-03T18:11:26\"\n }\n}"
}
]
}
