Chilkat Online Tools

Foxpro / New FreshBooks / Create Prepayment Credit

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
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": "0000070",
*     "currency_code": "CAD",
*     "create_date": "2020-07-31",
*     "notes": "Thank you for paying ahead of time",
*     "credit_type": "prepayment",
*     "terms": "Will be applied to future invoice",
*     "lines": [
*       {
*         "name": "Credit",
*         "description": "PrePayment for work",
*         "taxName1": null,
*         "taxAmount1": null,
*         "taxName2": null,
*         "taxAmount2": null,
*         "compounded_tax": false,
*         "qty": 1,
*         "unit_cost": {
*           "amount": "200",
*           "code": "CAD"
*         },
*         "credit_note": null
*       }
*     ],
*     "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","0000070")
loJson.UpdateString("credit_note.currency_code","CAD")
loJson.UpdateString("credit_note.create_date","2020-07-31")
loJson.UpdateString("credit_note.notes","Thank you for paying ahead of time")
loJson.UpdateString("credit_note.credit_type","prepayment")
loJson.UpdateString("credit_note.terms","Will be applied to future invoice")
loJson.UpdateString("credit_note.lines[0].name","Credit")
loJson.UpdateString("credit_note.lines[0].description","PrePayment for work")
loJson.UpdateNull("credit_note.lines[0].taxName1")
loJson.UpdateNull("credit_note.lines[0].taxAmount1")
loJson.UpdateNull("credit_note.lines[0].taxName2")
loJson.UpdateNull("credit_note.lines[0].taxAmount2")
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","200")
loJson.UpdateString("credit_note.lines[0].unit_cost.code","CAD")
loJson.UpdateNull("credit_note.lines[0].credit_note")
loJson.UpdateInt("credit_note.clientid",123)

loHttp.SetRequestHeader("Authorization","Bearer")

loResp = loHttp.PostJson3("https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Authorization: Bearer "
	-d '{
    "credit_note": {
        "credit_number": "0000070",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "Thank you for paying ahead of time",
        "credit_type": "prepayment",
        "terms": "Will be applied to future invoice",
        "lines": [
            {
                "name": "Credit",
                "description": "PrePayment for work",
                "taxName1": null,
                "taxAmount1": null,
                "taxName2": null,
                "taxAmount2": null,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "200",
                    "code": "CAD"
                },
                "credit_note": null
            }
        ],
        "clientid": {{clientId}}
    }
}'
https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes

Postman Collection Item JSON

{
  "name": "Create Prepayment Credit",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer ",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000070\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"Thank you for paying ahead of time\",\n        \"credit_type\": \"prepayment\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"lines\": [\n            {\n                \"name\": \"Credit\",\n                \"description\": \"PrePayment for work\",\n                \"taxName1\": null,\n                \"taxAmount1\": null,\n                \"taxName2\": null,\n                \"taxAmount2\": null,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"200\",\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/E86Qp/credit_notes/credit_notes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "E86Qp",
        "credit_notes",
        "credit_notes"
      ]
    }
  },
  "response": [
  ]
}