unicodeCpp / New FreshBooks / Create Retainer
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
// 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
// }
// }
CkJsonObjectW json;
json.UpdateString(L"retainer.client_user_id",L"32040");
json.UpdateString(L"retainer.start_date",L"2019-06-05");
json.UpdateString(L"retainer.next_period_start_date",L"2019-06-03");
json.UpdateInt(L"retainer.fee",600);
json.UpdateInt(L"retainer.excess_rate",200);
json.UpdateInt(L"retainer.budgeted_time",144000);
json.UpdateBool(L"retainer.active",true);
json.UpdateString(L"retainer.frequency",L"m");
json.UpdateInt(L"retainer.number_recurring",0);
json.UpdateBool(L"retainer.is_infinitely_recurring",true);
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken(L"<access_token>");
http.SetRequestHeader(L"Content-Type",L"application/json");
CkHttpResponseW *resp = http.PostJson3(L"https://api.freshbooks.com/comments/business/{{businessId}}/retainers",L"application/json",json);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
int Id = jResp.IntOf(L"retainer.id");
int Business_id = jResp.IntOf(L"retainer.business_id");
int System_id = jResp.IntOf(L"retainer.system_id");
const wchar_t *Invoice_profile_id = jResp.stringOf(L"retainer.invoice_profile_id");
int Client_user_id = jResp.IntOf(L"retainer.client_user_id");
const wchar_t *Start_date = jResp.stringOf(L"retainer.start_date");
const wchar_t *Next_period_start_date = jResp.stringOf(L"retainer.next_period_start_date");
const wchar_t *Fee = jResp.stringOf(L"retainer.fee");
const wchar_t *Excess_rate = jResp.stringOf(L"retainer.excess_rate");
int Budgeted_time = jResp.IntOf(L"retainer.budgeted_time");
bool Active = jResp.BoolOf(L"retainer.active");
const wchar_t *Created_at = jResp.stringOf(L"retainer.created_at");
const wchar_t *Updated_at = jResp.stringOf(L"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}"
}
]
}
