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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes', @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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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": {
-- "page": 1,
-- "pages": 1,
-- "per_page": 15,
-- "taxes": [
-- {
-- "accounting_systemid": "wkMd2g",
-- "amount": "13",
-- "compound": false,
-- "id": 3264,
-- "name": "other tax",
-- "number": "TAX-123456",
-- "taxid": 3264,
-- "updated": "2019-04-18 11:47:12"
-- },
-- {
-- "accounting_systemid": "wkMd2g",
-- "amount": "0",
-- "compound": false,
-- "id": 3294,
-- "name": "some tax",
-- "number": null,
-- "taxid": 3294,
-- "updated": "2019-04-18 11:44:56"
-- },
-- {
-- "accounting_systemid": "wkMd2g",
-- "amount": "0",
-- "compound": false,
-- "id": 3300,
-- "name": "some taxv2",
-- "number": null,
-- "taxid": 3300,
-- "updated": "2019-04-18 11:53:44"
-- }
-- ],
-- "total": 3
-- }
-- }
-- }
-- 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)
DECLARE @amount nvarchar(4000)
DECLARE @compound int
DECLARE @id int
DECLARE @name nvarchar(4000)
DECLARE @v_number nvarchar(4000)
DECLARE @taxid int
DECLARE @updated nvarchar(4000)
DECLARE @Page int
EXEC sp_OAMethod @jResp, 'IntOf', @Page OUT, 'response.result.page'
DECLARE @Pages int
EXEC sp_OAMethod @jResp, 'IntOf', @Pages OUT, 'response.result.pages'
DECLARE @Per_page int
EXEC sp_OAMethod @jResp, 'IntOf', @Per_page OUT, 'response.result.per_page'
DECLARE @Total int
EXEC sp_OAMethod @jResp, 'IntOf', @Total OUT, 'response.result.total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.taxes'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @accounting_systemid OUT, 'response.result.taxes[i].accounting_systemid'
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'response.result.taxes[i].amount'
EXEC sp_OAMethod @jResp, 'BoolOf', @compound OUT, 'response.result.taxes[i].compound'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'response.result.taxes[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'response.result.taxes[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_number OUT, 'response.result.taxes[i].number'
EXEC sp_OAMethod @jResp, 'IntOf', @taxid OUT, 'response.result.taxes[i].taxid'
EXEC sp_OAMethod @jResp, 'StringOf', @updated OUT, 'response.result.taxes[i].updated'
SELECT @i = @i + 1
END
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>"
https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes
Postman Collection Item JSON
{
"name": "List Taxes",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"postman.setEnvironmentVariable(\"taxId\", jsonData.response.result.taxes[0].id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"taxes",
"taxes"
]
}
},
"response": [
{
"name": "List Taxes",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"taxes",
"taxes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gQUE5WEVwXA0gHS0AUCBgCHVUAVANWAVdQBwdVUFIMAQVcTU8GHRUCUgZQUlECAQBRVl4DXgsGEB8DWA1CBG4="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:40:20 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": "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 18:40:20 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 \"result\": {\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"taxes\": [\n {\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": \"13\",\n \"compound\": false,\n \"id\": 3264,\n \"name\": \"other tax\",\n \"number\": \"TAX-123456\",\n \"taxid\": 3264,\n \"updated\": \"2019-04-18 11:47:12\"\n },\n {\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": \"0\",\n \"compound\": false,\n \"id\": 3294,\n \"name\": \"some tax\",\n \"number\": null,\n \"taxid\": 3294,\n \"updated\": \"2019-04-18 11:44:56\"\n },\n {\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": \"0\",\n \"compound\": false,\n \"id\": 3300,\n \"name\": \"some taxv2\",\n \"number\": null,\n \"taxid\": 3300,\n \"updated\": \"2019-04-18 11:53:44\"\n }\n ],\n \"total\": 3\n }\n }\n}"
}
]
}
