Chilkat Online Tools

Ruby / New FreshBooks / List Expense Categories

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>")
http.SetRequestHeader("Content-Type","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",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": {
#       "categories": [
#         {
#           "category": "Accident Insurance",
#           "categoryid": 2003192,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003192,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003186,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Accounting",
#           "categoryid": 2003198,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003198,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003194,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Advertising",
#           "categoryid": 2003168,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003168,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": null,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Airfare",
#           "categoryid": 2003242,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003242,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003238,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Bank Fees",
#           "categoryid": 2003148,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003148,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003142,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Business Insurance",
#           "categoryid": 2003146,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003146,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003142,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Car & Truck Expenses",
#           "categoryid": 2003170,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003170,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": null,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Commissions",
#           "categoryid": 2003164,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003164,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003142,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Computer Parts",
#           "categoryid": 2005674,
#           "created_at": "2019-04-18 09:40:57",
#           "id": 2005674,
#           "is_cogs": false,
#           "is_editable": true,
#           "parentid": 2003142,
#           "updated_at": "2019-04-18 09:40:57",
#           "vis_state": 0
#         },
#         {
#           "category": "Contractors",
#           "categoryid": 2003182,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003182,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": null,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Depreciation",
#           "categoryid": 2003160,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003160,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003142,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Education and Training",
#           "categoryid": 2003184,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003184,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": null,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Employee Benefits",
#           "categoryid": 2003186,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003186,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": null,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Entertainment",
#           "categoryid": 2003204,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003204,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003200,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         },
#         {
#           "category": "Equipment",
#           "categoryid": 2003232,
#           "created_at": "2019-04-18 09:14:52",
#           "id": 2003232,
#           "is_cogs": false,
#           "is_editable": false,
#           "parentid": 2003226,
#           "updated_at": "2019-04-18 09:14:52",
#           "vis_state": 0
#         }
#       ],
#       "page": 1,
#       "pages": 4,
#       "per_page": 15,
#       "total": 56
#     }
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Page = jResp.IntOf("response.result.page")
Pages = jResp.IntOf("response.result.pages")
Per_page = jResp.IntOf("response.result.per_page")
Total = jResp.IntOf("response.result.total")
i = 0
count_i = jResp.SizeOfArray("response.result.categories")
while i < count_i
    jResp.put_I(i)
    category = jResp.stringOf("response.result.categories[i].category")
    categoryid = jResp.IntOf("response.result.categories[i].categoryid")
    created_at = jResp.stringOf("response.result.categories[i].created_at")
    id = jResp.IntOf("response.result.categories[i].id")
    is_cogs = jResp.BoolOf("response.result.categories[i].is_cogs")
    is_editable = jResp.BoolOf("response.result.categories[i].is_editable")
    parentid = jResp.IntOf("response.result.categories[i].parentid")
    updated_at = jResp.stringOf("response.result.categories[i].updated_at")
    vis_state = jResp.IntOf("response.result.categories[i].vis_state")
    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories

Postman Collection Item JSON

{
  "name": "List Expense Categories",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody); ",
          "pm.environment.set(\"categoryId\", jsonData.response.result.categories[0].id) "
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "expenses",
        "categories"
      ]
    }
  },
  "response": [
    {
      "name": "List Expense Categories",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "expenses",
            "categories"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoBWRZdX1tAWgBKQx1RH1JKBwZVV1YJBwdTWVMEBgVWUx0bAk5EAVpSVghRWwBXUwEDDlIDAhFOAldbEgM+"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:03:50 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, 24 Apr 2019 18:03:50 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            \"categories\": [\n                {\n                    \"category\": \"Accident Insurance\",\n                    \"categoryid\": 2003192,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003192,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003186,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Accounting\",\n                    \"categoryid\": 2003198,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003198,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003194,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Advertising\",\n                    \"categoryid\": 2003168,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003168,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": null,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Airfare\",\n                    \"categoryid\": 2003242,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003242,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003238,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Bank Fees\",\n                    \"categoryid\": 2003148,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003148,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003142,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Business Insurance\",\n                    \"categoryid\": 2003146,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003146,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003142,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Car & Truck Expenses\",\n                    \"categoryid\": 2003170,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003170,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": null,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Commissions\",\n                    \"categoryid\": 2003164,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003164,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003142,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Computer Parts\",\n                    \"categoryid\": 2005674,\n                    \"created_at\": \"2019-04-18 09:40:57\",\n                    \"id\": 2005674,\n                    \"is_cogs\": false,\n                    \"is_editable\": true,\n                    \"parentid\": 2003142,\n                    \"updated_at\": \"2019-04-18 09:40:57\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Contractors\",\n                    \"categoryid\": 2003182,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003182,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": null,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Depreciation\",\n                    \"categoryid\": 2003160,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003160,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003142,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Education and Training\",\n                    \"categoryid\": 2003184,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003184,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": null,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Employee Benefits\",\n                    \"categoryid\": 2003186,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003186,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": null,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Entertainment\",\n                    \"categoryid\": 2003204,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003204,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003200,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"category\": \"Equipment\",\n                    \"categoryid\": 2003232,\n                    \"created_at\": \"2019-04-18 09:14:52\",\n                    \"id\": 2003232,\n                    \"is_cogs\": false,\n                    \"is_editable\": false,\n                    \"parentid\": 2003226,\n                    \"updated_at\": \"2019-04-18 09:14:52\",\n                    \"vis_state\": 0\n                }\n            ],\n            \"page\": 1,\n            \"pages\": 4,\n            \"per_page\": 15,\n            \"total\": 56\n        }\n    }\n}"
    }
  ]
}