Chilkat Online Tools

Ruby / New FreshBooks / Update Expense

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": {
#     "vendor": "WestJet"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("expense.vendor","WestJet")

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}",sbRequestBody,"utf-8","application/json",false,false)
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"
#         },
#         "background_jobid": null,
#         "bank_name": "",
#         "categoryid": 2003174,
#         "clientid": 0,
#         "compounded_tax": false,
#         "date": "2019-04-24",
#         "expenseid": 1825568,
#         "ext_invoiceid": 0,
#         "ext_systemid": 0,
#         "from_bulk_import": false,
#         "has_receipt": true,
#         "id": 1825568,
#         "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-05-08 16:03:24",
#         "vendor": "WestJet",
#         "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")
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")
Id = 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 PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "expense": {
    "vendor": "WestJet"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}

Postman Collection Item JSON

{
  "name": "Update Expense",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"expense\": {\n    \"vendor\": \"WestJet\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "expenses",
        "expenses",
        "{{expenseId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Update Expense",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"expense\": {\n    \"vendor\": \"WestJet\"\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "expenses",
            "expenses",
            "{{expenseId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoHQBJdVkdXEUkJTQFPAVRRDwZYUFsNAAZXVlQOBARKUAcaEVJWUAEHUwtUXl0GUAdSCAcTTVUDCEVSPA=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557345847"
        },
        {
          "key": "Retry-After",
          "value": "42"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:03:24 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, 08 May 2019 20:03:24 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-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            \"expense\": {\n                \"account_name\": \"\",\n                \"accountid\": null,\n                \"accounting_systemid\": \"wkMd2g\",\n                \"amount\": {\n                    \"amount\": \"79.73\",\n                    \"code\": \"USD\"\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\": 1825568,\n                \"ext_invoiceid\": 0,\n                \"ext_systemid\": 0,\n                \"from_bulk_import\": false,\n                \"has_receipt\": true,\n                \"id\": 1825568,\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-05-08 16:03:24\",\n                \"vendor\": \"WestJet\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}