Chilkat Online Tools

Xojo / New FreshBooks / Accounts Aging

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/accounts_aging",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "response": {
//     "result": {
//       "accounts_aging": {
//         "accounts": [
//           {
//             "0-30": {
//               "amount": "3830.00",
//               "code": "USD"
//             },
//             "31-60": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "61-90": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "91+": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "email": "first@company.com",
//             "fname": "Nicolas",
//             "lname": "one",
//             "organization": "first company",
//             "total": {
//               "amount": "3830.00",
//               "code": "USD"
//             },
//             "userid": 31006
//           },
//           {
//             "0-30": {
//               "amount": "50.00",
//               "code": "USD"
//             },
//             "31-60": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "61-90": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "91+": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "email": "mwesthofer5i@imdb.com",
//             "fname": "Myrta",
//             "lname": "Westhofer",
//             "organization": "Prosacco Group",
//             "total": {
//               "amount": "50.00",
//               "code": "USD"
//             },
//             "userid": 32080
//           },
//           {
//             "0-30": {
//               "amount": "398.48",
//               "code": "USD"
//             },
//             "31-60": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "61-90": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "91+": {
//               "amount": "0.00",
//               "code": "USD"
//             },
//             "email": "api.freshbooks@gmail.com",
//             "fname": "Ryan",
//             "lname": "Marr",
//             "organization": "Ryan Marr",
//             "total": {
//               "amount": "398.48",
//               "code": "USD"
//             },
//             "userid": 75162
//           }
//         ],
//         "company_name": "Postman Sandbox",
//         "currency_code": "USD",
//         "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjMxMDA0LCJjb250YWN0aWQiOi0xLCJsZXZlbCI6LTIwLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJhY2NvdW50c19hZ2luZyIsInBhcmFtcyI6eyJlbmRfZGF0ZSI6IjIwMTktMDUtMDgiLCJjdXJyZW5jeV9jb2RlIjoiVVNEIn0sImlhdCI6MTU1NzM0NjM4OCwiZXhwIjoxNTU5OTM4Mzg4fQ.Usasm7HQKxakFm5gFDAYMez__vLM5_VETtWdvdqJMeQ",
//         "end_date": "2019-05-08",
//         "totals": {
//           "0-30": {
//             "amount": "4278.48",
//             "code": "USD"
//           },
//           "31-60": {
//             "amount": "0.00",
//             "code": "USD"
//           },
//           "61-90": {
//             "amount": "0.00",
//             "code": "USD"
//           },
//           "91+": {
//             "amount": "0.00",
//             "code": "USD"
//           },
//           "total": {
//             "amount": "4278.48",
//             "code": "USD"
//           }
//         }
//       }
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim v_0_30Amount As String
Dim v_0_30Code As String
Dim email As String
Dim fname As String
Dim lname As String
Dim organization As String
Dim totalAmount As String
Dim totalCode As String
Dim userid As Int32

Dim Company_name As String
Company_name = jResp.StringOf("response.result.accounts_aging.company_name")
Dim Currency_code As String
Currency_code = jResp.StringOf("response.result.accounts_aging.currency_code")
Dim Download_token As String
Download_token = jResp.StringOf("response.result.accounts_aging.download_token")
Dim End_date As String
End_date = jResp.StringOf("response.result.accounts_aging.end_date")
Dim Amount As String
Amount = jResp.StringOf("response.result.accounts_aging.totals.0-30.amount")
Dim Code As String
Code = jResp.StringOf("response.result.accounts_aging.totals.0-30.code")
Dim v_31_60Amount As String
v_31_60Amount = jResp.StringOf("response.result.accounts_aging.totals.31-60.amount")
Dim v_31_60Code As String
v_31_60Code = jResp.StringOf("response.result.accounts_aging.totals.31-60.code")
Dim v_61_90Amount As String
v_61_90Amount = jResp.StringOf("response.result.accounts_aging.totals.61-90.amount")
Dim v_61_90Code As String
v_61_90Code = jResp.StringOf("response.result.accounts_aging.totals.61-90.code")
Dim v_91Amount As String
v_91Amount = jResp.StringOf("response.result.accounts_aging.totals.91+.amount")
Dim v_91Code As String
v_91Code = jResp.StringOf("response.result.accounts_aging.totals.91+.code")
Dim TotalAmount As String
TotalAmount = jResp.StringOf("response.result.accounts_aging.totals.total.amount")
Dim TotalCode As String
TotalCode = jResp.StringOf("response.result.accounts_aging.totals.total.code")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("response.result.accounts_aging.accounts")
While i < count_i
    jResp.I = i
    v_0_30Amount = jResp.StringOf("response.result.accounts_aging.accounts[i].0-30.amount")
    v_0_30Code = jResp.StringOf("response.result.accounts_aging.accounts[i].0-30.code")
    v_31_60Amount = jResp.StringOf("response.result.accounts_aging.accounts[i].31-60.amount")
    v_31_60Code = jResp.StringOf("response.result.accounts_aging.accounts[i].31-60.code")
    v_61_90Amount = jResp.StringOf("response.result.accounts_aging.accounts[i].61-90.amount")
    v_61_90Code = jResp.StringOf("response.result.accounts_aging.accounts[i].61-90.code")
    v_91Amount = jResp.StringOf("response.result.accounts_aging.accounts[i].91+.amount")
    v_91Code = jResp.StringOf("response.result.accounts_aging.accounts[i].91+.code")
    email = jResp.StringOf("response.result.accounts_aging.accounts[i].email")
    fname = jResp.StringOf("response.result.accounts_aging.accounts[i].fname")
    lname = jResp.StringOf("response.result.accounts_aging.accounts[i].lname")
    organization = jResp.StringOf("response.result.accounts_aging.accounts[i].organization")
    totalAmount = jResp.StringOf("response.result.accounts_aging.accounts[i].total.amount")
    totalCode = jResp.StringOf("response.result.accounts_aging.accounts[i].total.code")
    userid = jResp.IntOf("response.result.accounts_aging.accounts[i].userid")
    i = i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging

Postman Collection Item JSON

{
  "name": "Accounts Aging",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "reports",
        "accounting",
        "accounts_aging"
      ],
      "query": [
        {
          "key": "start_date",
          "value": "2019-01-01",
          "description": "created during or after the given date i.e. `2019-01-01`",
          "disabled": true
        },
        {
          "key": "currency_code",
          "value": "USD",
          "description": "reports using the given currency as primary currency i.e. `\"USD\"`",
          "disabled": true
        }
      ]
    }
  },
  "response": [
    {
      "name": "Accounts Aging",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/accounts_aging",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "reports",
            "accounting",
            "accounts_aging"
          ],
          "query": [
            {
              "key": "start_date",
              "value": "2019-01-01",
              "description": "created during or after the given date i.e. `2019-01-01`",
              "disabled": true
            },
            {
              "key": "currency_code",
              "value": "USD",
              "description": "reports using the given currency as primary currency i.e. `\"USD\"`",
              "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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAghXWFEBAgJRUAgOAlReWlccTwlOGg4MU1cHCVJSUgsAAgUPBwNBFFVRCBIHag=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346447"
        },
        {
          "key": "Retry-After",
          "value": "58"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:13:08 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, 08 May 2019 20:13:08 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-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            \"accounts_aging\": {\n                \"accounts\": [\n                    {\n                        \"0-30\": {\n                            \"amount\": \"3830.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"31-60\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"61-90\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"91+\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"email\": \"first@company.com\",\n                        \"fname\": \"Nicolas\",\n                        \"lname\": \"one\",\n                        \"organization\": \"first company\",\n                        \"total\": {\n                            \"amount\": \"3830.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"userid\": 31006\n                    },\n                    {\n                        \"0-30\": {\n                            \"amount\": \"50.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"31-60\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"61-90\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"91+\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"email\": \"mwesthofer5i@imdb.com\",\n                        \"fname\": \"Myrta\",\n                        \"lname\": \"Westhofer\",\n                        \"organization\": \"Prosacco Group\",\n                        \"total\": {\n                            \"amount\": \"50.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"userid\": 32080\n                    },\n                    {\n                        \"0-30\": {\n                            \"amount\": \"398.48\",\n                            \"code\": \"USD\"\n                        },\n                        \"31-60\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"61-90\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"91+\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"USD\"\n                        },\n                        \"email\": \"api.freshbooks@gmail.com\",\n                        \"fname\": \"Ryan\",\n                        \"lname\": \"Marr\",\n                        \"organization\": \"Ryan Marr\",\n                        \"total\": {\n                            \"amount\": \"398.48\",\n                            \"code\": \"USD\"\n                        },\n                        \"userid\": 75162\n                    }\n                ],\n                \"company_name\": \"Postman Sandbox\",\n                \"currency_code\": \"USD\",\n                \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjMxMDA0LCJjb250YWN0aWQiOi0xLCJsZXZlbCI6LTIwLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJhY2NvdW50c19hZ2luZyIsInBhcmFtcyI6eyJlbmRfZGF0ZSI6IjIwMTktMDUtMDgiLCJjdXJyZW5jeV9jb2RlIjoiVVNEIn0sImlhdCI6MTU1NzM0NjM4OCwiZXhwIjoxNTU5OTM4Mzg4fQ.Usasm7HQKxakFm5gFDAYMez__vLM5_VETtWdvdqJMeQ\",\n                \"end_date\": \"2019-05-08\",\n                \"totals\": {\n                    \"0-30\": {\n                        \"amount\": \"4278.48\",\n                        \"code\": \"USD\"\n                    },\n                    \"31-60\": {\n                        \"amount\": \"0.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"61-90\": {\n                        \"amount\": \"0.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"91+\": {\n                        \"amount\": \"0.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"total\": {\n                        \"amount\": \"4278.48\",\n                        \"code\": \"USD\"\n                    }\n                }\n            }\n        }\n    }\n}"
    }
  ]
}