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.
# {
# "expense": {
# "transactionid": null,
# "status": null,
# "has_receipt": false,
# "always_remember": false,
# "is_cogs": true,
# "account_name": null,
# "include_receipt": false,
# "amount": {
# "amount": "79.73",
# "code": "USD"
# },
# "notes": "Purchased Gasoline for deliveries",
# "vendor": "Shell Gas Station",
# "date": "2019-04-24",
# "staffid": 1,
# "author_name": null,
# "taxName1": "other tax",
# "taxName2": null,
# "taxAmount1": {
# "amount": "9.17",
# "code": "USD"
# },
# "taxPercent1": 13,
# "taxPercent2": null,
# "markup_percent": 20,
# "invoiceid": null,
# "attachment": {
# "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
# "media_type": "image/png",
# "expenseid": null
# },
# "categoryid": "65679",
# "category_name": "",
# "clientid": 485558,
# "converse_projectid": 12345
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateNull("expense.transactionid")
json.UpdateNull("expense.status")
json.UpdateBool("expense.has_receipt",false)
json.UpdateBool("expense.always_remember",false)
json.UpdateBool("expense.is_cogs",true)
json.UpdateNull("expense.account_name")
json.UpdateBool("expense.include_receipt",false)
json.UpdateString("expense.amount.amount","79.73")
json.UpdateString("expense.amount.code","USD")
json.UpdateString("expense.notes","Purchased Gasoline for deliveries")
json.UpdateString("expense.vendor","Shell Gas Station")
json.UpdateString("expense.date","2019-04-24")
json.UpdateInt("expense.staffid",1)
json.UpdateNull("expense.author_name")
json.UpdateString("expense.taxName1","other tax")
json.UpdateNull("expense.taxName2")
json.UpdateString("expense.taxAmount1.amount","9.17")
json.UpdateString("expense.taxAmount1.code","USD")
json.UpdateInt("expense.taxPercent1",13)
json.UpdateNull("expense.taxPercent2")
json.UpdateInt("expense.markup_percent",20)
json.UpdateNull("expense.invoiceid")
json.UpdateString("expense.attachment.jwt","eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA")
json.UpdateString("expense.attachment.media_type","image/png")
json.UpdateNull("expense.attachment.expenseid")
json.UpdateString("expense.categoryid","65679")
json.UpdateString("expense.category_name","")
json.UpdateInt("expense.clientid",485558)
json.UpdateInt("expense.converse_projectid",12345)
# 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}}/expenses/expenses?include%5B%5D=attachment","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": {
# "expense": {
# "account_name": "",
# "accountid": null,
# "accounting_systemid": "wkMd2g",
# "amount": {
# "amount": "79.73",
# "code": "USD"
# },
# "attachment": {
# "attachmentid": 8670,
# "id": 8670,
# "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
# "media_type": "image/png"
# },
# "background_jobid": null,
# "bank_name": "",
# "categoryid": 2003174,
# "clientid": 0,
# "compounded_tax": false,
# "date": "2019-04-24",
# "expenseid": 1825574,
# "ext_invoiceid": 0,
# "ext_systemid": 0,
# "from_bulk_import": false,
# "has_receipt": true,
# "id": 1825574,
# "include_receipt": false,
# "invoiceid": null,
# "is_cogs": false,
# "isduplicate": true,
# "markup_percent": "0",
# "notes": "Purchased Gasoline for deliveries",
# "profileid": null,
# "projectid": 0,
# "staffid": 1,
# "status": 0,
# "taxAmount1": {
# "amount": "9.17",
# "code": "USD"
# },
# "taxAmount2": null,
# "taxName1": "other tax",
# "taxName2": null,
# "taxPercent1": "13",
# "taxPercent2": null,
# "transactionid": null,
# "updated": "2019-04-24 11:33:35",
# "vendor": "Shell Gas Station",
# "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
Account_name = jResp.stringOf("response.result.expense.account_name")
Accountid = jResp.stringOf("response.result.expense.accountid")
Accounting_systemid = jResp.stringOf("response.result.expense.accounting_systemid")
Amount = jResp.stringOf("response.result.expense.amount.amount")
Code = jResp.stringOf("response.result.expense.amount.code")
Attachmentid = jResp.IntOf("response.result.expense.attachment.attachmentid")
Id = jResp.IntOf("response.result.expense.attachment.id")
v_Jwt = jResp.stringOf("response.result.expense.attachment.jwt")
Media_type = jResp.stringOf("response.result.expense.attachment.media_type")
Background_jobid = jResp.stringOf("response.result.expense.background_jobid")
Bank_name = jResp.stringOf("response.result.expense.bank_name")
Categoryid = jResp.IntOf("response.result.expense.categoryid")
Clientid = jResp.IntOf("response.result.expense.clientid")
Compounded_tax = jResp.BoolOf("response.result.expense.compounded_tax")
Date = jResp.stringOf("response.result.expense.date")
Expenseid = jResp.IntOf("response.result.expense.expenseid")
Ext_invoiceid = jResp.IntOf("response.result.expense.ext_invoiceid")
Ext_systemid = jResp.IntOf("response.result.expense.ext_systemid")
From_bulk_import = jResp.BoolOf("response.result.expense.from_bulk_import")
Has_receipt = jResp.BoolOf("response.result.expense.has_receipt")
ExpenseId = jResp.IntOf("response.result.expense.id")
Include_receipt = jResp.BoolOf("response.result.expense.include_receipt")
Invoiceid = jResp.stringOf("response.result.expense.invoiceid")
Is_cogs = jResp.BoolOf("response.result.expense.is_cogs")
Isduplicate = jResp.BoolOf("response.result.expense.isduplicate")
Markup_percent = jResp.stringOf("response.result.expense.markup_percent")
Notes = jResp.stringOf("response.result.expense.notes")
Profileid = jResp.stringOf("response.result.expense.profileid")
Projectid = jResp.IntOf("response.result.expense.projectid")
Staffid = jResp.IntOf("response.result.expense.staffid")
Status = jResp.IntOf("response.result.expense.status")
TaxAmount1Amount = jResp.stringOf("response.result.expense.taxAmount1.amount")
TaxAmount1Code = jResp.stringOf("response.result.expense.taxAmount1.code")
TaxAmount2 = jResp.stringOf("response.result.expense.taxAmount2")
TaxName1 = jResp.stringOf("response.result.expense.taxName1")
TaxName2 = jResp.stringOf("response.result.expense.taxName2")
TaxPercent1 = jResp.stringOf("response.result.expense.taxPercent1")
TaxPercent2 = jResp.stringOf("response.result.expense.taxPercent2")
Transactionid = jResp.stringOf("response.result.expense.transactionid")
Updated = jResp.stringOf("response.result.expense.updated")
Vendor = jResp.stringOf("response.result.expense.vendor")
Vis_state = jResp.IntOf("response.result.expense.vis_state")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"expense": {
"transactionid": null,
"status": null,
"has_receipt": false,
"always_remember": false,
"is_cogs": true,
"account_name": null,
"include_receipt": false,
"amount": {
"amount": "79.73",
"code": "USD"
},
"notes": "Purchased Gasoline for deliveries",
"vendor": "Shell Gas Station",
"date": "2019-04-24",
"staffid": 1,
"author_name": null,
"taxName1": "other tax",
"taxName2": null,
"taxAmount1": {
"amount": "9.17",
"code": "USD"
},
"taxPercent1": 13,
"taxPercent2": null,
"markup_percent": 20,
"invoiceid": null,
"attachment": {
"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA",
"media_type": "image/png",
"expenseid": null
},
"categoryid": "65679",
"category_name": "",
"clientid": 485558,
"converse_projectid": 12345
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment
Postman Collection Item JSON
{
"name": "Create Expense",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"expenseId\", jsonData.response.result.expense.id);",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"transactionid\": null,\n \"status\": null,\n \"has_receipt\": false,\n \"always_remember\": false,\n \"is_cogs\": true,\n \"account_name\": null,\n \"include_receipt\": false,\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"vendor\": \"Shell Gas Station\",\n \"date\": \"2019-04-24\",\n \"staffid\": 1,\n \"author_name\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxPercent1\": 13,\n \"taxPercent2\": null,\n \"markup_percent\": 20,\n \"invoiceid\": null,\n \"attachment\": {\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\",\n \"expenseid\": null\n },\n \"categoryid\": \"65679\",\n \"category_name\": \"\",\n \"clientid\": 485558,\n \"converse_projectid\": 12345\t\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses"
],
"query": [
{
"key": "include%5B%5D",
"value": "attachment"
}
]
},
"description": "Category can be passed as categoryid or category_name, both as string values."
},
"response": [
{
"name": "Create Expense",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"expense\": {\n \"transactionid\": null,\n \"status\": null,\n \"has_receipt\": false,\n \"always_remember\": false,\n \"is_cogs\": false,\n \"account_name\": null,\n \"include_receipt\": false,\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"vendor\": \"Shell Gas Station\",\n \"date\": \"2019-04-24\",\n \"staffid\": 1,\n \"author_name\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxPercent1\": 13,\n \"taxPercent2\": null,\n \"markup_percent\": null,\n \"invoiceid\": null,\n \"attachment\": {\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\",\n \"expenseid\": null\n },\n \"categoryid\": \"2003174\",\n \"clientid\": null\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses?include%5B%5D=attachment",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"expenses",
"expenses"
],
"query": [
{
"key": "include%5B%5D",
"value": "attachment"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoHQBJdVkdXQEcVUR1RHVBVBQBZU1UMCwNQVFsDBgVRSAAFBVBKQVFWUwEACAkBCgJcCFQBAAtASFBWDRUGZQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 15:33:35 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 15:33:35 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-jfk8129-JFK"
},
{
"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 \"expense\": {\n \"account_name\": \"\",\n \"accountid\": null,\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": {\n \"amount\": \"79.73\",\n \"code\": \"USD\"\n },\n \"attachment\": {\n \"attachmentid\": 8670,\n \"id\": 8670,\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50Ijo0MjM2NDEwLCJvcmlnaW5hbF9maWxlbmFtZSI6IlNjcmVlbiBTaG90IDIwMTktMDQtMjQgYXQgOS4zOS4xOSBBTS5wbmciLCJidWNrZXQiOiJ1cGxvYWRzIiwiZmlsZW5hbWUiOiJ1cGxvYWQtMGU2ZDMwOWQ1ZTI5MzA3NmNhMGIyNDdkODFlOGJlNWE4NDZlZWE0YSIsImxlbmd0aCI6MTkxNDcyLCJrZXkiOiInZG9jcy0nLTQyMzY0MTAvdXBsb2FkLTBlNmQzMDlkNWUyOTMwNzZjYTBiMjQ3ZDgxZThiZTVhODQ2ZWVhNGEifQ.SOoW3_nTUrxjYO76g1UXHPIrO_aLbTpXCHEa-ZcnejA\",\n \"media_type\": \"image/png\"\n },\n \"background_jobid\": null,\n \"bank_name\": \"\",\n \"categoryid\": 2003174,\n \"clientid\": 0,\n \"compounded_tax\": false,\n \"date\": \"2019-04-24\",\n \"expenseid\": 1825574,\n \"ext_invoiceid\": 0,\n \"ext_systemid\": 0,\n \"from_bulk_import\": false,\n \"has_receipt\": true,\n \"id\": 1825574,\n \"include_receipt\": false,\n \"invoiceid\": null,\n \"is_cogs\": false,\n \"isduplicate\": true,\n \"markup_percent\": \"0\",\n \"notes\": \"Purchased Gasoline for deliveries\",\n \"profileid\": null,\n \"projectid\": 0,\n \"staffid\": 1,\n \"status\": 0,\n \"taxAmount1\": {\n \"amount\": \"9.17\",\n \"code\": \"USD\"\n },\n \"taxAmount2\": null,\n \"taxName1\": \"other tax\",\n \"taxName2\": null,\n \"taxPercent1\": \"13\",\n \"taxPercent2\": null,\n \"transactionid\": null,\n \"updated\": \"2019-04-24 11:33:35\",\n \"vendor\": \"Shell Gas Station\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
