Report - Pension Summary

GET {{baseUrl}}/sf/funds/:fundId/reports/pensionSummary?financialYear={{financialYear}}

Allows you to retrieve a Pension Sumary for fund based on a Financial Year.

API Scopes

The following API scopes can access this resouce - investment - audit - smsf_partner

Response

Fund Data

Pensions Array

| Field | Data Type | Comments | | -------- | -------- | -------- | | peopleId | string | Unique Identifier of person in Simple Fund 360 | | contactId | string | Unique Identifier of person in Simple Fund 360 | | accounts | array | see below |

Accounts Array

| Field | Data Type | Comments | | -------- | -------- | -------- | | accountDescription | string | Description entered by the user for the Pension Account | | accountPhase | string | will return either Retirement Phase or Accumulation | | amountToReachMinimum | number | number of dollars required for this pension to reach the minimum | | endDate | date | yyyy-MM-dd : The end date of the pension if the account ceased during the Financial Year of the report. | | grossPensionPayments | number | The total pension payments recorded for this pension account for the Financial Year | | memberCode | string | The member code assigned to this Pension Account. This will also be equal to the sub-account code on other APIs | | minimum | number | The Minimum Pension amount required for this Pension Account for the Financial Year. | | maximum | number | The Maximum Pension amount (if applicable) required for this Pension Account for the Financial Year. | | netPensionPayments | number | The total pension payments recorded for this pension account for the Financial Year less PAYG payments | | note | string | Addtional details were pensionhas reverted | | openingBalance | number | The Balanace of the account as at July 1st of the Financial Year or the Penson startDate if the income stream commenced during the Financial Year. | | payg | number | The total PAYG amount withheld which has been recorded this Pension Account for the Financial Year. | | pensionType | string | Type of Pension | | reversionAccountCode | string | The Account Code, the Pension reverted from. | | reversionDate | date | Date original Pension reverted to Beneficiary | | reversionaryPensionDateOfDeath | Date | Date of death for orignal pension member | | startDate | date | The Start Date of this Pension | | taxFreeProportion | number | The Tax Free proportion recorded for this Pension Account |

Request Params

HEADERS

RESPONSES

status: OK

{"financialYear":"2018","fundAmountToReachMinimum":8320,"fundGrossPensionPayments":16500,"fundId":"8ad08af2632421da0163247db6d10005","fundMinimum":24820,"fundName":"Jones Retirement Fund","fundPayg":0,"fundPensionPayments":16500,"pensions":[{"accounts":[{"accountDescription":"Account Based Pension","accountPhase":"Retirement Phase","amountToReachMinimum":30,"endDate":null,"grossPensionPayments":0,"maximum":0,"memberCode":"JONJOH30020P","minimum":30,"netPensionPayments":0,"note":"","openingBalance":7962.53,"payg":0,"pensionType":"Account Based Pension","reversionAccountCode":null,"reversionDate":null,"reversionaryPensionDateOfDeath":null,"startDate":"30/05/2018","taxFreeProportion":0}],"contactId":"8a009e3b4cf98131014cf98b58750000","peopleId":"8a009e3b4cf98131014cf98b587e0001"},{"accounts":[{"accountDescription":"Account Based Pension","accountPhase":"Retirement Phase","amountToReachMinimum":8290,"endDate":null,"grossPensionPayments":16500,"maximum":0,"memberCode":"JONMAR30021P","minimum":24790,"netPensionPayments":16500,"note":"","openingBalance":500000,"payg":0,"pensionType":"Account Based Pension","reversionAccountCode":null,"reversionDate":null,"reversionaryPensionDateOfDeath":null,"startDate":"04/07/2017","taxFreeProportion":60}],"contactId":"8a009ec44d0e83ba014d1c144e0a0002","peopleId":"8a009ec44d0e83ba014d1c144e0d0003"}]}