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()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("dates[]","2019-04-19")
queryParams.UpdateString("dates[]","2019-04-25")
queryParams.UpdateString("currency_code","USD")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/balance_sheet",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "balance_sheet": {
# "assets_total": [
# {
# "balance": {
# "amount": "-1380.98",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "10345.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "company_name": "Postman Sandbox",
# "currency_code": "USD",
# "data": [
# {
# "account_type": "asset",
# "accounts": [
# {
# "account_name": "Cash",
# "account_number": "1000",
# "balances": [
# {
# "balance": {
# "amount": "5744.02",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "6310.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_accounts": [
# {
# "balances": [
# {
# "balance": {
# "amount": "5744.02",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "6310.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_account_name": "Petty Cash",
# "sub_account_number": "1"
# }
# ]
# },
# {
# "account_name": "Accounts Receivable",
# "account_number": "1200",
# "balances": [
# {
# "balance": {
# "amount": "-7125.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "4035.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_accounts": [
# {
# "balances": [
# {
# "balance": {
# "amount": "-7125.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "4435.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_account_name": "Accounts Receivable",
# "sub_account_number": "1"
# },
# {
# "balances": [
# {
# "balance": {
# "amount": "0.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "-400.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_account_name": "Customer Deposits",
# "sub_account_number": "2"
# }
# ]
# }
# ],
# "balances": [
# {
# "balance": {
# "amount": "-1380.98",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "10345.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "category": "current"
# },
# {
# "account_type": "liability",
# "accounts": [
# {
# "account_name": "Taxes Payable",
# "account_number": "2001",
# "balances": [
# {
# "balance": {
# "amount": "205.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "211.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_accounts": [
# {
# "balances": [
# {
# "balance": {
# "amount": "205.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "211.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_account_name": "HST",
# "sub_account_number": "1"
# }
# ]
# },
# {
# "account_name": "Customer Credit",
# "account_number": "2003",
# "balances": [
# {
# "balance": {
# "amount": "3120.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "3120.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_accounts": [
# {
# "balances": [
# {
# "balance": {
# "amount": "3120.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "3120.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_account_name": "Customer Credit",
# "sub_account_number": "1"
# }
# ]
# }
# ],
# "balances": [
# {
# "balance": {
# "amount": "3325.00",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "3331.00",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "category": "current"
# },
# {
# "account_type": "equity",
# "accounts": [
# {
# "account_name": "Net Income",
# "account_number": null,
# "balances": [
# {
# "balance": {
# "amount": "-4705.98",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "7014.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "sub_accounts": [
# ]
# }
# ],
# "balances": [
# {
# "balance": {
# "amount": "-4705.98",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "7014.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ],
# "category": null
# }
# ],
# "dates": [
# "2019-04-19",
# "2019-04-25"
# ],
# "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJiYWxhbmNlX3NoZWV0IiwicGFyYW1zIjp7ImRhdGVzIjpbIjIwMTktMDQtMTkiLCIyMDE5LTA0LTI1Il0sImN1cnJlbmN5X2NvZGUiOiJVU0QifSwiaWF0IjoxNTU2MTMwNzAzLCJleHAiOjE1NTg3MjI3MDN9.FziuxTK2nbj1xfrefdPjL9J7_a5tFjBneqTp5juy4D0",
# "liabilities_and_equity_total": [
# {
# "balance": {
# "amount": "-1380.98",
# "code": "USD"
# },
# "date": "2019-04-19"
# },
# {
# "balance": {
# "amount": "10345.56",
# "code": "USD"
# },
# "date": "2019-04-25"
# }
# ]
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Company_name = jResp.stringOf("response.result.balance_sheet.company_name")
Currency_code = jResp.stringOf("response.result.balance_sheet.currency_code")
Download_token = jResp.stringOf("response.result.balance_sheet.download_token")
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.assets_total")
while i < count_i
jResp.put_I(i)
Amount = jResp.stringOf("response.result.balance_sheet.assets_total[i].balance.amount")
Code = jResp.stringOf("response.result.balance_sheet.assets_total[i].balance.code")
date = jResp.stringOf("response.result.balance_sheet.assets_total[i].date")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.data")
while i < count_i
jResp.put_I(i)
account_type = jResp.stringOf("response.result.balance_sheet.data[i].account_type")
category = jResp.stringOf("response.result.balance_sheet.data[i].category")
j = 0
count_j = jResp.SizeOfArray("response.result.balance_sheet.data[i].accounts")
while j < count_j
jResp.put_J(j)
account_name = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].account_name")
account_number = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].account_number")
k = 0
count_k = jResp.SizeOfArray("response.result.balance_sheet.data[i].accounts[j].balances")
while k < count_k
jResp.put_K(k)
balanceAmount = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].balances[k].balance.amount")
balanceCode = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].balances[k].balance.code")
date = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].balances[k].date")
k = k + 1
end
k = 0
count_k = jResp.SizeOfArray("response.result.balance_sheet.data[i].accounts[j].sub_accounts")
while k < count_k
jResp.put_K(k)
sub_account_name = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].sub_accounts[k].sub_account_name")
sub_account_number = jResp.stringOf("response.result.balance_sheet.data[i].accounts[j].sub_accounts[k].sub_account_number")
# json1 is a CkJsonObject
json1 = jResp.ObjectOf("response.result.balance_sheet.data[i].accounts[j].sub_accounts[k]")
i1 = 0
count_i1 = json1.SizeOfArray("balances")
while i1 < count_i1
json1.put_I(i1)
balanceAmount = json1.stringOf("balances[i].balance.amount")
balanceCode = json1.stringOf("balances[i].balance.code")
date = json1.stringOf("balances[i].date")
i1 = i1 + 1
end
k = k + 1
end
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("response.result.balance_sheet.data[i].balances")
while j < count_j
jResp.put_J(j)
balanceAmount = jResp.stringOf("response.result.balance_sheet.data[i].balances[j].balance.amount")
balanceCode = jResp.stringOf("response.result.balance_sheet.data[i].balances[j].balance.code")
date = jResp.stringOf("response.result.balance_sheet.data[i].balances[j].date")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.dates")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("response.result.balance_sheet.dates[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.liabilities_and_equity_total")
while i < count_i
jResp.put_I(i)
balanceAmount = jResp.stringOf("response.result.balance_sheet.liabilities_and_equity_total[i].balance.amount")
balanceCode = jResp.stringOf("response.result.balance_sheet.liabilities_and_equity_total[i].balance.code")
date = jResp.stringOf("response.result.balance_sheet.liabilities_and_equity_total[i].date")
i = i + 1
end
Curl Command
curl -G -d "dates[]=2019-04-19"
-d "dates[]=2019-04-25"
-d "currency_code=USD"
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/balance_sheet
Postman Collection Item JSON
{
"name": "Balance Sheet",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/balance_sheet?dates[]=2019-04-19&dates[]=2019-04-25¤cy_code=USD",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"balance_sheet"
],
"query": [
{
"key": "dates[]",
"value": "2019-04-19",
"description": "will need to explain [] as anything before this date"
},
{
"key": "dates[]",
"value": "2019-04-25"
},
{
"key": "currency_code",
"value": "USD"
}
]
},
"description": "A snapshot of your company's assets, liabilities and equity at any given point in time."
},
"response": [
{
"name": "Balance Sheet",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/balance_sheet?dates[]=2019-04-19&dates[]=2019-04-25¤cy_code=USD",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"balance_sheet"
],
"query": [
{
"key": "dates[]",
"value": "2019-04-19",
"description": "will need to explain [] as anything before this date"
},
{
"key": "dates[]",
"value": "2019-04-25"
},
{
"key": "currency_code",
"value": "USD"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwlcU1QFAgZWVAMOA1VQUlUcTwlOGg5VB1dVAAMBUlEHUgBRBwdBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:31:43 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:31:43 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 \"balance_sheet\": {\n \"assets_total\": [\n {\n \"balance\": {\n \"amount\": \"-1380.98\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"10345.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"company_name\": \"Postman Sandbox\",\n \"currency_code\": \"USD\",\n \"data\": [\n {\n \"account_type\": \"asset\",\n \"accounts\": [\n {\n \"account_name\": \"Cash\",\n \"account_number\": \"1000\",\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"5744.02\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"6310.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_accounts\": [\n {\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"5744.02\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"6310.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_account_name\": \"Petty Cash\",\n \"sub_account_number\": \"1\"\n }\n ]\n },\n {\n \"account_name\": \"Accounts Receivable\",\n \"account_number\": \"1200\",\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"-7125.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"4035.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_accounts\": [\n {\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"-7125.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"4435.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_account_name\": \"Accounts Receivable\",\n \"sub_account_number\": \"1\"\n },\n {\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"-400.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_account_name\": \"Customer Deposits\",\n \"sub_account_number\": \"2\"\n }\n ]\n }\n ],\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"-1380.98\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"10345.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"category\": \"current\"\n },\n {\n \"account_type\": \"liability\",\n \"accounts\": [\n {\n \"account_name\": \"Taxes Payable\",\n \"account_number\": \"2001\",\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"205.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"211.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_accounts\": [\n {\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"205.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"211.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_account_name\": \"HST\",\n \"sub_account_number\": \"1\"\n }\n ]\n },\n {\n \"account_name\": \"Customer Credit\",\n \"account_number\": \"2003\",\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"3120.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"3120.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_accounts\": [\n {\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"3120.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"3120.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_account_name\": \"Customer Credit\",\n \"sub_account_number\": \"1\"\n }\n ]\n }\n ],\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"3325.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"3331.00\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"category\": \"current\"\n },\n {\n \"account_type\": \"equity\",\n \"accounts\": [\n {\n \"account_name\": \"Net Income\",\n \"account_number\": null,\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"-4705.98\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"7014.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"sub_accounts\": []\n }\n ],\n \"balances\": [\n {\n \"balance\": {\n \"amount\": \"-4705.98\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"7014.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ],\n \"category\": null\n }\n ],\n \"dates\": [\n \"2019-04-19\",\n \"2019-04-25\"\n ],\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJiYWxhbmNlX3NoZWV0IiwicGFyYW1zIjp7ImRhdGVzIjpbIjIwMTktMDQtMTkiLCIyMDE5LTA0LTI1Il0sImN1cnJlbmN5X2NvZGUiOiJVU0QifSwiaWF0IjoxNTU2MTMwNzAzLCJleHAiOjE1NTg3MjI3MDN9.FziuxTK2nbj1xfrefdPjL9J7_a5tFjBneqTp5juy4D0\",\n \"liabilities_and_equity_total\": [\n {\n \"balance\": {\n \"amount\": \"-1380.98\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-19\"\n },\n {\n \"balance\": {\n \"amount\": \"10345.56\",\n \"code\": \"USD\"\n },\n \"date\": \"2019-04-25\"\n }\n ]\n }\n }\n }\n}"
}
]
}
