Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(json,"bill.vis_state",1)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
amountAmount.s
amountCode.s
Category.s
Categoryid.i
categoryCreated_at.s
categoryId.i
Is_cogs.i
Is_editable.i
Parentid.s
categoryUpdated_at.s
categoryVis_state.i
description.s
id.i
list_index.i
quantity.s
tax_amount1.s
tax_amount2.s
tax_authorityid1.s
tax_authorityid2.s
tax_name1.s
tax_name2.s
tax_percent1.s
tax_percent2.s
total_amountAmount.s
total_amountCode.s
unit_costAmount.s
unit_costCode.s
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.amount.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.amount.code")
Attachment.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.attachment")
Bill_number.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.bill_number")
Created_at.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.created_at")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.currency_code")
Due_date.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.due_date")
Due_offset_days.i = CkJsonObject::ckIntOf(jResp,"response.result.bill.due_offset_days")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.bill.id")
Issue_date.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.issue_date")
Language.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.language")
OutstandingAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.outstanding.amount")
OutstandingCode.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.outstanding.code")
Overall_category.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.overall_category")
Overall_description.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.overall_description")
PaidAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.paid.amount")
PaidCode.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.paid.code")
Status.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.status")
Tax_amountAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.tax_amount.amount")
Tax_amountCode.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.tax_amount.code")
Total_amountAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.total_amount.amount")
Total_amountCode.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.total_amount.code")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"response.result.bill.updated_at")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.bill.vis_state")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"response.result.bill.bill_payments")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"response.result.bill.lines")
While i < count_i
CkJsonObject::setCkI(jResp, i)
amountAmount = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].amount.amount")
amountCode = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].amount.code")
Category = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].category.category")
Categoryid = CkJsonObject::ckIntOf(jResp,"response.result.bill.lines[i].category.categoryid")
categoryCreated_at = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].category.created_at")
categoryId = CkJsonObject::ckIntOf(jResp,"response.result.bill.lines[i].category.id")
Is_cogs = CkJsonObject::ckBoolOf(jResp,"response.result.bill.lines[i].category.is_cogs")
Is_editable = CkJsonObject::ckBoolOf(jResp,"response.result.bill.lines[i].category.is_editable")
Parentid = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].category.parentid")
categoryUpdated_at = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].category.updated_at")
categoryVis_state = CkJsonObject::ckIntOf(jResp,"response.result.bill.lines[i].category.vis_state")
description = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].description")
id = CkJsonObject::ckIntOf(jResp,"response.result.bill.lines[i].id")
list_index = CkJsonObject::ckIntOf(jResp,"response.result.bill.lines[i].list_index")
quantity = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].quantity")
tax_amount1 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_amount1")
tax_amount2 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_amount2")
tax_authorityid1 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_authorityid1")
tax_authorityid2 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_authorityid2")
tax_name1 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_name1")
tax_name2 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_name2")
tax_percent1 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_percent1")
tax_percent2 = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].tax_percent2")
total_amountAmount = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].total_amount.amount")
total_amountCode = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].total_amount.code")
unit_costAmount = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].unit_cost.amount")
unit_costCode = CkJsonObject::ckStringOf(jResp,"response.result.bill.lines[i].unit_cost.code")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
