Chilkat Online Tools

lianja / 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.

loHttp = createobject("CkHttp")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/taxes/taxes",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

lnPage = loJResp.IntOf("response.result.page")
lnPages = loJResp.IntOf("response.result.pages")
lnPer_page = loJResp.IntOf("response.result.per_page")
lnTotal = loJResp.IntOf("response.result.total")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.taxes")
do while i < lnCount_i
    loJResp.I = i
    lcAccounting_systemid = loJResp.StringOf("response.result.taxes[i].accounting_systemid")
    lcAmount = loJResp.StringOf("response.result.taxes[i].amount")
    llCompound = loJResp.BoolOf("response.result.taxes[i].compound")
    lnId = loJResp.IntOf("response.result.taxes[i].id")
    lcName = loJResp.StringOf("response.result.taxes[i].name")
    lcV_number = loJResp.StringOf("response.result.taxes[i].number")
    lnTaxid = loJResp.IntOf("response.result.taxes[i].taxid")
    lcUpdated = loJResp.StringOf("response.result.taxes[i].updated")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}