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.
' {
' "credit_note": {
' "vis_state": 1
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateInt("credit_note.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}}/credit_notes/credit_notes/{{creditId}}",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": {
' "credit_note": {
' "accounting_systemid": "E86Qp",
' "amount": {
' "amount": "150.00",
' "code": "CAD"
' },
' "city": "",
' "clientid": 599843,
' "code": "",
' "country": "",
' "create_date": "2020-07-31",
' "credit_number": "0000069",
' "credit_type": "goodwill",
' "creditid": 30947,
' "currency_code": "CAD",
' "current_organization": "Squarespace",
' "description": "Goodwill Credit",
' "display_status": "created",
' "dispute_status": null,
' "ext_archive": 0,
' "fname": "",
' "id": 30947,
' "language": "en",
' "last_order_status": null,
' "lname": "",
' "notes": "Free $150 voucher",
' "organization": "Squarespace",
' "paid": {
' "amount": "150.00",
' "code": "CAD"
' },
' "payment_status": "paid",
' "province": "",
' "sentid": 1,
' "status": "created",
' "street": "",
' "street2": "",
' "template": "clean-grouped",
' "terms": "Will be applied to future invoice",
' "vat_name": "",
' "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
Dim Accounting_systemid As String = jResp.StringOf("response.result.credit_note.accounting_systemid")
Dim Amount As String = jResp.StringOf("response.result.credit_note.amount.amount")
Dim Code As String = jResp.StringOf("response.result.credit_note.amount.code")
Dim City As String = jResp.StringOf("response.result.credit_note.city")
Dim Clientid As Integer = jResp.IntOf("response.result.credit_note.clientid")
Dim Credit_noteCode As String = jResp.StringOf("response.result.credit_note.code")
Dim Country As String = jResp.StringOf("response.result.credit_note.country")
Dim Create_date As String = jResp.StringOf("response.result.credit_note.create_date")
Dim Credit_number As String = jResp.StringOf("response.result.credit_note.credit_number")
Dim Credit_type As String = jResp.StringOf("response.result.credit_note.credit_type")
Dim Creditid As Integer = jResp.IntOf("response.result.credit_note.creditid")
Dim Currency_code As String = jResp.StringOf("response.result.credit_note.currency_code")
Dim Current_organization As String = jResp.StringOf("response.result.credit_note.current_organization")
Dim Description As String = jResp.StringOf("response.result.credit_note.description")
Dim Display_status As String = jResp.StringOf("response.result.credit_note.display_status")
Dim Dispute_status As String = jResp.StringOf("response.result.credit_note.dispute_status")
Dim Ext_archive As Integer = jResp.IntOf("response.result.credit_note.ext_archive")
Dim Fname As String = jResp.StringOf("response.result.credit_note.fname")
Dim Id As Integer = jResp.IntOf("response.result.credit_note.id")
Dim Language As String = jResp.StringOf("response.result.credit_note.language")
Dim Last_order_status As String = jResp.StringOf("response.result.credit_note.last_order_status")
Dim Lname As String = jResp.StringOf("response.result.credit_note.lname")
Dim Notes As String = jResp.StringOf("response.result.credit_note.notes")
Dim Organization As String = jResp.StringOf("response.result.credit_note.organization")
Dim PaidAmount As String = jResp.StringOf("response.result.credit_note.paid.amount")
Dim PaidCode As String = jResp.StringOf("response.result.credit_note.paid.code")
Dim Payment_status As String = jResp.StringOf("response.result.credit_note.payment_status")
Dim Province As String = jResp.StringOf("response.result.credit_note.province")
Dim Sentid As Integer = jResp.IntOf("response.result.credit_note.sentid")
Dim Status As String = jResp.StringOf("response.result.credit_note.status")
Dim Street As String = jResp.StringOf("response.result.credit_note.street")
Dim Street2 As String = jResp.StringOf("response.result.credit_note.street2")
Dim Template As String = jResp.StringOf("response.result.credit_note.template")
Dim Terms As String = jResp.StringOf("response.result.credit_note.terms")
Dim Vat_name As String = jResp.StringOf("response.result.credit_note.vat_name")
Dim Vat_number As String = jResp.StringOf("response.result.credit_note.vat_number")
Dim Vis_state As Integer = jResp.IntOf("response.result.credit_note.vis_state")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"credit_note": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}
Postman Collection Item JSON
{
"name": "Delete Credit",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"credit_notes",
"credit_notes",
"{{creditId}}"
]
}
},
"response": [
{
"name": "Delete Credit",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"vis_state\": 1\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"credit_notes",
"credit_notes",
"{{creditId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 11 Sep 2020 14:41:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gHQ1NXCxI8DF8WXRECW0ZXVwxND14VVkBIBhtRSFALCwZUV1ECBgJRUAUAAVtKV1ccQAAGDlsEBVYECwAGAAsBUwYVTQACVEBVOQ=="
},
{
"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": "595"
},
{
"key": "X-RateLimit-Reset",
"value": "1599835343"
},
{
"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 \"credit_note\": {\n \"accounting_systemid\": \"E86Qp\",\n \"amount\": {\n \"amount\": \"150.00\",\n \"code\": \"CAD\"\n },\n \"city\": \"\",\n \"clientid\": 599843,\n \"code\": \"\",\n \"country\": \"\",\n \"create_date\": \"2020-07-31\",\n \"credit_number\": \"0000069\",\n \"credit_type\": \"goodwill\",\n \"creditid\": 30947,\n \"currency_code\": \"CAD\",\n \"current_organization\": \"Squarespace\",\n \"description\": \"Goodwill Credit\",\n \"display_status\": \"created\",\n \"dispute_status\": null,\n \"ext_archive\": 0,\n \"fname\": \"\",\n \"id\": 30947,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"\",\n \"notes\": \"Free $150 voucher\",\n \"organization\": \"Squarespace\",\n \"paid\": {\n \"amount\": \"150.00\",\n \"code\": \"CAD\"\n },\n \"payment_status\": \"paid\",\n \"province\": \"\",\n \"sentid\": 1,\n \"status\": \"created\",\n \"street\": \"\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"Will be applied to future invoice\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
