autoit / New FreshBooks / Update Credit Note
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": {
; "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
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("credit_note.credit_number","0000066")
$oJson.UpdateString("credit_note.currency_code","CAD")
$oJson.UpdateString("credit_note.create_date","2020-08-04")
$oJson.UpdateString("credit_note.notes","")
$oJson.UpdateString("credit_note.credit_type","goodwill")
$oJson.UpdateNull("credit_note.terms")
$oJson.UpdateString("credit_note.language","en")
$oJson.UpdateString("credit_note.lines[0].id","20405-1")
$oJson.UpdateString("credit_note.lines[0].name","Credit")
$oJson.UpdateString("credit_note.lines[0].description","Free Voucher")
$oJson.UpdateNull("credit_note.lines[0].taxName1")
$oJson.UpdateInt("credit_note.lines[0].taxAmount1",0)
$oJson.UpdateNull("credit_note.lines[0].taxName2")
$oJson.UpdateInt("credit_note.lines[0].taxAmount2",0)
$oJson.UpdateBool("credit_note.lines[0].compounded_tax",False)
$oJson.UpdateInt("credit_note.lines[0].qty",1)
$oJson.UpdateString("credit_note.lines[0].unit_cost.amount","50")
$oJson.UpdateString("credit_note.lines[0].unit_cost.code","CAD")
$oJson.UpdateString("credit_note.lines[1].name","Credit")
$oJson.UpdateString("credit_note.lines[1].description","More voucher")
$oJson.UpdateNull("credit_note.lines[1].taxName1")
$oJson.UpdateNull("credit_note.lines[1].taxAmount1")
$oJson.UpdateNull("credit_note.lines[1].taxName2")
$oJson.UpdateNull("credit_note.lines[1].taxAmount2")
$oJson.UpdateBool("credit_note.lines[1].compounded_tax",False)
$oJson.UpdateInt("credit_note.lines[1].qty",1)
$oJson.UpdateString("credit_note.lines[1].unit_cost.amount","100")
$oJson.UpdateString("credit_note.lines[1].unit_cost.code","CAD")
$oJson.UpdateInt("credit_note.clientid",123)
; 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/{{creditnote}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)
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": [
]
}
