Chilkat Online Tools

Node.js / New FreshBooks / Create Prepayment Credit

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // 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
    //   }
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("credit_note.credit_number","0000070");
    json.UpdateString("credit_note.currency_code","CAD");
    json.UpdateString("credit_note.create_date","2020-07-31");
    json.UpdateString("credit_note.notes","Thank you for paying ahead of time");
    json.UpdateString("credit_note.credit_type","prepayment");
    json.UpdateString("credit_note.terms","Will be applied to future invoice");
    json.UpdateString("credit_note.lines[0].name","Credit");
    json.UpdateString("credit_note.lines[0].description","PrePayment for work");
    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","200");
    json.UpdateString("credit_note.lines[0].unit_cost.code","CAD");
    json.UpdateNull("credit_note.lines[0].credit_note");
    json.UpdateInt("credit_note.clientid",123);

    http.SetRequestHeader("Authorization","Bearer");

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

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": [
  ]
}