Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
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')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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": "Nicolas",
* "has_retainer": null,
* "home_phone": "555-555-1234",
* "id": 31006,
* "language": "en",
* "last_activity": null,
* "last_login": null,
* "level": 0,
* "lname": "one",
* "mob_phone": "",
* "note": null,
* "notified": false,
* "num_logins": 0,
* "organization": "first company",
* "p_city": "",
* "p_code": "",
* "p_country": "Canada",
* "p_province": "",
* "p_street": "",
* "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-04-18 13:38:23",
* "statement_token": null,
* "subdomain": null,
* "updated": "2019-04-29 16:45:55",
* "userid": 31006,
* "username": "clientone",
* "vat_name": null,
* "vat_number": "",
* "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 loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}
Postman Collection Item JSON
{
"name": "Single Client",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
]
},
"description": "Get a single client with the parameter associated with clientId"
},
"response": [
{
"name": "Single Client Error - Client Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customer_Id}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customer_Id}}"
]
}
},
"status": "NOT FOUND",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sJWQRZBFFcAgVTVVoLBAlcWU4aABtEVVBQVgZVAQZSAQxUWQ1WARFJXwBdElY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 17:50:37 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-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 \"errors\": [\n {\n \"errno\": 1012,\n \"field\": \"userid\",\n \"message\": \"Client not found.\",\n \"object\": \"client\",\n \"value\": \"{{customer_Id}}\"\n }\n ]\n }\n}"
},
{
"name": "Single Client",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sIVAFTClJQDg5QX1UPBAdXVU4aABtEBQQDVlMCUQcFBloDXQsHChFJXwBdElY/"
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557344346"
},
{
"key": "Retry-After",
"value": "20"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 19:38:45 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:38:45 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\": \"Nicolas\",\n \"has_retainer\": null,\n \"home_phone\": \"555-555-1234\",\n \"id\": 31006,\n \"language\": \"en\",\n \"last_activity\": null,\n \"last_login\": null,\n \"level\": 0,\n \"lname\": \"one\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"notified\": false,\n \"num_logins\": 0,\n \"organization\": \"first company\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"Canada\",\n \"p_province\": \"\",\n \"p_street\": \"\",\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-04-18 13:38:23\",\n \"statement_token\": null,\n \"subdomain\": null,\n \"updated\": \"2019-04-29 16:45:55\",\n \"userid\": 31006,\n \"username\": \"clientone\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
