Chilkat Online Tools

unicodeC / New FreshBooks / Sales Tax Summary

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *net_taxAmount;
    const wchar_t *net_taxCode;
    const wchar_t *net_taxable_amountAmount;
    const wchar_t *net_taxable_amountCode;
    const wchar_t *tax_collectedAmount;
    const wchar_t *tax_collectedCode;
    const wchar_t *tax_name;
    const wchar_t *tax_paidAmount;
    const wchar_t *tax_paidCode;
    const wchar_t *taxable_amount_collectedAmount;
    const wchar_t *taxable_amount_collectedCode;
    const wchar_t *taxable_amount_paidAmount;
    const wchar_t *taxable_amount_paidCode;
    BOOL Cash_based;
    const wchar_t *Currency_code;
    const wchar_t *Download_token;
    const wchar_t *End_date;
    const wchar_t *Start_date;
    const wchar_t *Amount;
    const wchar_t *Code;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"start_date",L"2019-01-01");
    CkJsonObjectW_UpdateString(queryParams,L"end_date",L"2019-05-01");
    CkJsonObjectW_UpdateString(queryParams,L"currency_code",L"USD");
    CkJsonObjectW_UpdateString(queryParams,L"cash_based",L"true");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Cash_based = CkJsonObjectW_BoolOf(jResp,L"response.result.taxsummary.cash_based");
    Currency_code = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.currency_code");
    Download_token = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.download_token");
    End_date = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.end_date");
    Start_date = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.start_date");
    Amount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.total_invoiced.amount");
    Code = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.total_invoiced.code");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"response.result.taxsummary.taxes");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        net_taxAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].net_tax.amount");
        net_taxCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].net_tax.code");
        net_taxable_amountAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].net_taxable_amount.amount");
        net_taxable_amountCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].net_taxable_amount.code");
        tax_collectedAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].tax_collected.amount");
        tax_collectedCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].tax_collected.code");
        tax_name = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].tax_name");
        tax_paidAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].tax_paid.amount");
        tax_paidCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].tax_paid.code");
        taxable_amount_collectedAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].taxable_amount_collected.amount");
        taxable_amount_collectedCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].taxable_amount_collected.code");
        taxable_amount_paidAmount = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].taxable_amount_paid.amount");
        taxable_amount_paidCode = CkJsonObjectW_stringOf(jResp,L"response.result.taxsummary.taxes[i].taxable_amount_paid.code");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

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&currency_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&currency_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}"
    }
  ]
}