PureBasic / New FreshBooks / Revenue By Client
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,"sales_type","collected")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client",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": {
; "revenue_by_client": {
; "clientids": [
; ],
; "clients": [
; ],
; "currency_code": "USD",
; "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJyZXZlbnVlX2J5X2NsaWVudCIsInBhcmFtcyI6eyJzdGFydF9kYXRlIjoiMjAxOS0wNC0yNCIsImVuZF9kYXRlIjoiMjAxOS0wNC0yNCIsImN1cnJlbmN5X2NvZGUiOiJVU0QiLCJjbGllbnRpZHMiOm51bGwsInNhbGVzX3R5cGUiOiJjb2xsZWN0ZWQifSwiaWF0IjoxNTU2MTMwNjc4LCJleHAiOjE1NTg3MjI2Nzh9.0jW6aVkfU850-zwX3YdShkwl6v9T0WGKZZKWkOKRAi8",
; "end_date": "2019-04-24",
; "labels": [
; "2019-04-01"
; ],
; "sales_type": "collected",
; "start_date": "2019-04-24",
; "total_sales": {
; "amount": "0.00",
; "code": "USD"
; },
; "total_sales_data": [
; {
; "amount": "0.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
strVal.s
amount.s
code.s
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.currency_code")
Download_token.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.download_token")
End_date.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.end_date")
Sales_type.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.sales_type")
Start_date.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.start_date")
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.total_sales.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.total_sales.code")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"response.result.revenue_by_client.clientids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"response.result.revenue_by_client.clients")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"response.result.revenue_by_client.labels")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.labels[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"response.result.revenue_by_client.total_sales_data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
amount = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.total_sales_data[i].amount")
code = CkJsonObject::ckStringOf(jResp,"response.result.revenue_by_client.total_sales_data[i].code")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "sales_type=collected"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client
Postman Collection Item JSON
{
"name": "Revenue By Client",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client?sales_type=collected",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"revenue_by_client"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"disabled": true
},
{
"key": "end_date",
"value": "2019-12-31",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"disabled": true
},
{
"key": "clientids%5B%5D",
"value": "31006",
"disabled": true
},
{
"key": "sales_type",
"value": "collected"
}
]
},
"description": "A breakdown of how much each of your clients is bringing in."
},
"response": [
{
"name": "Revenue By Client",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"revenue_by_client"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"disabled": true
},
{
"key": "end_date",
"value": "2019-12-31",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"disabled": true
},
{
"key": "clientids%5B%5D",
"value": "31006",
"disabled": true
},
{
"key": "sales_type",
"value": "collected",
"disabled": true
}
]
}
},
"status": "UNPROCESSABLE ENTITY",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwddVFQDAgRUXQcEA1FQUlEcTwlOGgwHU1BXCVkIBQRaVARRVwJBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Content-Length",
"value": "227"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:30:56 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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 1004,\n \"field\": \"sales_type\",\n \"message\": \"Invalid value '' for field 'sales_type'.\",\n \"object\": \"report\",\n \"value\": \"\"\n }\n ]\n }\n}"
},
{
"name": "Revenue By Client",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client?sales_type=collected",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"revenue_by_client"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"disabled": true
},
{
"key": "end_date",
"value": "2019-12-31",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"disabled": true
},
{
"key": "clientids%5B%5D",
"value": "31006",
"disabled": true
},
{
"key": "sales_type",
"value": "collected"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAwhXUFUPAw9XUwkCA1dRVVAcTwlOGg9RAgZcXFQAAgMBUg8PUVVBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:31:18 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:31:18 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 \"revenue_by_client\": {\n \"clientids\": [],\n \"clients\": [],\n \"currency_code\": \"USD\",\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJyZXZlbnVlX2J5X2NsaWVudCIsInBhcmFtcyI6eyJzdGFydF9kYXRlIjoiMjAxOS0wNC0yNCIsImVuZF9kYXRlIjoiMjAxOS0wNC0yNCIsImN1cnJlbmN5X2NvZGUiOiJVU0QiLCJjbGllbnRpZHMiOm51bGwsInNhbGVzX3R5cGUiOiJjb2xsZWN0ZWQifSwiaWF0IjoxNTU2MTMwNjc4LCJleHAiOjE1NTg3MjI2Nzh9.0jW6aVkfU850-zwX3YdShkwl6v9T0WGKZZKWkOKRAi8\",\n \"end_date\": \"2019-04-24\",\n \"labels\": [\n \"2019-04-01\"\n ],\n \"sales_type\": \"collected\",\n \"start_date\": \"2019-04-24\",\n \"total_sales\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"total_sales_data\": [\n {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n }\n ]\n }\n }\n }\n}"
}
]
}
