Member Details
GET {{baseUrl}}/sf/funds/:fundId/members?financialYear={{financialYear}}
Allows you to retrieve a List of members for the fund, a list of accounts which they have and the account balances at the start and end of the Financial Year.
API Scopes
The following API scopes can access this resouce - investment - audit - smsf_partner
Entities Supported
The following entityTypes are suppoprted - SMSF
Account Details
| Key | Data Type | Constraints/Description |
|---|---|---|
| accountDescription | String | Freeform description of pension entered by the user |
| accountPhase | Object | Accumulationor RetirementPhase |
| accountType | Object | Accumulationor Pension. A TRIS will always be regarded as a Pension for this field. |
| closingBalanceAt30June | number | Account Balance as at June 30 for the Financial Year requested |
| commencementConditionOfRelease | ConditionOfRelease | see below |
| conditionOfReleaseFromTRISRetire | ConditionOfRelease | see below |
| conversionConditionOfRelease | ConditionOfRelease | see below |
| conversionDate | String | Date pension was converted to an ABP |
| conversionDateFromTRISRetire | Date | Date pension was converted from a TRIS to a TRIS (Retirement Phase) |
| endDate | Date | If account has been closed then then date is returned |
| lastPensionType | String | If pension was converted to an ABP the previous pension type id displayed here. |
| lastPensionTypeFromTRISRetire | String | Text |
| memberCode | String | Member Code of Member Account |
| openingBalanceAt1July | Number | Account Balance as at 1st July for the Financial Year requested |
| 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. |
ConditionOfRelease
| Key | Description |
|---|---|
| Age65 | Attaining Age 65 |
| Retirement | Retirement |
| TMCondition | Terminal Medical Condition |
| PI | Permanent Incapacity |
| CG | Compassionate Grounds |
| Death | Death |
| SFH | Severe Financial Hardship |
| TI | Temporary Incapacity |
Account Details will repeat for each member account the person has
Person Details
| Key | Data Type | Contraints/Description |
|---|---|---|
| addressId | String | UniqueID of address for a firm. If address is used for multiple people or companies the id will be the same. |
| country | String | Address - Country |
| dob | Date | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
| String | email address if known | |
| firstName | String | Person's first name |
| lastName | String | Person's last name |
| otherName | String | Person's other/middle names |
| peopleId | String | UniqueID of person for a firm. If person is used for multiple companies or funds the id will be the same. |
| phone | String | phone number if known |
| postcode | String | Address - Postcode |
| state | object | 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 |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
financialYear | string | Required |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
[{"accounts":[{"accountDescription":"Accumulation","accountPhase":"Accumulation","accountType":"Accumulation","closingBalanceAt30June":850,"commencementConditionOfRelease":null,"conditionOfReleaseFromTRISRetire":null,"conversionConditionOfRelease":null,"conversionDate":null,"conversionDateFromTRISRetire":null,"endDate":null,"lastPensionType":null,"lastPensionTypeFromTRISRetire":null,"memberCode":"JONJOH00003A","openingBalanceAt1July":0,"pensionType":null,"startDate":"2015-07-01","taxFreeProportion":null}],"addressId":"1759059","country":"AUSTRALIA","dateOfDeath":null,"dob":"1947-11-09","email":null,"firstName":"John","gender":"MALE","lastName":"Jones","mobile":null,"otherName":null,"peopleId":"8ad08aec5eb73bcf015eb777cf160004","phone":null,"postCode":"3187","state":"VIC","streetLine1":"Suite 2","streetLine2":"606 - 608 Hawthorn Road","suburb":"Brighton East","tfn":"Provided","title":null}]