Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
# 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 = chilkat2.JsonObject()
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.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.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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"
]
},
"description": "If you add an `inventory` to an item, FreshBooks will decrement that `inventory` value each time you add that item to an invoice and save (or send) it. \n\nHowever, `qty` is seen as the amount of items associated with that sale. Therefore, it will remain unchanged with anytime it is added to an invoice. \n\nFor example: You may have 5 boxes of nails. Each box of nails will have 99 nails in it. Therefore, your `inventory` will equal `5` and your `qty` will equal `99`. \n"
},
"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}"
}
]
}
