Chilkat Online Tools

Swift3 / New FreshBooks / Delete Bill

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.

    // {
    //   "bill": {
    //     "vis_state": 1
    //   }
    // }

    let json = CkoJsonObject()!
    json.updateInt("bill.vis_state", value: 1)

    // 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/accounting/account/{{accountId}}/bills/bills/{{billId}}", 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": {
    //       "bill": {
    //         "amount": {
    //           "amount": "5.00",
    //           "code": "CAD"
    //         },
    //         "attachment": null,
    //         "bill_number": null,
    //         "bill_payments": [
    //         ],
    //         "created_at": "2020-10-07 21:33:27",
    //         "currency_code": "CAD",
    //         "due_date": "2020-11-06",
    //         "due_offset_days": 30,
    //         "id": 3,
    //         "issue_date": "2020-10-07",
    //         "language": "en",
    //         "lines": [
    //           {
    //             "amount": {
    //               "amount": "5.00",
    //               "code": "CAD"
    //             },
    //             "category": {
    //               "category": "Advertising",
    //               "categoryid": 65688,
    //               "created_at": "2016-11-17 14:22:35",
    //               "id": 65688,
    //               "is_cogs": true,
    //               "is_editable": false,
    //               "parentid": null,
    //               "updated_at": "2020-08-14 12:52:33",
    //               "vis_state": 0
    //             },
    //             "description": "Food",
    //             "id": 5,
    //             "list_index": 1,
    //             "quantity": "1",
    //             "tax_amount1": null,
    //             "tax_amount2": null,
    //             "tax_authorityid1": null,
    //             "tax_authorityid2": null,
    //             "tax_name1": null,
    //             "tax_name2": null,
    //             "tax_percent1": null,
    //             "tax_percent2": null,
    //             "total_amount": {
    //               "amount": "5.00",
    //               "code": "CAD"
    //             },
    //             "unit_cost": {
    //               "amount": "5.00",
    //               "code": "CAD"
    //             }
    //           },
    //           {
    //             "amount": {
    //               "amount": "0.00",
    //               "code": "CAD"
    //             },
    //             "category": {
    //               "category": "Advertising",
    //               "categoryid": 65688,
    //               "created_at": "2016-11-17 14:22:35",
    //               "id": 65688,
    //               "is_cogs": true,
    //               "is_editable": false,
    //               "parentid": null,
    //               "updated_at": "2020-08-14 12:52:33",
    //               "vis_state": 0
    //             },
    //             "description": null,
    //             "id": 7,
    //             "list_index": 2,
    //             "quantity": "1",
    //             "tax_amount1": null,
    //             "tax_amount2": null,
    //             "tax_authorityid1": null,
    //             "tax_authorityid2": null,
    //             "tax_name1": null,
    //             "tax_name2": null,
    //             "tax_percent1": null,
    //             "tax_percent2": null,
    //             "total_amount": {
    //               "amount": "0.00",
    //               "code": "CAD"
    //             },
    //             "unit_cost": {
    //               "amount": "0.00",
    //               "code": "CAD"
    //             }
    //           }
    //         ],
    //         "outstanding": {
    //           "amount": "5.00",
    //           "code": "CAD"
    //         },
    //         "overall_category": "Advertising",
    //         "overall_description": "Food",
    //         "paid": {
    //           "amount": "0.00",
    //           "code": "CAD"
    //         },
    //         "status": "unpaid",
    //         "tax_amount": {
    //           "amount": "0.00",
    //           "code": "CAD"
    //         },
    //         "total_amount": {
    //           "amount": "5.00",
    //           "code": "CAD"
    //         },
    //         "updated_at": "2020-10-09 15:41:35",
    //         "vis_state": 1
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var amountAmount: String?
    var amountCode: String?
    var Category: String?
    var Categoryid: Int
    var categoryCreated_at: String?
    var categoryId: Int
    var Is_cogs: Bool
    var Is_editable: Bool
    var Parentid: String?
    var categoryUpdated_at: String?
    var categoryVis_state: Int
    var description: String?
    var id: Int
    var list_index: Int
    var quantity: String?
    var tax_amount1: String?
    var tax_amount2: String?
    var tax_authorityid1: String?
    var tax_authorityid2: String?
    var tax_name1: String?
    var tax_name2: String?
    var tax_percent1: String?
    var tax_percent2: String?
    var total_amountAmount: String?
    var total_amountCode: String?
    var unit_costAmount: String?
    var unit_costCode: String?

    var Amount: String? = jResp.string(of: "response.result.bill.amount.amount")
    var Code: String? = jResp.string(of: "response.result.bill.amount.code")
    var Attachment: String? = jResp.string(of: "response.result.bill.attachment")
    var Bill_number: String? = jResp.string(of: "response.result.bill.bill_number")
    var Created_at: String? = jResp.string(of: "response.result.bill.created_at")
    var Currency_code: String? = jResp.string(of: "response.result.bill.currency_code")
    var Due_date: String? = jResp.string(of: "response.result.bill.due_date")
    var Due_offset_days: Int = jResp.int(of: "response.result.bill.due_offset_days").intValue
    var Id: Int = jResp.int(of: "response.result.bill.id").intValue
    var Issue_date: String? = jResp.string(of: "response.result.bill.issue_date")
    var Language: String? = jResp.string(of: "response.result.bill.language")
    var OutstandingAmount: String? = jResp.string(of: "response.result.bill.outstanding.amount")
    var OutstandingCode: String? = jResp.string(of: "response.result.bill.outstanding.code")
    var Overall_category: String? = jResp.string(of: "response.result.bill.overall_category")
    var Overall_description: String? = jResp.string(of: "response.result.bill.overall_description")
    var PaidAmount: String? = jResp.string(of: "response.result.bill.paid.amount")
    var PaidCode: String? = jResp.string(of: "response.result.bill.paid.code")
    var Status: String? = jResp.string(of: "response.result.bill.status")
    var Tax_amountAmount: String? = jResp.string(of: "response.result.bill.tax_amount.amount")
    var Tax_amountCode: String? = jResp.string(of: "response.result.bill.tax_amount.code")
    var Total_amountAmount: String? = jResp.string(of: "response.result.bill.total_amount.amount")
    var Total_amountCode: String? = jResp.string(of: "response.result.bill.total_amount.code")
    var Updated_at: String? = jResp.string(of: "response.result.bill.updated_at")
    var Vis_state: Int = jResp.int(of: "response.result.bill.vis_state").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "response.result.bill.bill_payments").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "response.result.bill.lines").intValue
    while i < count_i {
        jResp.i = i
        amountAmount = jResp.string(of: "response.result.bill.lines[i].amount.amount")
        amountCode = jResp.string(of: "response.result.bill.lines[i].amount.code")
        Category = jResp.string(of: "response.result.bill.lines[i].category.category")
        Categoryid = jResp.int(of: "response.result.bill.lines[i].category.categoryid").intValue
        categoryCreated_at = jResp.string(of: "response.result.bill.lines[i].category.created_at")
        categoryId = jResp.int(of: "response.result.bill.lines[i].category.id").intValue
        Is_cogs = jResp.bool(of: "response.result.bill.lines[i].category.is_cogs")
        Is_editable = jResp.bool(of: "response.result.bill.lines[i].category.is_editable")
        Parentid = jResp.string(of: "response.result.bill.lines[i].category.parentid")
        categoryUpdated_at = jResp.string(of: "response.result.bill.lines[i].category.updated_at")
        categoryVis_state = jResp.int(of: "response.result.bill.lines[i].category.vis_state").intValue
        description = jResp.string(of: "response.result.bill.lines[i].description")
        id = jResp.int(of: "response.result.bill.lines[i].id").intValue
        list_index = jResp.int(of: "response.result.bill.lines[i].list_index").intValue
        quantity = jResp.string(of: "response.result.bill.lines[i].quantity")
        tax_amount1 = jResp.string(of: "response.result.bill.lines[i].tax_amount1")
        tax_amount2 = jResp.string(of: "response.result.bill.lines[i].tax_amount2")
        tax_authorityid1 = jResp.string(of: "response.result.bill.lines[i].tax_authorityid1")
        tax_authorityid2 = jResp.string(of: "response.result.bill.lines[i].tax_authorityid2")
        tax_name1 = jResp.string(of: "response.result.bill.lines[i].tax_name1")
        tax_name2 = jResp.string(of: "response.result.bill.lines[i].tax_name2")
        tax_percent1 = jResp.string(of: "response.result.bill.lines[i].tax_percent1")
        tax_percent2 = jResp.string(of: "response.result.bill.lines[i].tax_percent2")
        total_amountAmount = jResp.string(of: "response.result.bill.lines[i].total_amount.amount")
        total_amountCode = jResp.string(of: "response.result.bill.lines[i].total_amount.code")
        unit_costAmount = jResp.string(of: "response.result.bill.lines[i].unit_cost.amount")
        unit_costCode = jResp.string(of: "response.result.bill.lines[i].unit_cost.code")
        i = i + 1
    }


}

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "bill": {
        "vis_state": 1
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}

Postman Collection Item JSON

{
  "name": "Delete Bill",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"bill\": {\n        \"vis_state\": 1\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "bills",
        "bills",
        "{{billId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Bill",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"bill\": {\n        \"vis_state\": 1\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "bills",
            "bills",
            "{{billId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Date",
          "value": "Fri, 09 Oct 2020 15:41:35 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfEVwBC1wOGk4IFAQcAFEJUQRSA1pVAwZTUlYJAgdIVVQbEwRfUAMGBgRUWlAIUwBQXAAWHlUEVRJUPA=="
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "X-Content-Security-Policy",
          "value": "default-src 'self'"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31556926; includeSubDomains; preload"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin-when-cross-origin"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "600"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "599"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1602258156"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Alt-Svc",
          "value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"bill\": {\n                \"amount\": {\n                    \"amount\": \"5.00\",\n                    \"code\": \"CAD\"\n                },\n                \"attachment\": null,\n                \"bill_number\": null,\n                \"bill_payments\": [],\n                \"created_at\": \"2020-10-07 21:33:27\",\n                \"currency_code\": \"CAD\",\n                \"due_date\": \"2020-11-06\",\n                \"due_offset_days\": 30,\n                \"id\": 3,\n                \"issue_date\": \"2020-10-07\",\n                \"language\": \"en\",\n                \"lines\": [\n                    {\n                        \"amount\": {\n                            \"amount\": \"5.00\",\n                            \"code\": \"CAD\"\n                        },\n                        \"category\": {\n                            \"category\": \"Advertising\",\n                            \"categoryid\": 65688,\n                            \"created_at\": \"2016-11-17 14:22:35\",\n                            \"id\": 65688,\n                            \"is_cogs\": true,\n                            \"is_editable\": false,\n                            \"parentid\": null,\n                            \"updated_at\": \"2020-08-14 12:52:33\",\n                            \"vis_state\": 0\n                        },\n                        \"description\": \"Food\",\n                        \"id\": 5,\n                        \"list_index\": 1,\n                        \"quantity\": \"1\",\n                        \"tax_amount1\": null,\n                        \"tax_amount2\": null,\n                        \"tax_authorityid1\": null,\n                        \"tax_authorityid2\": null,\n                        \"tax_name1\": null,\n                        \"tax_name2\": null,\n                        \"tax_percent1\": null,\n                        \"tax_percent2\": null,\n                        \"total_amount\": {\n                            \"amount\": \"5.00\",\n                            \"code\": \"CAD\"\n                        },\n                        \"unit_cost\": {\n                            \"amount\": \"5.00\",\n                            \"code\": \"CAD\"\n                        }\n                    },\n                    {\n                        \"amount\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"CAD\"\n                        },\n                        \"category\": {\n                            \"category\": \"Advertising\",\n                            \"categoryid\": 65688,\n                            \"created_at\": \"2016-11-17 14:22:35\",\n                            \"id\": 65688,\n                            \"is_cogs\": true,\n                            \"is_editable\": false,\n                            \"parentid\": null,\n                            \"updated_at\": \"2020-08-14 12:52:33\",\n                            \"vis_state\": 0\n                        },\n                        \"description\": null,\n                        \"id\": 7,\n                        \"list_index\": 2,\n                        \"quantity\": \"1\",\n                        \"tax_amount1\": null,\n                        \"tax_amount2\": null,\n                        \"tax_authorityid1\": null,\n                        \"tax_authorityid2\": null,\n                        \"tax_name1\": null,\n                        \"tax_name2\": null,\n                        \"tax_percent1\": null,\n                        \"tax_percent2\": null,\n                        \"total_amount\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"CAD\"\n                        },\n                        \"unit_cost\": {\n                            \"amount\": \"0.00\",\n                            \"code\": \"CAD\"\n                        }\n                    }\n                ],\n                \"outstanding\": {\n                    \"amount\": \"5.00\",\n                    \"code\": \"CAD\"\n                },\n                \"overall_category\": \"Advertising\",\n                \"overall_description\": \"Food\",\n                \"paid\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"CAD\"\n                },\n                \"status\": \"unpaid\",\n                \"tax_amount\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"CAD\"\n                },\n                \"total_amount\": {\n                    \"amount\": \"5.00\",\n                    \"code\": \"CAD\"\n                },\n                \"updated_at\": \"2020-10-09 15:41:35\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}