Chilkat Online Tools

Ruby / New FreshBooks / Expense Summaries

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/summaries",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
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

i = 0
count_i = jResp.SizeOfArray("response.result.summaries")
while i < count_i
    jResp.put_I(i)
    counts = jResp.IntOf("response.result.summaries[i].counts")
    id = jResp.stringOf("response.result.summaries[i].id")
    j = 0
    count_j = jResp.SizeOfArray("response.result.summaries[i].amounts")
    while j < count_j
        jResp.put_J(j)
        amount = jResp.stringOf("response.result.summaries[i].amounts[j].amount")
        code = jResp.stringOf("response.result.summaries[i].amounts[j].code")
        count = jResp.IntOf("response.result.summaries[i].amounts[j].count")
        j = j + 1
    end
    i = i + 1
end

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}"
    }
  ]
}