Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(json,"credit_note.vis_state",1)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/credit_notes/credit_notes/{{creditId}}",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
Accounting_systemid.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.accounting_systemid")
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.amount.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.amount.code")
City.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.city")
Clientid.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.clientid")
Credit_noteCode.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.code")
Country.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.country")
Create_date.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.create_date")
Credit_number.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.credit_number")
Credit_type.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.credit_type")
Creditid.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.creditid")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.currency_code")
Current_organization.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.current_organization")
Description.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.description")
Display_status.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.display_status")
Dispute_status.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.dispute_status")
Ext_archive.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.ext_archive")
Fname.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.fname")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.id")
Language.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.language")
Last_order_status.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.last_order_status")
Lname.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.lname")
Notes.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.notes")
Organization.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.organization")
PaidAmount.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.paid.amount")
PaidCode.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.paid.code")
Payment_status.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.payment_status")
Province.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.province")
Sentid.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.sentid")
Status.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.status")
Street.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.street")
Street2.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.street2")
Template.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.template")
Terms.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.terms")
Vat_name.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.vat_name")
Vat_number.s = CkJsonObject::ckStringOf(jResp,"response.result.credit_note.vat_number")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.credit_note.vis_state")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
