Chilkat Online Tools

delphiAx / New FreshBooks / List Items

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Accounting_systemid: WideString;
Description: WideString;
Id: Integer;
Inventory: WideString;
Itemid: Integer;
Name: WideString;
Qty: WideString;
Tax1: Integer;
Tax2: Integer;
Amount: WideString;
Code: WideString;
Updated: WideString;
Vis_state: Integer;

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

http := TChilkatHttp.Create(Self);

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Content-Type','application/json');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.freshbooks.com/accounting/account/{{accountId}}/items/items',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

// {
//   "response": {
//     "result": {
//       "item": {
//         "accounting_systemid": "wkMd2g",
//         "description": "Backpack with ferns",
//         "id": 59704,
//         "inventory": "55",
//         "itemid": 59704,
//         "name": "Backpack",
//         "qty": "20",
//         "tax1": 0,
//         "tax2": 0,
//         "unit_cost": {
//           "amount": "750.00",
//           "code": "USD"
//         },
//         "updated": "2019-04-19 08:09:32",
//         "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

Accounting_systemid := jResp.StringOf('response.result.item.accounting_systemid');
Description := jResp.StringOf('response.result.item.description');
Id := jResp.IntOf('response.result.item.id');
Inventory := jResp.StringOf('response.result.item.inventory');
Itemid := jResp.IntOf('response.result.item.itemid');
Name := jResp.StringOf('response.result.item.name');
Qty := jResp.StringOf('response.result.item.qty');
Tax1 := jResp.IntOf('response.result.item.tax1');
Tax2 := jResp.IntOf('response.result.item.tax2');
Amount := jResp.StringOf('response.result.item.unit_cost.amount');
Code := jResp.StringOf('response.result.item.unit_cost.code');
Updated := jResp.StringOf('response.result.item.updated');
Vis_state := jResp.IntOf('response.result.item.vis_state');

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Items",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"itemId\", jsonData.response.result.items[5].id);",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "items",
        "items"
      ]
    }
  },
  "response": [
    {
      "name": "Create Item",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": " {\n \"item\": {\n        \"name\": \"Backpack\",\n        \"qty\": \"20\",\n        \"inventory\": \"55\",\n        \"unit_cost\": {\n          \"amount\": \"750.00\",\n          \"code\": \"CAD\"\n        },\n        \"vis_state\": 0,\n        \"description\": \"Backpack with ferns\"\n      }\n }"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/items/items",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "items",
            "items"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNRVNeEVwKFlUPS0AUCBgCHVQBVQFXB1pSAwZQVFAIBwdIU1cAHRUHXAUGV1ZVUVIAAVxUCAEFEB8DWA1CBG4="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Thu, 19 Apr 2018 12:09:32 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": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Fri, 19 Apr 2019 12:09:32 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17357-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\": \"Backpack with ferns\",\n                \"id\": 59704,\n                \"inventory\": \"55\",\n                \"itemid\": 59704,\n                \"name\": \"Backpack\",\n                \"qty\": \"20\",\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"unit_cost\": {\n                    \"amount\": \"750.00\",\n                    \"code\": \"USD\"\n                },\n                \"updated\": \"2019-04-19 08:09:32\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}