Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccounting_systemid
Boolean iAllow_late_fees
Boolean iAllow_late_notifications
String sBus_phone
String sCompany_industry
String sCompany_size
String sCurrency_code
String sDirect_link_token
String sV_Email
String sFax
String sFname
String sHas_retainer
String sHome_phone
Integer iId
String sLanguage
String sLast_activity
String sLast_login
Integer iLevel
String sLname
String sMob_phone
String sNote
Boolean iNotified
Integer iNum_logins
String sOrganization
String sP_city
String sP_code
String sP_country
String sP_province
String sP_street
String sP_street2
Boolean iPref_email
Boolean iPref_gmail
String sRetainer_id
String sRole
String sS_city
String sS_code
String sS_country
String sS_province
String sS_street
String sS_street2
String sSignup_date
String sStatement_token
String sSubdomain
String sUpdated
Integer iUserid
String sUsername
String sVat_name
String sVat_number
Integer iVis_state
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "response.result.client.accounting_systemid" To sAccounting_systemid
Get ComBoolOf Of hoJResp "response.result.client.allow_late_fees" To iAllow_late_fees
Get ComBoolOf Of hoJResp "response.result.client.allow_late_notifications" To iAllow_late_notifications
Get ComStringOf Of hoJResp "response.result.client.bus_phone" To sBus_phone
Get ComStringOf Of hoJResp "response.result.client.company_industry" To sCompany_industry
Get ComStringOf Of hoJResp "response.result.client.company_size" To sCompany_size
Get ComStringOf Of hoJResp "response.result.client.currency_code" To sCurrency_code
Get ComStringOf Of hoJResp "response.result.client.direct_link_token" To sDirect_link_token
Get ComStringOf Of hoJResp "response.result.client.email" To sV_Email
Get ComStringOf Of hoJResp "response.result.client.fax" To sFax
Get ComStringOf Of hoJResp "response.result.client.fname" To sFname
Get ComStringOf Of hoJResp "response.result.client.has_retainer" To sHas_retainer
Get ComStringOf Of hoJResp "response.result.client.home_phone" To sHome_phone
Get ComIntOf Of hoJResp "response.result.client.id" To iId
Get ComStringOf Of hoJResp "response.result.client.language" To sLanguage
Get ComStringOf Of hoJResp "response.result.client.last_activity" To sLast_activity
Get ComStringOf Of hoJResp "response.result.client.last_login" To sLast_login
Get ComIntOf Of hoJResp "response.result.client.level" To iLevel
Get ComStringOf Of hoJResp "response.result.client.lname" To sLname
Get ComStringOf Of hoJResp "response.result.client.mob_phone" To sMob_phone
Get ComStringOf Of hoJResp "response.result.client.note" To sNote
Get ComBoolOf Of hoJResp "response.result.client.notified" To iNotified
Get ComIntOf Of hoJResp "response.result.client.num_logins" To iNum_logins
Get ComStringOf Of hoJResp "response.result.client.organization" To sOrganization
Get ComStringOf Of hoJResp "response.result.client.p_city" To sP_city
Get ComStringOf Of hoJResp "response.result.client.p_code" To sP_code
Get ComStringOf Of hoJResp "response.result.client.p_country" To sP_country
Get ComStringOf Of hoJResp "response.result.client.p_province" To sP_province
Get ComStringOf Of hoJResp "response.result.client.p_street" To sP_street
Get ComStringOf Of hoJResp "response.result.client.p_street2" To sP_street2
Get ComBoolOf Of hoJResp "response.result.client.pref_email" To iPref_email
Get ComBoolOf Of hoJResp "response.result.client.pref_gmail" To iPref_gmail
Get ComStringOf Of hoJResp "response.result.client.retainer_id" To sRetainer_id
Get ComStringOf Of hoJResp "response.result.client.role" To sRole
Get ComStringOf Of hoJResp "response.result.client.s_city" To sS_city
Get ComStringOf Of hoJResp "response.result.client.s_code" To sS_code
Get ComStringOf Of hoJResp "response.result.client.s_country" To sS_country
Get ComStringOf Of hoJResp "response.result.client.s_province" To sS_province
Get ComStringOf Of hoJResp "response.result.client.s_street" To sS_street
Get ComStringOf Of hoJResp "response.result.client.s_street2" To sS_street2
Get ComStringOf Of hoJResp "response.result.client.signup_date" To sSignup_date
Get ComStringOf Of hoJResp "response.result.client.statement_token" To sStatement_token
Get ComStringOf Of hoJResp "response.result.client.subdomain" To sSubdomain
Get ComStringOf Of hoJResp "response.result.client.updated" To sUpdated
Get ComIntOf Of hoJResp "response.result.client.userid" To iUserid
Get ComStringOf Of hoJResp "response.result.client.username" To sUsername
Get ComStringOf Of hoJResp "response.result.client.vat_name" To sVat_name
Get ComStringOf Of hoJResp "response.result.client.vat_number" To sVat_number
Get ComIntOf Of hoJResp "response.result.client.vis_state" To iVis_state
End_Procedure
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}"
}
]
}
