VB.NET / New FreshBooks / Payments Collected
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/payments_collected",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
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
Dim Download_token As String = jResp.StringOf("response.result.payments_collected.download_token")
Dim End_date As String = jResp.StringOf("response.result.payments_collected.end_date")
Dim Start_date As String = jResp.StringOf("response.result.payments_collected.start_date")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("response.result.payments_collected.clientids")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.payments_collected.currency_codes")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.payments_collected.payment_methods")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.payments_collected.payments")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.payments_collected.totals")
While i < count_i
jResp.I = i
i = i + 1
End While
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}"
}
]
}
