Ruby / New FreshBooks / Create Single Other Income
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.
# {
# "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"
# }
# ]
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("other_income.amount.amount","113.00")
json.UpdateString("other_income.amount.code","USD")
json.UpdateString("other_income.category_name","online_sales")
json.UpdateString("other_income.date","2019-04-20")
json.UpdateString("other_income.note","Han Solo portrait")
json.UpdateString("other_income.payment_type","Visa")
json.UpdateString("other_income.source","Etsy")
json.UpdateString("other_income.taxes[0].amount","3")
json.UpdateString("other_income.taxes[0].name","HST")
# 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}}/other_incomes/other_incomes","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": {
# "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
Amount = jResp.stringOf("response.result.other_income.amount.amount")
Code = jResp.stringOf("response.result.other_income.amount.code")
Category_name = jResp.stringOf("response.result.other_income.category_name")
Created_at = jResp.stringOf("response.result.other_income.created_at")
Date = jResp.stringOf("response.result.other_income.date")
Incomeid = jResp.IntOf("response.result.other_income.incomeid")
Note = jResp.stringOf("response.result.other_income.note")
Payment_type = jResp.stringOf("response.result.other_income.payment_type")
Source = jResp.stringOf("response.result.other_income.source")
Updated_at = jResp.stringOf("response.result.other_income.updated_at")
Vis_state = jResp.IntOf("response.result.other_income.vis_state")
i = 0
count_i = jResp.SizeOfArray("response.result.other_income.taxes")
while i < count_i
jResp.put_I(i)
amount = jResp.stringOf("response.result.other_income.taxes[i].amount")
name = jResp.stringOf("response.result.other_income.taxes[i].name")
i = i + 1
end
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}"
}
]
}
