Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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": {
# "credit_number": "0000066",
# "currency_code": "CAD",
# "create_date": "2020-08-04",
# "notes": "",
# "credit_type": "goodwill",
# "terms": null,
# "language": "en",
# "lines": [
# {
# "id": "20405-1",
# "name": "Credit",
# "description": "Free Voucher",
# "taxName1": null,
# "taxAmount1": 0,
# "taxName2": null,
# "taxAmount2": 0,
# "compounded_tax": false,
# "qty": 1,
# "unit_cost": {
# "amount": "50",
# "code": "CAD"
# }
# },
# {
# "name": "Credit",
# "description": "More voucher",
# "taxName1": null,
# "taxAmount1": null,
# "taxName2": null,
# "taxAmount2": null,
# "compounded_tax": false,
# "qty": 1,
# "unit_cost": {
# "amount": "100",
# "code": "CAD"
# }
# }
# ],
# "clientid": 123
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "credit_note.credit_number" "0000066"
CkJsonObject_UpdateString $json "credit_note.currency_code" "CAD"
CkJsonObject_UpdateString $json "credit_note.create_date" "2020-08-04"
CkJsonObject_UpdateString $json "credit_note.notes" ""
CkJsonObject_UpdateString $json "credit_note.credit_type" "goodwill"
CkJsonObject_UpdateNull $json "credit_note.terms"
CkJsonObject_UpdateString $json "credit_note.language" "en"
CkJsonObject_UpdateString $json "credit_note.lines[0].id" "20405-1"
CkJsonObject_UpdateString $json "credit_note.lines[0].name" "Credit"
CkJsonObject_UpdateString $json "credit_note.lines[0].description" "Free Voucher"
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxName1"
CkJsonObject_UpdateInt $json "credit_note.lines[0].taxAmount1" 0
CkJsonObject_UpdateNull $json "credit_note.lines[0].taxName2"
CkJsonObject_UpdateInt $json "credit_note.lines[0].taxAmount2" 0
CkJsonObject_UpdateBool $json "credit_note.lines[0].compounded_tax" 0
CkJsonObject_UpdateInt $json "credit_note.lines[0].qty" 1
CkJsonObject_UpdateString $json "credit_note.lines[0].unit_cost.amount" "50"
CkJsonObject_UpdateString $json "credit_note.lines[0].unit_cost.code" "CAD"
CkJsonObject_UpdateString $json "credit_note.lines[1].name" "Credit"
CkJsonObject_UpdateString $json "credit_note.lines[1].description" "More voucher"
CkJsonObject_UpdateNull $json "credit_note.lines[1].taxName1"
CkJsonObject_UpdateNull $json "credit_note.lines[1].taxAmount1"
CkJsonObject_UpdateNull $json "credit_note.lines[1].taxName2"
CkJsonObject_UpdateNull $json "credit_note.lines[1].taxAmount2"
CkJsonObject_UpdateBool $json "credit_note.lines[1].compounded_tax" 0
CkJsonObject_UpdateInt $json "credit_note.lines[1].qty" 1
CkJsonObject_UpdateString $json "credit_note.lines[1].unit_cost.amount" "100"
CkJsonObject_UpdateString $json "credit_note.lines[1].unit_cost.code" "CAD"
CkJsonObject_UpdateInt $json "credit_note.clientid" 123
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"credit_note": {
"credit_number": "0000066",
"currency_code": "CAD",
"create_date": "2020-08-04",
"notes": "",
"credit_type": "goodwill",
"terms": null,
"language": "en",
"lines": [
{
"id": "20405-1",
"name": "Credit",
"description": "Free Voucher",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "50",
"code": "CAD"
}
},
{
"name": "Credit",
"description": "More voucher",
"taxName1": null,
"taxAmount1": null,
"taxName2": null,
"taxAmount2": null,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "100",
"code": "CAD"
}
}
],
"clientid": {{clientId}}
}
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}
Postman Collection Item JSON
{
"name": "Update Credit Note",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"credit_number\": \"0000066\",\n \"currency_code\": \"CAD\",\n \"create_date\": \"2020-08-04\",\n \"notes\": \"\",\n \"credit_type\": \"goodwill\",\n \"terms\": null,\n \"language\": \"en\",\n \"lines\": [\n {\n \"id\": \"20405-1\",\n \"name\": \"Credit\",\n \"description\": \"Free Voucher\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"50\",\n \"code\": \"CAD\"\n }\n },\n {\n \"name\": \"Credit\",\n \"description\": \"More voucher\",\n \"taxName1\": null,\n \"taxAmount1\": null,\n \"taxName2\": null,\n \"taxAmount2\": null,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"100\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"clientid\": {{clientId}}\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountid}}",
"credit_notes",
"credit_notes",
"{{creditnote}}"
]
}
},
"response": [
]
}
