Chilkat Online Tools

VB.NET / New FreshBooks / Create Credit Note

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' 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": "0000064",
'     "currency_code": "CAD",
'     "create_date": "2020-07-31",
'     "notes": "Free $150 voucher",
'     "credit_type": "goodwill",
'     "terms": "Will be applied to future invoice",
'     "language": "en",
'     "lines": [
'       {
'         "name": "Credit",
'         "description": "Goodwill Credit",
'         "taxName1": null,
'         "taxAmount1": null,
'         "taxName2": null,
'         "taxAmount2": null,
'         "compounded_tax": false,
'         "qty": 1,
'         "unit_cost": {
'           "amount": "150",
'           "code": "CAD"
'         },
'         "credit_note": null
'       }
'     ],
'     "clientid": 123
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("credit_note.credit_number","0000064")
json.UpdateString("credit_note.currency_code","CAD")
json.UpdateString("credit_note.create_date","2020-07-31")
json.UpdateString("credit_note.notes","Free $150 voucher")
json.UpdateString("credit_note.credit_type","goodwill")
json.UpdateString("credit_note.terms","Will be applied to future invoice")
json.UpdateString("credit_note.language","en")
json.UpdateString("credit_note.lines[0].name","Credit")
json.UpdateString("credit_note.lines[0].description","Goodwill Credit")
json.UpdateNull("credit_note.lines[0].taxName1")
json.UpdateNull("credit_note.lines[0].taxAmount1")
json.UpdateNull("credit_note.lines[0].taxName2")
json.UpdateNull("credit_note.lines[0].taxAmount2")
json.UpdateBool("credit_note.lines[0].compounded_tax",False)
json.UpdateInt("credit_note.lines[0].qty",1)
json.UpdateString("credit_note.lines[0].unit_cost.amount","150")
json.UpdateString("credit_note.lines[0].unit_cost.code","CAD")
json.UpdateNull("credit_note.lines[0].credit_note")
json.UpdateInt("credit_note.clientid",123)


Dim resp As Chilkat.HttpResponse = http.PostJson3("https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

Curl Command

curl -X POST
	-d '{
    "credit_note": {
        "credit_number": "0000064",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "Free $150 voucher",
        "credit_type": "goodwill",
        "terms": "Will be applied to future invoice",
        "language": "en",
        "lines": [
            {
                "name": "Credit",
                "description": "Goodwill Credit",
                "taxName1": null,
                "taxAmount1": null,
                "taxName2": null,
                "taxAmount2": null,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "150",
                    "code": "CAD"
                },
                "credit_note": null
            }
        ],
        "clientid": {{clientid}}
    }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes

Postman Collection Item JSON

{
  "name": "Create Credit Note",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000064\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"Free $150 voucher\",\n        \"credit_type\": \"goodwill\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"language\": \"en\",\n        \"lines\": [\n            {\n                \"name\": \"Credit\",\n                \"description\": \"Goodwill Credit\",\n                \"taxName1\": null,\n                \"taxAmount1\": null,\n                \"taxName2\": null,\n                \"taxAmount2\": null,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"150\",\n                    \"code\": \"CAD\"\n                },\n                \"credit_note\": null\n            }\n        ],\n        \"clientid\": {{clientid}}\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountid}}",
        "credit_notes",
        "credit_notes"
      ]
    }
  },
  "response": [
  ]
}