Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccounting_systemid
String sDescription
Integer iId
String sInventory
Integer iItemid
String sName
String sQty
Integer iTax1
Integer iTax2
String sAmount
String sCode
String sUpdated
Integer iVis_state
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/{{itemId}}" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "response.result.item.accounting_systemid" To sAccounting_systemid
Get ComStringOf Of hoJResp "response.result.item.description" To sDescription
Get ComIntOf Of hoJResp "response.result.item.id" To iId
Get ComStringOf Of hoJResp "response.result.item.inventory" To sInventory
Get ComIntOf Of hoJResp "response.result.item.itemid" To iItemid
Get ComStringOf Of hoJResp "response.result.item.name" To sName
Get ComStringOf Of hoJResp "response.result.item.qty" To sQty
Get ComIntOf Of hoJResp "response.result.item.tax1" To iTax1
Get ComIntOf Of hoJResp "response.result.item.tax2" To iTax2
Get ComStringOf Of hoJResp "response.result.item.unit_cost.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.item.unit_cost.code" To sCode
Get ComStringOf Of hoJResp "response.result.item.updated" To sUpdated
Get ComIntOf Of hoJResp "response.result.item.vis_state" To iVis_state
End_Procedure
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}"
},
{
"name": "Single Item w/ added SKU",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items/303664",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"items",
"items",
"303664"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAlEAVAhTAlRVBwBZU1sACwdITFMbEw9WBwgGVlVUBQQHBAtTCVoWHlUEVRJUPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "500"
},
{
"key": "X-RateLimit-Remaining",
"value": "499"
},
{
"key": "X-RateLimit-Reset",
"value": "1561052088"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 20 Jun 2018 17:33:47 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": "Thu, 20 Jun 2019 17:33:47 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17355-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\": \"E86Qp\",\n \"description\": \"AirTV\",\n \"id\": 303664,\n \"inventory\": null,\n \"itemid\": 303664,\n \"name\": \"1 Month Subscription\",\n \"qty\": \"0\",\n \"sku\": null,\n \"tax1\": 0,\n \"tax2\": 0,\n \"unit_cost\": {\n \"amount\": \"75.00\",\n \"code\": \"CAD\"\n },\n \"updated\": \"2019-01-16 11:52:08\",\n \"vis_state\": 0\n }\n }\n }\n}"
},
{
"name": "Single Item w/ SKU",
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAl0IVgdRAFNVBwVXUVMACghITFMbEwEFAAADBVIAUFYGUV1WDFsWHlUEVRJUPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "500"
},
{
"key": "X-RateLimit-Remaining",
"value": "499"
},
{
"key": "X-RateLimit-Reset",
"value": "1561053195"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 20 Jun 2018 17:52:14 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": "Thu, 20 Jun 2019 17:52:14 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\": 59724,\n \"inventory\": \"4\",\n \"itemid\": 59724,\n \"name\": \"Alan Touring Pack\",\n \"qty\": \"10\",\n \"sku\": \"SDK2919361221\",\n \"tax1\": 0,\n \"tax2\": 0,\n \"unit_cost\": {\n \"amount\": \"550.00\",\n \"code\": \"USD\"\n },\n \"updated\": \"2019-06-20 13:50:24\",\n \"vis_state\": 0\n }\n }\n }\n}"
},
{
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPGk4IFAQcAVULUgFUA1VcAwdXUlUBBANITFMbE1ZUAlVTA1tXW1tSUg0BWgEWHlUEVRJUPA=="
},
{
"key": "X-RateLimit-Limit",
"value": "500"
},
{
"key": "X-RateLimit-Remaining",
"value": "499"
},
{
"key": "X-RateLimit-Reset",
"value": "1561053382"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 20 Jun 2018 17:55:21 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": "Thu, 20 Jun 2019 17:55:21 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\": 59724,\n \"inventory\": \"4\",\n \"itemid\": 59724,\n \"name\": \"Alan Touring Pack\",\n \"qty\": \"10\",\n \"sku\": \"SDK2919361221\",\n \"tax1\": 0,\n \"tax2\": 0,\n \"unit_cost\": {\n \"amount\": \"550.00\",\n \"code\": \"USD\"\n },\n \"updated\": \"2019-06-20 13:50:24\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
