Chilkat Online Tools

Node.js / New FreshBooks / Send Invoice by Email

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.

    // {
    //   "invoice": {
    //     "email_recipients": [
    //       "example@freshbooks.com",
    //       "example2@freshbooks.com"
    //     ],
    //     "invoice_customized_email": {
    //       "subject": "::company name:: has sent you an invoice (::invoice number::)",
    //       "body": "::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::"
    //     },
    //     "action_email": true
    //   }
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("invoice.email_recipients[0]","example@freshbooks.com");
    json.UpdateString("invoice.email_recipients[1]","example2@freshbooks.com");
    json.UpdateString("invoice.invoice_customized_email.subject","::company name:: has sent you an invoice (::invoice number::)");
    json.UpdateString("invoice.invoice_customized_email.body","::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::");
    json.UpdateBool("invoice.action_email",true);

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>";
    http.SetRequestHeader("Content-Type","application/json");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

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


}

chilkatExample();

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "invoice": {
        
        "email_recipients": [
            "example@freshbooks.com",
            "example2@freshbooks.com"
        ],
        "invoice_customized_email": {
        "subject": "::company name:: has sent you an invoice (::invoice number::)",
                "body":"::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that\'s due on ::invoice due date::"
            },
            "action_email": true
    }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}

Postman Collection Item JSON

{
  "name": "Send Invoice by Email",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"invoice\": {\n        \n        \"email_recipients\": [\n            \"example@freshbooks.com\",\n            \"example2@freshbooks.com\"\n        ],\n        \"invoice_customized_email\": {\n        \"subject\": \"::company name:: has sent you an invoice (::invoice number::)\",\n                \"body\":\"::company name:: sent you invoice (::invoice number::) for ::invoice amount:: that's due on ::invoice due date::\"\n            },\n            \"action_email\": true\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/invoices/invoices/{{invoiceid}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountid}}",
        "invoices",
        "invoices",
        "{{invoiceid}}"
      ]
    }
  },
  "response": [
  ]
}