PureBasic / New FreshBooks / Sales Tax Summary
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"start_date","2019-01-01")
CkJsonObject::ckUpdateString(queryParams,"end_date","2019-05-01")
CkJsonObject::ckUpdateString(queryParams,"currency_code","USD")
CkJsonObject::ckUpdateString(queryParams,"cash_based","true")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
net_taxAmount.s
net_taxCode.s
net_taxable_amountAmount.s
net_taxable_amountCode.s
tax_collectedAmount.s
tax_collectedCode.s
tax_name.s
tax_paidAmount.s
tax_paidCode.s
taxable_amount_collectedAmount.s
taxable_amount_collectedCode.s
taxable_amount_paidAmount.s
taxable_amount_paidCode.s
Cash_based.i = CkJsonObject::ckBoolOf(jResp,"response.result.taxsummary.cash_based")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.currency_code")
Download_token.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.download_token")
End_date.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.end_date")
Start_date.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.start_date")
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.total_invoiced.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.total_invoiced.code")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"response.result.taxsummary.taxes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
net_taxAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].net_tax.amount")
net_taxCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].net_tax.code")
net_taxable_amountAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].net_taxable_amount.amount")
net_taxable_amountCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].net_taxable_amount.code")
tax_collectedAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].tax_collected.amount")
tax_collectedCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].tax_collected.code")
tax_name = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].tax_name")
tax_paidAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].tax_paid.amount")
tax_paidCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].tax_paid.code")
taxable_amount_collectedAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].taxable_amount_collected.amount")
taxable_amount_collectedCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].taxable_amount_collected.code")
taxable_amount_paidAmount = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].taxable_amount_paid.amount")
taxable_amount_paidCode = CkJsonObject::ckStringOf(jResp,"response.result.taxsummary.taxes[i].taxable_amount_paid.code")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
