Chilkat Online Tools

Swift / New FreshBooks / Update Checkout Link

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.

    // {
    //   "item_id": "147778",
    //   "amount": "100",
    //   "currency": "CAD",
    //   "note": "Thank you for your Business",
    //   "is_active": false,
    //   "send_admin_receipt": true,
    //   "taxes": [
    //     {
    //       "name": "HST",
    //       "amount": 13
    //     }
    //   ],
    //   "item_name": "The Best Doorknob"
    // }

    let json = CkoJsonObject()
    json.UpdateString("item_id", value: "147778")
    json.UpdateString("amount", value: "100")
    json.UpdateString("currency", value: "CAD")
    json.UpdateString("note", value: "Thank you for your Business")
    json.UpdateBool("is_active", value: false)
    json.UpdateBool("send_admin_receipt", value: true)
    json.UpdateString("taxes[0].name", value: "HST")
    json.UpdateInt("taxes[0].amount", value: 13)
    json.UpdateString("item_name", value: "The Best Doorknob")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "item_id": "147778",
    "amount": "100",
    "currency": "CAD",
    "note": "Thank you for your Business",
    "is_active": false,
    "send_admin_receipt": true,
    "taxes": [{"name":"HST","amount":13}],
    "item_name": "The Best Doorknob"
}'
https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}

Postman Collection Item JSON

{
  "name": "Update Checkout Link",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"item_id\": \"147778\",\n    \"amount\": \"100\",\n    \"currency\": \"CAD\",\n    \"note\": \"Thank you for your Business\",\n    \"is_active\": false,\n    \"send_admin_receipt\": true,\n    \"taxes\": [{\"name\":\"HST\",\"amount\":13}],\n    \"item_name\": \"The Best Doorknob\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "payments",
        "account",
        "{{accountid}}",
        "checkout-links",
        "{{checkoutlinkid}}"
      ]
    }
  },
  "response": [
  ]
}