Report - Member's Statement
GET {{baseUrl}}/sf/funds/:fundId/reports/membersStatement?start={{start}}&end={{end}}
The Member's Statement will report each Member Account's balances, movement, Preservation components and Taxation components for a period.
API Scopes
The following API scopes can access this resouce - investment - audit - smsf_partner
Response Body
| Key | Type | Comments |
|---|---|---|
| accounts | array | see accounts array |
| addressId | String | UniqueID of address for a firm. If the address is used for multiple people or companies the id will be the same. |
| country | String | Address - Country |
| dob | Date | Person's Date of birth. ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| string | Person's email address if known | |
| firstName | string | Perosn's first name |
| lastName | string | Person's last name |
| otherName | string | Person's other/middle names |
| peopleId | string | UniqueID of the person for a firm. If a person is used for multiple companies or funds the id will be the same. |
| phone | phone | person's phone number if known |
| postcode | string | Address - Postcode |
| state | string | List in ( VIC, NSW, QLD, WA, NSW, ACT, TAS, FOR) |
| streetLine1 | String | Address - Street Line 1 |
| streetLine2 | String | Address - Street Line 2 |
| suburb | String | Address - Suburb |
| tfn | String | will return 'Provided' or 'Not Provided' |
| title | String | Title if known |
Accounts Array
| Key | Type | Comments |
|---|---|---|
| accountDescription | String | Freeform description of account entered by the user |
| accountPhase | Object | Accumulationor RetirementPhase |
| accountType | Object | Accumulationor Pension. A TRIS will always be regarded as a Pension for this field. |
| balanceClosing | number | Account Balance as at End Date requested |
| balanceOpening | Number | Account Balance as at Start Date requested |
| balancePreserved | number | Preserved balance as at end date. |
| balanceRestrictedNonPreserved | number | Restricted Non Preserved as at end date. |
| balanceTaxable | number | Member's Taxable balance as at the end date. |
| balanceTaxFree | number | Member's Tax-Free balance as at the end date. |
| balanceUnrestrictedNonPreserved | number | Unrestricted Non Preserved balance as at end date. |
| beneficiaries | Array | See below |
| decreaseBenefitsPaidTransfersOut | number | Total Benefits Paid/Transfers Out recorded for the period |
| decreaseContributionsTax | number | Total Contributions Tax recorded for the period |
| decreaseDivision293Tax | number | Total Division 293 Tax recorded for the period |
| decreaseExcessContributionsTax | number | Total Excess Contributions Tax recorded for the period |
| decreaseIncomeTax | number | Total Income Tax recorded for the period |
| decreaseInsurancePolicyPremiums | number | Total Insurance Policy Premiums Paid recorded for the period |
| decreaseInternalTransferOut | number | Total Internal Transfer Out recorded for the period |
| decreaseManagementFees | number | Total Management Fees recorded for the period |
| decreaseMemberExpenses | number | Total Member Expenses recorded for the period |
| decreaseNoTFN ExcessTax | number | Total No TFN Excess Contributions Tax recorded for the period |
| decreasePensionsPaid | number | Total Pensions Paid recorded for the period |
| decreaseRefundExcessContributions | number | Total Refund Excess Contributions recorded for the period |
| decreaseSuperannuationSurchargeTax | number | Total Superannuation Surcharge Tax recorded for the period |
| endDate | Date | If the account has been closed then the date is returned |
| increaseEmployerContributions | number | Total Employer Contributions recorded for the period |
| increaseGovernmentCoContributions | number | Total Government Co-Contributions recorded for the period |
| increaseInternalTransferIn | number | Total Internal Transfer In recorded for the period |
| increaseNetEarnings | number | Total Net Earnings recorded for the period |
| increasePersonalContributionsConcessional | number | Total Personal Concessional Contributions recorded for the period |
| increasePersonalContributionsNonConcessional | number | Total Personal NCC Contributions recorded for the period |
| increaseProceedsOfInsurancePolicies | number | Total Proceeds of Insurance Policies recorded for the period |
| increaseTransfersIn | number | Total Transfers In recorded for the period |
| memberCode | String | Member Code of Member Account recorded for the period |
| nominationBinding | boolean | For Death Benefit Nominations, has been created as binding or non-binding |
| nominationTimeframe | String | 3 year Lapsingor Non Lapsing. Used for Death Benefit Nominations |
| nominationEndDate | Date | Used for Death Benefit Nominations |
| pensionSetupWithReversionaryBeneficiary | boolean | Trueor "False: Has Pension been setup with a Reversionary Beneficiary |
| pensionType | Object | List in (Accumulation = null, Account-Based Pension = AccountBasedPension, Market Linked Pension = MarketLinkedPension, TRIS (Retirement Phase) = TRISRetirementPhase, Transition to Retirement Pension = TransitionToRetirement, Allocated Pension = AllocatedPension, Complying Pension = ComplyingPension) |
| startDate | Date | The date the member account commenced in the fund |
| taxFreeProportion | Number | The tax-free percentage of the member's account balance will display. This amount is automatically calculated based on the taxable and tax-free components of the member's balances upon pension commencement. |
| totalDeathBenefit | Number | Account Entitlement in the event of death. |
| totalDisbabilityBenefit | Number | Account Entitlement in the event of a Permanent Disability. |
| vestedBenefits | Number | Superannuation is said to vest in a member when the member becomes legally entitled to it |
Beneficiaries Array
| Key | Type | Comments |
|---|---|---|
| firstName | String | Person's first name |
| lastName | String | |
| nominationLastModified | Date | Date and time Beneficiary details were last modified. |
| otherName | String | Person's other/middle names |
| peopleId | String | UniqueID of the person for a firm. If a person is used for multiple companies or funds the id will be the same. |
| relationship | String | User Entered e.g Spouse |
| proportion | Number | 1-100% |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start | string | [REQUIRED] Start Date of Report. Expected format : YYYY/MM/DD | |
end | string | [REQUIRED] End Date of Report. Expected format : YYYY/MM/DD |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"members":[{"accounts":[{"accountDescription":"Pension","accountPhase":"Retirement Phase","accountType":"Pension","balanceClosing":542290,"balanceOpening":535467,"balancePreserved":0,"balanceRestrictedNonPreserved":0,"balanceTaxFree":62779,"balanceTaxable":479511,"balanceUnrestrictedNonPreserved":542290,"beneficiaries":[{"firstName":"Mary","lastName":"Jones","nominationLastModified":"2020-09-14","otherName":null,"peopleId":"8ad08b356cf44a92016cf597be3a003a","proportion":100,"relationship":"Wife"}],"decreaseBenefitsPaidTransfersOut":0,"decreaseContributionsTax":0,"decreaseDivision293Tax":0,"decreaseExcessContributionsTax":0,"decreaseIncomeTax":0,"decreaseInsurancePolicyPremiums":0,"decreaseInternalTransferOut":0,"decreaseManagementFees":0,"decreaseMemberExpenses":0,"decreaseNoTFNExcessTax":0,"decreasePensionsPaid":0,"decreaseRefundExcessContributions":0,"decreaseSuperannuationSurchargeTax":0,"endDate":"","increaseEmployerContributions":0,"increaseGovernmentCoContributions":0,"increaseInternalTransferIn":0,"increaseNetEarnings":6823,"increaseOtherContributions":0,"increasePersonalContributionsConcessional":0,"increasePersonalContributionsNonConcessional":0,"increaseProceedsOfInsurancePolicies":0,"increaseTransfersIn":0,"memberCode":"JONJOH00001P","nominationBinding":true,"nominationEndDate":null,"nominationTimeframe":"NonLapsing","pensionSetupWithReversionaryBeneficiary":false,"pensionType":"AccountBasedPension","startDate":"1994-06-14","taxFreeProportion":11.58,"totalDeathBenefit":1542290,"totalDisbabilityBenefit":0,"vestedBenefits":542290},{"accountDescription":"Accumulation","accountPhase":"Accumulation Phase","accountType":"Accumulation","balanceClosing":546206,"balanceOpening":519362,"balancePreserved":0,"balanceRestrictedNonPreserved":0,"balanceTaxFree":520000,"balanceTaxable":26206,"balanceUnrestrictedNonPreserved":546206,"beneficiaries":[],"decreaseBenefitsPaidTransfersOut":0,"decreaseContributionsTax":3750,"decreaseDivision293Tax":0,"decreaseExcessContributionsTax":0,"decreaseIncomeTax":1035,"decreaseInsurancePolicyPremiums":0,"decreaseInternalTransferOut":0,"decreaseManagementFees":0,"decreaseMemberExpenses":0,"decreaseNoTFNExcessTax":0,"decreasePensionsPaid":0,"decreaseRefundExcessContributions":0,"decreaseSuperannuationSurchargeTax":0,"endDate":"","increaseEmployerContributions":0,"increaseGovernmentCoContributions":0,"increaseInternalTransferIn":0,"increaseNetEarnings":6629,"increaseOtherContributions":0,"increasePersonalContributionsConcessional":25000,"increasePersonalContributionsNonConcessional":0,"increaseProceedsOfInsurancePolicies":0,"increaseTransfersIn":0,"memberCode":"JONJOH00002A","nominationBinding":false,"nominationEndDate":null,"nominationTimeframe":null,"pensionSetupWithReversionaryBeneficiary":false,"pensionType":null,"startDate":"1994-06-14","taxFreeProportion":null,"totalDeathBenefit":null,"totalDisbabilityBenefit":null,"vestedBenefits":546206}],"addressId":"18435","country":"AUSTRALIA","dob":"1947-09-05","email":null,"firstName":"John","lastName":"Jones","otherName":null,"peopleId":"8ad08bf35f7b8296015fb8492c2200dd","phone":"0396960000","postcode":"3205","state":"VICTORIA","streetLine1":"12 Market Street","streetLine2":null,"suburb":"South Melbourne","tfn":"Provided","title":null},{"accounts":[{"accountDescription":"Accumulation","accountPhase":"Accumulation Phase","accountType":"Accumulation","balanceClosing":977776,"balanceOpening":843027,"balancePreserved":968652,"balanceRestrictedNonPreserved":0,"balanceTaxFree":414235,"balanceTaxable":563541,"balanceUnrestrictedNonPreserved":9124,"beneficiaries":[],"decreaseBenefitsPaidTransfersOut":0,"decreaseContributionsTax":2010,"decreaseDivision293Tax":0,"decreaseExcessContributionsTax":0,"decreaseIncomeTax":1688,"decreaseInsurancePolicyPremiums":0,"decreaseInternalTransferOut":0,"decreaseManagementFees":0,"decreaseMemberExpenses":0,"decreaseNoTFNExcessTax":0,"decreasePensionsPaid":0,"decreaseRefundExcessContributions":0,"decreaseSuperannuationSurchargeTax":0,"endDate":"","increaseEmployerContributions":0,"increaseGovernmentCoContributions":0,"increaseInternalTransferIn":0,"increaseNetEarnings":10812,"increaseOtherContributions":0,"increasePersonalContributionsConcessional":13400,"increasePersonalContributionsNonConcessional":114235,"increaseProceedsOfInsurancePolicies":0,"increaseTransfersIn":0,"memberCode":"JONMAR00001A","nominationBinding":false,"nominationEndDate":null,"nominationTimeframe":null,"pensionSetupWithReversionaryBeneficiary":false,"pensionType":null,"startDate":"1994-06-14","taxFreeProportion":null,"totalDeathBenefit":1977776,"totalDisbabilityBenefit":0,"vestedBenefits":977776}],"addressId":"18435","country":"AUSTRALIA","dob":"1948-08-17","email":null,"firstName":"Mary","lastName":"Jones","otherName":null,"peopleId":"8ad08bf35f7b8296015fb8492c2900df","phone":"0396960000","postcode":"3205","state":"VICTORIA","streetLine1":"12 Market Street","streetLine2":null,"suburb":"South Melbourne","tfn":"Provided","title":null}]}