Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateInt("bill.vis_state",1)
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/bills/bills/{{billId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim amountAmount As String
Dim amountCode As String
Dim Category As String
Dim Categoryid As Integer
Dim categoryCreated_at As String
Dim categoryId As Integer
Dim Is_cogs As Boolean
Dim Is_editable As Boolean
Dim Parentid As String
Dim categoryUpdated_at As String
Dim categoryVis_state As Integer
Dim description As String
Dim id As Integer
Dim list_index As Integer
Dim quantity As String
Dim tax_amount1 As String
Dim tax_amount2 As String
Dim tax_authorityid1 As String
Dim tax_authorityid2 As String
Dim tax_name1 As String
Dim tax_name2 As String
Dim tax_percent1 As String
Dim tax_percent2 As String
Dim total_amountAmount As String
Dim total_amountCode As String
Dim unit_costAmount As String
Dim unit_costCode As String
Dim Amount As String = jResp.StringOf("response.result.bill.amount.amount")
Dim Code As String = jResp.StringOf("response.result.bill.amount.code")
Dim Attachment As String = jResp.StringOf("response.result.bill.attachment")
Dim Bill_number As String = jResp.StringOf("response.result.bill.bill_number")
Dim Created_at As String = jResp.StringOf("response.result.bill.created_at")
Dim Currency_code As String = jResp.StringOf("response.result.bill.currency_code")
Dim Due_date As String = jResp.StringOf("response.result.bill.due_date")
Dim Due_offset_days As Integer = jResp.IntOf("response.result.bill.due_offset_days")
Dim Id As Integer = jResp.IntOf("response.result.bill.id")
Dim Issue_date As String = jResp.StringOf("response.result.bill.issue_date")
Dim Language As String = jResp.StringOf("response.result.bill.language")
Dim OutstandingAmount As String = jResp.StringOf("response.result.bill.outstanding.amount")
Dim OutstandingCode As String = jResp.StringOf("response.result.bill.outstanding.code")
Dim Overall_category As String = jResp.StringOf("response.result.bill.overall_category")
Dim Overall_description As String = jResp.StringOf("response.result.bill.overall_description")
Dim PaidAmount As String = jResp.StringOf("response.result.bill.paid.amount")
Dim PaidCode As String = jResp.StringOf("response.result.bill.paid.code")
Dim Status As String = jResp.StringOf("response.result.bill.status")
Dim Tax_amountAmount As String = jResp.StringOf("response.result.bill.tax_amount.amount")
Dim Tax_amountCode As String = jResp.StringOf("response.result.bill.tax_amount.code")
Dim Total_amountAmount As String = jResp.StringOf("response.result.bill.total_amount.amount")
Dim Total_amountCode As String = jResp.StringOf("response.result.bill.total_amount.code")
Dim Updated_at As String = jResp.StringOf("response.result.bill.updated_at")
Dim Vis_state As Integer = jResp.IntOf("response.result.bill.vis_state")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("response.result.bill.bill_payments")
While i < count_i
jResp.I = i
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("response.result.bill.lines")
While i < count_i
jResp.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 While
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}"
}
]
}
