Chilkat Online Tools

Ruby / New FreshBooks / Create Item

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "item": {
#     "name": "Packback",
#     "qty": "10",
#     "inventory": "50",
#     "unit_cost": {
#       "amount": "550.00",
#       "code": "CAD"
#     },
#     "vis_state": 0,
#     "description": "65L Brack Pack",
#     "sku": "KS994RUR"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("item.name","Packback")
json.UpdateString("item.qty","10")
json.UpdateString("item.inventory","50")
json.UpdateString("item.unit_cost.amount","550.00")
json.UpdateString("item.unit_cost.code","CAD")
json.UpdateInt("item.vis_state",0)
json.UpdateString("item.description","65L Brack Pack")
json.UpdateString("item.sku","KS994RUR")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/items/items","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    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 POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
	"item": {
		"name": "Packback",
		"qty": "10",
		"inventory": "50",
		"unit_cost": {
			"amount": "550.00",
			"code": "CAD"
		},
		"vis_state": 0,
		"description": "65L Brack Pack",
		"sku": "KS994RUR"
	}
 }'
https://api.freshbooks.com/accounting/account/{{accountId}}/items/items

Postman Collection Item JSON

{
  "name": "Create Item",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"itemId\", jsonData.response.result.item.id);",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": " {\n\t\"item\": {\n\t\t\"name\": \"Packback\",\n\t\t\"qty\": \"10\",\n\t\t\"inventory\": \"50\",\n\t\t\"unit_cost\": {\n\t\t\t\"amount\": \"550.00\",\n\t\t\t\"code\": \"CAD\"\n\t\t},\n\t\t\"vis_state\": 0,\n\t\t\"description\": \"65L Brack Pack\",\n\t\t\"sku\": \"KS994RUR\"\n\t}\n }"
    },
    "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}"
    }
  ]
}