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.
// {
// "estimate": {
// "vis_state": 1
// }
// }
let json = CkoJsonObject()
json.UpdateInt("estimate.vis_state", value: 1)
// 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}}/estimates/estimates/{{estimateId}}", 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": {
// "estimate": {
// "accepted": false,
// "accounting_systemid": "wkMd2g",
// "address": "",
// "amount": {
// "amount": "17628.00",
// "code": "USD"
// },
// "city": "",
// "code": "",
// "country": "Canada",
// "create_date": "2019-04-18",
// "created_at": "2019-04-18 09:42:52",
// "currency_code": "USD",
// "current_organization": "first company",
// "customerid": 31006,
// "description": "it's a computer hardware version 1",
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "display_status": "draft",
// "estimate_number": "0000001",
// "estimateid": 1706,
// "ext_archive": 0,
// "fname": "Client",
// "id": 1706,
// "invoiced": false,
// "language": "en",
// "lname": "one",
// "notes": "This is an estimate for the computer",
// "organization": "first company",
// "ownerid": 1,
// "po_number": null,
// "province": "",
// "reply_status": null,
// "require_client_signature": false,
// "rich_proposal": false,
// "sentid": 1,
// "status": 1,
// "street": "",
// "street2": "",
// "template": "clean-grouped",
// "terms": "50% deposit upon acceptance, 50% on delivery of the computers.",
// "ui_status": "draft",
// "updated": "2019-04-24 14:01:21",
// "vat_name": null,
// "vat_number": "",
// "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 Accepted: Bool = jResp.BoolOf("response.result.estimate.accepted")
var Accounting_systemid: String? = jResp.StringOf("response.result.estimate.accounting_systemid")
var Address: String? = jResp.StringOf("response.result.estimate.address")
var Amount: String? = jResp.StringOf("response.result.estimate.amount.amount")
var Code: String? = jResp.StringOf("response.result.estimate.amount.code")
var City: String? = jResp.StringOf("response.result.estimate.city")
var EstimateCode: String? = jResp.StringOf("response.result.estimate.code")
var Country: String? = jResp.StringOf("response.result.estimate.country")
var Create_date: String? = jResp.StringOf("response.result.estimate.create_date")
var Created_at: String? = jResp.StringOf("response.result.estimate.created_at")
var Currency_code: String? = jResp.StringOf("response.result.estimate.currency_code")
var Current_organization: String? = jResp.StringOf("response.result.estimate.current_organization")
var Customerid: Int = jResp.IntOf("response.result.estimate.customerid").intValue
var Description: String? = jResp.StringOf("response.result.estimate.description")
var Discount_totalAmount: String? = jResp.StringOf("response.result.estimate.discount_total.amount")
var Discount_totalCode: String? = jResp.StringOf("response.result.estimate.discount_total.code")
var Discount_value: String? = jResp.StringOf("response.result.estimate.discount_value")
var Display_status: String? = jResp.StringOf("response.result.estimate.display_status")
var Estimate_number: String? = jResp.StringOf("response.result.estimate.estimate_number")
var Estimateid: Int = jResp.IntOf("response.result.estimate.estimateid").intValue
var Ext_archive: Int = jResp.IntOf("response.result.estimate.ext_archive").intValue
var Fname: String? = jResp.StringOf("response.result.estimate.fname")
var Id: Int = jResp.IntOf("response.result.estimate.id").intValue
var Invoiced: Bool = jResp.BoolOf("response.result.estimate.invoiced")
var Language: String? = jResp.StringOf("response.result.estimate.language")
var Lname: String? = jResp.StringOf("response.result.estimate.lname")
var Notes: String? = jResp.StringOf("response.result.estimate.notes")
var Organization: String? = jResp.StringOf("response.result.estimate.organization")
var Ownerid: Int = jResp.IntOf("response.result.estimate.ownerid").intValue
var Po_number: String? = jResp.StringOf("response.result.estimate.po_number")
var Province: String? = jResp.StringOf("response.result.estimate.province")
var Reply_status: String? = jResp.StringOf("response.result.estimate.reply_status")
var Require_client_signature: Bool = jResp.BoolOf("response.result.estimate.require_client_signature")
var Rich_proposal: Bool = jResp.BoolOf("response.result.estimate.rich_proposal")
var Sentid: Int = jResp.IntOf("response.result.estimate.sentid").intValue
var Status: Int = jResp.IntOf("response.result.estimate.status").intValue
var Street: String? = jResp.StringOf("response.result.estimate.street")
var Street2: String? = jResp.StringOf("response.result.estimate.street2")
var Template: String? = jResp.StringOf("response.result.estimate.template")
var Terms: String? = jResp.StringOf("response.result.estimate.terms")
var Ui_status: String? = jResp.StringOf("response.result.estimate.ui_status")
var Updated: String? = jResp.StringOf("response.result.estimate.updated")
var Vat_name: String? = jResp.StringOf("response.result.estimate.vat_name")
var Vat_number: String? = jResp.StringOf("response.result.estimate.vat_number")
var Vis_state: Int = jResp.IntOf("response.result.estimate.vis_state").intValue
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"estimate": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}
Postman Collection Item JSON
{
"name": "Delete Estimate",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"vis_state\": 1\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"response": [
{
"name": "Delete Estimate",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"estimate\": {\n \"vis_state\": 1\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/estimates/estimates/{{estimateId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"estimates",
"estimates",
"{{estimateId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gBQkJaDwcXB0NYXRFMUVlTRwAbTQFNA0xVBgFYVlQLBQdTUVQFCA9eVx0CAU5EWgQJWwlVCAkMUwZWXFkAWRFOAldbEgM+"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:01:21 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, 24 Apr 2019 18:01:21 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-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 \"estimate\": {\n \"accepted\": false,\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"amount\": {\n \"amount\": \"17628.00\",\n \"code\": \"USD\"\n },\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"create_date\": \"2019-04-18\",\n \"created_at\": \"2019-04-18 09:42:52\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"first company\",\n \"customerid\": 31006,\n \"description\": \"it's a computer hardware version 1\",\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"estimate_number\": \"0000001\",\n \"estimateid\": 1706,\n \"ext_archive\": 0,\n \"fname\": \"Client\",\n \"id\": 1706,\n \"invoiced\": false,\n \"language\": \"en\",\n \"lname\": \"one\",\n \"notes\": \"This is an estimate for the computer\",\n \"organization\": \"first company\",\n \"ownerid\": 1,\n \"po_number\": null,\n \"province\": \"\",\n \"reply_status\": null,\n \"require_client_signature\": false,\n \"rich_proposal\": false,\n \"sentid\": 1,\n \"status\": 1,\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"50% deposit upon acceptance, 50% on delivery of the computers.\",\n \"ui_status\": \"draft\",\n \"updated\": \"2019-04-24 14:01:21\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
