Chilkat Online Tools

TCL / New FreshBooks / Create Retainer

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "retainer.client_user_id" "32040"
CkJsonObject_UpdateString $json "retainer.start_date" "2019-06-05"
CkJsonObject_UpdateString $json "retainer.next_period_start_date" "2019-06-03"
CkJsonObject_UpdateInt $json "retainer.fee" 600
CkJsonObject_UpdateInt $json "retainer.excess_rate" 200
CkJsonObject_UpdateInt $json "retainer.budgeted_time" 144000
CkJsonObject_UpdateBool $json "retainer.active" 1
CkJsonObject_UpdateString $json "retainer.frequency" "m"
CkJsonObject_UpdateInt $json "retainer.number_recurring" 0
CkJsonObject_UpdateBool $json "retainer.is_infinitely_recurring" 1

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/comments/business/{{businessId}}/retainers" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set Id [CkJsonObject_IntOf $jResp "retainer.id"]
set Business_id [CkJsonObject_IntOf $jResp "retainer.business_id"]
set System_id [CkJsonObject_IntOf $jResp "retainer.system_id"]
set Invoice_profile_id [CkJsonObject_stringOf $jResp "retainer.invoice_profile_id"]
set Client_user_id [CkJsonObject_IntOf $jResp "retainer.client_user_id"]
set Start_date [CkJsonObject_stringOf $jResp "retainer.start_date"]
set Next_period_start_date [CkJsonObject_stringOf $jResp "retainer.next_period_start_date"]
set Fee [CkJsonObject_stringOf $jResp "retainer.fee"]
set Excess_rate [CkJsonObject_stringOf $jResp "retainer.excess_rate"]
set Budgeted_time [CkJsonObject_IntOf $jResp "retainer.budgeted_time"]
set Active [CkJsonObject_BoolOf $jResp "retainer.active"]
set Created_at [CkJsonObject_stringOf $jResp "retainer.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "retainer.updated_at"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}