Chilkat Online Tools

Foxpro / New FreshBooks / Single Item

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAccounting_systemid
LOCAL lcDescription
LOCAL lnId
LOCAL lcInventory
LOCAL lnItemid
LOCAL lcName
LOCAL lcQty
LOCAL lnTax1
LOCAL lnTax2
LOCAL lcAmount
LOCAL lcCode
LOCAL lcUpdated
LOCAL lnVis_state

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loHttp = CreateObject('Chilkat_9_5_0.Http')

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

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
ENDIF

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

* {
*   "response": {
*     "result": {
*       "item": {
*         "accounting_systemid": "wkMd2g",
*         "description": "Just a touring pack",
*         "id": 59726,
*         "inventory": "4",
*         "itemid": 59726,
*         "name": "Touring Pack",
*         "qty": "10",
*         "tax1": 0,
*         "tax2": 0,
*         "unit_cost": {
*           "amount": "550.00",
*           "code": "USD"
*         },
*         "updated": "2019-04-19 08:38:19",
*         "vis_state": 0
*       }
*     }
*   }
* }

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

lcAccounting_systemid = loJResp.StringOf("response.result.item.accounting_systemid")
lcDescription = loJResp.StringOf("response.result.item.description")
lnId = loJResp.IntOf("response.result.item.id")
lcInventory = loJResp.StringOf("response.result.item.inventory")
lnItemid = loJResp.IntOf("response.result.item.itemid")
lcName = loJResp.StringOf("response.result.item.name")
lcQty = loJResp.StringOf("response.result.item.qty")
lnTax1 = loJResp.IntOf("response.result.item.tax1")
lnTax2 = loJResp.IntOf("response.result.item.tax2")
lcAmount = loJResp.StringOf("response.result.item.unit_cost.amount")
lcCode = loJResp.StringOf("response.result.item.unit_cost.code")
lcUpdated = loJResp.StringOf("response.result.item.updated")
lnVis_state = loJResp.IntOf("response.result.item.vis_state")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Single Item",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"itemId\", jsonData.response.result.item.id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "items",
        "items",
        "{{itemId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Single Item",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items",
            "{{itemId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcA1IAWQVYCldcAgZYUVoBCxxJUE4VBA8CBlRXUFoDAFUCBwAAXhoYVFIJSgRs"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:18:58 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:18:58 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            \"item\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"description\": \"Just a touring pack\",\n                \"id\": 59726,\n                \"inventory\": \"4\",\n                \"itemid\": 59726,\n                \"name\": \"Touring Pack\",\n                \"qty\": \"10\",\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"550.00\",\n                    \"code\": \"USD\"\n                },\n                \"updated\": \"2019-04-19 08:38:19\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}