DataFlex / New FreshBooks / Profit/Loss Report
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sDescription
String sEntry_type
String sTotalAmount
String sTotalCode
Integer j
Integer iCount_j
Integer k
Integer iCount_k
Boolean iCash_based
String sCompany_name
String sCurrency_code
String sDownload_token
String sEnd_date
String sDescription
String sEntry_type
String sAmount
String sCode
String sResolution
String sStart_date
String sTotal_expensesDescription
String sTotal_expensesEntry_type
String sTotalAmount
String sTotalCode
String sTotal_incomeDescription
String sTotal_incomeEntry_type
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/profitloss_entity" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "profitloss": {
// "cash_based": false,
// "company_name": "Postman Sandbox",
// "currency_code": "USD",
// "download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJwcm9maXRsb3NzIiwicGFyYW1zIjp7InN0YXJ0X2RhdGUiOiIyMDE5LTA0LTI0IiwiZW5kX2RhdGUiOiIyMDE5LTA0LTI0IiwicmVzb2x1dGlvbiI6bnVsbCwiY3VycmVuY3lfY29kZSI6IlVTRCIsImNhc2hfYmFzZWQiOmZhbHNlLCJyZXBvcnRfbW9kZSI6Im1vZGVybl9lbnRpdHkifSwiaWF0IjoxNTU2MTMwNTkzLCJleHAiOjE1NTg3MjI1OTN9.YbSTjVO5hTVP_l2bo0w2m5i_11IlLBD_KePsJp5FPIg",
// "end_date": "2019-04-24",
// "expenses": [
// {
// "children": [
// {
// "children": [
// ],
// "data": [
// ],
// "description": "Gas",
// "entry_type": "debit",
// "total": {
// "amount": "141.12",
// "code": "USD"
// }
// }
// ],
// "data": [
// ],
// "description": "Car & Truck Expenses",
// "entry_type": "debit",
// "total": {
// "amount": "141.12",
// "code": "USD"
// }
// }
// ],
// "income": [
// {
// "children": [
// ],
// "data": [
// ],
// "description": "Sales",
// "entry_type": "credit",
// "total": {
// "amount": "0.00",
// "code": "USD"
// }
// },
// {
// "children": [
// ],
// "data": [
// ],
// "description": "Cost of Goods Sold",
// "entry_type": "credit",
// "total": {
// "amount": "0.00",
// "code": "USD"
// }
// }
// ],
// "labels": [
// ],
// "net_profit": {
// "children": [
// ],
// "data": [
// ],
// "description": "Net Profit (USD)",
// "entry_type": "credit",
// "total": {
// "amount": "-141.12",
// "code": "USD"
// }
// },
// "resolution": null,
// "start_date": "2019-04-24",
// "total_expenses": {
// "children": [
// ],
// "data": [
// ],
// "description": "Total Expenses",
// "entry_type": "debit",
// "total": {
// "amount": "141.12",
// "code": "USD"
// }
// },
// "total_income": {
// "children": [
// ],
// "data": [
// ],
// "description": "Gross Profit",
// "entry_type": "credit",
// "total": {
// "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
Get ComBoolOf Of hoJResp "response.result.profitloss.cash_based" To iCash_based
Get ComStringOf Of hoJResp "response.result.profitloss.company_name" To sCompany_name
Get ComStringOf Of hoJResp "response.result.profitloss.currency_code" To sCurrency_code
Get ComStringOf Of hoJResp "response.result.profitloss.download_token" To sDownload_token
Get ComStringOf Of hoJResp "response.result.profitloss.end_date" To sEnd_date
Get ComStringOf Of hoJResp "response.result.profitloss.net_profit.description" To sDescription
Get ComStringOf Of hoJResp "response.result.profitloss.net_profit.entry_type" To sEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.net_profit.total.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.profitloss.net_profit.total.code" To sCode
Get ComStringOf Of hoJResp "response.result.profitloss.resolution" To sResolution
Get ComStringOf Of hoJResp "response.result.profitloss.start_date" To sStart_date
Get ComStringOf Of hoJResp "response.result.profitloss.total_expenses.description" To sTotal_expensesDescription
Get ComStringOf Of hoJResp "response.result.profitloss.total_expenses.entry_type" To sTotal_expensesEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.total_expenses.total.amount" To sTotalAmount
Get ComStringOf Of hoJResp "response.result.profitloss.total_expenses.total.code" To sTotalCode
Get ComStringOf Of hoJResp "response.result.profitloss.total_income.description" To sTotal_incomeDescription
Get ComStringOf Of hoJResp "response.result.profitloss.total_income.entry_type" To sTotal_incomeEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.total_income.total.amount" To sTotalAmount
Get ComStringOf Of hoJResp "response.result.profitloss.total_income.total.code" To sTotalCode
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.expenses" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].description" To sDescription
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].entry_type" To sEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].total.amount" To sTotalAmount
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].total.code" To sTotalCode
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.profitloss.expenses[i].children" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].children[j].description" To sDescription
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].children[j].entry_type" To sEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].children[j].total.amount" To sTotalAmount
Get ComStringOf Of hoJResp "response.result.profitloss.expenses[i].children[j].total.code" To sTotalCode
Move 0 To k
Get ComSizeOfArray Of hoJResp "response.result.profitloss.expenses[i].children[j].children" To iCount_k
While (k < iCount_k)
Set ComK Of hoJResp To k
Move (k + 1) To k
Loop
Move 0 To k
Get ComSizeOfArray Of hoJResp "response.result.profitloss.expenses[i].children[j].data" To iCount_k
While (k < iCount_k)
Set ComK Of hoJResp To k
Move (k + 1) To k
Loop
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.profitloss.expenses[i].data" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.income" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "response.result.profitloss.income[i].description" To sDescription
Get ComStringOf Of hoJResp "response.result.profitloss.income[i].entry_type" To sEntry_type
Get ComStringOf Of hoJResp "response.result.profitloss.income[i].total.amount" To sTotalAmount
Get ComStringOf Of hoJResp "response.result.profitloss.income[i].total.code" To sTotalCode
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.profitloss.income[i].children" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "response.result.profitloss.income[i].data" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.labels" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.net_profit.children" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.net_profit.data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.total_expenses.children" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.total_expenses.data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.total_income.children" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.result.profitloss.total_income.data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/profitloss_entity
Postman Collection Item JSON
{
"name": "Profit/Loss Report",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/profitloss_entity",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"profitloss_entity"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
},
{
"key": "cash_based",
"value": "false",
"description": "True ignores billed payments and uses just collected payments i.e. `true`, `false`",
"disabled": true
},
{
"key": "resolution",
"value": "3m",
"description": "specifies how often data is calculated and stored. For example, \"3m\" would specify to return data grouped in three month intervals. i.e. `\"3m\"`",
"disabled": true
}
]
},
"description": "The Profit/Loss Report shows all the information involving both your profits and losses"
},
"response": [
{
"name": "Profit/Loss Report",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/profitloss_entity",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"reports",
"accounting",
"profitloss_entity"
],
"query": [
{
"key": "start_date",
"value": "2019-01-01",
"description": "created during or after the given date i.e. `2019-01-01`",
"disabled": true
},
{
"key": "end_date",
"value": "2019-05-01",
"description": "created during or before the given date i.e. `2019-05-01`",
"disabled": true
},
{
"key": "currency_code",
"value": "USD",
"description": "reports using the given currency as primary currency i.e. `\"USD\"`",
"disabled": true
},
{
"key": "cash_based",
"value": "false",
"description": "True ignores billed payments and uses just collected payments i.e. `true`, `false`",
"disabled": true
},
{
"key": "resolution",
"value": "3m",
"description": "specifies how often data is calculated and stored. For example, \"3m\" would specify to return data grouped in three month intervals. i.e. `\"3m\"`",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gWVEZcEBIQWFEBWw1NVkBbXQJLBEEOQRYXFBtRSlMWAgVRWFAHBAdTUQMFBVpXVVYcTwlOGg8GUwIDC1JSVwpQVQ8BVwBBFFVRCBIHag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:29:53 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:29:53 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 \"profitloss\": {\n \"cash_based\": false,\n \"company_name\": \"Postman Sandbox\",\n \"currency_code\": \"USD\",\n \"download_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJwcm9maXRsb3NzIiwicGFyYW1zIjp7InN0YXJ0X2RhdGUiOiIyMDE5LTA0LTI0IiwiZW5kX2RhdGUiOiIyMDE5LTA0LTI0IiwicmVzb2x1dGlvbiI6bnVsbCwiY3VycmVuY3lfY29kZSI6IlVTRCIsImNhc2hfYmFzZWQiOmZhbHNlLCJyZXBvcnRfbW9kZSI6Im1vZGVybl9lbnRpdHkifSwiaWF0IjoxNTU2MTMwNTkzLCJleHAiOjE1NTg3MjI1OTN9.YbSTjVO5hTVP_l2bo0w2m5i_11IlLBD_KePsJp5FPIg\",\n \"end_date\": \"2019-04-24\",\n \"expenses\": [\n {\n \"children\": [\n {\n \"children\": [],\n \"data\": [],\n \"description\": \"Gas\",\n \"entry_type\": \"debit\",\n \"total\": {\n \"amount\": \"141.12\",\n \"code\": \"USD\"\n }\n }\n ],\n \"data\": [],\n \"description\": \"Car & Truck Expenses\",\n \"entry_type\": \"debit\",\n \"total\": {\n \"amount\": \"141.12\",\n \"code\": \"USD\"\n }\n }\n ],\n \"income\": [\n {\n \"children\": [],\n \"data\": [],\n \"description\": \"Sales\",\n \"entry_type\": \"credit\",\n \"total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n }\n },\n {\n \"children\": [],\n \"data\": [],\n \"description\": \"Cost of Goods Sold\",\n \"entry_type\": \"credit\",\n \"total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n }\n }\n ],\n \"labels\": [],\n \"net_profit\": {\n \"children\": [],\n \"data\": [],\n \"description\": \"Net Profit (USD)\",\n \"entry_type\": \"credit\",\n \"total\": {\n \"amount\": \"-141.12\",\n \"code\": \"USD\"\n }\n },\n \"resolution\": null,\n \"start_date\": \"2019-04-24\",\n \"total_expenses\": {\n \"children\": [],\n \"data\": [],\n \"description\": \"Total Expenses\",\n \"entry_type\": \"debit\",\n \"total\": {\n \"amount\": \"141.12\",\n \"code\": \"USD\"\n }\n },\n \"total_income\": {\n \"children\": [],\n \"data\": [],\n \"description\": \"Gross Profit\",\n \"entry_type\": \"credit\",\n \"total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n }\n }\n }\n }\n }\n}"
}
]
}
