Chilkat Online Tools

Swift3 / New FreshBooks / Update Expense

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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"
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("expense.vendor", value: "WestJet")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/expenses/{{expenseId}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var Account_name: String? = jResp.string(of: "response.result.expense.account_name")
    var Accountid: String? = jResp.string(of: "response.result.expense.accountid")
    var Accounting_systemid: String? = jResp.string(of: "response.result.expense.accounting_systemid")
    var Amount: String? = jResp.string(of: "response.result.expense.amount.amount")
    var Code: String? = jResp.string(of: "response.result.expense.amount.code")
    var Background_jobid: String? = jResp.string(of: "response.result.expense.background_jobid")
    var Bank_name: String? = jResp.string(of: "response.result.expense.bank_name")
    var Categoryid: Int = jResp.int(of: "response.result.expense.categoryid").intValue
    var Clientid: Int = jResp.int(of: "response.result.expense.clientid").intValue
    var Compounded_tax: Bool = jResp.bool(of: "response.result.expense.compounded_tax")
    var Date: String? = jResp.string(of: "response.result.expense.date")
    var Expenseid: Int = jResp.int(of: "response.result.expense.expenseid").intValue
    var Ext_invoiceid: Int = jResp.int(of: "response.result.expense.ext_invoiceid").intValue
    var Ext_systemid: Int = jResp.int(of: "response.result.expense.ext_systemid").intValue
    var From_bulk_import: Bool = jResp.bool(of: "response.result.expense.from_bulk_import")
    var Has_receipt: Bool = jResp.bool(of: "response.result.expense.has_receipt")
    var Id: Int = jResp.int(of: "response.result.expense.id").intValue
    var Include_receipt: Bool = jResp.bool(of: "response.result.expense.include_receipt")
    var Invoiceid: String? = jResp.string(of: "response.result.expense.invoiceid")
    var Is_cogs: Bool = jResp.bool(of: "response.result.expense.is_cogs")
    var Isduplicate: Bool = jResp.bool(of: "response.result.expense.isduplicate")
    var Markup_percent: String? = jResp.string(of: "response.result.expense.markup_percent")
    var Notes: String? = jResp.string(of: "response.result.expense.notes")
    var Profileid: String? = jResp.string(of: "response.result.expense.profileid")
    var Projectid: Int = jResp.int(of: "response.result.expense.projectid").intValue
    var Staffid: Int = jResp.int(of: "response.result.expense.staffid").intValue
    var Status: Int = jResp.int(of: "response.result.expense.status").intValue
    var TaxAmount1Amount: String? = jResp.string(of: "response.result.expense.taxAmount1.amount")
    var TaxAmount1Code: String? = jResp.string(of: "response.result.expense.taxAmount1.code")
    var TaxAmount2: String? = jResp.string(of: "response.result.expense.taxAmount2")
    var TaxName1: String? = jResp.string(of: "response.result.expense.taxName1")
    var TaxName2: String? = jResp.string(of: "response.result.expense.taxName2")
    var TaxPercent1: String? = jResp.string(of: "response.result.expense.taxPercent1")
    var TaxPercent2: String? = jResp.string(of: "response.result.expense.taxPercent2")
    var Transactionid: String? = jResp.string(of: "response.result.expense.transactionid")
    var Updated: String? = jResp.string(of: "response.result.expense.updated")
    var Vendor: String? = jResp.string(of: "response.result.expense.vendor")
    var Vis_state: Int = jResp.int(of: "response.result.expense.vis_state").intValue

}

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}"
    }
  ]
}