Chilkat Online Tools

Swift / New FreshBooks / Profit/Loss Report

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"
    http.SetRequestHeader("Content-Type", value: "application/json")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/profitloss_entity", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    var description: String?
    var entry_type: String?
    var totalAmount: String?
    var totalCode: String?
    var j: Int
    var count_j: Int
    var k: Int
    var count_k: Int

    var Cash_based: Bool = jResp.BoolOf("response.result.profitloss.cash_based")
    var Company_name: String? = jResp.StringOf("response.result.profitloss.company_name")
    var Currency_code: String? = jResp.StringOf("response.result.profitloss.currency_code")
    var Download_token: String? = jResp.StringOf("response.result.profitloss.download_token")
    var End_date: String? = jResp.StringOf("response.result.profitloss.end_date")
    var Description: String? = jResp.StringOf("response.result.profitloss.net_profit.description")
    var Entry_type: String? = jResp.StringOf("response.result.profitloss.net_profit.entry_type")
    var Amount: String? = jResp.StringOf("response.result.profitloss.net_profit.total.amount")
    var Code: String? = jResp.StringOf("response.result.profitloss.net_profit.total.code")
    var Resolution: String? = jResp.StringOf("response.result.profitloss.resolution")
    var Start_date: String? = jResp.StringOf("response.result.profitloss.start_date")
    var Total_expensesDescription: String? = jResp.StringOf("response.result.profitloss.total_expenses.description")
    var Total_expensesEntry_type: String? = jResp.StringOf("response.result.profitloss.total_expenses.entry_type")
    var TotalAmount: String? = jResp.StringOf("response.result.profitloss.total_expenses.total.amount")
    var TotalCode: String? = jResp.StringOf("response.result.profitloss.total_expenses.total.code")
    var Total_incomeDescription: String? = jResp.StringOf("response.result.profitloss.total_income.description")
    var Total_incomeEntry_type: String? = jResp.StringOf("response.result.profitloss.total_income.entry_type")
    TotalAmount = jResp.StringOf("response.result.profitloss.total_income.total.amount")
    TotalCode = jResp.StringOf("response.result.profitloss.total_income.total.code")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("response.result.profitloss.expenses").intValue
    while i < count_i {
        jResp.I = i
        description = jResp.StringOf("response.result.profitloss.expenses[i].description")
        entry_type = jResp.StringOf("response.result.profitloss.expenses[i].entry_type")
        totalAmount = jResp.StringOf("response.result.profitloss.expenses[i].total.amount")
        totalCode = jResp.StringOf("response.result.profitloss.expenses[i].total.code")
        j = 0
        count_j = jResp.SizeOfArray("response.result.profitloss.expenses[i].children").intValue
        while j < count_j {
            jResp.J = j
            description = jResp.StringOf("response.result.profitloss.expenses[i].children[j].description")
            entry_type = jResp.StringOf("response.result.profitloss.expenses[i].children[j].entry_type")
            totalAmount = jResp.StringOf("response.result.profitloss.expenses[i].children[j].total.amount")
            totalCode = jResp.StringOf("response.result.profitloss.expenses[i].children[j].total.code")
            k = 0
            count_k = jResp.SizeOfArray("response.result.profitloss.expenses[i].children[j].children").intValue
            while k < count_k {
                jResp.K = k
                k = k + 1
            }

            k = 0
            count_k = jResp.SizeOfArray("response.result.profitloss.expenses[i].children[j].data").intValue
            while k < count_k {
                jResp.K = k
                k = k + 1
            }

            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("response.result.profitloss.expenses[i].data").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.income").intValue
    while i < count_i {
        jResp.I = i
        description = jResp.StringOf("response.result.profitloss.income[i].description")
        entry_type = jResp.StringOf("response.result.profitloss.income[i].entry_type")
        totalAmount = jResp.StringOf("response.result.profitloss.income[i].total.amount")
        totalCode = jResp.StringOf("response.result.profitloss.income[i].total.code")
        j = 0
        count_j = jResp.SizeOfArray("response.result.profitloss.income[i].children").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("response.result.profitloss.income[i].data").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.labels").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.net_profit.children").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.net_profit.data").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.total_expenses.children").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.total_expenses.data").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.total_income.children").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.result.profitloss.total_income.data").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

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