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>"
http.SetRequestHeader("Content-Type","")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/invoice_details",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": {
' "invoice_details": {
' "clientids": [
' ],
' "clients": [
' ],
' "company_name": "Postman Sandbox",
' "currency_code": "USD",
' "date_type": "issue",
' "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJpbnZvaWNlX2RldGFpbHMiLCJwYXJhbXMiOnsic3RhcnRfZGF0ZSI6IjIwMTktMDQtMjQiLCJlbmRfZGF0ZSI6IjIwMTktMDQtMjQiLCJkYXRlX3R5cGUiOiJpc3N1ZSIsImN1cnJlbmN5X2NvZGUiOiJVU0QiLCJjbGllbnRpZHMiOltdLCJzdGF0dXNpZHMiOltdfSwiaWF0IjoxNTU2MTMwNTYyLCJleHAiOjE1NTg3MjI1NjJ9.aV3sb8ohrAx8q0cus1gk_DnRikgvKRjJdpGyIM0lKqQ",
' "end_date": "2019-04-24",
' "start_date": "2019-04-24",
' "statusids": [
' ],
' "summary": {
' "outstanding": {
' "amount": "0.00",
' "code": "USD"
' },
' "paid": {
' "amount": "0.00",
' "code": "USD"
' },
' "total": {
' "amount": "0.00",
' "code": "USD"
' }
' },
' "summary_only": false
' }
' }
' }
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim Date_type As New Chilkat.DtObj
Dim Company_name As String = jResp.StringOf("response.result.invoice_details.company_name")
Dim Currency_code As String = jResp.StringOf("response.result.invoice_details.currency_code")
jResp.DtOf("response.result.invoice_details.date_type",False,Date_type)
Dim Download_token As String = jResp.StringOf("response.result.invoice_details.download_token")
Dim End_date As String = jResp.StringOf("response.result.invoice_details.end_date")
Dim Start_date As String = jResp.StringOf("response.result.invoice_details.start_date")
Dim Amount As String = jResp.StringOf("response.result.invoice_details.summary.outstanding.amount")
Dim Code As String = jResp.StringOf("response.result.invoice_details.summary.outstanding.code")
Dim PaidAmount As String = jResp.StringOf("response.result.invoice_details.summary.paid.amount")
Dim PaidCode As String = jResp.StringOf("response.result.invoice_details.summary.paid.code")
Dim TotalAmount As String = jResp.StringOf("response.result.invoice_details.summary.total.amount")
Dim TotalCode As String = jResp.StringOf("response.result.invoice_details.summary.total.code")
Dim Summary_only As Boolean = jResp.BoolOf("response.result.invoice_details.summary_only")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("response.result.invoice_details.clientids")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.invoice_details.clients")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.invoice_details.statusids")
While i < count_i
jResp.I = i
i = i + 1
End While
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: "
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/invoice_details
Postman Collection Item JSON
{
"name": "Invoice Details",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/invoice_details",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"invoice_details"
],
"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-04-20`",
"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": "statusids",
"value": "",
"description": "returns invoices that has the same status as the given status. i.e. `\"draft\"`, `\"sent\"`, `\"paid\"`, etc.",
"disabled": true
},
{
"key": "date_type",
"value": "issue",
"description": "returns invoices with the specified date_type (`\"issue\"` or `\"paid\"`)",
"disabled": true
}
]
},
"description": "## Invoice Details\n\nThe Invoice Details Report shows all the information involving your invoices"
},
"response": [
{
"name": "Invoice Details",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/invoice_details",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"invoice_details"
],
"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-04-20`",
"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": "statusids",
"value": "",
"description": "returns invoices that has the same status as the given status. i.e. `\"draft\"`, `\"sent\"`, `\"paid\"`, etc.",
"disabled": true
},
{
"key": "date_type",
"value": "issue",
"description": "returns invoices with the specified date_type (`\"issue\"` or `\"paid\"`)",
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwlQUFUBBgFfVgQABltXW04dUxRAW11VUQRUDlMEBAUGVVRVVERPXlJcFwQ/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:29:22 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:29:22 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 \"invoice_details\": {\n \"clientids\": [],\n \"clients\": [],\n \"company_name\": \"Postman Sandbox\",\n \"currency_code\": \"USD\",\n \"date_type\": \"issue\",\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJpbnZvaWNlX2RldGFpbHMiLCJwYXJhbXMiOnsic3RhcnRfZGF0ZSI6IjIwMTktMDQtMjQiLCJlbmRfZGF0ZSI6IjIwMTktMDQtMjQiLCJkYXRlX3R5cGUiOiJpc3N1ZSIsImN1cnJlbmN5X2NvZGUiOiJVU0QiLCJjbGllbnRpZHMiOltdLCJzdGF0dXNpZHMiOltdfSwiaWF0IjoxNTU2MTMwNTYyLCJleHAiOjE1NTg3MjI1NjJ9.aV3sb8ohrAx8q0cus1gk_DnRikgvKRjJdpGyIM0lKqQ\",\n \"end_date\": \"2019-04-24\",\n \"start_date\": \"2019-04-24\",\n \"statusids\": [],\n \"summary\": {\n \"outstanding\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n }\n },\n \"summary_only\": false\n }\n }\n }\n}"
}
]
}
