TCL / New FreshBooks / Create Single Other Income
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "other_income": {
# "amount": {
# "amount": "113.00",
# "code": "USD"
# },
# "category_name": "online_sales",
# "date": "2019-04-20",
# "note": "Han Solo portrait",
# "payment_type": "Visa",
# "source": "Etsy",
# "taxes": [
# {
# "amount": "3",
# "name": "HST"
# }
# ]
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "other_income.amount.amount" "113.00"
CkJsonObject_UpdateString $json "other_income.amount.code" "USD"
CkJsonObject_UpdateString $json "other_income.category_name" "online_sales"
CkJsonObject_UpdateString $json "other_income.date" "2019-04-20"
CkJsonObject_UpdateString $json "other_income.note" "Han Solo portrait"
CkJsonObject_UpdateString $json "other_income.payment_type" "Visa"
CkJsonObject_UpdateString $json "other_income.source" "Etsy"
CkJsonObject_UpdateString $json "other_income.taxes[0].amount" "3"
CkJsonObject_UpdateString $json "other_income.taxes[0].name" "HST"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "result": {
# "other_income": {
# "amount": {
# "amount": "113.00",
# "code": "USD"
# },
# "category_name": "online_sales",
# "created_at": "2019-04-24 14:20:41",
# "date": "2019-04-20",
# "incomeid": 2852,
# "note": "Han Solo portrait",
# "payment_type": "VISA",
# "source": "Etsy",
# "taxes": [
# {
# "amount": "3",
# "name": "HST"
# }
# ],
# "updated_at": "2019-04-24 14:20:41",
# "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
set Amount [CkJsonObject_stringOf $jResp "response.result.other_income.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.other_income.amount.code"]
set Category_name [CkJsonObject_stringOf $jResp "response.result.other_income.category_name"]
set Created_at [CkJsonObject_stringOf $jResp "response.result.other_income.created_at"]
set Date [CkJsonObject_stringOf $jResp "response.result.other_income.date"]
set Incomeid [CkJsonObject_IntOf $jResp "response.result.other_income.incomeid"]
set Note [CkJsonObject_stringOf $jResp "response.result.other_income.note"]
set Payment_type [CkJsonObject_stringOf $jResp "response.result.other_income.payment_type"]
set Source [CkJsonObject_stringOf $jResp "response.result.other_income.source"]
set Updated_at [CkJsonObject_stringOf $jResp "response.result.other_income.updated_at"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.other_income.vis_state"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.result.other_income.taxes"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set amount [CkJsonObject_stringOf $jResp "response.result.other_income.taxes[i].amount"]
set name [CkJsonObject_stringOf $jResp "response.result.other_income.taxes[i].name"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"other_income": {
"amount": {
"amount": "113.00",
"code": "USD"
},
"category_name": "online_sales",
"date": "2019-04-20",
"note": "Han Solo portrait",
"payment_type": "Visa",
"source": "Etsy",
"taxes": [
{
"amount": "3",
"name": "HST"
}
]
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes
Postman Collection Item JSON
{
"name": "Create Single Other Income",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"date\": \"2019-04-20\",\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"Visa\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
},
"description": "This allows you to create a single entry for other income you collected (or will collect) through other means outside of FreshBooks."
},
"response": [
{
"name": "Create Single Other Income",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"date\": \"2019-04-20\",\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"Visa\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/other_incomes/other_incomes",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"other_incomes",
"other_incomes"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gLRV5WEDkKDFMNVQdLAltGWwBLCF8CXA8BRRVNVk8IHQFRUVoHBgZSVgMDBFRfU1YDTgtQDBQWAANXCVMHVwdUBVQFAl5bXBEcAgAORFRq"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:20:41 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": "Wed, 24 Apr 2019 18:20:41 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 \"other_income\": {\n \"amount\": {\n \"amount\": \"113.00\",\n \"code\": \"USD\"\n },\n \"category_name\": \"online_sales\",\n \"created_at\": \"2019-04-24 14:20:41\",\n \"date\": \"2019-04-20\",\n \"incomeid\": 2852,\n \"note\": \"Han Solo portrait\",\n \"payment_type\": \"VISA\",\n \"source\": \"Etsy\",\n \"taxes\": [\n {\n \"amount\": \"3\",\n \"name\": \"HST\"\n }\n ],\n \"updated_at\": \"2019-04-24 14:20:41\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}