Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAccounting_systemid
LOCAL lnAllow_late_fees
LOCAL lnAllow_late_notifications
LOCAL lcBus_phone
LOCAL lcCompany_industry
LOCAL lcCompany_size
LOCAL lcCurrency_code
LOCAL lcDirect_link_token
LOCAL lcV_Email
LOCAL lcFax
LOCAL lcFname
LOCAL lcHas_retainer
LOCAL lcHome_phone
LOCAL lnId
LOCAL lcLanguage
LOCAL lcLast_activity
LOCAL lcLast_login
LOCAL lnLevel
LOCAL lcLname
LOCAL lcMob_phone
LOCAL lcNote
LOCAL lnNotified
LOCAL lnNum_logins
LOCAL lcOrganization
LOCAL lcP_city
LOCAL lcP_code
LOCAL lcP_country
LOCAL lcP_province
LOCAL lcP_street
LOCAL lcP_street2
LOCAL lnPref_email
LOCAL lnPref_gmail
LOCAL lcRetainer_id
LOCAL lcRole
LOCAL lcS_city
LOCAL lcS_code
LOCAL lcS_country
LOCAL lcS_province
LOCAL lcS_street
LOCAL lcS_street2
LOCAL lcSignup_date
LOCAL lcStatement_token
LOCAL lcSubdomain
LOCAL lcUpdated
LOCAL lnUserid
LOCAL lcUsername
LOCAL lcVat_name
LOCAL lcVat_number
LOCAL lnVis_state
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* 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
* }
* ]
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("client.fname","first1")
loJson.UpdateString("client.lname","last1")
loJson.UpdateString("client.email","email1@freshbooks.com")
loJson.UpdateString("client.organization","company1")
loJson.UpdateNull("client.vat_name")
loJson.UpdateString("client.vat_number","")
loJson.UpdateNull("client.status")
loJson.UpdateNull("client.note")
loJson.UpdateNull("client.home_phone")
loJson.UpdateNull("client.userid")
loJson.UpdateNull("client.source")
loJson.UpdateNull("client.highlight_string")
loJson.UpdateString("client.p_street","1655 Dupont St. W.")
loJson.UpdateNull("client.p_street2")
loJson.UpdateString("client.p_city","Toronto")
loJson.UpdateString("client.p_country","Canada")
loJson.UpdateString("client.p_province","Ontario")
loJson.UpdateString("client.p_code","M6P 3T1")
loJson.UpdateString("client.currency_code","USD")
loJson.UpdateString("client.language","en")
loJson.UpdateNull("client.last_activity")
loJson.UpdateNull("client.face")
loJson.UpdateNull("client.late_fee")
loJson.UpdateNewArray("client.late_reminders")
loJson.UpdateString("client.contacts[0].email","email+2@freshbooks.com")
loJson.UpdateString("client.contacts[0].fname","first2")
loJson.UpdateString("client.contacts[0].lname","last2")
loJson.UpdateNull("client.contacts[0].phone1")
loJson.UpdateNull("client.contacts[0].userid")
loJson.UpdateNull("client.contacts[0].face")
loJson.UpdateString("client.contacts[1].email","email+3@freshbooks.com")
loJson.UpdateString("client.contacts[1].fname","first3")
loJson.UpdateString("client.contacts[1].lname","last3")
loJson.UpdateNull("client.contacts[1].phone1")
loJson.UpdateNull("client.contacts[1].userid")
loJson.UpdateNull("client.contacts[1].face")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAccounting_systemid = loJResp.StringOf("response.result.client.accounting_systemid")
lnAllow_late_fees = loJResp.BoolOf("response.result.client.allow_late_fees")
lnAllow_late_notifications = loJResp.BoolOf("response.result.client.allow_late_notifications")
lcBus_phone = loJResp.StringOf("response.result.client.bus_phone")
lcCompany_industry = loJResp.StringOf("response.result.client.company_industry")
lcCompany_size = loJResp.StringOf("response.result.client.company_size")
lcCurrency_code = loJResp.StringOf("response.result.client.currency_code")
lcDirect_link_token = loJResp.StringOf("response.result.client.direct_link_token")
lcV_Email = loJResp.StringOf("response.result.client.email")
lcFax = loJResp.StringOf("response.result.client.fax")
lcFname = loJResp.StringOf("response.result.client.fname")
lcHas_retainer = loJResp.StringOf("response.result.client.has_retainer")
lcHome_phone = loJResp.StringOf("response.result.client.home_phone")
lnId = loJResp.IntOf("response.result.client.id")
lcLanguage = loJResp.StringOf("response.result.client.language")
lcLast_activity = loJResp.StringOf("response.result.client.last_activity")
lcLast_login = loJResp.StringOf("response.result.client.last_login")
lnLevel = loJResp.IntOf("response.result.client.level")
lcLname = loJResp.StringOf("response.result.client.lname")
lcMob_phone = loJResp.StringOf("response.result.client.mob_phone")
lcNote = loJResp.StringOf("response.result.client.note")
lnNotified = loJResp.BoolOf("response.result.client.notified")
lnNum_logins = loJResp.IntOf("response.result.client.num_logins")
lcOrganization = loJResp.StringOf("response.result.client.organization")
lcP_city = loJResp.StringOf("response.result.client.p_city")
lcP_code = loJResp.StringOf("response.result.client.p_code")
lcP_country = loJResp.StringOf("response.result.client.p_country")
lcP_province = loJResp.StringOf("response.result.client.p_province")
lcP_street = loJResp.StringOf("response.result.client.p_street")
lcP_street2 = loJResp.StringOf("response.result.client.p_street2")
lnPref_email = loJResp.BoolOf("response.result.client.pref_email")
lnPref_gmail = loJResp.BoolOf("response.result.client.pref_gmail")
lcRetainer_id = loJResp.StringOf("response.result.client.retainer_id")
lcRole = loJResp.StringOf("response.result.client.role")
lcS_city = loJResp.StringOf("response.result.client.s_city")
lcS_code = loJResp.StringOf("response.result.client.s_code")
lcS_country = loJResp.StringOf("response.result.client.s_country")
lcS_province = loJResp.StringOf("response.result.client.s_province")
lcS_street = loJResp.StringOf("response.result.client.s_street")
lcS_street2 = loJResp.StringOf("response.result.client.s_street2")
lcSignup_date = loJResp.StringOf("response.result.client.signup_date")
lcStatement_token = loJResp.StringOf("response.result.client.statement_token")
lcSubdomain = loJResp.StringOf("response.result.client.subdomain")
lcUpdated = loJResp.StringOf("response.result.client.updated")
lnUserid = loJResp.IntOf("response.result.client.userid")
lcUsername = loJResp.StringOf("response.result.client.username")
lcVat_name = loJResp.StringOf("response.result.client.vat_name")
lcVat_number = loJResp.StringOf("response.result.client.vat_number")
lnVis_state = loJResp.IntOf("response.result.client.vis_state")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
