SQL Server / New FreshBooks / Single Client
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
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
DECLARE @Accounting_systemid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accounting_systemid OUT, 'response.result.client.accounting_systemid'
DECLARE @Allow_late_fees int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_late_fees OUT, 'response.result.client.allow_late_fees'
DECLARE @Allow_late_notifications int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_late_notifications OUT, 'response.result.client.allow_late_notifications'
DECLARE @Bus_phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Bus_phone OUT, 'response.result.client.bus_phone'
DECLARE @Company_industry nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Company_industry OUT, 'response.result.client.company_industry'
DECLARE @Company_size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Company_size OUT, 'response.result.client.company_size'
DECLARE @Currency_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Currency_code OUT, 'response.result.client.currency_code'
DECLARE @Direct_link_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Direct_link_token OUT, 'response.result.client.direct_link_token'
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'response.result.client.email'
DECLARE @Fax nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fax OUT, 'response.result.client.fax'
DECLARE @Fname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fname OUT, 'response.result.client.fname'
DECLARE @Has_retainer nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Has_retainer OUT, 'response.result.client.has_retainer'
DECLARE @Home_phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Home_phone OUT, 'response.result.client.home_phone'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'response.result.client.id'
DECLARE @Language nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Language OUT, 'response.result.client.language'
DECLARE @Last_activity nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_activity OUT, 'response.result.client.last_activity'
DECLARE @Last_login nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_login OUT, 'response.result.client.last_login'
DECLARE @Level int
EXEC sp_OAMethod @jResp, 'IntOf', @Level OUT, 'response.result.client.level'
DECLARE @Lname nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Lname OUT, 'response.result.client.lname'
DECLARE @Mob_phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Mob_phone OUT, 'response.result.client.mob_phone'
DECLARE @Note nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Note OUT, 'response.result.client.note'
DECLARE @Notified int
EXEC sp_OAMethod @jResp, 'BoolOf', @Notified OUT, 'response.result.client.notified'
DECLARE @Num_logins int
EXEC sp_OAMethod @jResp, 'IntOf', @Num_logins OUT, 'response.result.client.num_logins'
DECLARE @Organization nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Organization OUT, 'response.result.client.organization'
DECLARE @P_city nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_city OUT, 'response.result.client.p_city'
DECLARE @P_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_code OUT, 'response.result.client.p_code'
DECLARE @P_country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_country OUT, 'response.result.client.p_country'
DECLARE @P_province nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_province OUT, 'response.result.client.p_province'
DECLARE @P_street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_street OUT, 'response.result.client.p_street'
DECLARE @P_street2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @P_street2 OUT, 'response.result.client.p_street2'
DECLARE @Pref_email int
EXEC sp_OAMethod @jResp, 'BoolOf', @Pref_email OUT, 'response.result.client.pref_email'
DECLARE @Pref_gmail int
EXEC sp_OAMethod @jResp, 'BoolOf', @Pref_gmail OUT, 'response.result.client.pref_gmail'
DECLARE @Retainer_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Retainer_id OUT, 'response.result.client.retainer_id'
DECLARE @Role nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Role OUT, 'response.result.client.role'
DECLARE @S_city nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_city OUT, 'response.result.client.s_city'
DECLARE @S_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_code OUT, 'response.result.client.s_code'
DECLARE @S_country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_country OUT, 'response.result.client.s_country'
DECLARE @S_province nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_province OUT, 'response.result.client.s_province'
DECLARE @S_street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_street OUT, 'response.result.client.s_street'
DECLARE @S_street2 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @S_street2 OUT, 'response.result.client.s_street2'
DECLARE @Signup_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Signup_date OUT, 'response.result.client.signup_date'
DECLARE @Statement_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Statement_token OUT, 'response.result.client.statement_token'
DECLARE @Subdomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Subdomain OUT, 'response.result.client.subdomain'
DECLARE @Updated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated OUT, 'response.result.client.updated'
DECLARE @Userid int
EXEC sp_OAMethod @jResp, 'IntOf', @Userid OUT, 'response.result.client.userid'
DECLARE @Username nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Username OUT, 'response.result.client.username'
DECLARE @Vat_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_name OUT, 'response.result.client.vat_name'
DECLARE @Vat_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Vat_number OUT, 'response.result.client.vat_number'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.client.vis_state'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
