Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": 2
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateInt("bill.vis_state",2)
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
Amount = jResp.stringOf("response.result.bill.amount.amount")
Code = jResp.stringOf("response.result.bill.amount.code")
Attachment = jResp.stringOf("response.result.bill.attachment")
Bill_number = jResp.stringOf("response.result.bill.bill_number")
Created_at = jResp.stringOf("response.result.bill.created_at")
Currency_code = jResp.stringOf("response.result.bill.currency_code")
Due_date = jResp.stringOf("response.result.bill.due_date")
Due_offset_days = jResp.IntOf("response.result.bill.due_offset_days")
Id = jResp.IntOf("response.result.bill.id")
Issue_date = jResp.stringOf("response.result.bill.issue_date")
Language = jResp.stringOf("response.result.bill.language")
OutstandingAmount = jResp.stringOf("response.result.bill.outstanding.amount")
OutstandingCode = jResp.stringOf("response.result.bill.outstanding.code")
Overall_category = jResp.stringOf("response.result.bill.overall_category")
Overall_description = jResp.stringOf("response.result.bill.overall_description")
PaidAmount = jResp.stringOf("response.result.bill.paid.amount")
PaidCode = jResp.stringOf("response.result.bill.paid.code")
Status = jResp.stringOf("response.result.bill.status")
Tax_amountAmount = jResp.stringOf("response.result.bill.tax_amount.amount")
Tax_amountCode = jResp.stringOf("response.result.bill.tax_amount.code")
Total_amountAmount = jResp.stringOf("response.result.bill.total_amount.amount")
Total_amountCode = jResp.stringOf("response.result.bill.total_amount.code")
Updated_at = jResp.stringOf("response.result.bill.updated_at")
Vis_state = jResp.IntOf("response.result.bill.vis_state")
i = 0
count_i = jResp.SizeOfArray("response.result.bill.bill_payments")
while i < count_i
jResp.put_I(i)
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("response.result.bill.lines")
while i < count_i
jResp.put_I(i)
amountAmount = jResp.stringOf("response.result.bill.lines[i].amount.amount")
amountCode = jResp.stringOf("response.result.bill.lines[i].amount.code")
Category = jResp.stringOf("response.result.bill.lines[i].category.category")
Categoryid = jResp.IntOf("response.result.bill.lines[i].category.categoryid")
categoryCreated_at = jResp.stringOf("response.result.bill.lines[i].category.created_at")
categoryId = jResp.IntOf("response.result.bill.lines[i].category.id")
Is_cogs = jResp.BoolOf("response.result.bill.lines[i].category.is_cogs")
Is_editable = jResp.BoolOf("response.result.bill.lines[i].category.is_editable")
Parentid = jResp.stringOf("response.result.bill.lines[i].category.parentid")
categoryUpdated_at = jResp.stringOf("response.result.bill.lines[i].category.updated_at")
categoryVis_state = jResp.IntOf("response.result.bill.lines[i].category.vis_state")
description = jResp.stringOf("response.result.bill.lines[i].description")
id = jResp.IntOf("response.result.bill.lines[i].id")
list_index = jResp.IntOf("response.result.bill.lines[i].list_index")
quantity = jResp.stringOf("response.result.bill.lines[i].quantity")
tax_amount1 = jResp.stringOf("response.result.bill.lines[i].tax_amount1")
tax_amount2 = jResp.stringOf("response.result.bill.lines[i].tax_amount2")
tax_authorityid1 = jResp.stringOf("response.result.bill.lines[i].tax_authorityid1")
tax_authorityid2 = jResp.stringOf("response.result.bill.lines[i].tax_authorityid2")
tax_name1 = jResp.stringOf("response.result.bill.lines[i].tax_name1")
tax_name2 = jResp.stringOf("response.result.bill.lines[i].tax_name2")
tax_percent1 = jResp.stringOf("response.result.bill.lines[i].tax_percent1")
tax_percent2 = jResp.stringOf("response.result.bill.lines[i].tax_percent2")
total_amountAmount = jResp.stringOf("response.result.bill.lines[i].total_amount.amount")
total_amountCode = jResp.stringOf("response.result.bill.lines[i].total_amount.code")
unit_costAmount = jResp.stringOf("response.result.bill.lines[i].unit_cost.amount")
unit_costCode = jResp.stringOf("response.result.bill.lines[i].unit_cost.code")
i = i + 1
end
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"bill": {
"vis_state": 2
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}
Postman Collection Item JSON
{
"name": "Archive Bill",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill\": {\n \"vis_state\": 2\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}"
},
{
"name": "Archive Bill",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill\": {\n \"vis_state\": 2\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:42:25 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfEVwBC1wOGk4IFAQcB1cNVwhXAVJTBgNXU1MACxxQV04VVAQHAQFUBAFRAFVVAFlUDxoYVFIJSgRs"
},
{
"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": "598"
},
{
"key": "X-RateLimit-Reset",
"value": "1602258206"
},
{
"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:42:26\",\n \"vis_state\": 2\n }\n }\n }\n}"
}
]
}
