Foxpro / New FreshBooks / Update Credit Note
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("credit_note.credit_number","0000066")
loJson.UpdateString("credit_note.currency_code","CAD")
loJson.UpdateString("credit_note.create_date","2020-08-04")
loJson.UpdateString("credit_note.notes","")
loJson.UpdateString("credit_note.credit_type","goodwill")
loJson.UpdateNull("credit_note.terms")
loJson.UpdateString("credit_note.language","en")
loJson.UpdateString("credit_note.lines[0].id","20405-1")
loJson.UpdateString("credit_note.lines[0].name","Credit")
loJson.UpdateString("credit_note.lines[0].description","Free Voucher")
loJson.UpdateNull("credit_note.lines[0].taxName1")
loJson.UpdateInt("credit_note.lines[0].taxAmount1",0)
loJson.UpdateNull("credit_note.lines[0].taxName2")
loJson.UpdateInt("credit_note.lines[0].taxAmount2",0)
loJson.UpdateBool("credit_note.lines[0].compounded_tax",0)
loJson.UpdateInt("credit_note.lines[0].qty",1)
loJson.UpdateString("credit_note.lines[0].unit_cost.amount","50")
loJson.UpdateString("credit_note.lines[0].unit_cost.code","CAD")
loJson.UpdateString("credit_note.lines[1].name","Credit")
loJson.UpdateString("credit_note.lines[1].description","More voucher")
loJson.UpdateNull("credit_note.lines[1].taxName1")
loJson.UpdateNull("credit_note.lines[1].taxAmount1")
loJson.UpdateNull("credit_note.lines[1].taxName2")
loJson.UpdateNull("credit_note.lines[1].taxAmount2")
loJson.UpdateBool("credit_note.lines[1].compounded_tax",0)
loJson.UpdateInt("credit_note.lines[1].qty",1)
loJson.UpdateString("credit_note.lines[1].unit_cost.amount","100")
loJson.UpdateString("credit_note.lines[1].unit_cost.code","CAD")
loJson.UpdateInt("credit_note.clientid",123)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
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": [
]
}
