Powershell / New FreshBooks / List Other Income
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$http.SetRequestHeader("Content-Type","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "other_income": [
# {
# "amount": {
# "amount": "125.00",
# "code": "USD"
# },
# "category_name": "online_sales",
# "created_at": "2019-04-19 08:51:14",
# "date": "2019-04-19",
# "incomeid": 2122,
# "note": "Nepalese Hand-sewn Pouch",
# "payment_type": "VISA",
# "source": "Squarespace Site",
# "taxes": [
# ],
# "updated_at": "2019-04-19 08:58:09",
# "vis_state": 0
# },
# {
# "amount": {
# "amount": "1300.00",
# "code": "USD"
# },
# "category_name": "online_sales",
# "created_at": "2019-04-18 09:40:34",
# "date": "2019-04-18",
# "incomeid": 1872,
# "note": null,
# "payment_type": null,
# "source": "Shopify",
# "taxes": [
# {
# "amount": "140",
# "name": "HST"
# }
# ],
# "updated_at": "2019-04-18 09:40:34",
# "vis_state": 0
# }
# ],
# "page": 1,
# "pages": 1,
# "per_page": 15,
# "total": 2
# }
# }
# }
# 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.other_income")
while ($i -lt $count_i) {
$jResp.I = $i
$Amount = $jResp.StringOf("response.result.other_income[i].amount.amount")
$Code = $jResp.StringOf("response.result.other_income[i].amount.code")
$category_name = $jResp.StringOf("response.result.other_income[i].category_name")
$created_at = $jResp.StringOf("response.result.other_income[i].created_at")
$date = $jResp.StringOf("response.result.other_income[i].date")
$incomeid = $jResp.IntOf("response.result.other_income[i].incomeid")
$note = $jResp.StringOf("response.result.other_income[i].note")
$payment_type = $jResp.StringOf("response.result.other_income[i].payment_type")
$source = $jResp.StringOf("response.result.other_income[i].source")
$updated_at = $jResp.StringOf("response.result.other_income[i].updated_at")
$vis_state = $jResp.IntOf("response.result.other_income[i].vis_state")
$j = 0
$count_j = $jResp.SizeOfArray("response.result.other_income[i].taxes")
while ($j -lt $count_j) {
$jResp.J = $j
$amount = $jResp.StringOf("response.result.other_income[i].taxes[j].amount")
$name = $jResp.StringOf("response.result.other_income[i].taxes[j].name")
$j = $j + 1
}
$i = $i + 1
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes
Postman Collection Item JSON
{
"name": "List Other Income",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"incomeId\", jsonData.response.result.other_income[0].incomeid);"
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
},
"description": "List all available other income instances."
},
"response": [
{
"name": "List Other Income",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BRRVNVk8IHQFQVVsFAgVXVAACB1JSUVsHThVTFBpWVlBTDQMAWAtVAQ4EBFMFGh9WBQ0RUmw="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:19:25 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:19:25 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 \"other_income\": [\n {\n \"amount\": {\n \"amount\": \"125.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"created_at\": \"2019-04-19 08:51:14\",\n \"date\": \"2019-04-19\",\n \"incomeid\": 2122,\n \"note\": \"Nepalese Hand-sewn Pouch\",\n \"payment_type\": \"VISA\",\n \"source\": \"Squarespace Site\",\n \"taxes\": [],\n \"updated_at\": \"2019-04-19 08:58:09\",\n \"vis_state\": 0\n },\n {\n \"amount\": {\n \"amount\": \"1300.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"created_at\": \"2019-04-18 09:40:34\",\n \"date\": \"2019-04-18\",\n \"incomeid\": 1872,\n \"note\": null,\n \"payment_type\": null,\n \"source\": \"Shopify\",\n \"taxes\": [\n {\n \"amount\": \"140\",\n \"name\": \"HST\"\n }\n ],\n \"updated_at\": \"2019-04-18 09:40:34\",\n \"vis_state\": 0\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"total\": 2\n }\n }\n}"
}
]
}
