autoit / New FreshBooks / List Other Income
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sAmount
Local $sCode
Local $sCategory_name
Local $sCreated_at
Local $sDate
Local $incomeid
Local $sNote
Local $sPayment_type
Local $source
Local $sUpdated_at
Local $iVis_state
Local $iJ
Local $iCount_j
Local $sAmount
Local $sName
Local $iPage = $oJResp.IntOf("response.result.page")
Local $iPages = $oJResp.IntOf("response.result.pages")
Local $iPer_page = $oJResp.IntOf("response.result.per_page")
Local $iTotal = $oJResp.IntOf("response.result.total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("response.result.other_income")
While $i < $iCount_i
$oJResp.I = $i
$sAmount = $oJResp.StringOf("response.result.other_income[i].amount.amount")
$sCode = $oJResp.StringOf("response.result.other_income[i].amount.code")
$sCategory_name = $oJResp.StringOf("response.result.other_income[i].category_name")
$sCreated_at = $oJResp.StringOf("response.result.other_income[i].created_at")
$sDate = $oJResp.StringOf("response.result.other_income[i].date")
$incomeid = $oJResp.IntOf("response.result.other_income[i].incomeid")
$sNote = $oJResp.StringOf("response.result.other_income[i].note")
$sPayment_type = $oJResp.StringOf("response.result.other_income[i].payment_type")
$source = $oJResp.StringOf("response.result.other_income[i].source")
$sUpdated_at = $oJResp.StringOf("response.result.other_income[i].updated_at")
$iVis_state = $oJResp.IntOf("response.result.other_income[i].vis_state")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("response.result.other_income[i].taxes")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sAmount = $oJResp.StringOf("response.result.other_income[i].taxes[j].amount")
$sName = $oJResp.StringOf("response.result.other_income[i].taxes[j].name")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
