PureBasic / New FreshBooks / Expense Summaries
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/summaries",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
counts.i
id.s
j.i
count_j.i
amount.s
code.s
count.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"response.result.summaries")
While i < count_i
CkJsonObject::setCkI(jResp, i)
counts = CkJsonObject::ckIntOf(jResp,"response.result.summaries[i].counts")
id = CkJsonObject::ckStringOf(jResp,"response.result.summaries[i].id")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"response.result.summaries[i].amounts")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
amount = CkJsonObject::ckStringOf(jResp,"response.result.summaries[i].amounts[j].amount")
code = CkJsonObject::ckStringOf(jResp,"response.result.summaries[i].amounts[j].code")
count = CkJsonObject::ckIntOf(jResp,"response.result.summaries[i].amounts[j].count")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}