Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateInt("credit_note.vis_state",1)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sAccounting_systemid = $oJResp.StringOf("response.result.credit_note.accounting_systemid")
Local $sAmount = $oJResp.StringOf("response.result.credit_note.amount.amount")
Local $sCode = $oJResp.StringOf("response.result.credit_note.amount.code")
Local $sCity = $oJResp.StringOf("response.result.credit_note.city")
Local $iClientid = $oJResp.IntOf("response.result.credit_note.clientid")
Local $sCredit_noteCode = $oJResp.StringOf("response.result.credit_note.code")
Local $sCountry = $oJResp.StringOf("response.result.credit_note.country")
Local $sCreate_date = $oJResp.StringOf("response.result.credit_note.create_date")
Local $sCredit_number = $oJResp.StringOf("response.result.credit_note.credit_number")
Local $sCredit_type = $oJResp.StringOf("response.result.credit_note.credit_type")
Local $iCreditid = $oJResp.IntOf("response.result.credit_note.creditid")
Local $sCurrency_code = $oJResp.StringOf("response.result.credit_note.currency_code")
Local $sCurrent_organization = $oJResp.StringOf("response.result.credit_note.current_organization")
Local $sDescription = $oJResp.StringOf("response.result.credit_note.description")
Local $sDisplay_status = $oJResp.StringOf("response.result.credit_note.display_status")
Local $sDispute_status = $oJResp.StringOf("response.result.credit_note.dispute_status")
Local $iExt_archive = $oJResp.IntOf("response.result.credit_note.ext_archive")
Local $sFname = $oJResp.StringOf("response.result.credit_note.fname")
Local $iId = $oJResp.IntOf("response.result.credit_note.id")
Local $sLanguage = $oJResp.StringOf("response.result.credit_note.language")
Local $sLast_order_status = $oJResp.StringOf("response.result.credit_note.last_order_status")
Local $sLname = $oJResp.StringOf("response.result.credit_note.lname")
Local $sNotes = $oJResp.StringOf("response.result.credit_note.notes")
Local $sOrganization = $oJResp.StringOf("response.result.credit_note.organization")
Local $sPaidAmount = $oJResp.StringOf("response.result.credit_note.paid.amount")
Local $sPaidCode = $oJResp.StringOf("response.result.credit_note.paid.code")
Local $sPayment_status = $oJResp.StringOf("response.result.credit_note.payment_status")
Local $sProvince = $oJResp.StringOf("response.result.credit_note.province")
Local $iSentid = $oJResp.IntOf("response.result.credit_note.sentid")
Local $sStatus = $oJResp.StringOf("response.result.credit_note.status")
Local $sStreet = $oJResp.StringOf("response.result.credit_note.street")
Local $sStreet2 = $oJResp.StringOf("response.result.credit_note.street2")
Local $sTemplate = $oJResp.StringOf("response.result.credit_note.template")
Local $sTerms = $oJResp.StringOf("response.result.credit_note.terms")
Local $sVat_name = $oJResp.StringOf("response.result.credit_note.vat_name")
Local $sVat_number = $oJResp.StringOf("response.result.credit_note.vat_number")
Local $iVis_state = $oJResp.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}"
}
]
}
