Entity Details
GET {{baseUrl}}/sf/funds/{{fundId}}
Allows you to retrieve the entity details based on a FundId
API Scopes
The following API scopes can access this resouce
- investment
- audit
- smsf_partner
- bgl_partner
Entities Supported
The following entityTypes are supported
- SMSF
- BillableTrust
- BillableCompany
- BillableIndividual
Response
| Key | Type | Mandatory | Description/Constraints |
|---|---|---|---|
| abn | number | No | ABN of the entity if entered in SF360 |
| badgeId | Number | No | Badge id of the firm |
| billableCompanyType | String | Yes for Companies | From List (Private, Public,LifeInsurance,RSAProvidersOtherThanLifeInsurance, PooledDevelopmentFunds,SmallCreditUnions, MediumCreditUnion, LargeCreditUnions, NotForProfit |
| billableTrustType | String | Yes for Trusts | From List (Discretionary,Unit, Hybrid, Testamentary,Bare,Business,PrivateAncillary ) |
| dateFormed | date | No | format yyyy-MM-dd |
| enteringOpeningBalance | Boolean | No | True or False |
| entityType | String | No | From list ( SMSF / Company/ Trust / Individual ) |
| esa | String | No | Electronic Service Address for an SMSF |
| financialYearFrom | date | No | format yyyy-MM-dd |
| financialYearEnd | date | No | format yyyy-MM-dd |
| fundCode | String | No | Code issued to the entity by the account owner/ auto-created by Simple Fund 360 |
| gstregistered | string | No | true or false |
| name | String | No | The name of the entity |
| physicalAddress | Object | No | see Address Array below |
| postalAddress | Object | No | see Address Array below |
| systemStartDate | date | No | format yyyy-MM-dd |
| taxEffectAccount | string | No | true or false |
| trustDeedRuleClauseDeathBenefit | String | No | |
| trustDeedLastModifiedDate | date | No | format yyyy-MM-dd |
| trustDeedSource | String | No | |
| tfn | number | No | TFN of the entity if entered in SF360 |
| windUpDate | date | No | format yyyy-MM-dd |
Address Object
| Key | Type | Mandatory | Constraints/Comments |
|---|---|---|---|
| streetLine1 | String | Yes | |
| streetLine2 | String | No | |
| city | String | Yes | |
| state | String | Yes | One of (ACT’/‘NSW’/‘VIC’/‘QLD’/‘SA’/‘WA’/‘TAS’/‘NT) |
| postCode | String | Yes | |
| country | String | Yes | Country code as defined in https://en.wikipedia.org/wiki/ISO3166-1alpha-2 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"abn":"84111122223","badgeId":1322,"billableCompanyType":null,"billableTrustType":null,"dateFormed":"2013-07-08","enteringOpeningBalance":false,"entityType":"SMSF","esa":"AUSPOSTSMSF","financialYearEnd":"2021-06-30","financialYearFrom":"2020-07-01","fundCode":"JEEVAN101832","id":"000000004636a3060146372123456789","name":"The Sample Super Fund","physicalAddress":{"city":"Melbourne","country":"AU","postCode":"3000","state":"VIC","streetLine1":"123 Fake Street","streetLine2":""},"postalAddress":{"city":"Melbourne","country":"AU","postCode":"3000","state":"VIC","streetLine1":"123 Fake Street","streetLine2":""},"systemStartDate":null,"tfn":"******123","trustDeedLastModifiedDate":"2013-07-08","trustDeedRuleClauseDeathBenefit":"","trustDeedSource":"Top Docs ","windUpDate":null}