Strategy summary

Before using the functions on this page, you may find it useful to review the following information:

The list of all functions is here.

Description of this function	Get the Assumptions report as JSON Get the Summary report as JSON. Get the chart data for any specific chart within the Summary report Get the data for all Action items
List of functions	`/service/getAssumptionsReport` `/service/getSummaryReports` `/service/getChartRawData` `/service/getActionItems`

The functions described in this section are useful if you want to emulate the ‘Strategy summary’ page (in the 'Results' section) in Pathfinder. That page has two parts:

An Assumptions report
The strategy report, which consists of sections (e.g. Wealth summary, cash reserve) with:
1. A bullet point list
2. One or two charts

`/service/getAssumptionsReport` function

The first call below is how you would get the Assumptions report.

JS

function OnGetAssumptions() {
    var guid = $('#scenarioguid').val();
    OnGetJson('/service/getassumptionsreport', {
        scenarioGuid: guid
    });
}

The sample output from calling that endpoint is as follows.

JS

{
  "ColNames": [
    "Messages",
    "Presentation"
  ],
  "SectionName": "Assumptions",
  "Data": [
    [
      "#p In conducting our analysis, we have made the following assumptions:",
      "f:normal"
    ],
    [
      "#b1 AWOTE 3%pa.",
      "f:normal"
    ],
    [
      "#b1 CPI 2.5%pa.",
      "f:normal"
    ],
    [
      "#b1 Cash account return 0.1% from 2021/22; then 1.7% from 2026/27.",
      "f:normal"
    ],
    [
      "#b1 Returns for Balanced funds inside super:",
      "f:normal"
    ],
    [
      "#b2 Accumulation and TRIS phase of super 4.3%pa (after tax and fees);",
      "f:normal"
    ],
    [
      "#b2 Pension phase of super 4.9%pa (after fees).",
      "f:normal"
    ],
    [
      "#b1 For investment properties:",
      "f:normal"
    ],
    [
      "#b2 Value $540,000 for 'Old investment property' (at start of simulation);",
      "f:normal"
    ],
    [
      "#b2 Value $600,000 for 'New Investment Property' (as at 2021/22);",
      "f:normal"
    ],
    [
      "#b2 Capital growth 2.5%pa;",
      "f:normal"
    ],
    [
      "#b2 Rental income 5%pa;",
      "f:normal"
    ],
    [
      "#b2 Running expenses 1.3%pa;",
      "f:normal"
    ],
    [
      "#b2 Depreciation 1.2%pa;",
      "f:normal"
    ],
    [
      "#b2 Acquisition costs 5% (including stamp duty etc.);",
      "f:normal"
    ],
    [
      "#b2 Disposal costs 2.5%.",
      "f:normal"
    ],
    [
      "#b1 For family home:",
      "f:normal"
    ],
    [
      "#b2 Value $1,200,000 for 'Family home' (at start of simulation);",
      "f:normal"
    ],

`/service/getSummaryReports` function – Get Summary Reports

The call to get the Summary report is as follows.

JS

function OnGetSummary() {// Test 2
    var guid = $('#scenarioguid').val();
    OnGetJson('/service/getsummaryreports', {
        scenarioGuid: guid
    });
}

An edited example of what is returned is as follows.

JS

[
  {
    "Name": "01 Wealth summary",
    "Path": "Data\Actual value reports\SOA summary pages\01 Wealth summary",
    "ReportName": "WealthSummary",
    "Text": "#h2 Wealth summary\r\n#b1 Total net wealth at the end of the analysis $4,701,816 (present value $2,941,116):\r\n#b2 Family home $1,966,340 (present value $1,230,000)\r\n#b2 Total other assets $1,885,885 (present value $1,179,673)\r\n#b2 Home mortgage $0\r\n#b2 Total other liabilities $534,868 (present value $334,575)\r\n#b2 Total Superannuation $1,384,459 (present value $866,018)\r\n#b1 Length of analysis 20 years.",
    "Charts": [
      {
        "Name": "Assets and Loans",
        "Path": "Report Chart\SOA summary charts\WealthSummary\Assets and Loans",
        "Chart": "WealthSummary\Assets and Loans"
      },
      {
        "Name": "Assets Distribution",
        "Path": "Report Chart\SOA summary charts\WealthSummary\Assets Distribution",
        "Chart": "WealthSummary\Assets Distribution"
      }
    ],
    "OwnerName": "Consolidated"
  },
  {
    "Name": "02 Keep a cash reserve goal",
    "Path": "Data\Actual value reports\SOA summary pages\02 Keep a cash reserve goal",
    "ReportName": "CashReserveSummary",
    "Text": "#h2 Cash reserve\r\n#b1 Required cash reserve $30,000\r\n#b1 Highest amount of cash over required reserve $111,157 (reached in year 2023/24)",
    "Charts": [
      {
        "Name": "Balance",
        "Path": "Report Chart\SOA summary charts\CashReserveSummary\Balance",
        "Chart": "CashReserveSummary\Balance"
      }
    ],
    "OwnerName": "Consolidated"
  }
]

`Text` parameter

The Text parameter is the text for that report and contains various “#” codes to indicate the paragraph style:

Code	Meaning
#h1	Heading 1
#h2	Heading 2
#b1	Bullet point level 1
#b2	Bullet point level 2
#p	Paragraph

`Charts` parameter

The Charts section is a list of charts for that report:

Name is the name of the chart
Chart is the name that is used to retrieve the data for that chart.

`OwnerName` parameter

The OwnerName parameter indicates the individual or entity that each report describes. This is similar to the OwnerName parameter in the output returned by the /service/getDataFromReportList function (for more on this function, see here). It may be the name of an SMSF or trust, of take the form “Individual\[Name of Individual]”, or equal “Consolidated” for items that are owned by two or more individuals or for reports that cover the entire case, such as the Wealth summary report, which typically includes everything.

`/service/getChartRawData` function – Get Chart Data

To retrieve the chart data, call code as follows. Note how this call must provide a scenarioGuid. This is the unique identifier appearing in the list of scenarios provided by /service/getScenarios. (For more details, see Scenarios.)

JS

function OnGetChartData() {// Test 3
    var guid = $('#scenarioguid').val();
    var chart = $('#chartname').val();
    var reportPath = $('#reportPath').val();
    OnGetJson('/service/getchartrawdata', {
        scenarioGuid: guid,
      chart: chart,
      reportPath: reportPath
    });
}

An abbreviated sample of what is returned is as follows.

JS

{
  "Data": [
    {
      "ColNames": [
        "",
        "Total assets"
      ],
      "SectionName": "",
      "Data": [
        [
          "2021/22",
          2316364.04283301
        ],
        [
          "2022/23",
          2446353.35967528
        ],
        [
          "2023/24",
          2583215.37061245
        ],
        [
          "2024/25",
          3221456.28585207
        ],
        [
          "2025/26",
          3403235.60604116
        ],
        [
          "2026/27",
          3597108.23257548
        ],
        [
          "2027/28",
          3801416.86548106
        ],
        [
          "2028/29",
          4010282.13941248
        ],
        [
          "2029/30",
          4232175.07049075
        ],
        [
          "2030/31",
          4505229.81913153
        ],
        [
          "2031/32",
          4707479.54419327
        ],
        [
          "2032/33",
          4768366.06294723
        ],
        [
          "2033/34",
          4828982.60948957
        ],
        [
          "2034/35",
          4889232.41439831
        ],
        [
          "2035/36",
          4949011.76724686
        ],
        [
          "2036/37",
          5008209.61594746
        ],
        [
          "2037/38",
          5066707.14466937
        ],

`/service/getActionItems` – Get all Action Items

The data for all Action items can be returned by calling code similar to the following.

JS

function OnGetActionItems() {
    var guid = $('#scenarioguid').val();
    OnGetJson('/service/getactionitems', {
        scenarioGuid: guid
    });
}

An abbreviated example of what is returned is as follows.

JS

[
  {
    "ReportName": "Action items 2021/22",
    "Data": [
      {
        "ColNames": [
          "Messages",
          "Presentation"
        ],
        "SectionName": "Action items 2021/22",
        "Data": [
          [
            "Robert, in 2021/22 it is recommended you do the following:",
            "s:h1"
          ],
          [
            "Make a voluntary pre-tax contribution of $1,026 making your total concessional contribution $10,026 (including super guarantee payment of $9,000) which is well below the sum of this year's cap of $27,500 and your available unused cap of $53,343. The contribution may be your salary sacrifice, personal deductible contributions or both.",
            "f:normal"
          ],
          [
            "Maintain your existing insurances as follows:",
            "f:normal"
          ],
          [
            "\t'Robert IP insurance' (Income protection insurance) paid directly with a premium of $1,200pa.",
            "f:normal"
          ],

/service/getAssumptionsReport function

/service/getSummaryReports function – Get Summary Reports

Text parameter

Charts parameter

OwnerName parameter

/service/getChartRawData function – Get Chart Data

/service/getActionItems – Get all Action Items