Foxpro / New FreshBooks / List Other Income
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAmount
LOCAL lcCode
LOCAL lcCategory_name
LOCAL lcCreated_at
LOCAL lcDate
LOCAL lnIncomeid
LOCAL lcNote
LOCAL lcPayment_type
LOCAL lcSource
LOCAL lcUpdated_at
LOCAL lnVis_state
LOCAL j
LOCAL lnCount_j
LOCAL lcAmount
LOCAL lcName
LOCAL lnPage
LOCAL lnPages
LOCAL lnPer_page
LOCAL lnTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lnPage = loJResp.IntOf("response.result.page")
lnPages = loJResp.IntOf("response.result.pages")
lnPer_page = loJResp.IntOf("response.result.per_page")
lnTotal = loJResp.IntOf("response.result.total")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.other_income")
DO WHILE i < lnCount_i
loJResp.I = i
lcAmount = loJResp.StringOf("response.result.other_income[i].amount.amount")
lcCode = loJResp.StringOf("response.result.other_income[i].amount.code")
lcCategory_name = loJResp.StringOf("response.result.other_income[i].category_name")
lcCreated_at = loJResp.StringOf("response.result.other_income[i].created_at")
lcDate = loJResp.StringOf("response.result.other_income[i].date")
lnIncomeid = loJResp.IntOf("response.result.other_income[i].incomeid")
lcNote = loJResp.StringOf("response.result.other_income[i].note")
lcPayment_type = loJResp.StringOf("response.result.other_income[i].payment_type")
lcSource = loJResp.StringOf("response.result.other_income[i].source")
lcUpdated_at = loJResp.StringOf("response.result.other_income[i].updated_at")
lnVis_state = loJResp.IntOf("response.result.other_income[i].vis_state")
j = 0
lnCount_j = loJResp.SizeOfArray("response.result.other_income[i].taxes")
DO WHILE j < lnCount_j
loJResp.J = j
lcAmount = loJResp.StringOf("response.result.other_income[i].taxes[j].amount")
lcName = loJResp.StringOf("response.result.other_income[i].taxes[j].name")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
