autoit / New FreshBooks / Get all retainers
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
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.freshbooks.com/comments/business/{{businessId}}/retainers",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "retainers": [
; {
; "id": 2248,
; "business_id": 1966214,
; "system_id": 4236410,
; "invoice_profile_id": null,
; "client_user_id": 32046,
; "start_date": "2019-06-03",
; "next_period_start_date": "2019-06-03",
; "fee": "500.00",
; "excess_rate": "100.00",
; "budgeted_time": 144000,
; "active": true,
; "created_at": "2019-06-03T15:42:49",
; "updated_at": "2019-06-03T15:42:49"
; },
; {
; "id": 2272,
; "business_id": 1966214,
; "system_id": 4236410,
; "invoice_profile_id": null,
; "client_user_id": 75162,
; "start_date": "2019-06-03",
; "next_period_start_date": "2019-06-03",
; "fee": "20.00",
; "excess_rate": "500.00",
; "budgeted_time": 180000,
; "active": true,
; "created_at": "2019-06-03T18:08:30",
; "updated_at": "2019-06-03T18:08:30"
; },
; {
; "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 $id
Local $iBusiness_id
Local $iSystem_id
Local $sInvoice_profile_id
Local $iClient_user_id
Local $start_date
Local $sNext_period_start_date
Local $sFee
Local $sExcess_rate
Local $iBudgeted_time
Local $bActive
Local $sCreated_at
Local $sUpdated_at
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("retainers")
While $i < $iCount_i
$oJResp.I = $i
$id = $oJResp.IntOf("retainers[i].id")
$iBusiness_id = $oJResp.IntOf("retainers[i].business_id")
$iSystem_id = $oJResp.IntOf("retainers[i].system_id")
$sInvoice_profile_id = $oJResp.StringOf("retainers[i].invoice_profile_id")
$iClient_user_id = $oJResp.IntOf("retainers[i].client_user_id")
$start_date = $oJResp.StringOf("retainers[i].start_date")
$sNext_period_start_date = $oJResp.StringOf("retainers[i].next_period_start_date")
$sFee = $oJResp.StringOf("retainers[i].fee")
$sExcess_rate = $oJResp.StringOf("retainers[i].excess_rate")
$iBudgeted_time = $oJResp.IntOf("retainers[i].budgeted_time")
$bActive = $oJResp.BoolOf("retainers[i].active")
$sCreated_at = $oJResp.StringOf("retainers[i].created_at")
$sUpdated_at = $oJResp.StringOf("retainers[i].updated_at")
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/comments/business/{{businessId}}/retainers
Postman Collection Item JSON
{
"name": "Get all retainers",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainers",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainers"
]
}
},
"response": [
{
"name": "Get all retainers Success",
"originalRequest": {
"method": "GET",
"header": [
],
"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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlXUwYBClRXUVcEUwlbAA8HHh5UFUNSA1YBVQVVUgQFWVdRB1MEFR1RBwhCU24="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1559585847"
},
{
"key": "Retry-After",
"value": "59"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Sun, 03 Jun 2018 18:16:27 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Content-Length",
"value": "1028"
},
{
"key": "Date",
"value": "Mon, 03 Jun 2019 18:16: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 \"retainers\": [\n {\n \"id\": 2248,\n \"business_id\": 1966214,\n \"system_id\": 4236410,\n \"invoice_profile_id\": null,\n \"client_user_id\": 32046,\n \"start_date\": \"2019-06-03\",\n \"next_period_start_date\": \"2019-06-03\",\n \"fee\": \"500.00\",\n \"excess_rate\": \"100.00\",\n \"budgeted_time\": 144000,\n \"active\": true,\n \"created_at\": \"2019-06-03T15:42:49\",\n \"updated_at\": \"2019-06-03T15:42:49\"\n },\n {\n \"id\": 2272,\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-06-03\",\n \"fee\": \"20.00\",\n \"excess_rate\": \"500.00\",\n \"budgeted_time\": 180000,\n \"active\": true,\n \"created_at\": \"2019-06-03T18:08:30\",\n \"updated_at\": \"2019-06-03T18:08:30\"\n },\n {\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 ]\n}"
}
]
}
