Node.js / New FreshBooks / Sales Tax Summary
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;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("start_date","2019-01-01");
queryParams.UpdateString("end_date","2019-05-01");
queryParams.UpdateString("currency_code","USD");
queryParams.UpdateString("cash_based","true");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "taxsummary": {
// "cash_based": true,
// "currency_code": "USD",
// "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJ0YXhzdW1tYXJ5IiwicGFyYW1zIjp7InN0YXJ0X2RhdGUiOiIyMDE5LTAxLTAxIiwiZW5kX2RhdGUiOiIyMDE5LTA1LTAxIiwiY3VycmVuY3lfY29kZSI6IlVTRCIsImNhc2hfYmFzZWQiOnRydWV9LCJpYXQiOjE1NTYxMzA2MTksImV4cCI6MTU1ODcyMjYxOX0.7Ewyvilpqg_TzcPjGm70jfkLZhg-jAm6N0i5QJICrl8",
// "end_date": "2019-05-01",
// "start_date": "2019-01-01",
// "taxes": [
// {
// "net_tax": {
// "amount": "-659.42",
// "code": "USD"
// },
// "net_taxable_amount": {
// "amount": "-4815.57",
// "code": "USD"
// },
// "tax_collected": {
// "amount": "146.00",
// "code": "USD"
// },
// "tax_name": "HST",
// "tax_paid": {
// "amount": "805.42",
// "code": "USD"
// },
// "taxable_amount_collected": {
// "amount": "1380.00",
// "code": "USD"
// },
// "taxable_amount_paid": {
// "amount": "6195.57",
// "code": "USD"
// }
// },
// {
// "net_tax": {
// "amount": "-18.34",
// "code": "USD"
// },
// "net_taxable_amount": {
// "amount": "-141.12",
// "code": "USD"
// },
// "tax_collected": {
// "amount": "0.00",
// "code": "USD"
// },
// "tax_name": "other tax",
// "tax_paid": {
// "amount": "18.34",
// "code": "USD"
// },
// "taxable_amount_collected": {
// "amount": "0.00",
// "code": "USD"
// },
// "taxable_amount_paid": {
// "amount": "141.12",
// "code": "USD"
// }
// }
// ],
// "total_invoiced": {
// "amount": "9891.00",
// "code": "USD"
// }
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var net_taxAmount;
var net_taxCode;
var net_taxable_amountAmount;
var net_taxable_amountCode;
var tax_collectedAmount;
var tax_collectedCode;
var tax_name;
var tax_paidAmount;
var tax_paidCode;
var taxable_amount_collectedAmount;
var taxable_amount_collectedCode;
var taxable_amount_paidAmount;
var taxable_amount_paidCode;
var Cash_based = jResp.BoolOf("response.result.taxsummary.cash_based");
var Currency_code = jResp.StringOf("response.result.taxsummary.currency_code");
var Download_token = jResp.StringOf("response.result.taxsummary.download_token");
var End_date = jResp.StringOf("response.result.taxsummary.end_date");
var Start_date = jResp.StringOf("response.result.taxsummary.start_date");
var Amount = jResp.StringOf("response.result.taxsummary.total_invoiced.amount");
var Code = jResp.StringOf("response.result.taxsummary.total_invoiced.code");
var i = 0;
var count_i = jResp.SizeOfArray("response.result.taxsummary.taxes");
while (i < count_i) {
jResp.I = i;
net_taxAmount = jResp.StringOf("response.result.taxsummary.taxes[i].net_tax.amount");
net_taxCode = jResp.StringOf("response.result.taxsummary.taxes[i].net_tax.code");
net_taxable_amountAmount = jResp.StringOf("response.result.taxsummary.taxes[i].net_taxable_amount.amount");
net_taxable_amountCode = jResp.StringOf("response.result.taxsummary.taxes[i].net_taxable_amount.code");
tax_collectedAmount = jResp.StringOf("response.result.taxsummary.taxes[i].tax_collected.amount");
tax_collectedCode = jResp.StringOf("response.result.taxsummary.taxes[i].tax_collected.code");
tax_name = jResp.StringOf("response.result.taxsummary.taxes[i].tax_name");
tax_paidAmount = jResp.StringOf("response.result.taxsummary.taxes[i].tax_paid.amount");
tax_paidCode = jResp.StringOf("response.result.taxsummary.taxes[i].tax_paid.code");
taxable_amount_collectedAmount = jResp.StringOf("response.result.taxsummary.taxes[i].taxable_amount_collected.amount");
taxable_amount_collectedCode = jResp.StringOf("response.result.taxsummary.taxes[i].taxable_amount_collected.code");
taxable_amount_paidAmount = jResp.StringOf("response.result.taxsummary.taxes[i].taxable_amount_paid.amount");
taxable_amount_paidCode = jResp.StringOf("response.result.taxsummary.taxes[i].taxable_amount_paid.code");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -G -d "start_date=2019-01-01"
-d "end_date=2019-05-01"
-d "currency_code=USD"
-d "cash_based=true"
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary
Postman Collection Item JSON
{
"name": "Sales Tax Summary",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary?start_date=2019-01-01&end_date=2019-05-01¤cy_code=USD&cash_based=true",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"taxsummary"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`"
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`"
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`"
},
{
"key": "cash_based",
"value": "true",
"description": "True ignores billed payments and uses just collected payments i.e. `true`, `false`"
}
]
}
},
"response": [
{
"name": "Sales Tax Summary",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary?start_date=2019-01-01&end_date=2019-05-01¤cy_code=USD&cash_based=true",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"taxsummary"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`"
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`"
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`"
},
{
"key": "cash_based",
"value": "true",
"description": "True ignores billed payments and uses just collected payments i.e. `true`, `false`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwldUVMPAgRTVwUEB1JRUVEcTwlOGghQUAJQAVQIUwsHAFAHUwRBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:30: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:30: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 \"taxsummary\": {\n \"cash_based\": true,\n \"currency_code\": \"USD\",\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJ0YXhzdW1tYXJ5IiwicGFyYW1zIjp7InN0YXJ0X2RhdGUiOiIyMDE5LTAxLTAxIiwiZW5kX2RhdGUiOiIyMDE5LTA1LTAxIiwiY3VycmVuY3lfY29kZSI6IlVTRCIsImNhc2hfYmFzZWQiOnRydWV9LCJpYXQiOjE1NTYxMzA2MTksImV4cCI6MTU1ODcyMjYxOX0.7Ewyvilpqg_TzcPjGm70jfkLZhg-jAm6N0i5QJICrl8\",\n \"end_date\": \"2019-05-01\",\n \"start_date\": \"2019-01-01\",\n \"taxes\": [\n {\n \"net_tax\": {\n \"amount\": \"-659.42\",\n \"code\": \"USD\"\n },\n \"net_taxable_amount\": {\n \"amount\": \"-4815.57\",\n \"code\": \"USD\"\n },\n \"tax_collected\": {\n \"amount\": \"146.00\",\n \"code\": \"USD\"\n },\n \"tax_name\": \"HST\",\n \"tax_paid\": {\n \"amount\": \"805.42\",\n \"code\": \"USD\"\n },\n \"taxable_amount_collected\": {\n \"amount\": \"1380.00\",\n \"code\": \"USD\"\n },\n \"taxable_amount_paid\": {\n \"amount\": \"6195.57\",\n \"code\": \"USD\"\n }\n },\n {\n \"net_tax\": {\n \"amount\": \"-18.34\",\n \"code\": \"USD\"\n },\n \"net_taxable_amount\": {\n \"amount\": \"-141.12\",\n \"code\": \"USD\"\n },\n \"tax_collected\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"tax_name\": \"other tax\",\n \"tax_paid\": {\n \"amount\": \"18.34\",\n \"code\": \"USD\"\n },\n \"taxable_amount_collected\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"taxable_amount_paid\": {\n \"amount\": \"141.12\",\n \"code\": \"USD\"\n }\n }\n ],\n \"total_invoiced\": {\n \"amount\": \"9891.00\",\n \"code\": \"USD\"\n }\n }\n }\n }\n}"
}
]
}
