Python / New FreshBooks / Revenue By Client
Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
queryParams = chilkat2.JsonObject()
queryParams.UpdateString("sales_type","collected")
# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/revenue_by_client",queryParams)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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
Currency_code = jResp.StringOf("response.result.revenue_by_client.currency_code")
Download_token = jResp.StringOf("response.result.revenue_by_client.download_token")
End_date = jResp.StringOf("response.result.revenue_by_client.end_date")
Sales_type = jResp.StringOf("response.result.revenue_by_client.sales_type")
Start_date = jResp.StringOf("response.result.revenue_by_client.start_date")
Amount = jResp.StringOf("response.result.revenue_by_client.total_sales.amount")
Code = jResp.StringOf("response.result.revenue_by_client.total_sales.code")
i = 0
count_i = jResp.SizeOfArray("response.result.revenue_by_client.clientids")
while i < count_i :
jResp.I = i
i = i + 1
i = 0
count_i = jResp.SizeOfArray("response.result.revenue_by_client.clients")
while i < count_i :
jResp.I = i
i = i + 1
i = 0
count_i = jResp.SizeOfArray("response.result.revenue_by_client.labels")
while i < count_i :
jResp.I = i
strVal = jResp.StringOf("response.result.revenue_by_client.labels[i]")
i = i + 1
i = 0
count_i = jResp.SizeOfArray("response.result.revenue_by_client.total_sales_data")
while i < count_i :
jResp.I = i
amount = jResp.StringOf("response.result.revenue_by_client.total_sales_data[i].amount")
code = jResp.StringOf("response.result.revenue_by_client.total_sales_data[i].code")
i = i + 1
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}"
}
]
}
