Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "client": {
; "fname": "first1",
; "lname": "last1",
; "email": "email1@freshbooks.com",
; "organization": "company1",
; "vat_name": null,
; "vat_number": "",
; "status": null,
; "note": null,
; "home_phone": null,
; "userid": null,
; "source": null,
; "highlight_string": null,
; "p_street": "1655 Dupont St. W.",
; "p_street2": null,
; "p_city": "Toronto",
; "p_country": "Canada",
; "p_province": "Ontario",
; "p_code": "M6P 3T1",
; "currency_code": "USD",
; "language": "en",
; "last_activity": null,
; "face": null,
; "late_fee": null,
; "late_reminders": [
; ],
; "contacts": [
; {
; "email": "email+2@freshbooks.com",
; "fname": "first2",
; "lname": "last2",
; "phone1": null,
; "userid": null,
; "face": null
; },
; {
; "email": "email+3@freshbooks.com",
; "fname": "first3",
; "lname": "last3",
; "phone1": null,
; "userid": null,
; "face": null
; }
; ]
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"client.fname","first1")
CkJsonObject::ckUpdateString(json,"client.lname","last1")
CkJsonObject::ckUpdateString(json,"client.email","email1@freshbooks.com")
CkJsonObject::ckUpdateString(json,"client.organization","company1")
CkJsonObject::ckUpdateNull(json,"client.vat_name")
CkJsonObject::ckUpdateString(json,"client.vat_number","")
CkJsonObject::ckUpdateNull(json,"client.status")
CkJsonObject::ckUpdateNull(json,"client.note")
CkJsonObject::ckUpdateNull(json,"client.home_phone")
CkJsonObject::ckUpdateNull(json,"client.userid")
CkJsonObject::ckUpdateNull(json,"client.source")
CkJsonObject::ckUpdateNull(json,"client.highlight_string")
CkJsonObject::ckUpdateString(json,"client.p_street","1655 Dupont St. W.")
CkJsonObject::ckUpdateNull(json,"client.p_street2")
CkJsonObject::ckUpdateString(json,"client.p_city","Toronto")
CkJsonObject::ckUpdateString(json,"client.p_country","Canada")
CkJsonObject::ckUpdateString(json,"client.p_province","Ontario")
CkJsonObject::ckUpdateString(json,"client.p_code","M6P 3T1")
CkJsonObject::ckUpdateString(json,"client.currency_code","USD")
CkJsonObject::ckUpdateString(json,"client.language","en")
CkJsonObject::ckUpdateNull(json,"client.last_activity")
CkJsonObject::ckUpdateNull(json,"client.face")
CkJsonObject::ckUpdateNull(json,"client.late_fee")
CkJsonObject::ckUpdateNewArray(json,"client.late_reminders")
CkJsonObject::ckUpdateString(json,"client.contacts[0].email","email+2@freshbooks.com")
CkJsonObject::ckUpdateString(json,"client.contacts[0].fname","first2")
CkJsonObject::ckUpdateString(json,"client.contacts[0].lname","last2")
CkJsonObject::ckUpdateNull(json,"client.contacts[0].phone1")
CkJsonObject::ckUpdateNull(json,"client.contacts[0].userid")
CkJsonObject::ckUpdateNull(json,"client.contacts[0].face")
CkJsonObject::ckUpdateString(json,"client.contacts[1].email","email+3@freshbooks.com")
CkJsonObject::ckUpdateString(json,"client.contacts[1].fname","first3")
CkJsonObject::ckUpdateString(json,"client.contacts[1].lname","last3")
CkJsonObject::ckUpdateNull(json,"client.contacts[1].phone1")
CkJsonObject::ckUpdateNull(json,"client.contacts[1].userid")
CkJsonObject::ckUpdateNull(json,"client.contacts[1].face")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "response": {
; "result": {
; "client": {
; "accounting_systemid": "wkMd2g",
; "allow_late_fees": true,
; "allow_late_notifications": true,
; "bus_phone": "",
; "company_industry": null,
; "company_size": null,
; "currency_code": "USD",
; "direct_link_token": null,
; "email": "api.freshbooks@gmail.com",
; "fax": "",
; "fname": "Nicholas",
; "has_retainer": null,
; "home_phone": null,
; "id": 92402,
; "language": "en",
; "last_activity": null,
; "last_login": null,
; "level": 0,
; "lname": "Jaar",
; "mob_phone": "",
; "note": null,
; "notified": false,
; "num_logins": 0,
; "organization": "Space Is Only Noise",
; "p_city": "Toronto",
; "p_code": "M6P 3T1",
; "p_country": "",
; "p_province": "Ontario",
; "p_street": "1655 Dupont St. W.",
; "p_street2": "",
; "pref_email": true,
; "pref_gmail": false,
; "retainer_id": null,
; "role": "client",
; "s_city": "",
; "s_code": "",
; "s_country": "",
; "s_province": "",
; "s_street": "",
; "s_street2": "",
; "signup_date": "2019-05-08 19:25:29",
; "statement_token": null,
; "subdomain": null,
; "updated": "2019-05-08 15:25:29",
; "userid": 92402,
; "username": "nicholasjaar2",
; "vat_name": null,
; "vat_number": null,
; "vis_state": 0
; }
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Accounting_systemid.s = CkJsonObject::ckStringOf(jResp,"response.result.client.accounting_systemid")
Allow_late_fees.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.allow_late_fees")
Allow_late_notifications.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.allow_late_notifications")
Bus_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.bus_phone")
Company_industry.s = CkJsonObject::ckStringOf(jResp,"response.result.client.company_industry")
Company_size.s = CkJsonObject::ckStringOf(jResp,"response.result.client.company_size")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.currency_code")
Direct_link_token.s = CkJsonObject::ckStringOf(jResp,"response.result.client.direct_link_token")
v_Email.s = CkJsonObject::ckStringOf(jResp,"response.result.client.email")
Fax.s = CkJsonObject::ckStringOf(jResp,"response.result.client.fax")
Fname.s = CkJsonObject::ckStringOf(jResp,"response.result.client.fname")
Has_retainer.s = CkJsonObject::ckStringOf(jResp,"response.result.client.has_retainer")
Home_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.home_phone")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.client.id")
Language.s = CkJsonObject::ckStringOf(jResp,"response.result.client.language")
Last_activity.s = CkJsonObject::ckStringOf(jResp,"response.result.client.last_activity")
Last_login.s = CkJsonObject::ckStringOf(jResp,"response.result.client.last_login")
Level.i = CkJsonObject::ckIntOf(jResp,"response.result.client.level")
Lname.s = CkJsonObject::ckStringOf(jResp,"response.result.client.lname")
Mob_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.mob_phone")
Note.s = CkJsonObject::ckStringOf(jResp,"response.result.client.note")
Notified.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.notified")
Num_logins.i = CkJsonObject::ckIntOf(jResp,"response.result.client.num_logins")
Organization.s = CkJsonObject::ckStringOf(jResp,"response.result.client.organization")
P_city.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_city")
P_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_code")
P_country.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_country")
P_province.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_province")
P_street.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_street")
P_street2.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_street2")
Pref_email.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.pref_email")
Pref_gmail.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.pref_gmail")
Retainer_id.s = CkJsonObject::ckStringOf(jResp,"response.result.client.retainer_id")
Role.s = CkJsonObject::ckStringOf(jResp,"response.result.client.role")
S_city.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_city")
S_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_code")
S_country.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_country")
S_province.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_province")
S_street.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_street")
S_street2.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_street2")
Signup_date.s = CkJsonObject::ckStringOf(jResp,"response.result.client.signup_date")
Statement_token.s = CkJsonObject::ckStringOf(jResp,"response.result.client.statement_token")
Subdomain.s = CkJsonObject::ckStringOf(jResp,"response.result.client.subdomain")
Updated.s = CkJsonObject::ckStringOf(jResp,"response.result.client.updated")
Userid.i = CkJsonObject::ckIntOf(jResp,"response.result.client.userid")
Username.s = CkJsonObject::ckStringOf(jResp,"response.result.client.username")
Vat_name.s = CkJsonObject::ckStringOf(jResp,"response.result.client.vat_name")
Vat_number.s = CkJsonObject::ckStringOf(jResp,"response.result.client.vat_number")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.client.vis_state")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"client": {
"fname": "first1",
"lname": "last1",
"email": "email1@freshbooks.com",
"organization": "company1",
"vat_name": null,
"vat_number": "",
"status": null,
"note": null,
"home_phone": null,
"userid": null,
"source": null,
"highlight_string": null,
"p_street": "1655 Dupont St. W.",
"p_street2": null,
"p_city": "Toronto",
"p_country": "Canada",
"p_province": "Ontario",
"p_code": "M6P 3T1",
"currency_code": "USD",
"language": "en",
"last_activity": null,
"face": null,
"late_fee": null,
"late_reminders": [],
"contacts": [
{
"email": "email+2@freshbooks.com",
"fname": "first2",
"lname": "last2",
"phone1": null,
"userid": null,
"face": null
},
{
"email": "email+3@freshbooks.com",
"fname": "first3",
"lname": "last3",
"phone1": null,
"userid": null,
"face": null
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients
Postman Collection Item JSON
{
"name": "New Client",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"first1\",\n \"lname\": \"last1\",\n \"email\": \"email1@freshbooks.com\",\n \"organization\": \"company1\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"status\": null,\n \"note\": null,\n \"home_phone\": null,\n \"userid\": null,\n \"source\": null,\n \"highlight_string\": null,\n \"p_street\": \"1655 Dupont St. W.\",\n \"p_street2\": null,\n \"p_city\": \"Toronto\",\n \"p_country\": \"Canada\",\n \"p_province\": \"Ontario\",\n \"p_code\": \"M6P 3T1\",\n \"currency_code\": \"USD\",\n \"language\": \"en\",\n \"last_activity\": null,\n \"face\": null,\n \"late_fee\": null,\n \"late_reminders\": [],\n \"contacts\": [\n {\n \"email\": \"email+2@freshbooks.com\",\n \"fname\": \"first2\",\n \"lname\": \"last2\",\n \"phone1\": null,\n \"userid\": null,\n \"face\": null\n },\n {\n \"email\": \"email+3@freshbooks.com\",\n \"fname\": \"first3\",\n \"lname\": \"last3\",\n \"phone1\": null,\n \"userid\": null,\n \"face\": null\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients"
]
},
"description": "Note: If you do not add an `organization` to your Client object, `organization` will automatically be added as the client's first and last name. "
},
"response": [
{
"name": "New Client",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"email\": \"api.freshbooks@gmail.com\",\n \"fname\": \"Nicholas\",\n\t\t\"lname\": \"Jaar\",\n\t\t\"organization\": \"Space Is Only Noise\",\n\t\t\"p_street\": \"1655 Dupont St. W.\", \n\t\t\"p_city\": \"Toronto\",\n\t\t\"p_province\":\"Ontario\",\n\t\t\"p_code\": \"M6P 3T1\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhZLGhgCH1UXUwhRBVNdBwRVX1MKCgVQUE4FBwBKRggPUQdUAQAGVgBaWQFRUQBHFQdQDUAHOQ=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557343565"
},
{
"key": "Retry-After",
"value": "36"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 19:25:28 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 19:25:28 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17330-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"client\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"allow_late_fees\": true,\n \"allow_late_notifications\": true,\n \"bus_phone\": \"\",\n \"company_industry\": null,\n \"company_size\": null,\n \"currency_code\": \"USD\",\n \"direct_link_token\": null,\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"fname\": \"Nicholas\",\n \"has_retainer\": null,\n \"home_phone\": null,\n \"id\": 92402,\n \"language\": \"en\",\n \"last_activity\": null,\n \"last_login\": null,\n \"level\": 0,\n \"lname\": \"Jaar\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"notified\": false,\n \"num_logins\": 0,\n \"organization\": \"Space Is Only Noise\",\n \"p_city\": \"Toronto\",\n \"p_code\": \"M6P 3T1\",\n \"p_country\": \"\",\n \"p_province\": \"Ontario\",\n \"p_street\": \"1655 Dupont St. W.\",\n \"p_street2\": \"\",\n \"pref_email\": true,\n \"pref_gmail\": false,\n \"retainer_id\": null,\n \"role\": \"client\",\n \"s_city\": \"\",\n \"s_code\": \"\",\n \"s_country\": \"\",\n \"s_province\": \"\",\n \"s_street\": \"\",\n \"s_street2\": \"\",\n \"signup_date\": \"2019-05-08 19:25:29\",\n \"statement_token\": null,\n \"subdomain\": null,\n \"updated\": \"2019-05-08 15:25:29\",\n \"userid\": 92402,\n \"username\": \"nicholasjaar2\",\n \"vat_name\": null,\n \"vat_number\": null,\n \"vis_state\": 0\n }\n }\n }\n}"
},
{
"name": "Exceeding Client Limit",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"client\": {\n \"fname\": \"first1\",\n \"lname\": \"last1\",\n \"email\": \"email1@freshbooks.com\",\n \"organization\": \"company1\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"status\": null,\n \"note\": null,\n \"home_phone\": null,\n \"userid\": null,\n \"source\": null,\n \"highlight_string\": null,\n \"p_street\": \"1655 Dupont St. W.\",\n \"p_street2\": null,\n \"p_city\": \"Toronto\",\n \"p_country\": \"Canada\",\n \"p_province\": \"Ontario\",\n \"p_code\": \"M6P 3T1\",\n \"currency_code\": \"USD\",\n \"language\": \"en\",\n \"last_activity\": null,\n \"face\": null,\n \"late_fee\": null,\n \"late_reminders\": [],\n \"contacts\": [\n {\n \"email\": \"email+2@freshbooks.com\",\n \"fname\": \"first2\",\n \"lname\": \"last2\",\n \"phone1\": null,\n \"userid\": null,\n \"face\": null\n },\n {\n \"email\": \"email+3@freshbooks.com\",\n \"fname\": \"first3\",\n \"lname\": \"last3\",\n \"phone1\": null,\n \"userid\": null,\n \"face\": null\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "gunicorn/19.9.0"
},
{
"key": "Date",
"value": "Thu, 26 Sep 2019 17:17:14 GMT"
},
{
"key": "content-type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxY0QwgcAwdVWBQIFxdISwUCAVhEWRItVUtOTRMQB0IRFwFUUVFcRxYbTQFNA0xUBgdVUVQPCgBcUlACAA5TVwAEBk5XUVEHThpQCVxWUwFTDlcIAwRSVwEEQ0oFWV9DATw="
},
{
"key": "Content-Length",
"value": "74"
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "2"
},
{
"key": "X-RateLimit-Reset",
"value": "1569518295"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "clear"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 7005,\n \"field\": null,\n \"message\": \"Client limit of 50 reached\",\n \"object\": null,\n \"value\": null\n }\n ]\n }\n}"
}
]
}
