PowerBuilder / New FreshBooks / Payments Collected
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Download_token
string ls_End_date
string ls_Start_date
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "payments_collected": {
// "clientids": [
// ],
// "currency_codes": [
// ],
// "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJwYXltZW50c19jb2xsZWN0ZWQiLCJwYXJhbXMiOnsic3RhcnRfZGF0ZSI6IjIwMTktMDQtMjQiLCJlbmRfZGF0ZSI6IjIwMTktMDQtMjQiLCJjdXJyZW5jeV9jb2RlcyI6bnVsbCwiY2xpZW50aWRzIjpudWxsLCJwYXltZW50X21ldGhvZHMiOm51bGx9LCJpYXQiOjE1NTYxMzA2MzksImV4cCI6MTU1ODcyMjYzOX0.MzRz-wIKOTpSjvsp90JGLQmO1oIA92SqLz93tPlHCRU",
// "end_date": "2019-04-24",
// "payment_methods": [
// ],
// "payments": [
// ],
// "start_date": "2019-04-24",
// "totals": [
// ]
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Download_token = loo_JResp.StringOf("response.result.payments_collected.download_token")
ls_End_date = loo_JResp.StringOf("response.result.payments_collected.end_date")
ls_Start_date = loo_JResp.StringOf("response.result.payments_collected.start_date")
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.payments_collected.clientids")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.payments_collected.currency_codes")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.payments_collected.payment_methods")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.payments_collected.payments")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.payments_collected.totals")
do while i < li_Count_i
loo_JResp.I = i
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected
Postman Collection Item JSON
{
"name": "Payments Collected",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"payments_collected"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
},
{
"key": "clientids",
"value": "",
"description": "returns data from specific client(s) i.e. `31007, 32291`",
"disabled": true
},
{
"key": "payment_method",
"value": "Visa",
"description": "returns data from clients who used the specific method of payment i.e. `\"Visa\"`, `\"Cash\"`, etc.",
"disabled": true
}
]
}
},
"response": [
{
"name": "Payments Collected",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"payments_collected"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
},
{
"key": "clientids",
"value": null,
"description": "returns data from specific client(s) i.e. `31007, 32291`",
"disabled": true
},
{
"key": "payment_method",
"value": "Visa",
"description": "returns data from clients who used the specific method of payment i.e. `\"Visa\"`, `\"Cash\"`, etc.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwdUWFcCCA5XUwUCCltTUlAcTwlOGgkBBFZVDgAAU1dWBwFTVgJBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:30:39 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:30:39 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 \"payments_collected\": {\n \"clientids\": [],\n \"currency_codes\": [],\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJwYXltZW50c19jb2xsZWN0ZWQiLCJwYXJhbXMiOnsic3RhcnRfZGF0ZSI6IjIwMTktMDQtMjQiLCJlbmRfZGF0ZSI6IjIwMTktMDQtMjQiLCJjdXJyZW5jeV9jb2RlcyI6bnVsbCwiY2xpZW50aWRzIjpudWxsLCJwYXltZW50X21ldGhvZHMiOm51bGx9LCJpYXQiOjE1NTYxMzA2MzksImV4cCI6MTU1ODcyMjYzOX0.MzRz-wIKOTpSjvsp90JGLQmO1oIA92SqLz93tPlHCRU\",\n \"end_date\": \"2019-04-24\",\n \"payment_methods\": [],\n \"payments\": [],\n \"start_date\": \"2019-04-24\",\n \"totals\": []\n }\n }\n }\n}"
}
]
}
