Chilkat Online Tools

VB.NET / New FreshBooks / Update Retainer

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' 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
'   }
' }

Dim json As New Chilkat.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")

Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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




Dim Id As Integer = jResp.IntOf("retainer.id")
Dim Business_id As Integer = jResp.IntOf("retainer.business_id")
Dim System_id As Integer = jResp.IntOf("retainer.system_id")
Dim Invoice_profile_id As String = jResp.StringOf("retainer.invoice_profile_id")
Dim Client_user_id As Integer = jResp.IntOf("retainer.client_user_id")
Dim Start_date As String = jResp.StringOf("retainer.start_date")
Dim Next_period_start_date As String = jResp.StringOf("retainer.next_period_start_date")
Dim Fee As String = jResp.StringOf("retainer.fee")
Dim Excess_rate As String = jResp.StringOf("retainer.excess_rate")
Dim Budgeted_time As Integer = jResp.IntOf("retainer.budgeted_time")
Dim Active As Boolean = jResp.BoolOf("retainer.active")
Dim Created_at As String = jResp.StringOf("retainer.created_at")
Dim Updated_at As String = 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}"
    }
  ]
}