Chilkat Online Tools

Node.js / New FreshBooks / Single Invoice

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;

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "response": {
    //     "result": {
    //       "invoice": {
    //         "accountid": "wkMd2g",
    //         "accounting_systemid": "wkMd2g",
    //         "address": "",
    //         "amount": {
    //           "amount": "180.00",
    //           "code": "USD"
    //         },
    //         "auto_bill": false,
    //         "autobill_status": null,
    //         "basecampid": 0,
    //         "city": "",
    //         "code": "",
    //         "country": "Canada",
    //         "create_date": "2019-04-20",
    //         "created_at": "2019-04-22 10:50:19",
    //         "currency_code": "USD",
    //         "current_organization": "first company",
    //         "customerid": 31006,
    //         "date_paid": null,
    //         "deposit_amount": null,
    //         "deposit_percentage": null,
    //         "deposit_status": "none",
    //         "description": "",
    //         "discount_description": null,
    //         "discount_total": {
    //           "amount": "0.00",
    //           "code": "USD"
    //         },
    //         "discount_value": "0",
    //         "display_status": "viewed",
    //         "dispute_status": null,
    //         "due_date": "2019-04-20",
    //         "due_offset_days": 0,
    //         "estimateid": 0,
    //         "ext_archive": 0,
    //         "fname": "Client",
    //         "fulfillment_date": "2019-04-20",
    //         "generation_date": null,
    //         "gmail": false,
    //         "id": 29618,
    //         "invoice_number": "0000012",
    //         "invoiceid": 29618,
    //         "language": "en",
    //         "last_order_status": null,
    //         "lname": "one",
    //         "notes": "",
    //         "organization": "first company",
    //         "outstanding": {
    //           "amount": "180.00",
    //           "code": "USD"
    //         },
    //         "ownerid": 31004,
    //         "paid": {
    //           "amount": "0.00",
    //           "code": "USD"
    //         },
    //         "parent": 0,
    //         "payment_details": "",
    //         "payment_status": "unpaid",
    //         "po_number": null,
    //         "province": "",
    //         "return_uri": null,
    //         "sentid": 31004,
    //         "show_attachments": true,
    //         "status": 3,
    //         "street": "",
    //         "street2": "",
    //         "template": "clean-grouped",
    //         "terms": "",
    //         "updated": "2019-04-23 17:59:12",
    //         "v3_status": "overdue",
    //         "vat_name": "",
    //         "vat_number": "",
    //         "vis_state": 0
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Date_paid = new chilkat.DtObj();

    var Accountid = jResp.StringOf("response.result.invoice.accountid");
    var Accounting_systemid = jResp.StringOf("response.result.invoice.accounting_systemid");
    var Address = jResp.StringOf("response.result.invoice.address");
    var Amount = jResp.StringOf("response.result.invoice.amount.amount");
    var Code = jResp.StringOf("response.result.invoice.amount.code");
    var Auto_bill = jResp.BoolOf("response.result.invoice.auto_bill");
    var Autobill_status = jResp.StringOf("response.result.invoice.autobill_status");
    var Basecampid = jResp.IntOf("response.result.invoice.basecampid");
    var City = jResp.StringOf("response.result.invoice.city");
    var InvoiceCode = jResp.StringOf("response.result.invoice.code");
    var Country = jResp.StringOf("response.result.invoice.country");
    var Create_date = jResp.StringOf("response.result.invoice.create_date");
    var Created_at = jResp.StringOf("response.result.invoice.created_at");
    var Currency_code = jResp.StringOf("response.result.invoice.currency_code");
    var Current_organization = jResp.StringOf("response.result.invoice.current_organization");
    var Customerid = jResp.IntOf("response.result.invoice.customerid");
    jResp.DtOf("response.result.invoice.date_paid",false,Date_paid);
    var Deposit_amount = jResp.StringOf("response.result.invoice.deposit_amount");
    var Deposit_percentage = jResp.StringOf("response.result.invoice.deposit_percentage");
    var Deposit_status = jResp.StringOf("response.result.invoice.deposit_status");
    var Description = jResp.StringOf("response.result.invoice.description");
    var Discount_description = jResp.StringOf("response.result.invoice.discount_description");
    var Discount_totalAmount = jResp.StringOf("response.result.invoice.discount_total.amount");
    var Discount_totalCode = jResp.StringOf("response.result.invoice.discount_total.code");
    var Discount_value = jResp.StringOf("response.result.invoice.discount_value");
    var Display_status = jResp.StringOf("response.result.invoice.display_status");
    var Dispute_status = jResp.StringOf("response.result.invoice.dispute_status");
    var Due_date = jResp.StringOf("response.result.invoice.due_date");
    var Due_offset_days = jResp.IntOf("response.result.invoice.due_offset_days");
    var Estimateid = jResp.IntOf("response.result.invoice.estimateid");
    var Ext_archive = jResp.IntOf("response.result.invoice.ext_archive");
    var Fname = jResp.StringOf("response.result.invoice.fname");
    var Fulfillment_date = jResp.StringOf("response.result.invoice.fulfillment_date");
    var Generation_date = jResp.StringOf("response.result.invoice.generation_date");
    var Gmail = jResp.BoolOf("response.result.invoice.gmail");
    var Id = jResp.IntOf("response.result.invoice.id");
    var Invoice_number = jResp.StringOf("response.result.invoice.invoice_number");
    var Invoiceid = jResp.IntOf("response.result.invoice.invoiceid");
    var Language = jResp.StringOf("response.result.invoice.language");
    var Last_order_status = jResp.StringOf("response.result.invoice.last_order_status");
    var Lname = jResp.StringOf("response.result.invoice.lname");
    var Notes = jResp.StringOf("response.result.invoice.notes");
    var Organization = jResp.StringOf("response.result.invoice.organization");
    var OutstandingAmount = jResp.StringOf("response.result.invoice.outstanding.amount");
    var OutstandingCode = jResp.StringOf("response.result.invoice.outstanding.code");
    var Ownerid = jResp.IntOf("response.result.invoice.ownerid");
    var PaidAmount = jResp.StringOf("response.result.invoice.paid.amount");
    var PaidCode = jResp.StringOf("response.result.invoice.paid.code");
    var Parent = jResp.IntOf("response.result.invoice.parent");
    var Payment_details = jResp.StringOf("response.result.invoice.payment_details");
    var Payment_status = jResp.StringOf("response.result.invoice.payment_status");
    var Po_number = jResp.StringOf("response.result.invoice.po_number");
    var Province = jResp.StringOf("response.result.invoice.province");
    var Return_uri = jResp.StringOf("response.result.invoice.return_uri");
    var Sentid = jResp.IntOf("response.result.invoice.sentid");
    var Show_attachments = jResp.BoolOf("response.result.invoice.show_attachments");
    var Status = jResp.IntOf("response.result.invoice.status");
    var Street = jResp.StringOf("response.result.invoice.street");
    var Street2 = jResp.StringOf("response.result.invoice.street2");
    var Template = jResp.StringOf("response.result.invoice.template");
    var Terms = jResp.StringOf("response.result.invoice.terms");
    var Updated = jResp.StringOf("response.result.invoice.updated");
    var V3_status = jResp.StringOf("response.result.invoice.v3_status");
    var Vat_name = jResp.StringOf("response.result.invoice.vat_name");
    var Vat_number = jResp.StringOf("response.result.invoice.vat_number");
    var Vis_state = jResp.IntOf("response.result.invoice.vis_state");

}

chilkatExample();

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceId}}

Postman Collection Item JSON

{
  "name": "Single Invoice",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"invoiceId\", jsonData.response.result.invoice.id);",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "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": [
    {
      "name": "Single Invoice",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "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}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXEUkJTQFPA1pXAAVTUlYNBglSWFAECQRKSQAaEQZTUAYAUw5QWgpXUwtUD1ATTVUDCEVSPA=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:05:19 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:05:19 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"invoice\": {\n                \"accountid\": \"wkMd2g\",\n                \"accounting_systemid\": \"wkMd2g\",\n                \"address\": \"\",\n                \"amount\": {\n                    \"amount\": \"180.00\",\n                    \"code\": \"USD\"\n                },\n                \"auto_bill\": false,\n                \"autobill_status\": null,\n                \"basecampid\": 0,\n                \"city\": \"\",\n                \"code\": \"\",\n                \"country\": \"Canada\",\n                \"create_date\": \"2019-04-20\",\n                \"created_at\": \"2019-04-22 10:50:19\",\n                \"currency_code\": \"USD\",\n                \"current_organization\": \"first company\",\n                \"customerid\": 31006,\n                \"date_paid\": null,\n                \"deposit_amount\": null,\n                \"deposit_percentage\": null,\n                \"deposit_status\": \"none\",\n                \"description\": \"\",\n                \"discount_description\": null,\n                \"discount_total\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"USD\"\n                },\n                \"discount_value\": \"0\",\n                \"display_status\": \"viewed\",\n                \"dispute_status\": null,\n                \"due_date\": \"2019-04-20\",\n                \"due_offset_days\": 0,\n                \"estimateid\": 0,\n                \"ext_archive\": 0,\n                \"fname\": \"Client\",\n                \"fulfillment_date\": \"2019-04-20\",\n                \"generation_date\": null,\n                \"gmail\": false,\n                \"id\": 29618,\n                \"invoice_number\": \"0000012\",\n                \"invoiceid\": 29618,\n                \"language\": \"en\",\n                \"last_order_status\": null,\n                \"lname\": \"one\",\n                \"notes\": \"\",\n                \"organization\": \"first company\",\n                \"outstanding\": {\n                    \"amount\": \"180.00\",\n                    \"code\": \"USD\"\n                },\n                \"ownerid\": 31004,\n                \"paid\": {\n                    \"amount\": \"0.00\",\n                    \"code\": \"USD\"\n                },\n                \"parent\": 0,\n                \"payment_details\": \"\",\n                \"payment_status\": \"unpaid\",\n                \"po_number\": null,\n                \"province\": \"\",\n                \"return_uri\": null,\n                \"sentid\": 31004,\n                \"show_attachments\": true,\n                \"status\": 3,\n                \"street\": \"\",\n                \"street2\": \"\",\n                \"template\": \"clean-grouped\",\n                \"terms\": \"\",\n                \"updated\": \"2019-04-23 17:59:12\",\n                \"v3_status\": \"overdue\",\n                \"vat_name\": \"\",\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}