Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateString("dates[]", value: "2019-04-19")
queryParams.UpdateString("dates[]", value: "2019-04-25")
queryParams.UpdateString("currency_code", value: "USD")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/balance_sheet", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Amount: String?
var Code: String?
var date: String?
var account_type: String?
var category: String?
var j: Int
var count_j: Int
var account_name: String?
var account_number: String?
var k: Int
var count_k: Int
var balanceAmount: String?
var balanceCode: String?
var sub_account_name: String?
var sub_account_number: String?
var json1: CkoJsonObject?
var i1: Int
var count_i1: Int
var strVal: String?
var Company_name: String? = jResp.StringOf("response.result.balance_sheet.company_name")
var Currency_code: String? = jResp.StringOf("response.result.balance_sheet.currency_code")
var Download_token: String? = jResp.StringOf("response.result.balance_sheet.download_token")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("response.result.balance_sheet.assets_total").intValue
while i < count_i {
jResp.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
}
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.data").intValue
while i < count_i {
jResp.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").intValue
while j < count_j {
jResp.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").intValue
while k < count_k {
jResp.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
}
k = 0
count_k = jResp.SizeOfArray("response.result.balance_sheet.data[i].accounts[j].sub_accounts").intValue
while k < count_k {
jResp.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 = jResp.ObjectOf("response.result.balance_sheet.data[i].accounts[j].sub_accounts[k]")
i1 = 0
count_i1 = json1!.SizeOfArray("balances").intValue
while i1 < count_i1 {
json1.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
}
json1 = nil
k = k + 1
}
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("response.result.balance_sheet.data[i].balances").intValue
while j < count_j {
jResp.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
}
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.dates").intValue
while i < count_i {
jResp.I = i
strVal = jResp.StringOf("response.result.balance_sheet.dates[i]")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("response.result.balance_sheet.liabilities_and_equity_total").intValue
while i < count_i {
jResp.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
}
}
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}"
}
]
}
