SQL Server / New FreshBooks / Expense Summaries
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>'
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}}/expenses/summaries', @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": {
-- "summaries": [
-- {
-- "amounts": [
-- {
-- "amount": "7040.981",
-- "code": "USD",
-- "count": 2
-- }
-- ],
-- "counts": 2,
-- "id": "grand_total"
-- },
-- {
-- "amounts": [
-- ],
-- "counts": 0,
-- "id": "archived"
-- },
-- {
-- "amounts": [
-- {
-- "amount": "7040.981",
-- "code": "USD",
-- "count": 2
-- }
-- ],
-- "counts": 2,
-- "id": "active"
-- }
-- ]
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @counts int
DECLARE @id nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @amount nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @count int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.summaries'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @counts OUT, 'response.result.summaries[i].counts'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'response.result.summaries[i].id'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'response.result.summaries[i].amounts'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @amount OUT, 'response.result.summaries[i].amounts[j].amount'
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'response.result.summaries[i].amounts[j].code'
EXEC sp_OAMethod @jResp, 'IntOf', @count OUT, 'response.result.summaries[i].amounts[j].count'
SELECT @j = @j + 1
END
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}}/expenses/summaries
Postman Collection Item JSON
{
"name": "Expense Summaries",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/summaries",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"summaries"
]
},
"description": "This endpoint will return summaries of the total amounts of expenses by active, archived, and grand total. \n\nActive means not archived or deleted.\n\nArchived is simply reorganizing the experience on FreshBooks so they're tucked away nicely. They will still show up on your reports and count towards active clients. \n\nDeleted clients will be removed from your active clients list, however, any activity related to those accounts will not show up on your reports. \n"
},
"response": [
{
"name": "Expense Summaries Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://my.freshbooks.com/service/api/accounting/account/{{accountId}}/expenses/summaries",
"protocol": "https",
"host": [
"my",
"freshbooks",
"com"
],
"path": [
"service",
"api",
"accounting",
"account",
"{{accountId}}",
"expenses",
"summaries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoHQBJdVkdXQBBUDFATSkBIBhtRSFMAAQRRWVIGCAVTUgQPAlpKTlMcQA5bWQtQUVBdCFgBAgUABVIVTQACVEBVOQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 15:14:45 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"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 15:14:45 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-jfk8128-JFK"
},
{
"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 \"summaries\": [\n {\n \"amounts\": [\n {\n \"amount\": \"7040.981\",\n \"code\": \"USD\",\n \"count\": 2\n }\n ],\n \"counts\": 2,\n \"id\": \"grand_total\"\n },\n {\n \"amounts\": [],\n \"counts\": 0,\n \"id\": \"archived\"\n },\n {\n \"amounts\": [\n {\n \"amount\": \"7040.981\",\n \"code\": \"USD\",\n \"count\": 2\n }\n ],\n \"counts\": 2,\n \"id\": \"active\"\n }\n ]\n }\n }\n}"
}
]
}
