Chilkat Online Tools

VB.NET / New FreshBooks / List Taxes

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}}/taxes/taxes",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": {
'       "page": 1,
'       "pages": 1,
'       "per_page": 15,
'       "taxes": [
'         {
'           "accounting_systemid": "wkMd2g",
'           "amount": "13",
'           "compound": false,
'           "id": 3264,
'           "name": "other tax",
'           "number": "TAX-123456",
'           "taxid": 3264,
'           "updated": "2019-04-18 11:47:12"
'         },
'         {
'           "accounting_systemid": "wkMd2g",
'           "amount": "0",
'           "compound": false,
'           "id": 3294,
'           "name": "some tax",
'           "number": null,
'           "taxid": 3294,
'           "updated": "2019-04-18 11:44:56"
'         },
'         {
'           "accounting_systemid": "wkMd2g",
'           "amount": "0",
'           "compound": false,
'           "id": 3300,
'           "name": "some taxv2",
'           "number": null,
'           "taxid": 3300,
'           "updated": "2019-04-18 11:53:44"
'         }
'       ],
'       "total": 3
'     }
'   }
' }

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



Dim accounting_systemid As String
Dim amount As String
Dim compound As Boolean
Dim id As Integer
Dim name As String
Dim v_number As String
Dim taxid As Integer
Dim updated As String

Dim Page As Integer = jResp.IntOf("response.result.page")
Dim Pages As Integer = jResp.IntOf("response.result.pages")
Dim Per_page As Integer = jResp.IntOf("response.result.per_page")
Dim Total As Integer = jResp.IntOf("response.result.total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("response.result.taxes")
While i < count_i
    jResp.I = i
    accounting_systemid = jResp.StringOf("response.result.taxes[i].accounting_systemid")
    amount = jResp.StringOf("response.result.taxes[i].amount")
    compound = jResp.BoolOf("response.result.taxes[i].compound")
    id = jResp.IntOf("response.result.taxes[i].id")
    name = jResp.StringOf("response.result.taxes[i].name")
    v_number = jResp.StringOf("response.result.taxes[i].number")
    taxid = jResp.IntOf("response.result.taxes[i].taxid")
    updated = jResp.StringOf("response.result.taxes[i].updated")
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Taxes",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"taxId\", jsonData.response.result.taxes[0].id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "taxes",
        "taxes"
      ]
    }
  },
  "response": [
    {
      "name": "List Taxes",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "taxes",
            "taxes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gQUE5WEVwXA0gHS0AUCBgCHVUAVANWAVdQBwdVUFIMAQVcTU8GHRUCUgZQUlECAQBRVl4DXgsGEB8DWA1CBG4="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:40:20 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:40:20 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            \"page\": 1,\n            \"pages\": 1,\n            \"per_page\": 15,\n            \"taxes\": [\n                {\n                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": \"13\",\n                    \"compound\": false,\n                    \"id\": 3264,\n                    \"name\": \"other tax\",\n                    \"number\": \"TAX-123456\",\n                    \"taxid\": 3264,\n                    \"updated\": \"2019-04-18 11:47:12\"\n                },\n                {\n                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": \"0\",\n                    \"compound\": false,\n                    \"id\": 3294,\n                    \"name\": \"some tax\",\n                    \"number\": null,\n                    \"taxid\": 3294,\n                    \"updated\": \"2019-04-18 11:44:56\"\n                },\n                {\n                    \"accounting_systemid\": \"wkMd2g\",\n                    \"amount\": \"0\",\n                    \"compound\": false,\n                    \"id\": 3300,\n                    \"name\": \"some taxv2\",\n                    \"number\": null,\n                    \"taxid\": 3300,\n                    \"updated\": \"2019-04-18 11:53:44\"\n                }\n            ],\n            \"total\": 3\n        }\n    }\n}"
    }
  ]
}