Chilkat Online Tools

Swift3 / New FreshBooks / Create Custom Expense Category

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.

    // {
    //   "category": {
    //     "category": "catstuff2",
    //     "is_cogs": false,
    //     "is_editable": true,
    //     "parentid": 123,
    //     "subcategories": [
    //     ]
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("category.category", value: "catstuff2")
    json.updateBool("category.is_cogs", value: false)
    json.updateBool("category.is_editable", value: true)
    json.updateInt("category.parentid", value: 123)
    json.updateNewArray("category.subcategories")

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

    var resp: CkoHttpResponse? = http.postJson3("https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories", contentType: "application/json", json: json)
    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": {
    //       "category": {
    //         "category": "catstuff",
    //         "categoryid": 5503992,
    //         "created_at": "2019-05-17 09:23:19",
    //         "id": 5503992,
    //         "is_cogs": false,
    //         "is_editable": true,
    //         "parentid": 2003142,
    //         "updated_at": "2019-05-17 09:23:19",
    //         "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 Category: String? = jResp.string(of: "response.result.category.category")
    var Categoryid: Int = jResp.int(of: "response.result.category.categoryid").intValue
    var Created_at: String? = jResp.string(of: "response.result.category.created_at")
    var Id: Int = jResp.int(of: "response.result.category.id").intValue
    var Is_cogs: Bool = jResp.bool(of: "response.result.category.is_cogs")
    var Is_editable: Bool = jResp.bool(of: "response.result.category.is_editable")
    var Parentid: Int = jResp.int(of: "response.result.category.parentid").intValue
    var Updated_at: String? = jResp.string(of: "response.result.category.updated_at")
    var Vis_state: Int = jResp.int(of: "response.result.category.vis_state").intValue

}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "category": {
        "category": "catstuff2",
        "is_cogs": false,
        "is_editable": true,
        "parentid": {{parentCategoryId}},
        "subcategories": []
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories

Postman Collection Item JSON

{
  "name": "Create Custom Expense Category",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"category\": {\n        \"category\": \"catstuff2\",\n        \"is_cogs\": false,\n        \"is_editable\": true,\n        \"parentid\": {{parentCategoryId}},\n        \"subcategories\": []\n    }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "expenses",
        "categories"
      ]
    },
    "description": "Custome expense categories require a parent category ID. Please make a call to list expense categories to find the parent ID you'd like."
  },
  "response": [
    {
      "name": "Create Custom Expense Category",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"category\": {\n        \"category\": \"catstuff2\",\n        \"is_cogs\": false,\n        \"is_editable\": true,\n        \"parentid\": {{parentCategoryId}},\n        \"subcategories\": []\n    }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/expenses/categories",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "expenses",
            "categories"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBSUZWDBUGEQoBWRZdX1tAWgBKQx1RH1JKBg5XUFoJBQBcVVAPCAJTVAkaAlVUT0BSUwkADltXBQoEDwdQUlVVRhpRAAoQXW4="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1558099457"
        },
        {
          "key": "Retry-After",
          "value": "57"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Thu, 17 May 2018 13:23:19 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": "Fri, 17 May 2019 13:23:19 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17335-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            \"category\": {\n                \"category\": \"catstuff\",\n                \"categoryid\": 5503992,\n                \"created_at\": \"2019-05-17 09:23:19\",\n                \"id\": 5503992,\n                \"is_cogs\": false,\n                \"is_editable\": true,\n                \"parentid\": 2003142,\n                \"updated_at\": \"2019-05-17 09:23:19\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}