Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateInt $json "bill.vis_state" 1
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set Amount [CkJsonObject_stringOf $jResp "response.result.bill.amount.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.bill.amount.code"]
set Attachment [CkJsonObject_stringOf $jResp "response.result.bill.attachment"]
set Bill_number [CkJsonObject_stringOf $jResp "response.result.bill.bill_number"]
set Created_at [CkJsonObject_stringOf $jResp "response.result.bill.created_at"]
set Currency_code [CkJsonObject_stringOf $jResp "response.result.bill.currency_code"]
set Due_date [CkJsonObject_stringOf $jResp "response.result.bill.due_date"]
set Due_offset_days [CkJsonObject_IntOf $jResp "response.result.bill.due_offset_days"]
set Id [CkJsonObject_IntOf $jResp "response.result.bill.id"]
set Issue_date [CkJsonObject_stringOf $jResp "response.result.bill.issue_date"]
set Language [CkJsonObject_stringOf $jResp "response.result.bill.language"]
set OutstandingAmount [CkJsonObject_stringOf $jResp "response.result.bill.outstanding.amount"]
set OutstandingCode [CkJsonObject_stringOf $jResp "response.result.bill.outstanding.code"]
set Overall_category [CkJsonObject_stringOf $jResp "response.result.bill.overall_category"]
set Overall_description [CkJsonObject_stringOf $jResp "response.result.bill.overall_description"]
set PaidAmount [CkJsonObject_stringOf $jResp "response.result.bill.paid.amount"]
set PaidCode [CkJsonObject_stringOf $jResp "response.result.bill.paid.code"]
set Status [CkJsonObject_stringOf $jResp "response.result.bill.status"]
set Tax_amountAmount [CkJsonObject_stringOf $jResp "response.result.bill.tax_amount.amount"]
set Tax_amountCode [CkJsonObject_stringOf $jResp "response.result.bill.tax_amount.code"]
set Total_amountAmount [CkJsonObject_stringOf $jResp "response.result.bill.total_amount.amount"]
set Total_amountCode [CkJsonObject_stringOf $jResp "response.result.bill.total_amount.code"]
set Updated_at [CkJsonObject_stringOf $jResp "response.result.bill.updated_at"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.bill.vis_state"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.result.bill.bill_payments"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.result.bill.lines"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set amountAmount [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].amount.amount"]
set amountCode [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].amount.code"]
set Category [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].category.category"]
set Categoryid [CkJsonObject_IntOf $jResp "response.result.bill.lines[i].category.categoryid"]
set categoryCreated_at [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].category.created_at"]
set categoryId [CkJsonObject_IntOf $jResp "response.result.bill.lines[i].category.id"]
set Is_cogs [CkJsonObject_BoolOf $jResp "response.result.bill.lines[i].category.is_cogs"]
set Is_editable [CkJsonObject_BoolOf $jResp "response.result.bill.lines[i].category.is_editable"]
set Parentid [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].category.parentid"]
set categoryUpdated_at [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].category.updated_at"]
set categoryVis_state [CkJsonObject_IntOf $jResp "response.result.bill.lines[i].category.vis_state"]
set description [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].description"]
set id [CkJsonObject_IntOf $jResp "response.result.bill.lines[i].id"]
set list_index [CkJsonObject_IntOf $jResp "response.result.bill.lines[i].list_index"]
set quantity [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].quantity"]
set tax_amount1 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_amount1"]
set tax_amount2 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_amount2"]
set tax_authorityid1 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_authorityid1"]
set tax_authorityid2 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_authorityid2"]
set tax_name1 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_name1"]
set tax_name2 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_name2"]
set tax_percent1 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_percent1"]
set tax_percent2 [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].tax_percent2"]
set total_amountAmount [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].total_amount.amount"]
set total_amountCode [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].total_amount.code"]
set unit_costAmount [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].unit_cost.amount"]
set unit_costCode [CkJsonObject_stringOf $jResp "response.result.bill.lines[i].unit_cost.code"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}