Chilkat Online Tools

Classic ASP / New FreshBooks / Update Prepayment Credit

Back to Collection Items

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

set http = Server.CreateObject("Chilkat_9_5_0.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": "0000070",
'     "currency_code": "CAD",
'     "create_date": "2020-07-31",
'     "notes": "PrePayment for work",
'     "credit_type": "prepayment",
'     "terms": "Will be applied to future invoice",
'     "language": "en",
'     "lines": [
'       {
'         "id": "20375-1",
'         "name": "Credit",
'         "description": "Current Credit Balance",
'         "taxName1": null,
'         "taxAmount1": 0,
'         "taxName2": null,
'         "taxAmount2": 0,
'         "compounded_tax": false,
'         "qty": 1,
'         "unit_cost": {
'           "amount": "150",
'           "code": "CAD"
'         }
'       },
'       {
'         "name": "Credit",
'         "description": "Current Credit Balance",
'         "taxName1": null,
'         "taxAmount1": 0,
'         "taxName2": null,
'         "taxAmount2": 0,
'         "compounded_tax": false,
'         "qty": 1,
'         "unit_cost": {
'           "amount": "100",
'           "code": "CAD"
'         }
'       }
'     ],
'     "clientid": 123
'   }
' }

set json = Server.CreateObject("Chilkat_9_5_0.JsonObject")
success = json.UpdateString("credit_note.credit_number","0000070")
success = json.UpdateString("credit_note.currency_code","CAD")
success = json.UpdateString("credit_note.create_date","2020-07-31")
success = json.UpdateString("credit_note.notes","PrePayment for work")
success = json.UpdateString("credit_note.credit_type","prepayment")
success = json.UpdateString("credit_note.terms","Will be applied to future invoice")
success = json.UpdateString("credit_note.language","en")
success = json.UpdateString("credit_note.lines[0].id","20375-1")
success = json.UpdateString("credit_note.lines[0].name","Credit")
success = json.UpdateString("credit_note.lines[0].description","Current Credit Balance")
success = json.UpdateNull("credit_note.lines[0].taxName1")
success = json.UpdateInt("credit_note.lines[0].taxAmount1",0)
success = json.UpdateNull("credit_note.lines[0].taxName2")
success = json.UpdateInt("credit_note.lines[0].taxAmount2",0)
success = json.UpdateBool("credit_note.lines[0].compounded_tax",0)
success = json.UpdateInt("credit_note.lines[0].qty",1)
success = json.UpdateString("credit_note.lines[0].unit_cost.amount","150")
success = json.UpdateString("credit_note.lines[0].unit_cost.code","CAD")
success = json.UpdateString("credit_note.lines[1].name","Credit")
success = json.UpdateString("credit_note.lines[1].description","Current Credit Balance")
success = json.UpdateNull("credit_note.lines[1].taxName1")
success = json.UpdateInt("credit_note.lines[1].taxAmount1",0)
success = json.UpdateNull("credit_note.lines[1].taxName2")
success = json.UpdateInt("credit_note.lines[1].taxAmount2",0)
success = json.UpdateBool("credit_note.lines[1].compounded_tax",0)
success = json.UpdateInt("credit_note.lines[1].qty",1)
success = json.UpdateString("credit_note.lines[1].unit_cost.amount","100")
success = json.UpdateString("credit_note.lines[1].unit_cost.code","CAD")
success = json.UpdateInt("credit_note.clientid",123)

set sbRequestBody = Server.CreateObject("Chilkat_9_5_0.StringBuilder")
success = json.EmitSb(sbRequestBody)

' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
    Response.End
End If

Response.Write "<pre>" & Server.HTMLEncode( resp.StatusCode) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.BodyStr) & "</pre>"


%>
</body>
</html>

Curl Command

curl -X PUT
	-d '{
    "credit_note": {
        "credit_number": "0000070",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "PrePayment for work",
        "credit_type": "prepayment",
        "terms": "Will be applied to future invoice",
        "language": "en",
        "lines": [
            {
                "id": "20375-1",
                "name": "Credit",
                "description": "Current Credit Balance",
                "taxName1": null,
                "taxAmount1": 0,
                "taxName2": null,
                "taxAmount2": 0,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "150",
                    "code": "CAD"
                }
            },
            {
                "name": "Credit",
                "description": "Current Credit Balance",
                "taxName1": null,
                "taxAmount1": 0,
                "taxName2": null,
                "taxAmount2": 0,
                "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 Prepayment Credit",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "PUT",
    "header": [
      {
        "key": "",
        "value": "",
        "type": "text",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000070\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"PrePayment for work\",\n        \"credit_type\": \"prepayment\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"language\": \"en\",\n        \"lines\": [\n            {\n                \"id\": \"20375-1\",\n                \"name\": \"Credit\",\n                \"description\": \"Current Credit Balance\",\n                \"taxName1\": null,\n                \"taxAmount1\": 0,\n                \"taxName2\": null,\n                \"taxAmount2\": 0,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"150\",\n                    \"code\": \"CAD\"\n                }\n            },\n            {\n                \"name\": \"Credit\",\n                \"description\": \"Current Credit Balance\",\n                \"taxName1\": null,\n                \"taxAmount1\": 0,\n                \"taxName2\": null,\n                \"taxAmount2\": 0,\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": [
  ]
}